dirass_internal.h

Go to the documentation of this file.

/*
 * Copyright 2019 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 __DIRASS_INTERNAL_H_INCLUDED__
#define __DIRASS_INTERNAL_H_INCLUDED__
 
#include "dirass.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(DIRASS_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define DIRASS_FRAME_SIZE ( FRAME_SIZE )   
# else /* Otherwise, the default framesize for this example is: */
#  define DIRASS_FRAME_SIZE ( 1024 )         
# endif
#endif
#define MAX_DISPLAY_SH_ORDER ( 20 )          
#define MAX_NUM_INPUT_SH_SIGNALS ( (MAX_SH_ORDER+1)*(MAX_SH_ORDER+1) )   
#define MAX_NUM_DISPLAY_SH_SIGNALS ( (MAX_DISPLAY_SH_ORDER+1)*(MAX_DISPLAY_SH_ORDER+1) )  
#define NUM_DISP_SLOTS ( 2 )                 
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  typedef _Atomic DIRASS_UPSCALE_ORDERS   _Atomic_DIRASS_UPSCALE_ORDERS;
  typedef _Atomic DIRASS_GRID_OPTIONS     _Atomic_DIRASS_GRID_OPTIONS;
  typedef _Atomic DIRASS_REASS_MODES      _Atomic_DIRASS_REASS_MODES;
#else
  typedef DIRASS_UPSCALE_ORDERS           _Atomic_DIRASS_UPSCALE_ORDERS;
  typedef DIRASS_GRID_OPTIONS             _Atomic_DIRASS_GRID_OPTIONS;
  typedef DIRASS_REASS_MODES              _Atomic_DIRASS_REASS_MODES;
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */

typedef struct _dirass_codecPars
{
    /* scanning grid and intepolation table */
    float* grid_dirs_deg;     
    int grid_nDirs;           
    float* interp_dirs_deg;   
    float* interp_dirs_rad;   
    float* interp_table;      
    int interp_nDirs;         
    int interp_nTri;          
    float* ss;                
    float* ssxyz;             
    int* est_dirs_idx;        
    float* prev_intensity;    
    float* prev_energy;       
    
    /* sector beamforming and upscaling */
    float* Cxyz;              
    float* Cw;                
    float* Uw;                
    float* Y_up;              
    float* est_dirs;          
    
    /* regular beamforming */
    float* w;                 
     
}dirass_codecPars;
    
typedef struct _dirass
{
    /* FIFO buffers */
    int FIFO_idx;                           
    float inFIFO[MAX_NUM_INPUT_SH_SIGNALS][DIRASS_FRAME_SIZE]; 
    
    /* Buffers */
    float SHframeTD[MAX_NUM_INPUT_SH_SIGNALS][DIRASS_FRAME_SIZE];       
    float SHframe_upTD[MAX_NUM_DISPLAY_SH_SIGNALS][DIRASS_FRAME_SIZE];  
    float fs;                               
    
    /* internal */ 
    _Atomic_INT32 dispWidth;                          
    float Wz12_hpf[MAX_NUM_INPUT_SH_SIGNALS][2];      
    float Wz12_lpf[MAX_NUM_INPUT_SH_SIGNALS][2];      
    _Atomic_INT32 new_inputOrder;                     
    _Atomic_INT32 new_upscaleOrder;                   
    
    /* ana configuration */
    _Atomic_CODEC_STATUS codecStatus;       
    _Atomic_PROC_STATUS procStatus;         
    _Atomic_FLOAT32 progressBar0_1;         
    char* progressBarText;                  
    dirass_codecPars* pars;                 
    
    /* display */
    float* pmap;                            
    float* pmap_grid[NUM_DISP_SLOTS];       
    _Atomic_INT32 dispSlotIdx;              
    float pmap_grid_minVal;                 
    float pmap_grid_maxVal;                 
    _Atomic_INT32 recalcPmap;               
    _Atomic_INT32 pmapReady;                
    
    /* User parameters */
    _Atomic_INT32 inputOrder;                       
    _Atomic_STATIC_BEAM_TYPES beamType;             
    _Atomic_DIRASS_REASS_MODES DirAssMode;          
    _Atomic_INT32 upscaleOrder;                     
    _Atomic_DIRASS_GRID_OPTIONS gridOption;         
    _Atomic_FLOAT32 pmapAvgCoeff;                   
    _Atomic_FLOAT32 minFreq_hz;                     
    _Atomic_FLOAT32 maxFreq_hz;                     
    _Atomic_CH_ORDER chOrdering;                    
    _Atomic_NORM_TYPES norm;                        
    _Atomic_HFOV_OPTIONS HFOVoption;                
    _Atomic_ASPECT_RATIO_OPTIONS aspectRatioOption; 
    
} dirass_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */

void dirass_setCodecStatus(void* const hDir, CODEC_STATUS newStatus);

void dirass_initAna(void* const hDir);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __DIRASS_INTERNAL_H_INCLUDED__ */