ambi_drc.h

A frequency-dependent Ambisonic sound scene dynamic range compressor (DRC)

A frequency-dependent Ambisonic sound scene dynamic range compressor (DRC)

Files

ambi_drc.h (include), ambi_drc_internal.h, ambi_drc.c, ambi_drc_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_DRC_H_INCLUDED__
#define __AMBI_DRC_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define ENABLE_TF_DISPLAY 
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */
 
#ifdef ENABLE_TF_DISPLAY
# define AMBI_DRC_NUM_DISPLAY_SECONDS ( 8 )
# define AMBI_DRC_NUM_DISPLAY_TIME_SLOTS ( (int)(AMBI_DRC_NUM_DISPLAY_SECONDS*48000.0f/(float)128) )
# define AMBI_DRC_READ_OFFSET ( 200 )
# define AMBI_DRC_NUM_BANDS ( 133 )
#endif
#define AMBI_DRC_SPECTRAL_FLOOR (0.1585f)
 
#define AMBI_DRC_IN_GAIN_MIN_VAL ( -40.0f )   
#define AMBI_DRC_IN_GAIN_MAX_VAL ( 20.0f )    
#define AMBI_DRC_THRESHOLD_MIN_VAL ( -60.0f ) 
#define AMBI_DRC_THRESHOLD_MAX_VAL ( 0.0f )   
#define AMBI_DRC_RATIO_MIN_VAL ( 1.0f )       
#define AMBI_DRC_RATIO_MAX_VAL ( 30.0f )      
#define AMBI_DRC_KNEE_MIN_VAL ( 0.0f )        
#define AMBI_DRC_KNEE_MAX_VAL ( 10.0f )       
#define AMBI_DRC_ATTACK_MIN_VAL ( 10.0f )     
#define AMBI_DRC_ATTACK_MAX_VAL ( 200.0f )    
#define AMBI_DRC_RELEASE_MIN_VAL ( 50.0f )    
#define AMBI_DRC_RELEASE_MAX_VAL ( 1000.0f )  
#define AMBI_DRC_OUT_GAIN_MIN_VAL ( -20.0f )  
#define AMBI_DRC_OUT_GAIN_MAX_VAL ( 40.0f )   
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void ambi_drc_create(void** const phAmbi);
 
void ambi_drc_destroy(void** const phAmbi);
 
void ambi_drc_init(void* const hAmbi,
                   int samplerate);
 
void ambi_drc_process(void* const hAmbi,
                      const float *const * inputs,
                      float* const* outputs,
                      int nCH,
                      int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void ambi_drc_refreshSettings(void* const hAmbi);
 
void ambi_drc_setThreshold(void* const hAmbi, float newValue);
 
void ambi_drc_setRatio(void* const hAmbi, float newValue);
 
void ambi_drc_setKnee(void* const hAmbi, float newValue);
 
void ambi_drc_setInGain(void* const hAmbi, float newValue);
    
void ambi_drc_setOutGain(void* const hAmbi, float newValue);
    
void ambi_drc_setAttack(void* const hAmbi, float newValue);
 
void ambi_drc_setRelease(void* const hAmbi, float newValue);
    
void ambi_drc_setChOrder(void* const hAmbi, int newOrder);
 
void ambi_drc_setNormType(void* const hAmbi, int newType);
    
void ambi_drc_setInputPreset(void* const hAmbi, SH_ORDERS newPreset);
 
    
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int ambi_drc_getFrameSize(void);
 
float** ambi_drc_getGainTF(void* const hAmbi);
 
int ambi_drc_getGainTFwIdx(void* const hAmbi);
 
int ambi_drc_getGainTFrIdx(void* const hAmbi);
 
float* ambi_drc_getFreqVector(void* const hAmbi, int* nFreqPoints);
    
float ambi_drc_getThreshold(void* const hAmbi);
 
float ambi_drc_getRatio(void* const hAmbi);
 
float ambi_drc_getKnee(void* const hAmbi);
 
float ambi_drc_getInGain(void* const hAmbi);
 
float ambi_drc_getOutGain(void* const hAmbi);
 
float ambi_drc_getAttack(void* const hAmbi);
 
float ambi_drc_getRelease(void* const hAmbi);
 
int ambi_drc_getChOrder(void* const hAmbi);
 
int ambi_drc_getNormType(void* const hAmbi);
    
SH_ORDERS ambi_drc_getInputPreset(void* const hAmbi);
    
int ambi_drc_getNSHrequired(void* const hAmbi);
    
int ambi_drc_getSamplerate(void* const hAmbi);
    
int ambi_drc_getProcessingDelay(void);
    
    
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __AMBI_DRC_H_INCLUDED__ */