beamformer.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_H_INCLUDED__
#define __BEAMFORMER_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void beamformer_create(void** const phBeam);
 
void beamformer_destroy(void** const phBeam);
 
void beamformer_init(void* const hBeam,
                     int samplerate);
 
void beamformer_process(void* const hBeam,
                        const float *const * inputs,
                        float* const* outputs,
                        int nInputs,
                        int nOutputs,
                        int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void beamformer_refreshSettings(void* const hBeam);
    
void beamformer_setBeamOrder(void* const hBeam,  int newValue);
 
void beamformer_setBeamAzi_deg(void* const hBeam, int index, float newAzi_deg);
 
void beamformer_setBeamElev_deg(void* const hBeam, int index, float newElev_deg);
 
void beamformer_setNumBeams(void* const hBeam, int new_nBeams);
 
void beamformer_setChOrder(void* const hBeam, int newOrder);
 
void beamformer_setNormType(void* const hBeam, int newType);
    
void beamformer_setBeamType(void* const hBeam, int newID);
 
    
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int beamformer_getFrameSize(void);
 
int beamformer_getBeamOrder(void* const hBeam);
 
float beamformer_getBeamAzi_deg(void* const hBeam, int index);
 
float beamformer_getBeamElev_deg(void* const hBeam, int index);
 
int beamformer_getNumBeams(void* const hBeam);
    
int beamformer_getMaxNumBeams(void);
    
int  beamformer_getNSHrequired(void* const hBeam);
 
int beamformer_getChOrder(void* const hBeam);
 
int beamformer_getNormType(void* const hBeam);
    
int beamformer_getBeamType(void* const hBeam);
 
int beamformer_getProcessingDelay(void);
 
    
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __BEAMFORMER_H_INCLUDED__ */