mixer.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_MIXER_H
#define OAKFIELD_MIXER_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimMixerMode {
    SIM_MIXER_MODE_LINEAR = 0,          
    SIM_MIXER_MODE_MULTIPLY,            
    SIM_MIXER_MODE_CROSSFADE,           
    SIM_MIXER_MODE_SUM,                 
    SIM_MIXER_MODE_POWER,               
    SIM_MIXER_MODE_AM,                  
    SIM_MIXER_MODE_FM,                  
    SIM_MIXER_MODE_PM,                  
    SIM_MIXER_MODE_RING_MOD,            
    SIM_MIXER_MODE_MAX,                 
    SIM_MIXER_MODE_MIN,                 
    SIM_MIXER_MODE_AVERAGE,             
    SIM_MIXER_MODE_DIFFERENCE,          
    SIM_MIXER_MODE_ABSOLUTE_DIFFERENCE, 
    SIM_MIXER_MODE_FEEDBACK             
} SimMixerMode;
 
typedef enum SimMixerFeedbackEpsilonMode {
    SIM_MIXER_FEEDBACK_EPS_INPUT = 0, 
    SIM_MIXER_FEEDBACK_EPS_FEEDBACK   
} SimMixerFeedbackEpsilonMode;
 
typedef enum SimMixerFeedbackSplitMode {
    SIM_MIXER_FEEDBACK_SPLIT_NONE = 0, 
    SIM_MIXER_FEEDBACK_SPLIT_LIE,      
    SIM_MIXER_FEEDBACK_SPLIT_STRANG    
} SimMixerFeedbackSplitMode;
 
typedef struct SimMixerOperatorConfig {
    size_t lhs_field;        
    size_t rhs_field;        
    size_t output_field;     
    double lhs_gain;         
    double rhs_gain;         
    double mix;              
    double bias;             
    double feedback_epsilon; 
    SimMixerMode mode;       
    SimMixerFeedbackEpsilonMode feedback_epsilon_mode; 
    SimMixerFeedbackSplitMode feedback_split; 
    bool accumulate;                          
    bool scale_by_dt; 
} SimMixerOperatorConfig;
 
const char *mixer_mode_name(SimMixerMode mode);
 
const char *mixer_feedback_epsilon_mode_name(SimMixerFeedbackEpsilonMode mode);
 
const char *mixer_feedback_split_name(SimMixerFeedbackSplitMode mode);
 
bool mixer_mode_from_name(const char *name, SimMixerMode *out_mode);
 
bool mixer_feedback_epsilon_mode_from_name(const char *name, SimMixerFeedbackEpsilonMode *out_mode);
 
bool mixer_feedback_split_from_name(const char *name, SimMixerFeedbackSplitMode *out_mode);
 
SimResult sim_add_mixer_operator(struct SimContext *context, const SimMixerOperatorConfig *config,
                                 size_t *out_index);
 
SimResult sim_mixer_config(struct SimContext *context, size_t operator_index,
                           SimMixerOperatorConfig *out_config);
 
SimResult sim_mixer_update(struct SimContext *context, size_t operator_index,
                           const SimMixerOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_MIXER_H */