ambi_drc_internal.h

Go to the documentation of this file.

/*
 * 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_INTERNAL_H_INCLUDED__
#define __AMBI_DRC_INTERNAL_H_INCLUDED__
 
#include "ambi_drc.h"      /* Include header for this example */
#include "saf.h"           /* Main include header for SAF */
#include "saf_externals.h" /* To also include SAF dependencies (cblas etc.) */
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                            Internal Parameters                             */
/* ========================================================================== */
 
#if !defined(AMBI_DRC_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define AMBI_DRC_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define AMBI_DRC_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                              
#define HYBRID_BANDS ( HOP_SIZE + 5 )                 
#define TIME_SLOTS ( AMBI_DRC_FRAME_SIZE / HOP_SIZE ) 
/* Checks: */
#if (AMBI_DRC_FRAME_SIZE % HOP_SIZE != 0)
# error "AMBI_DRC_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
    
typedef struct _ambi_drc
{ 
    /* audio buffers and afSTFT handle */
    float** frameTD;                 
    float_complex*** inputFrameTF;   
    float_complex*** outputFrameTF;  
    void* hSTFT;                     
    float freqVector[HYBRID_BANDS];  
    /* internal */
    int nSH;                         
    int new_nSH;                     
    float fs;                        
    float yL_z1[HYBRID_BANDS];       
    int reInitTFT;                   
#ifdef ENABLE_TF_DISPLAY
    int wIdx;                        
    int rIdx;                        
    int storeIdx;                    
    float** gainsTF_bank0;           
    float** gainsTF_bank1;           
#endif
 
    /* user parameters */
    float theshold;                  
    float ratio;                     
    float knee;                      
    float inGain;                    
    float outGain;                   
    float attack_ms;                 
    float release_ms;                
    CH_ORDER chOrdering;             
    NORM_TYPES norm;                 
    SH_ORDERS currentOrder;          
} ambi_drc_data;
     
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
float ambi_drc_gainComputer(float xG, float T, float R, float W);
 
float ambi_drc_smoothPeakDetector(float xL, float yL_z1, float alpha_a, float alpha_r);
    
void ambi_drc_initTFT(void* const hAmbi);
 
void ambi_drc_setInputOrder(SH_ORDERS inOrder, int* nSH);
 
    
#ifdef __cplusplus
} /* extern "C" */
#endif/* __cplusplus */
 
#endif /* __AMBI_DRC_INTERNAL_H_INCLUDED__ */