sldoa.h

A spatially-localised active-intensity (SLAI) based direction-of- arrival estimator (SLDoA)

A spatially-localised active-intensity (SLAI) based direction-of- arrival estimator (SLDoA)

Files

sldoa.h (include), sldoa_internal.h, sldoa_database.h, sldoa.c, sldoa_internal.c, sldoa_database.c

Include Header

/*
 * 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_H_INCLUDED__
#define __SLDOA_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void sldoa_create(void** const phSld);
 
void sldoa_destroy(void** const phSld);
 
void sldoa_init(void* const hSld,
                float samplerate);
    
void sldoa_initCodec(void* const hSld);
    
void sldoa_analysis(void* const hSld,
                    const float *const * inputs,
                    int nInputs,
                    int nSamples,
                    int isPlaying);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void sldoa_setMasterOrder(void* const hSld,  int newValue);
 
void sldoa_refreshSettings(void* const hSld);
   
void sldoa_setMaxFreq(void* const hSld, float newFreq);
 
void sldoa_setMinFreq(void* const hSld, float newFreq);
    
void sldoa_setAvg(void* const hSld, float newAvg);
 
void sldoa_setAnaOrder(void* const hSld, int newValue, int bandIdx);
 
void sldoa_setAnaOrderAllBands(void* const hSld,  int newValue);
 
void sldoa_setChOrder(void* const hSld, int newOrder);
 
void sldoa_setNormType(void* const hSld, int newType);
 
void sldoa_setSourcePreset(void* const hSld, int newPresetID);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int sldoa_getFrameSize(void);
 
CODEC_STATUS sldoa_getCodecStatus(void* const hSld);
 
float sldoa_getProgressBar0_1(void* const hSld);
 
void sldoa_getProgressBarText(void* const hSld, char* text);
 
int sldoa_getMasterOrder(void* const hSld);
 
int sldoa_getSamplingRate(void* const hSld);
 
float sldoa_getMaxFreq(void* const hSld);
 
float sldoa_getMinFreq(void* const hSld);
 
float sldoa_getAvg(void* const hSld);
 
int sldoa_getNumberOfBands(void);
 
int sldoa_getNSHrequired(void* const hSld);
    
void sldoa_getDisplayData(void *  const hSld,
                          float** pAzi_deg,
                          float** pElev_deg,
                          float** pColourScale,
                          float** pAlphaScale,
                          int** pNsectorsPerBand,
                          int* pMaxNumSectors,
                          int* pStartBand,
                          int* pEndBand);
    
int sldoa_getAnaOrder(void* const hSld, int bandIdx);
 
int sldoa_getAnaOrderAllBands(void* const hSld);
 
void sldoa_getAnaOrderHandle(void* const hSld,
                             float** pX_vector,
                             int** pY_values,
                             int* pNpoints);
 
int sldoa_getChOrder(void* const hSld);
 
int sldoa_getNormType(void* const hSld);
 
int sldoa_getProcessingDelay(void);
 
    
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SLDOA_H_INCLUDED__ */