ambi_dec.h

A frequency-dependent Ambisonic decoder for reproducing Ambisonic sound scenes over loudspeakers.

A frequency-dependent Ambisonic decoder for reproducing Ambisonic sound scenes over loudspeakers

Files

ambi_dec.h (include), ambi_dec_internal.h, ambi_dec.c, ambi_dec_internal.c

Include Header

/*
 * Copyright 2017-2018 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 __AMBI_DEC_H_INCLUDED__
#define __AMBI_DEC_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */
 
typedef enum {
    DECODING_METHOD_SAD = 1, 
    DECODING_METHOD_MMD,     
    DECODING_METHOD_EPAD,    
    DECODING_METHOD_ALLRAD   
} AMBI_DEC_DECODING_METHODS;
 
#define AMBI_DEC_NUM_DECODING_METHODS ( 4 )
 
typedef enum {
    AMPLITUDE_PRESERVING=1, 
    ENERGY_PRESERVING       
} AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH;
 
#define AMBI_DEC_TRANSITION_MIN_VALUE ( 500.0f )
 
#define AMBI_DEC_TRANSITION_MAX_VALUE ( 2000.0f )
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void ambi_dec_create(void** const phAmbi);
 
void ambi_dec_destroy(void** const phAmbi);
 
void ambi_dec_init(void* const hAmbi,
                   int samplerate);
 
void ambi_dec_initCodec(void* const hAmbi);
 
void ambi_dec_process(void* const hAmbi,
                      const float *const * inputs,
                      float* const* outputs,
                      int nInputs,
                      int nOutputs,
                      int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void ambi_dec_refreshSettings(void* const hAmbi);
    
void ambi_dec_setMasterDecOrder(void* const hAmbi,  int newValue);
    
void ambi_dec_setDecOrder(void* const hAmbi,  int newValue, int bandIdx);
 
void ambi_dec_setDecOrderAllBands(void* const hAmbi,  int newValue);
 
void ambi_dec_setLoudspeakerAzi_deg(void* const hAmbi,
                                    int index,
                                    float newAzi_deg);
 
void ambi_dec_setLoudspeakerElev_deg(void* const hAmbi,
                                     int index,
                                     float newElev_deg);
 
void ambi_dec_setNumLoudspeakers(void* const hAmbi, int new_nLoudspeakers);
 
void ambi_dec_setBinauraliseLSflag(void* const hAmbi, int newState);
 
void ambi_dec_setUseDefaultHRIRsflag(void* const hAmbi, int newState);
 
void ambi_dec_setSofaFilePath(void* const hAmbi, const char* path);
 
void ambi_dec_setEnableHRIRsPreProc(void* const hAmbi, int newState);
 
void ambi_dec_setSourcePreset(void* const hAmbi, int newPresetID);
 
void ambi_dec_setOutputConfigPreset(void* const hAmbi, int newPresetID);
 
void ambi_dec_setChOrder(void* const hAmbi, int newOrder);
 
void ambi_dec_setNormType(void* const hAmbi, int newType);
 
void ambi_dec_setDecMethod(void* const hAmbi, int index, int newID);
 
void ambi_dec_setDecEnableMaxrE(void* const hAmbi, int index, int newID);
 
void ambi_dec_setDecNormType(void* const hAmbi, int index, int newID);
 
void ambi_dec_setTransitionFreq(void* const hAmbi, float newValue);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int ambi_dec_getFrameSize(void);
 
CODEC_STATUS ambi_dec_getCodecStatus(void* const hAmbi);
 
float ambi_dec_getProgressBar0_1(void* const hAmbi);
 
void ambi_dec_getProgressBarText(void* const hAmbi, char* text);
 
int ambi_dec_getMasterDecOrder(void* const hAmbi);
    
int ambi_dec_getDecOrder(void* const hAmbi, int bandIdx);
  
int ambi_dec_getDecOrderAllBands(void* const hAmbi);
 
void ambi_dec_getDecOrderHandle(void* const hAmbi,
                                float** pX_vector,
                                int** pY_values,
                                int* pNpoints);
 
int ambi_dec_getNumberOfBands(void);
 
float ambi_dec_getLoudspeakerAzi_deg(void* const hAmbi, int index);
 
float ambi_dec_getLoudspeakerElev_deg(void* const hAmbi, int index);
 
int ambi_dec_getNumLoudspeakers(void* const hAmbi);
 
int ambi_dec_getMaxNumLoudspeakers(void);
 
int  ambi_dec_getNSHrequired(void* const hAmbi); 
 
int ambi_dec_getBinauraliseLSflag(void* const hAmbi);
 
int ambi_dec_getUseDefaultHRIRsflag(void* const hAmbi);
 
char* ambi_dec_getSofaFilePath(void* const hAmbi);
 
int ambi_dec_getEnableHRIRsPreProc(void* const hAmbi);
 
int ambi_dec_getChOrder(void* const hAmbi);
 
int ambi_dec_getNormType(void* const hAmbi);
 
int ambi_dec_getDecMethod(void* const hAmbi, int index);
    
int ambi_dec_getDecEnableMaxrE(void* const hAmbi, int index);
 
int ambi_dec_getDecNormType(void* const hAmbi, int index);
 
float ambi_dec_getTransitionFreq(void* const hAmbi);
    
int ambi_dec_getHRIRsamplerate(void* const hAmbi);
 
int ambi_dec_getDAWsamplerate(void* const hAmbi);
    
int ambi_dec_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __AMBI_DEC_H_INCLUDED__ */