sldoa_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 __SLDOA_INTERNAL_H_INCLUDED__
#define __SLDOA_INTERNAL_H_INCLUDED__
 
#include "sldoa.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(SLDOA_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define SLDOA_FRAME_SIZE ( FRAME_SIZE )  
# else /* Otherwise, the default framesize for this example is: */
#  define SLDOA_FRAME_SIZE ( 512 )         
# endif
#endif
#define ORDER2NUMSECTORS(L) ( L*L )        
#define HOP_SIZE ( 128 )                   
#define HYBRID_BANDS ( HOP_SIZE + 5 )      
#define TIME_SLOTS ( SLDOA_FRAME_SIZE / HOP_SIZE )          
#define MAX_NUM_SECTORS ( 64 )             
#define NUM_DISP_SLOTS ( 2 )               
/* Checks: */
#if (SLDOA_FRAME_SIZE % HOP_SIZE != 0)
# error "SLDOA_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
    
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
   
typedef struct _sldoa
{
    /* FIFO buffers */
    int FIFO_idx;                   
    float** inFIFO;                 
    /* TFT */
    float** SHframeTD;              
    float_complex*** SHframeTF;     
    void* hSTFT;                    
    float freqVector[HYBRID_BANDS]; 
    float fs;                       
    /* ana configuration */
    CODEC_STATUS codecStatus;       
    PROC_STATUS procStatus;         
    float progressBar0_1;           
    char* progressBarText;          
    /* internal */
    int nGrid;                      
    float** grid_Y;                 
    float** grid_Y_dipoles_norm;    
    float** grid_dirs_deg;          
    float_complex* secCoeffs[MAX_SH_ORDER-1];        
    float doa_rad[HYBRID_BANDS][MAX_NUM_SECTORS][2]; 
    float energy [HYBRID_BANDS][MAX_NUM_SECTORS];    
    int nSectorsPerBand[HYBRID_BANDS];               
    int new_masterOrder;                             
    /* display */
    float* azi_deg[NUM_DISP_SLOTS];      
    float* elev_deg[NUM_DISP_SLOTS];     
    float* colourScale[NUM_DISP_SLOTS];  
    float* alphaScale[NUM_DISP_SLOTS];   
    int current_disp_idx;                
    /* User parameters */
    int masterOrder;                     
    int analysisOrderPerBand[HYBRID_BANDS]; 
    float maxFreq;                       
    float minFreq;                       
    float avg_ms;                        
    CH_ORDER chOrdering;                 
    NORM_TYPES norm;                     
} sldoa_data;
     
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void sldoa_setCodecStatus(void* const hSld, CODEC_STATUS newStatus);
 
void sldoa_initAna(void* const hSld);
    
void sldoa_initTFT(void* const hSld);
  
void sldoa_estimateDoA(float_complex** SHframeTF,
                       int anaOrder,
                       float_complex* secCoeffs,
                       float doa[MAX_NUM_SECTORS][TIME_SLOTS][2],
                       float energy[MAX_NUM_SECTORS][TIME_SLOTS]);
    
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SLDOA_INTERNAL_H_INCLUDED__ */