sound_observation.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_SOUND_OBSERVATION_H
#define OAKFIELD_SOUND_OBSERVATION_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimSoundTranslationSource {
    SIM_SOUND_TRANSLATION_SOURCE_OFF = 0,           
    SIM_SOUND_TRANSLATION_SOURCE_AMPLITUDE,         
    SIM_SOUND_TRANSLATION_SOURCE_PHASE,             
    SIM_SOUND_TRANSLATION_SOURCE_SPECTRAL_CENTROID, 
    SIM_SOUND_TRANSLATION_SOURCE_FIELD              
} SimSoundTranslationSource;
 
typedef enum SimSoundModulatorSource {
    SIM_SOUND_MODULATOR_NONE = 0,      
    SIM_SOUND_MODULATOR_SELF_FIELD,    
    SIM_SOUND_MODULATOR_EXTERNAL_FIELD 
} SimSoundModulatorSource;
 
typedef enum SimSoundSamplingMode {
    SIM_SOUND_SAMPLING_POINT = 0,   
    SIM_SOUND_SAMPLING_MEAN,        
    SIM_SOUND_SAMPLING_RMS,         
    SIM_SOUND_SAMPLING_PEAK,        
    SIM_SOUND_SAMPLING_ABS_MEAN,    
    SIM_SOUND_SAMPLING_ABS_PEAK,    
    SIM_SOUND_SAMPLING_WINDOWED_RMS 
} SimSoundSamplingMode;
 
typedef enum SimSoundSamplingDomain {
    SIM_SOUND_SAMPLING_DOMAIN_PHYSICAL = 0, 
    SIM_SOUND_SAMPLING_DOMAIN_SPECTRAL      
} SimSoundSamplingDomain;
 
typedef enum SimSoundWindowType {
    SIM_SOUND_WINDOW_RECT = 0, 
    SIM_SOUND_WINDOW_HANN,     
    SIM_SOUND_WINDOW_HAMMING,  
    SIM_SOUND_WINDOW_BLACKMAN, 
    SIM_SOUND_WINDOW_KAISER    
} SimSoundWindowType;
 
typedef enum SimSoundPanLaw {
    SIM_SOUND_PAN_LAW_LINEAR = 0, 
    SIM_SOUND_PAN_LAW_EQUAL_POWER 
} SimSoundPanLaw;
 
typedef enum SimSoundPitchScale {
    SIM_SOUND_PITCH_SCALE_LINEAR_HZ = 0, 
    SIM_SOUND_PITCH_SCALE_LOG2_HZ,       
    SIM_SOUND_PITCH_SCALE_MIDI           
} SimSoundPitchScale;
 
typedef enum SimSoundOutputMode {
    SIM_SOUND_OUTPUT_CONTROLS = 0, 
    SIM_SOUND_OUTPUT_RAW_SAMPLES   
} SimSoundOutputMode;
 
typedef enum SimSoundRawSampleSource {
    SIM_SOUND_RAW_SOURCE_REAL = 0,  
    SIM_SOUND_RAW_SOURCE_IMAG,      
    SIM_SOUND_RAW_SOURCE_MAGNITUDE, 
    SIM_SOUND_RAW_SOURCE_PHASE      
} SimSoundRawSampleSource;
 
typedef enum SimSoundRawChannelMode {
    SIM_SOUND_RAW_CHANNEL_MONO = 0,         
    SIM_SOUND_RAW_CHANNEL_STEREO_DUPLICATE, 
    SIM_SOUND_RAW_CHANNEL_STEREO_REAL_IMAG  
} SimSoundRawChannelMode;
 
typedef enum SimSoundResampleMode {
    SIM_SOUND_RESAMPLE_NEAREST = 0, 
    SIM_SOUND_RESAMPLE_LINEAR,      
    SIM_SOUND_RESAMPLE_CUBIC        
} SimSoundResampleMode;
 
typedef struct SimSoundObservationConfig {
    size_t input_field;             
    size_t modulator_field;         
    SimSoundOutputMode output_mode; 
    size_t output_bus;              
    double output_send;             
    bool output_pre_fader;          
    SimSoundSamplingMode sampling_mode;     
    SimSoundSamplingDomain sampling_domain; 
    SimSoundWindowType window_type;         
    size_t window_length;                   
    size_t window_offset;                  
    size_t sample_index;                   
    SimSoundTranslationSource gain_source; 
    SimSoundModulatorSource gain_modulator;  
    double gain_base;                        
    double gain_scale;                       
    double gain_min;                         
    double gain_max;                         
    SimSoundTranslationSource pan_source;    
    SimSoundModulatorSource pan_modulator;   
    double pan_center;                       
    double pan_width;                        
    SimSoundPanLaw pan_law;                  
    SimSoundTranslationSource pitch_source;  
    SimSoundModulatorSource pitch_modulator; 
    double pitch_base_hz;                    
    double pitch_range_octaves;              
    SimSoundPitchScale pitch_scale;          
    SimSoundTranslationSource fm_source;     
    SimSoundModulatorSource fm_modulator;    
    double fm_depth;                         
    double fm_center;                        
    double fm_ratio;                         
    double fm_clip;                          
    double attack_ms;                        
    double release_ms;                       
    double smoothing_tau;                    
    bool scale_by_dt;                        
    SimSoundRawSampleSource raw_source;      
    SimSoundRawChannelMode raw_channel_mode; 
    double raw_gain;                         
    double raw_clip;                         
    SimSoundResampleMode raw_resample_mode;  
} SimSoundObservationConfig;
 
typedef struct SimSoundObservationTap {
    double gain;                    
    double pan;                     
    double pitch_hz;                
    double fm;                      
    SimSoundOutputMode output_mode; 
    bool valid;                     
    size_t step_index;              
} SimSoundObservationTap;
 
SimResult sim_add_sound_observation_operator(struct SimContext *context,
                                             const SimSoundObservationConfig *config,
                                             size_t *out_index);
 
SimResult sim_sound_observation_config(struct SimContext *context, size_t operator_index,
                                       SimSoundObservationConfig *out_config);
 
SimResult sim_sound_observation_update(struct SimContext *context, size_t operator_index,
                                       const SimSoundObservationConfig *config);
 
SimResult sim_sound_observation_tap(struct SimContext *context, size_t operator_index,
                                    SimSoundObservationTap *out_tap);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_SOUND_OBSERVATION_H */