ambi_dec_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_DEC_INTERNAL_H_INCLUDED__
#define __AMBI_DEC_INTERNAL_H_INCLUDED__
 
#include "ambi_dec.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_DEC_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define AMBI_DEC_FRAME_SIZE ( FRAME_SIZE )           
# else /* Otherwise, the default framesize for this example is: */
#  define AMBI_DEC_FRAME_SIZE ( 128 )                  
# endif
#endif
#define HOP_SIZE ( 128 )                               
#define HYBRID_BANDS ( HOP_SIZE + 5 )                  
#define TIME_SLOTS ( AMBI_DEC_FRAME_SIZE / HOP_SIZE )  
#define MAX_NUM_LOUDSPEAKERS ( MAX_NUM_OUTPUTS )       
#define MIN_NUM_LOUDSPEAKERS ( 4 )                     
#define NUM_DECODERS ( 2 )                             
/* Checks: */
#if (AMBI_DEC_FRAME_SIZE % HOP_SIZE != 0)
# error "AMBI_DEC_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _ambi_dec_codecPars
{
    /* decoders */
    float* M_dec[NUM_DECODERS][MAX_SH_ORDER];   
    float_complex* M_dec_cmplx[NUM_DECODERS][MAX_SH_ORDER]; 
    float* M_dec_maxrE[NUM_DECODERS][MAX_SH_ORDER]; 
    float_complex* M_dec_cmplx_maxrE[NUM_DECODERS][MAX_SH_ORDER]; 
    float M_norm[NUM_DECODERS][MAX_SH_ORDER][2]; 
    /* sofa file info */
    char* sofa_filepath;                        
    float* hrirs;                               
    float* hrir_dirs_deg;                       
    int N_hrir_dirs;                            
    int hrir_len;                               
    int hrir_fs;                                
    /* vbap gain table for panning the HRIRs */
    int hrtf_vbapTableRes[2];                   
    int N_hrtf_vbap_gtable;                     
    int hrtf_nTriangles;                        
    int* hrtf_vbap_gtableIdx;                   
    float* hrtf_vbap_gtableComp;                
    /* hrir filterbank coefficients */
    float* itds_s;                              
    float_complex* hrtf_fb;                     
    float* hrtf_fb_mag;                         
    float_complex hrtf_interp[MAX_NUM_LOUDSPEAKERS][HYBRID_BANDS][NUM_EARS]; 
    /* integration weights */
    float* weights;                             
}ambi_dec_codecPars;
 
typedef struct _ambi_dec
{
    /* audio buffers + afSTFT time-frequency transform handle */
    float** SHFrameTD;                   
    float** outputFrameTD;               
    float_complex*** SHframeTF;          
    float_complex*** outputframeTF;      
    float_complex*** binframeTF;         
    void* hSTFT;                         
    int afSTFTdelay;                     
    int fs;                              
    float freqVector[HYBRID_BANDS];      
    /* our codec configuration */
    CODEC_STATUS codecStatus;            
    float progressBar0_1;                
    char* progressBarText;               
    ambi_dec_codecPars* pars;            
    /* internal variables */
    int loudpkrs_nDims;                  
    int new_nLoudpkrs;                   
    int new_binauraliseLS;               
    int new_masterOrder;                 
    /* flags */
    PROC_STATUS procStatus;              
    int reinit_hrtfsFLAG;                
    int recalc_hrtf_interpFLAG[MAX_NUM_LOUDSPEAKERS]; 
    /* user parameters */
    int masterOrder;                     
    int orderPerBand[HYBRID_BANDS];      
    AMBI_DEC_DECODING_METHODS dec_method[NUM_DECODERS]; 
    int rE_WEIGHT[NUM_DECODERS];         
    AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH diffEQmode[NUM_DECODERS]; 
    float transitionFreq;                
    int nLoudpkrs;                       
    float loudpkrs_dirs_deg[MAX_NUM_LOUDSPEAKERS][NUM_DECODERS]; 
    int useDefaultHRIRsFLAG;             
    int enableHRIRsPreProc;              
    int binauraliseLS;                   
    CH_ORDER chOrdering;                 
    NORM_TYPES norm;                     
} ambi_dec_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void ambi_dec_setCodecStatus(void* const hCmp, CODEC_STATUS newStatus);
 
void ambi_dec_interpHRTFs(void* const hAmbi,
                          float azimuth_deg,
                          float elevation_deg,
                          float_complex h_intrp[HYBRID_BANDS][NUM_EARS]);
 
void loadLoudspeakerArrayPreset(LOUDSPEAKER_ARRAY_PRESETS preset,
                                float dirs_deg[MAX_NUM_LOUDSPEAKERS][2],
                                int* nCH,
                                int* nDims);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __AMBI_DEC_INTERNAL_H_INCLUDED__ */