shithub: leaf

ref: ffde7bf885e8a4dbe08b470c82344e16805b0022
dir: /LEAF/Inc/leaf-global.h/

/*
 ==============================================================================
 
 leaf-global.h
 Created: 24 Oct 2019 2:24:38pm
 Author:  Matthew Wang
 
 ==============================================================================
 */

#ifndef LEAF_GLOBAL_H_INCLUDED
#define LEAF_GLOBAL_H_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif
    
#include "leaf-mempool.h"
    
    /*!
     * @ingroup leaf
     * @brief The struct of the global LEAF instance `leaf`. Contains global variables and settings.
     */
    struct LEAF
    {
        ///@{ 
        float   sampleRate; //!< The current audio sample rate. Set with LEAF_setSampleRate().
        float   invSampleRate; //!< The inverse of the current sample rate.
        int     blockSize; //!< The audio block size.
        float   twoPiTimesInvSampleRate; //!<  Two-pi times the inverse of the current sample rate.
        float   (*random)(void); //!< A pointer to the random() function provided on initialization.
        int     clearOnAllocation; //!< A flag that determines whether memory allocated from the LEAF memory pool will be cleared.
        tMempool mempool; //!< The default LEAF mempool object.
        _tMempool _mempool;
        size_t header_size; //!< The size in bytes of memory region headers within mempools.
        ///@}
    };
    typedef struct LEAF LEAF;
    
    extern LEAF leaf;
    
    //==============================================================================
    
#ifdef __cplusplus
}
#endif

#endif  // LEAF_GLOBAL_H_INCLUDED

//==============================================================================