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
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  typedef _Atomic AMBI_BIN_PREPROC _Atomic_AMBI_BIN_PREPROC;
  typedef _Atomic AMBI_BIN_DECODING_METHODS _Atomic_AMBI_BIN_DECODING_METHODS;
#else
  typedef AMBI_BIN_PREPROC _Atomic_AMBI_BIN_PREPROC;
  typedef AMBI_BIN_DECODING_METHODS _Atomic_AMBI_BIN_DECODING_METHODS;
#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;   
    _Atomic_INT32 N_hrir_dirs; 
    _Atomic_INT32 hrir_len; 
    _Atomic_INT32 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 */
    _Atomic_INT32 fs;                
    float** SHFrameTD;              
    float** binFrameTD;             
    float_complex*** SHframeTF;     
    float_complex*** binframeTF;    
    void* hSTFT;                    
    int afSTFTdelay;                
    float freqVector[HYBRID_BANDS]; 
     
    /* our codec configuration */
    _Atomic_CODEC_STATUS codecStatus; 
    _Atomic_FLOAT32 progressBar0_1;   
    char* progressBarText;          
    ambi_bin_codecPars* pars;       
    
    /* internal variables */
    _Atomic_PROC_STATUS procStatus; 
    float_complex M_rot[MAX_NUM_SH_SIGNALS][MAX_NUM_SH_SIGNALS]; 
    _Atomic_INT32 new_order;        
    _Atomic_INT32 nSH;              
    
    /* flags */ 
    _Atomic_INT32 recalc_M_rotFLAG; 
    _Atomic_INT32 reinit_hrtfsFLAG; 
    
    /* user parameters */
    _Atomic_INT32 order;            
    _Atomic_INT32 enableMaxRE;      
    _Atomic_INT32 enableDiffuseMatching; 
    _Atomic_INT32 enableTruncationEQ;    
    _Atomic_AMBI_BIN_DECODING_METHODS method;  
    _Atomic_INT32 useDefaultHRIRsFLAG; 
    _Atomic_AMBI_BIN_PREPROC preProc; 
    _Atomic_CH_ORDER chOrdering;    
    _Atomic_NORM_TYPES norm;        
    _Atomic_INT32 enableRotation;   
    _Atomic_FLOAT32 yaw;            
    _Atomic_FLOAT32 roll;           
    _Atomic_FLOAT32 pitch;          
    _Atomic_INT32 bFlipYaw;         
    _Atomic_INT32 bFlipPitch;       
    _Atomic_INT32 bFlipRoll;        
    _Atomic_INT32 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__ */