beamformer_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 __BEAMFORMER_INTERNAL_H_INCLUDED__
#define __BEAMFORMER_INTERNAL_H_INCLUDED__
 
#include "beamformer.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(BEAMFORMER_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define BEAMFORMER_FRAME_SIZE ( FRAME_SIZE ) 
# else /* Otherwise, the default framesize for this example is: */
#  define BEAMFORMER_FRAME_SIZE ( 128 )        
# endif
#endif
#define MAX_NUM_BEAMS ( MAX_NUM_OUTPUTS )      
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _beamformer
{
    /* Internal audio buffers */
    float SHFrameTD[MAX_NUM_SH_SIGNALS][BEAMFORMER_FRAME_SIZE];             
    float prev_SHFrameTD[MAX_NUM_SH_SIGNALS][BEAMFORMER_FRAME_SIZE];        
    float tempFrame[MAX_NUM_BEAMS][BEAMFORMER_FRAME_SIZE];                  
    float tempFrame_fadeOut[MAX_NUM_SH_SIGNALS][BEAMFORMER_FRAME_SIZE];     
    float outputFrameTD[MAX_NUM_BEAMS][BEAMFORMER_FRAME_SIZE];              
    float outputFrameTD_fadeIn[MAX_NUM_SH_SIGNALS][BEAMFORMER_FRAME_SIZE];  
    /* internal variables */
    int fs;                                             
    float beamWeights[MAX_NUM_BEAMS][MAX_NUM_SH_SIGNALS];      
    float prev_beamWeights[MAX_NUM_BEAMS][MAX_NUM_SH_SIGNALS]; 
    float interpolator_fadeIn[BEAMFORMER_FRAME_SIZE];   
    float interpolator_fadeOut[BEAMFORMER_FRAME_SIZE];  
    int recalc_beamWeights[MAX_NUM_BEAMS];              
    /* user parameters */
    int beamOrder;                           
    int nBeams;                              
    float beam_dirs_deg[MAX_NUM_BEAMS][2];   
    STATIC_BEAM_TYPES beamType;              
    CH_ORDER chOrdering;                     
    NORM_TYPES norm;                         
} beamformer_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __BEAMFORMER_INTERNAL_H_INCLUDED__ */