binauraliser_nf_internal.h

Go to the documentation of this file.

/*
 * Copyright 2022 Michael McCrea, 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_NF_INTERNAL_H_INCLUDED__
#define __BINAURALISER_NF_INTERNAL_H_INCLUDED__
 
#include "../binauraliser/binauraliser_internal.h"
#include "binauraliser_nf.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 */
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */

typedef struct _binauraliserNF {
    //struct _binauraliser; /**< "inherit" member vars of binauraliser struct - requires -fms-extensions compile flag */
 
    /* The following variables MUST match those of the _binauraliser struct */
 
    /* 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;            
    _Atomic_INT32 N_hrir_dirs;       
    _Atomic_INT32 hrir_loaded_len;   
    _Atomic_INT32 hrir_runtime_len;  
    _Atomic_INT32 hrir_loaded_fs;    
    _Atomic_INT32 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 */
    _Atomic_CODEC_STATUS codecStatus;          
    _Atomic_FLOAT32 progressBar0_1;            
    char* progressBarText;                     
    _Atomic_PROC_STATUS procStatus;            
    _Atomic_INT32 recalc_hrtf_interpFLAG[MAX_NUM_INPUTS]; 
    _Atomic_INT32 reInitHRTFsAndGainTables;    
    _Atomic_INT32 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;                            
    _Atomic_INT32 new_nSources;                
 
    /* user parameters */
    _Atomic_INT32 nSources;                            
    _Atomic_FLOAT32 src_dirs_deg[MAX_NUM_INPUTS][2];   
    _Atomic_INTERP_MODES interpMode;                   
    _Atomic_INT32 useDefaultHRIRsFLAG;                 
    _Atomic_INT32 enableHRIRsDiffuseEQ;                
    _Atomic_INT32 enableRotation;                      
    _Atomic_FLOAT32 yaw;                               
    _Atomic_FLOAT32 roll;                              
    _Atomic_FLOAT32 pitch;                             
    _Atomic_INT32 bFlipYaw;                            
    _Atomic_INT32 bFlipPitch;                          
    _Atomic_INT32 bFlipRoll;                           
    _Atomic_INT32 useRollPitchYawFlag;                 
    _Atomic_FLOAT32 src_gains[MAX_NUM_INPUTS];         
 
 
    /* End copied _binauraliser struct members. The following are unique to the _binauraliserNF struct */
 
    float b_dvf[MAX_NUM_INPUTS][NUM_EARS][2];                   
    float a_dvf[MAX_NUM_INPUTS][NUM_EARS][2];                   
    float dvfmags[MAX_NUM_INPUTS][NUM_EARS][HYBRID_BANDS];      
    float dvfphases[MAX_NUM_INPUTS][NUM_EARS][HYBRID_BANDS];    
 
    /* misc. */
    _Atomic_FLOAT32 src_dists_m[MAX_NUM_INPUTS];  
    float farfield_thresh_m;            
    float farfield_headroom;            
    float nearfield_limit_m;            
    float head_radius;                  
    float head_radius_recip;            
    float src_dirs_cur[MAX_NUM_INPUTS][2];    
 
    /* flags/status */
    _Atomic_INT32 recalc_dvfCoeffFLAG[MAX_NUM_INPUTS]; 
 
} binauraliserNF_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */

void binauraliserNF_initTFT(void* const hBin);

void binauraliserNF_resetSourceDistances(void* const hBin);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __BINAURALISER_INTERNAL_NF_H_INCLUDED__ */