panner_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 __PANNER_INTERNAL_H_INCLUDED__
#define __PANNER_INTERNAL_H_INCLUDED__
 
#include "panner.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                             */
/* ========================================================================== */
 
#define FORCE_3D_LAYOUT 
#if !defined(PANNER_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define PANNER_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define PANNER_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                            
#define HYBRID_BANDS ( HOP_SIZE + 5 )               
#define TIME_SLOTS ( PANNER_FRAME_SIZE / HOP_SIZE ) 
/* Checks: */
#if (PANNER_FRAME_SIZE % HOP_SIZE != 0)
# error "PANNER_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
    
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _panner
{
    /* audio buffers */
    float** inputFrameTD;           
    float** outputFrameTD;          
    float_complex*** inputframeTF;  
    float_complex*** outputframeTF; 
    int fs;                         
    /* time-frequency transform */
    float freqVector[HYBRID_BANDS]; 
    void* hSTFT;                    
    /* Internal */
    int vbapTableRes[2];            
    float* vbap_gtable;             
    int N_vbap_gtable;              
    float_complex G_src[HYBRID_BANDS][MAX_NUM_INPUTS][MAX_NUM_OUTPUTS];  
    /* flags */
    CODEC_STATUS codecStatus;       
    PROC_STATUS procStatus;         
    float progressBar0_1;           
    char* progressBarText;          
    int recalc_gainsFLAG[MAX_NUM_INPUTS]; 
    int recalc_M_rotFLAG;           
    int reInitGainTables;           
    /* 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 output_nDims;               
    int new_nLoudpkrs;              
    int new_nSources;               
    /* pValue */
    float pValue[HYBRID_BANDS];     
    /* user parameters */
    int nSources;                   
    float src_dirs_deg[MAX_NUM_INPUTS][2]; 
    float DTT;                      
    float spread_deg;               
    int nLoudpkrs;                  
    float loudpkrs_dirs_deg[MAX_NUM_OUTPUTS][2]; 
    float yaw;                      
    float roll;                     
    float pitch;                    
    int bFlipYaw;                   
    int bFlipPitch;                 
    int bFlipRoll;                  
} panner_data;
     
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void panner_setCodecStatus(void* const hPan, CODEC_STATUS newStatus);
    
void panner_initGainTables(void* const hPan);
    
void panner_initTFT(void* const hPan);
    
void panner_loadSourcePreset(SOURCE_CONFIG_PRESETS preset,
                             float dirs_deg[MAX_NUM_INPUTS][2],
                             int* newNCH,
                             int* nDims);
 
void panner_loadLoudspeakerPreset(LOUDSPEAKER_ARRAY_PRESETS preset,
                                  float dirs_deg[MAX_NUM_INPUTS][2],
                                  int* newNCH,
                                  int* nDims);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __PANNER_INTERNAL_H_INCLUDED__ */