array2sh_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 __ARRAY2SH_INTERNAL_H_INCLUDED__
#define __ARRAY2SH_INTERNAL_H_INCLUDED__
 
#include "array2sh.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(ARRAY2SH_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define ARRAY2SH_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define ARRAY2SH_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                              
#define HYBRID_BANDS ( HOP_SIZE + 5 )                 
#define TIME_SLOTS ( ARRAY2SH_FRAME_SIZE / HOP_SIZE ) 
#define MAX_NUM_SENSORS ( ARRAY2SH_MAX_NUM_SENSORS )  
#define MAX_EVAL_FREQ_HZ ( 20e3f )                    
#define MAX_NUM_SENSORS_IN_PRESET ( MAX_NUM_SENSORS ) 
 
/* Checks: */
#if (ARRAY2SH_FRAME_SIZE % HOP_SIZE != 0)
# error "ARRAY2SH_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  typedef _Atomic ARRAY2SH_MICROPHONE_ARRAY_PRESETS  _Atomic_ARRAY2SH_MICROPHONE_ARRAY_PRESETS;
  typedef _Atomic ARRAY2SH_FILTER_TYPES _Atomic_ARRAY2SH_FILTER_TYPES;
  typedef _Atomic ARRAY2SH_ARRAY_TYPES  _Atomic_ARRAY2SH_ARRAY_TYPES;
  typedef _Atomic ARRAY2SH_WEIGHT_TYPES _Atomic_ARRAY2SH_WEIGHT_TYPES;
  typedef _Atomic ARRAY2SH_EVAL_STATUS  _Atomic_ARRAY2SH_EVAL_STATUS;
#else
  typedef ARRAY2SH_MICROPHONE_ARRAY_PRESETS  _Atomic_ARRAY2SH_MICROPHONE_ARRAY_PRESETS;
  typedef ARRAY2SH_FILTER_TYPES _Atomic_ARRAY2SH_FILTER_TYPES;
  typedef ARRAY2SH_ARRAY_TYPES  _Atomic_ARRAY2SH_ARRAY_TYPES;
  typedef ARRAY2SH_WEIGHT_TYPES _Atomic_ARRAY2SH_WEIGHT_TYPES;
  typedef ARRAY2SH_EVAL_STATUS  _Atomic_ARRAY2SH_EVAL_STATUS;
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */

typedef struct _array2sh_arrayPars {
    _Atomic_INT32 Q;                                      
    _Atomic_INT32 newQ;                                   
    _Atomic_FLOAT32 r;                                    
    _Atomic_FLOAT32 R;                                    
    _Atomic_ARRAY2SH_ARRAY_TYPES arrayType;               
    _Atomic_ARRAY2SH_WEIGHT_TYPES weightType;             
    _Atomic_FLOAT32 sensorCoords_rad[MAX_NUM_SENSORS][2]; 
    _Atomic_FLOAT32 sensorCoords_deg[MAX_NUM_SENSORS][2]; 
        
}array2sh_arrayPars;

typedef struct _array2sh
{
    /* audio buffers */
    float** inputFrameTD;           
    float** SHframeTD;              
    float_complex*** inputframeTF;  
    float_complex*** SHframeTF;     
    
    /* intermediates */
    double_complex bN_modal[HYBRID_BANDS][MAX_SH_ORDER + 1];    
    double_complex* bN;                                         
    double_complex bN_inv[HYBRID_BANDS][MAX_SH_ORDER + 1];      
    double_complex bN_inv_R[HYBRID_BANDS][MAX_NUM_SH_SIGNALS];  
    float_complex W[HYBRID_BANDS][MAX_NUM_SH_SIGNALS][MAX_NUM_SENSORS];        
    float_complex W_diffEQ[HYBRID_BANDS][MAX_NUM_SH_SIGNALS][MAX_NUM_SENSORS]; 
    
    /* for displaying the bNs */
    float** bN_modal_dB;            
    float** bN_inv_dB;              
    float* cSH;                     
    float* lSH;                     
    
    /* time-frequency transform and array details */
    float freqVector[HYBRID_BANDS]; 
    void* hSTFT;                    
    void* arraySpecs;               
    
    /* internal parameters */
    _Atomic_ARRAY2SH_EVAL_STATUS evalStatus; 
    _Atomic_FLOAT32 progressBar0_1;  
    char* progressBarText;           
    int fs;                          
    _Atomic_INT32 new_order;         
 
    /* For diffuse-field equalisation */
    double_complex* L_diff_fal;
    double_complex* L_diff;
    double_complex* E_diff;
    double_complex* W_diffEQ_tmp;
    double_complex* W_tmp;
 
    /* flags */
    _Atomic_PROC_STATUS procStatus;         
    _Atomic_INT32 reinitSHTmatrixFLAG;        
    _Atomic_INT32 evalRequestedFLAG;          
    
    /* additional user parameters that are not included in the array presets */
    _Atomic_INT32 order;                      
    _Atomic_ARRAY2SH_MICROPHONE_ARRAY_PRESETS preset; 
    _Atomic_ARRAY2SH_FILTER_TYPES filterType; 
    _Atomic_FLOAT32 regPar;                   
    _Atomic_CH_ORDER chOrdering;              
    _Atomic_NORM_TYPES norm;                  
    _Atomic_FLOAT32 c;                        
    _Atomic_FLOAT32 gain_dB;                  
    _Atomic_INT32 enableDiffEQpastAliasing;   
    
} array2sh_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */

void array2sh_initTFT(void* const hA2sh);

void array2sh_calculate_sht_matrix(void* const hA2sh);

void array2sh_apply_diff_EQ(void* const hA2sh);

void array2sh_calculate_mag_curves(void* const hA2sh);

void array2sh_evaluateSHTfilters(void* hA2sh);

void array2sh_createArray(void ** const hPars);

void array2sh_destroyArray(void ** const hPars);

void array2sh_initArray(void * const hPars,
                        ARRAY2SH_MICROPHONE_ARRAY_PRESETS preset,
                        _Atomic_INT32* arrayOrder,
                        int firstInitFLAG);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __ARRAY2SH_INTERNAL_H_INCLUDED__ */