spreader.h

Go to the documentation of this file.

/*
 * Copyright 2021 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef __SPREADER_H_INCLUDED__
#define __SPREADER_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "_common.h"
 
#define SPREADER_MAX_NUM_SOURCES ( 8 )
 
typedef enum {
    SPREADER_MODE_NAIVE = 1, 
    SPREADER_MODE_OM,        
    SPREADER_MODE_EVD        
} SPREADER_PROC_MODES;
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void spreader_create(void** const phSpr);
 
void spreader_destroy(void** const phSpr);
 
void spreader_init(void* const hSpr,
                   int samplerate);
 
void spreader_initCodec(void* const hSpr);
 
void spreader_process(void* const hSpr,
                      const float *const * inputs,
                      float* const* outputs,
                      int nInputs,
                      int nOutputs,
                      int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void spreader_refreshSettings(void* const hSpr);
 
void spreader_setSpreadingMode(void* const hSpr, int newMode);
 
void spreader_setAveragingCoeff(void* const hSpr, float newValue);
    
void spreader_setSourceAzi_deg(void* const hSpr,
                               int index,
                               float newAzi_deg);
 
void spreader_setSourceElev_deg(void* const hSpr,
                                int index,
                                float newElev_deg);
 
void spreader_setSourceSpread_deg(void* const hSpr,
                                  int index,
                                  float newSpread_deg);
 
void spreader_setNumSources(void* const hSpr, int new_nSources);
 
void spreader_setUseDefaultHRIRsflag(void* const hSpr, int newState);
 
void spreader_setSofaFilePath(void* const hSpr, const char* path);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int spreader_getFrameSize(void);
 
CODEC_STATUS spreader_getCodecStatus(void* const hSpr);
 
float spreader_getProgressBar0_1(void* const hSpr);
 
void spreader_getProgressBarText(void* const hSpr, char* text);
 
int* spreader_getDirectionActivePtr(void* const hSpr, int index);
 
int spreader_getSpreadingMode(void* const hSpr);
 
float spreader_getAveragingCoeff(void* const hSpr);
 
float spreader_getSourceAzi_deg(void* const hSpr, int index);
 
float spreader_getSourceElev_deg(void* const hSpr, int index);
 
float spreader_getSourceSpread_deg(void* const hSpr, int index);
 
int spreader_getNumSources(void* const hSpr);
 
int spreader_getMaxNumSources(void);
 
int spreader_getNumOutputs(void* const hSpr);
 
int spreader_getNDirs(void* const hSpr);
 
float spreader_getIRAzi_deg(void* const hSpr, int index);
 
float spreader_getIRElev_deg(void* const hSpr, int index);
 
int spreader_getIRlength(void* const hSpr);
 
int spreader_getIRsamplerate(void* const hSpr);
 
int spreader_getUseDefaultHRIRsflag(void* const hSpr);
 
char* spreader_getSofaFilePath(void* const hSpr);
 
int spreader_getDAWsamplerate(void* const hSpr);
 
int spreader_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __SPREADER_H_INCLUDED__ */