Config.hpp

Go to the documentation of this file.

#include "MayaFlux/Journal/JournalEntry.hpp"
 
namespace MayaFlux {
 
namespace Nodes {
    struct NodeConfig;
}
 
namespace Core {
    struct GlobalStreamInfo;
    struct GlobalGraphicsConfig;
    struct GlobalInputConfig;
    struct GlobalNetworkConfig;
}
 
/**
 * @brief Checks if the default engine has currently accepted all configurations and initialized all managers
 * @return True if the engine is ready for processing, false otherwise
 */
MAYAFLUX_API bool is_engine_configured();
 
/**
@brief Globlal configuration for MayaFlux
*
* This namespace contains global configuration settings for MayaFlux, including graph and node configurations.
* It provides access to settings such as sample rate, buffer size, and number of output channels
* from the default audio engine.
*/
namespace Config {
 
    MAYAFLUX_API Nodes::NodeConfig& get_node_config();
 
    /**
     * @brief Sets the node configuration for the default engine
     * @param config The NodeConfig to set
     */
    MAYAFLUX_API void set_node_config(const Nodes::NodeConfig& config);
 
    /**
     * @brief Gets the sample rate from the default engine
     * @return Current sample rate in Hz
     */
    MAYAFLUX_API uint32_t get_sample_rate();
 
    /**
     * @brief Gets the buffer size from the default engine
     * @return Current buffer size in frames
     */
    MAYAFLUX_API uint32_t get_buffer_size();
 
    /**
     * @brief Gets the number of output channels from the default engine
     * @return Current number of output channels
     */
    MAYAFLUX_API uint32_t get_num_out_channels();
 
    /**
     * @brief Gets the stream configuration from the default engine
     * @return Copy of the GlobalStreamInfo struct
     */
    MAYAFLUX_API Core::GlobalStreamInfo& get_global_stream_info();
 
    /**
     * @brief Gets the graphics configuration from the default engine
     * @return Copy of the GlobalGraphicsConfig struct
     */
    MAYAFLUX_API Core::GlobalGraphicsConfig& get_global_graphics_config();
 
    /**
     * @brief Gets the input configuration from the default engine
     * @return Copy of the GlobalInputConfig struct
     */
    MAYAFLUX_API Core::GlobalInputConfig& get_global_input_config();
 
    /**
     * @brief Gets the network configuration from the default engine
     * @return Copy of the GlobalNetworkConfig struct
     */
    MAYAFLUX_API Core::GlobalNetworkConfig& get_global_network_config();
 
    /**
     * @brief Sets the minimum severity level for journal entries to be logged
     * @param severity Minimum severity level (e.g., INFO, WARN, ERROR, TRACE, DEBUG, FATAL)
     */
    MAYAFLUX_API void set_journal_severity(Journal::Severity severity);
 
    /**
     * @brief Enables or disables logging for specific journal components
     * @param component Vector of Journal::Component values to enable/disable
     * @param enabled True to enable logging for the specified components, false to disable
     */
    MAYAFLUX_API void set_journal_component_filter(const std::vector<Journal::Component>& component, bool enabled);
 
    /**
     * @brief Enables or disables logging for specific journal contexts
     * @param context Vector of Journal::Context values to enable/disable
     * @param enabled True to enable logging for the specified contexts, false to disable
     */
    MAYAFLUX_API void set_journal_context_filter(const std::vector<Journal::Context>& context, bool enabled);
 
    /**
     * @brief Stores journal entries to a file by adding a FileSink to the Archivist
     * @param file_name Path to the log file
     */
    MAYAFLUX_API void store_journal_entries(const std::string& file_name);
 
    /**
     * @brief Outputs journal entries to the console by adding a ConsoleSink to the Archivist
     * NOTE: This records thread safe entries and cannot unsink once called.
     */
    MAYAFLUX_API void sink_journal_to_console();
 
    /**
     * @brief Load engine configuration from a JSON file, applying any present fields
     *        to the pre-Init config structs.
     * @param path Path to a mayaflux.json file.
     * @return True if the file was read and at least partially applied. False if the
     *         file could not be opened or parsed; last_error() will be set.
     * @note Must be called before Init(). Fields absent from the file retain defaults.
     */
    MAYAFLUX_API bool load_config_from_file(const std::string& path);
}
 
}