powermap_internal.h

Go to the documentation of this file.

/*
 * Copyright 2016-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 __POWERMAP_INTERNAL_H_INCLUDED__
#define __POWERMAP_INTERNAL_H_INCLUDED__
 
#include "powermap.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(POWERMAP_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define POWERMAP_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define POWERMAP_FRAME_SIZE ( 1024 )                
# endif
#endif
#define HOP_SIZE ( 128 )                              
#define HYBRID_BANDS ( HOP_SIZE + 5 )                 
#define TIME_SLOTS ( POWERMAP_FRAME_SIZE / HOP_SIZE ) 
#define NUM_DISP_SLOTS ( 2 )                          
#define MAX_COV_AVG_COEFF ( 0.45f )                   
/* Checks: */
#if (POWERMAP_FRAME_SIZE % HOP_SIZE != 0)
# error "POWERMAP_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
    
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _powermap_codecPars
{
    float* grid_dirs_deg;   
    int grid_nDirs;         
    float* interp_dirs_deg; 
    float* interp_table;    
    int interp_nDirs;       
    int interp_nTri;        
    float* Y_grid[MAX_SH_ORDER];                 
    float_complex* Y_grid_cmplx[MAX_SH_ORDER];   
}powermap_codecPars;
    
typedef struct _powermap
{
    /* FIFO buffers */
    int FIFO_idx;                   
    float inFIFO[MAX_NUM_SH_SIGNALS][POWERMAP_FRAME_SIZE]; 
    /* TFT */
    float** SHframeTD;              
    float_complex*** SHframeTF;     
    void* hSTFT;                    
    float freqVector[HYBRID_BANDS]; 
    float fs;                       
    /* internal */
    float_complex Cx[HYBRID_BANDS][MAX_NUM_SH_SIGNALS*MAX_NUM_SH_SIGNALS];     
    int new_masterOrder;            
    int dispWidth;                  
    /* ana configuration */
    CODEC_STATUS codecStatus;       
    PROC_STATUS procStatus;         
    float progressBar0_1;           
    char* progressBarText;          
    powermap_codecPars* pars;       
    /* display */
    float* pmap;                    
    float* prev_pmap;               
    float* pmap_grid[NUM_DISP_SLOTS]; 
    int dispSlotIdx;                
    float pmap_grid_minVal;         
    float pmap_grid_maxVal;         
    int recalcPmap;                 
    int pmapReady;                  
    /* User parameters */
    int masterOrder;                
    int analysisOrderPerBand[HYBRID_BANDS]; 
    float pmapEQ[HYBRID_BANDS];     
    HFOV_OPTIONS HFOVoption;        
    ASPECT_RATIO_OPTIONS aspectRatioOption; 
    float covAvgCoeff;              
    float pmapAvgCoeff;             
    int nSources;                   
    POWERMAP_MODES pmap_mode;       
    CH_ORDER chOrdering;            
    NORM_TYPES norm;                
} powermap_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void powermap_setCodecStatus(void* const hPm, CODEC_STATUS newStatus);
 
void powermap_initAna(void* const hPm);
 
void powermap_initTFT(void* const hPm);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __POWERMAP_INTERNAL_H_INCLUDED__ */