binauraliser_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 __BINAURALISER_INTERNAL_H_INCLUDED__
#define __BINAURALISER_INTERNAL_H_INCLUDED__
 
#include "binauraliser.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(BINAURALISER_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define BINAURALISER_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define BINAURALISER_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                                  
#define HYBRID_BANDS ( HOP_SIZE + 5 )                     
#define TIME_SLOTS ( BINAURALISER_FRAME_SIZE / HOP_SIZE ) 
/* Checks: */
#if (BINAURALISER_FRAME_SIZE % HOP_SIZE != 0)
# error "BINAURALISER_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _binauraliser
{
    /* audio buffers */
    float** inputFrameTD;            
    float** outframeTD;              
    float_complex*** inputframeTF;   
    float_complex*** outputframeTF;  
    int fs;                          
    float freqVector[HYBRID_BANDS];  
    void* hSTFT;                     
    /* sofa file info */
    char* sofa_filepath;             
    float* hrirs;                    
    float* hrir_dirs_deg;            
    int N_hrir_dirs;                 
    int hrir_loaded_len;             
    int hrir_runtime_len;            
    int hrir_loaded_fs;              
    int hrir_runtime_fs;             
    float* weights;                  
    /* vbap gain table */
    int hrtf_vbapTableRes[2];        
    int N_hrtf_vbap_gtable;          
    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_INPUTS][HYBRID_BANDS][NUM_EARS]; 
    /* flags/status */
    CODEC_STATUS codecStatus;        
    float progressBar0_1;            
    char* progressBarText;           
    PROC_STATUS procStatus;          
    int recalc_hrtf_interpFLAG[MAX_NUM_INPUTS]; 
    int reInitHRTFsAndGainTables;    
    int recalc_M_rotFLAG;            
    /* misc. */
    float src_dirs_rot_deg[MAX_NUM_INPUTS][2]; 
    float src_dirs_rot_xyz[MAX_NUM_INPUTS][3]; 
    float src_dirs_xyz[MAX_NUM_INPUTS][3];     
    int nTriangles;                            
    int new_nSources;                          
    /* user parameters */
    int nSources;                            
    float src_dirs_deg[MAX_NUM_INPUTS][2];   
    INTERP_MODES interpMode;                 
    int useDefaultHRIRsFLAG;                 
    int enableHRIRsDiffuseEQ;                
    int enableRotation;                      
    float yaw;                               
    float roll;                              
    float pitch;                             
    int bFlipYaw;                            
    int bFlipPitch;                          
    int bFlipRoll;                           
    int useRollPitchYawFlag;                 
    float src_gains[MAX_NUM_INPUTS];         
} binauraliser_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void binauraliser_setCodecStatus(void* const hBin,
                                 CODEC_STATUS newStatus);
 
void binauraliser_interpHRTFs(void* const hBin,
                              INTERP_MODES mode,
                              float azimuth_deg,
                              float elevation_deg,
                              float_complex h_intrp[HYBRID_BANDS][NUM_EARS]);
 
void binauraliser_initHRTFsAndGainTables(void* const hBin);
 
void binauraliser_initTFT(void* const hBin);
 
void binauraliser_loadPreset(SOURCE_CONFIG_PRESETS preset,
                             float dirs_deg[MAX_NUM_INPUTS][2],
                             int* newNCH,
                             int* nDims);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __BINAURALISER_INTERNAL_H_INCLUDED__ */