td_vr_error_codes.h

来自「Motorola synergy audio component」· C头文件 代码 · 共 290 行

#ifndef TD_VR_ERROR_CODES_INCLUDE /* To prevent inadvertently including a header twice */
#define TD_VR_ERROR_CODES_INCLUDE

#ifdef __cplusplus  /* allow #include in a C++ file (only put this in .h files) */
extern "C" {
#endif

/* (c) Copyright Motorola 1997, 1998, All rights reserved.
   Motorola Confidential Proprietary
   Contains confidential proprietary information of Motorola, Inc.
   Reverse engineering is prohibited.
   The copyright notice does not imply publication.

   DESCRIPTION:
       This file defines the error codes for voice recognition.

 ************** REVISION HISTORY **********************************************

   Date       Author      Reference
   ========   ========    ==========================
   01-04-25   rsubram     CR - CSGce96735
              TDMA: MCU needs to match the error codes defined in DSP
              - Conditionally compiled out the error codes for TDMA.

   00-08-11   qcf001      CR - CSGce68439
              Add success/fail/value_unch for vr_enable/disable


   98-11-17   blamers     CR - CSGce23508
              Whitecap VR Audio Manager Support
              - Add TD_VR_ERROR_CODES typedef.

   97-09-04   slam        PR - CSGce11610
              - Add VA warning codes.
              - Add TD_VA_SUCCESS and TD_VR_SUCCESS definitions.
              - Add TD_VR_TR_DISSIMILAR error code.
              - Add VA error codes.
              - Rename flash errors so that they are not VR specific.

   97-07-23   slam        PR - CSGce10240
              - Add TD_VR_DSP_FLASH_BUSY error code.
              - Two error codes are created to distinguish whether VR
                request is aborted by a key tone or by a non key tone.

   97-06-16   joshuag     PR - CSGce10240
              - Development for Speaker Dependent Voice Recognition.
              - Added special error codes to be set and used by MMI VR and TNO.

   97-06-05   slam        PR - CSGce10240
              - Initial release
*/
/************** HEADER FILE INCLUDES ******************************************/
#include "audio_conditional_compile_def.h"

/************** CONSTANTS *****************************************************/
#define TD_VA_SUCCESS 0
#define TD_VR_SUCCESS 0

/************** VR Enable/Disable Error Codes *********************************/
/* Value for VR Fail is for Enable/Disable only!  Probable cause is that we are 
   in a call   */
#define TD_VR_FAIL 1  

/* Value for Enable/Disable VR Only!  Means that we were already enabled/disabled
   when we received a enable/disable message */
#define TD_VR_VALUE_UNCH 2 

/* Mean update failed after state reduction */
#define TD_VR_TR_RED_MEAN_ERR 2

/* Went past minimum during state reduction */
#define TD_VR_TR_RED_MIN_ERR 3

/* Initial mean calculation failed */
#define TD_VR_TR_INIT_MEAN_ERR 4

/* bincnt fell to low */
#define TD_VR_TR_BINCNT 8

/* a particular group has reached its maximum capacity (25 for any group) */
#define TD_VR_TR_GROUP_FULL 9

/* the total model capacity limit has been reached (probably 40 for now, 
   may be higher to allow for UI changes in the future)
*/
#define TD_VR_TR_MODELS_FULL 10

/* too many different groups have been specified.
   (The limit will probably be 2 for the initial implementation, but may be
   higher to allow for UI changes in the future, such as multiple speakers).
*/
#define TD_VR_TR_GROUPS_FULL 11

/* the requested repetition number does not exist or is invalid */
#define TD_VR_TR_NO_REP 12

/* the training mode requested is invalid */
#define TD_VR_TR_INVALID_MODE 13

/************** GENERAL ERROR CODES *******************************************/
/* the requested model ID does not exist */
#define TD_VR_NO_MODEL 50

/* the requested group ID does not exist */
#define TD_VR_NO_GROUP 51

/* the capture or recognition window is too long */
#define TD_VR_TOO_MUCH_TIME 52

/* an error occurred while reading flash */
#define TD_DSP_FLASH_READ_ERR 53

/* an error occurred while writing flash */
#define TD_DSP_FLASH_WRITE_ERR 54

/* the requested voice tag does not exist */
#define TD_VR_NO_TAG 55

/* DSP flash is busy */
#define TD_DSP_FLASH_BUSY 56

/* the requested repetition number is invalid */
#define TD_VR_CAP_REPETITION 100

/* average energy lower than threshold */
#define TD_VR_CAP_AVGEGY 103

/* VR request is being interrupted by a non keytone */
#define TD_VR_ABORTED_BY_NON_KEY_TONE 254

/* VR request is being interrupted by a key tone */
#define TD_VR_ABORTED_BY_KEY_TONE 255

/* The following error codes (used as causes) will be set by MMILOC_VR_EHandler
   to tell MMITNO_Abbr_Dialing_EHandler what to do when training or voice
   recognition is complete. Note:  The group will determine which set (training or
   voice recognition) will be evaluated.  All codes cannot be  evaluated together.
*/
/* Training complete.  Store voice tag model.*/
#define TD_TRAIN_COMPLETE_STORE 0

/* Training complete.  Redisplay "Add Voice Tag" mw.*/
#define TD_TRAIN_COMPLETE_REDISPLAY 1

/* VR complete.  Play back matched voice tag model and display entry in scrolling list.*/
#define TD_VR_COMPLETE_PLAY_AND_SCROLL 0

/* VR complete.  Start alpha scrolling list. */
#define TD_VR_COMPLETE_JUST_SCROLL 1

/* VR complete.  Do nothing. */
#define TD_VR_COMPLETE_DO_NOTHING 2



#if ((AUDIO_CDMA == TRUE) || ((AUDIO_GSM == TRUE) && (AUDIO_RAINBOW == FALSE)))  

/************** TRAINING ERROR CODES ******************************************/
/* Need to reduce states, but state reduction is off */
#define TD_VR_TR_RED_OFF_ERR 1

/* Mean update error after viterbi alignment */
#define TD_VR_TR_VIT_MEAN_ERR 5

/* No speech was found in a feature segment */
#define TD_VR_TR_ENDPOINT_ERR 6

/************** OTHER TRAINING ERROR CODES ************************************/
/* tag is too similar to an existing tag */
#define TD_VR_TR_REJTAG 7

/* two utterances are not of similar length */
#define TD_VR_TR_DISSIMILAR	14

/************** CAPTURE ERROR CODES *******************************************/

/* clipping detected */
#define TD_VR_CAP_CLIPPING 101

/* low signal to noise ratio */
#define TD_VR_CAP_LOWSNR 102

/* too much energy in first frame */
#define TD_VR_CAP_FRSTFRMEGY 104

/* too much energy in the last frame */
#define TD_VR_CAP_LASTFRMEGY 105


/************** RECOGNITION ERROR CODES ***************************************/
/* no end state was found (i.e. no word matched) */
#define TD_VR_NO_END_STATE_ERROR 200

/* ran out of links in the recognition process */
#define TD_VR_LINK_ERROR 203

/* the garbage word was the best match */
#define TD_VR_BE_GARBAGE 204

/* no copy of a previous capture is stored in the phone's memory
   (this is if recognition is attempted on a previous capture)
*/
#define TD_VR_BE_NO_COPY 205

#endif


#if ((AUDIO_TDMA == TRUE) || (AUDIO_RAINBOW == TRUE))

/* clipping detected */
#define TD_VR_CAP_CLIPPING 1

/* low signal to noise ratio */
#define TD_VR_CAP_LOWSNR 2

/* too much energy in first frame */
#define TD_VR_CAP_FRSTFRMEGY 3

/* too much energy in the last frame */
#define TD_VR_CAP_LASTFRMEGY 4

/* No speech was found in a feature segment */
#define TD_VR_TR_ENDPOINT_ERR 5

/* tag is too similar to an existing tag */
#define TD_VR_TR_REJTAG 65

/* Need to reduce states, but state reduction is off */
#define TD_VR_TR_RED_OFF_ERR 66

/* two utterances are not of similar length */
#define TD_VR_TR_DISSIMILAR	67

/* Mean update error after viterbi alignment */
#define TD_VR_TR_VIT_MEAN_ERR 70

/* no end state was found (i.e. no word matched) */
#define TD_VR_NO_END_STATE_ERROR 129

/* the garbage word was the best match */
#define TD_VR_BE_GARBAGE 130

/* no copy of a previous capture is stored in the phone's memory
   (this is if recognition is attempted on a previous capture)
*/
#define TD_VR_BE_NO_COPY 131

/* ran out of links in the recognition process */
#define TD_VR_LINK_ERROR 131

#endif


/************** VA ERROR MESSAGES *********************************************/

/* The requested VA VoiceNote identifier has already been used */
#define TD_VA_LOCATION_USED	220

/* The requested VA VoiceNote identifier was not found */
#define TD_VA_LOCATION_NOT_FOUND 221

/* There is no space left for a new VA message */
#define TD_VA_OVF 222

/************** VA WARNING CODES **********************************************/
#define TD_VA_NO_WARNING 0

/* The VA memory has been filled while recording */
#define TD_VA_MEMORY_FULL_WARNING 1




/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/
typedef UINT8 TD_VR_ERROR_CODES;

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/

/************** GLOBAL VARIABLES **********************************************/


#ifdef __cplusplus /* allow #include in a C++ file (only put this in .h files) */
}
#endif
#endif /* end of - prevent inadvertently including a header file twice */