ambi_bin_internal.h

Go to the documentation of this file.

/*
 * Copyright 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_BIN_INTERNAL_H_INCLUDED__
#define __AMBI_BIN_INTERNAL_H_INCLUDED__
 
#include "ambi_bin.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_BIN_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define AMBI_BIN_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define AMBI_BIN_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                              
#define HYBRID_BANDS ( HOP_SIZE + 5 )                 
#define TIME_SLOTS ( AMBI_BIN_FRAME_SIZE / HOP_SIZE ) 
#define POST_GAIN ( -9.0f )                           
/* Checks: */
#if (AMBI_BIN_FRAME_SIZE % HOP_SIZE != 0)
# error "AMBI_BIN_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
    
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _ambi_bin_codecPars
{
    /* Decoder */
    float_complex M_dec[HYBRID_BANDS][NUM_EARS][MAX_NUM_SH_SIGNALS];     
    float_complex M_dec_rot[HYBRID_BANDS][NUM_EARS][MAX_NUM_SH_SIGNALS]; 
    /* sofa file info */
    char* sofa_filepath;    
    float* hrirs;           
    float* hrir_dirs_deg;   
    int N_hrir_dirs;        
    int hrir_len;           
    int hrir_fs;            
    /* hrtf filterbank coefficients */
    float* itds_s;          
    float_complex* hrtf_fb; 
    /* integration weights */
    float* weights;         
}ambi_bin_codecPars;
    
typedef struct _ambi_bin
{
    /* audio buffers + afSTFT time-frequency transform handle */
    int fs;                         
    float** SHFrameTD;              
    float** binFrameTD;             
    float_complex*** SHframeTF;     
    float_complex*** binframeTF;    
    void* hSTFT;                    
    int afSTFTdelay;                
    float freqVector[HYBRID_BANDS]; 
    /* our codec configuration */
    CODEC_STATUS codecStatus;       
    float progressBar0_1;           
    char* progressBarText;          
    ambi_bin_codecPars* pars;       
    /* internal variables */
    PROC_STATUS procStatus;         
    float_complex M_rot[MAX_NUM_SH_SIGNALS][MAX_NUM_SH_SIGNALS]; 
    int new_order;                  
    int nSH;                        
    /* flags */ 
    int recalc_M_rotFLAG;           
    int reinit_hrtfsFLAG;           
    /* user parameters */
    int order;                      
    int enableMaxRE;                
    int enableDiffuseMatching;      
    int enableTruncationEQ;         
    AMBI_BIN_DECODING_METHODS method; 
    float EQ[HYBRID_BANDS];         
    int useDefaultHRIRsFLAG;        
    AMBI_BIN_PREPROC preProc;       
    CH_ORDER chOrdering;            
    NORM_TYPES norm;                
    int enableRotation;             
    float yaw;                      
    float roll;                     
    float pitch;                    
    int bFlipYaw;                   
    int bFlipPitch;                 
    int bFlipRoll;                  
    int useRollPitchYawFlag;        
} ambi_bin_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void ambi_bin_setCodecStatus(void* const hAmbi,
                             CODEC_STATUS newStatus);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __AMBI_BIN_INTERNAL_H_INCLUDED__ */