vad.h

Go to the documentation of this file.

#ifndef _VAD_H
#define _VAD_H

#if defined(__cplusplus)
extern "C"
{
#endif

/*
 =============================================================================
 */

/*----------------------------------------------------------------------------
 Includes 
 ---------------------------------------------------------------------------*/

#include <stdint.h>
     
/*----------------------------------------------------------------------------
 Defines
 ---------------------------------------------------------------------------*/
/*
 =============================================================================
 */
#define VAD_INIT_FRAMES (5)

#define VAD_DELAY_FRAMES (13)

#define VAD_ALPHA_Q15 (31128)

#define VAD_FAST_COEF_Q15 (26214)

#define VAD_SLOW_COEF_Q15 (31129 )

#define VAD_MIN_SIG_Q30 (603809)

#define VAD_MIN_NOISE_Q30 (603809)

#define VAD_SNR_THRESHOLD_Q10 (1532)

#define VAD_SNR_LIMIT_Q10 (4077)

#define VAD_NOISE_RATE_Q14 (16498)

#define VAD_API

/*--------------------------------------------------------------------------
  Typedefs
 -------------------------------------------------------------------------*/

/*
 =============================================================================
 */
typedef enum VAD_MessageEnumDef
{
    VAD_Background = 0,
    VAD_Hang = 1,
    VAD_Detect = 2,
    VAD_Ongoing = 3
} VAD_MessageEnum;  

typedef struct VAD_ObjStructDef *VAD_Handle;

/*------------------------------------------------------------------------------
 Functions
 -----------------------------------------------------------------------------*/

/*
 =============================================================================
 */
VAD_API
VAD_Handle VAD_setup();

VAD_API
int_least16_t VAD_getInitFrames(VAD_Handle handle);

VAD_API
void VAD_setInitFrames( VAD_Handle handle, int_least16_t initFrames );

VAD_API
int_least16_t VAD_getDelayFrames( VAD_Handle handle );

VAD_API
void VAD_setDelayFrames( VAD_Handle handle, int_least16_t delayFrames );

VAD_API
int_least16_t VAD_getAlpha( VAD_Handle handle );

VAD_API
void VAD_setAlpha( VAD_Handle handle, int_least16_t alpha );

VAD_API
int_least16_t VAD_getFastCoef( VAD_Handle handle );

VAD_API
void VAD_setFastCoef( VAD_Handle handle, int_least16_t fastCoef );

VAD_API
int_least16_t VAD_getSlowCoef( VAD_Handle handle );

VAD_API
void VAD_setSlowCoef(VAD_Handle handle, int_least16_t slowCoef);

VAD_API
int_least16_t VAD_getSignalFloor(VAD_Handle handle);

VAD_API
void VAD_setSignalFloor( VAD_Handle handle, int_least32_t signalFloor );

VAD_API
int_least16_t VAD_getNoiseFloor(VAD_Handle handle);

VAD_API
void VAD_setNoiseFloor(VAD_Handle handle, int_least32_t noiseFloor);

VAD_API
int_least16_t VAD_getSigSNRThresh(VAD_Handle handle);

VAD_API
void VAD_setSigSNRThresh(VAD_Handle handle, int_least16_t sigSNRThresh);

VAD_API
int_least16_t VAD_getSigSNRLimit(VAD_Handle handle);

VAD_API
void VAD_setSigSNRLimit( VAD_Handle handle, int_least16_t sigSNRLimit );

VAD_API
int_least16_t VAD_getNoiseRate( VAD_Handle handle );

VAD_API
void VAD_setNoiseRate(VAD_Handle handle, int_least16_t noiseRate);

VAD_API
VAD_MessageEnum VAD_run(VAD_Handle handle, int_least16_t rmsegy);

VAD_API
const char *VAD_getVersion(void);

#ifdef __cplusplus
}
#endif

#endif //_VAD_H