vcd.h

Go to the documentation of this file.

#ifndef _VCD_H
#define _VCD_H

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

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

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

#include <stdint.h>
#include <stdbool.h>
#include <stdio.h> 

/*--------------------------------------------------------------------------
 Defines
 -------------------------------------------------------------------------*/

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

/*
 =============================================================================
 */
#define VCD_SAMPLE_RATE (8000)

#define VCD_FRAME_SAMPLES (160)

#define VCD_MODELS_OVERHEAD (6)

#define VCD_MODELS_NAME_CHARS (16)

#define VCD_MODELS_OBS_DATA (16)

#define VCD_P_MULT (2)

#define VCD_M16_MULT (39)

#define VCD_M16_ADD (16)

#define VCD_API

/*----------------------------------------------------------------------------
 Typedefs and Enumerations 
 --------------------------------------------------------------------------- */

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

typedef struct VCD_ConfigStructDef
{
   uint_least16_t modelsNum;
   uint_least16_t modelsObsMax;
   uint_least32_t modelsSizeMax;
   int_least16_t **modelsList;
   int_least16_t numUserModels;
   void *p;
   int_least16_t *m16;
} VCD_ConfigStruct;

typedef struct VCD_ObjStructDef *VCD_Handle;

typedef enum VCD_MessageEnumDef
{
   VCD_MsgNone = 0,
   VCD_MsgFail = 1,
   VCD_MsgNoMemory = 2,
   VCD_MsgState = 3,
   VCD_MsgValidModel = 4,
   VCD_MsgInvalidModel = 5,
   VCD_MsgKeywordFound = 6,
   VCD_MsgEnrollTooShort = 7,
   VCD_MsgEnrollTooLong = 8,
   VCD_MsgUpdateNoMatch = 9,
   VCD_MsgRecoVAD = 10,
   VCD_MsgRecoRunning = 11,
   VCD_MsgRecoComplete = 12,
   VCD_MsgRecoEnd = 13,
   VCD_MsgInvalidParameters = 14
} VCD_MessageEnum;

typedef enum VCD_ModelTypesEnum
{
    VCD_LeftToRight = 0,
    VCD_Mixture = 1
} VCD_ModelTypesEnum;

typedef enum VCD_RecoResultEnumDef
{
    VCD_RecoSuccess = 0,
    VCD_RecoLowScore = 1,
    VCD_RecoKeyPrune = 2
} VCD_RecoResultEnum;

typedef struct VCD_RecoStructDef
{
    VCD_RecoResultEnum status;
   int_least32_t fullScore;
   int_least32_t confScore;
   int_least16_t normScore;
   int_least16_t modelIndex;
   char const *name;
} VCD_RecoStruct;

typedef VCD_RecoStruct *VCD_Reco;

typedef struct VCD_ModelInfoStructDef
{
   int_least16_t numModels;
   int_least16_t numObs;
   int_least16_t numUpdates;
   int_least16_t type;
   char const *name;
   int_least16_t index;
   bool enabled;
} VCD_ModelInfoStruct;

typedef VCD_ModelInfoStruct *VCD_ModelInfo;

typedef struct VCD_ParamsStructDef
{
   int_least16_t unnormMixScore;
   int_least16_t unnormFillerScore;
   int_least16_t unnormStayScore;
   int_least16_t unnormProgScore;
   int_least16_t unnormSkipScore;
   int_least16_t iMaxDelta;
   int_least16_t hmmTransWgt;
   int_least16_t oovMult;
   int_least16_t scrThreshMult;
   int_least16_t minModelStates;
   int_least16_t maxModelStates;
   char const *keyword;
   char const *filler;
   bool waitCommit;
   int_least16_t sampleRate;
   int_least16_t frameLength;
   int_least16_t vadAlpha;
   int_least16_t vadSigSNRThresh;
} VCD_ParamsStruct;

typedef VCD_ParamsStruct *VCD_Params;

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

VCD_API
VCD_MessageEnum VCD_init(VCD_Handle *pmh, VCD_ConfigStruct *config);

VCD_API
VCD_MessageEnum VCD_startEnroll(VCD_Handle vh, char const *name);

VCD_API
VCD_MessageEnum VCD_processFrame(VCD_Handle vh,
                                       int_least16_t const *data);

VCD_API
VCD_MessageEnum VCD_getEnrollQuality(VCD_Handle vh,
                                           int_least16_t *quality);

VCD_API
VCD_MessageEnum VCD_getEnrollDifference(VCD_Handle vh,
                                             int_least16_t *difference);

VCD_API
VCD_MessageEnum VCD_addEnroll(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_stopEnroll(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_startUpdate(VCD_Handle vh, char const *name);

VCD_API
VCD_MessageEnum VCD_addUpdate(VCD_Handle vh,
                                    int_least16_t priorUpdates);

VCD_API
VCD_MessageEnum VCD_stopUpdate(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_startSearch(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_stopSearch(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_getResult(VCD_Handle vh,
                                    VCD_Reco result);

VCD_API
VCD_MessageEnum VCD_resetSearch(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_getModelInfo(VCD_Handle vh, char const *name,
                                       int_least16_t index,
                                       VCD_ModelInfo info);

VCD_API
VCD_MessageEnum VCD_removeModel(VCD_Handle vh, char const *name,
                                      int_least16_t index);

VCD_API
VCD_MessageEnum VCD_disableModel(VCD_Handle vh, char *name,
                                       int_least16_t index);

VCD_API
VCD_MessageEnum VCD_enableModel(VCD_Handle vh, char *name,
                                      int_least16_t index);

VCD_API
VCD_MessageEnum VCD_getParams(VCD_Handle vh, VCD_Params params);

VCD_API
VCD_MessageEnum VCD_setParams(VCD_Handle vh, VCD_Params params);

VCD_API
VCD_MessageEnum VCD_shutdown(VCD_Handle vh);

VCD_API
VCD_MessageEnum VCD_checkValidModel(int_least16_t *address);

VCD_API
VCD_MessageEnum VCD_addList(VCD_Handle vh,
                                  int_least16_t **modelsList,
                                  int_least16_t numModels);

VCD_API
VCD_MessageEnum VCD_writeModel( VCD_Handle vh,
                                      int_least16_t *ptrModel,
                                      int_least32_t mSize,
                                      int_least16_t **mAddress);

VCD_API
VCD_MessageEnum VCD_clearModel(int_least16_t *mAddress);

VCD_MessageEnum VCD_updateModel(VCD_Handle vh,
                                      int_least16_t *ptrModel,
                                      int_least32_t mSize,
                                      int_least16_t *mAddress);

#if defined( __cplusplus )
}
#endif

#endif //_VCD_H