am_sdvr_records.h

Motorola synergy audio component

#ifndef AM_SDVR_RECORD_INCLUDE
#define AM_SDVR_RECORD_INCLUDE

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

#ifdef __cplusplus  /* allow #include in a C++ file */
extern "C" {
#endif

/*
DESCRIPTION: 

This file defines utterance capture record.

*/


/*
****************************** REVISION HISTORY ******************************

    Date        Author      Reference Number
    ========    ========    ================
    99-01-13    jkraisor    CR - CSGce26811
                VA/VR FDI Interface Completion
                - Added group_id to the structure.

    97-05-28    slam        PR - CSGce10240

******************************************************************************
*/


/* INCLUDES */

#include <SUAPI/su_basictypes.h>
#include <ENGINE_AUDIO/td_vr_defs.h>
#include <ENGINE_AUDIO/td_vr_group_types.h>
#include <ENGINE_AUDIO/td_vr_voice_tag.h>
#include <ENGINE_AUDIO/td_vr_training_types.h>

/****************************************************************************/
/* code */
/****************************************************************************/


typedef struct
{
    /* The repetition number that is assigned to this utterance of
       the word. Up to TD_SCM_VR_MAX_CAPTURE_REPETITIONS will be
       supported in the DSP implementation. */
    UINT16           repetition;
    UINT16           time;       /* Time interval ( ms) in which voice input capture is performed*/
    TD_VR_GROUP_TYPE group_id;   /* Identification for group for VR capture request.*/
} AM_SDVR_CAPTURE_RECORD;




typedef struct
{

    /* Identifier of the group in which voice recognition is allowed */
    TD_VR_GROUP_TYPE        group_id;

    /* If the repeat indication is set to TRUE, the recognition will
       be repeated with a different set of models.
    */
    BOOL                    repeat_indication;

    /* Number of nbest matches for the utterance to be returned. The
       maximum number is TD_VR_MAX_NBEST_MODELS.
    */
    UINT8                    nbest;

    /* Size of the active bit array in units of UINT16 length (16 bits).
       The maximum number is TD_VR_MAX_ACTIVE_ARRAY_SIZE.
    */
    UINT8                    active_bit_array_size;

    /* Bit array indicating which model IDs within the chosen group are
       active. The right most bit of the first word of the array corresponds
       to model ID 0. Bit is set to 1 if the model is active, 0 if inactive.
    */
    UINT16                   active_bit_array[ TD_VR_MAX_ACTIVE_ARRAY_SIZE ];

    /* time interval in units of ms in which voice recognition is allowed */
    UINT16                  time;
} AM_SDVR_RECOG_RECORD;



typedef struct
{
    /* Identifier of the group to which the utterance being trained
       should be performed.
    */
    TD_VR_GROUP_TYPE        group_id;

    /* A training mode of VR_TRAIN_ALL indicates that all utterances specified
       in the repetition mask should be used for training. A training
       mode of VR_TRAIN_BEST allows the DSP to select the best utterances
       specified in the repetition mask and use those for training.
    */
    TD_VR_TRAINING_TYPE     training_mode;
	
    /* Bit mask indicating which repetition of an utterance should
       be used for training. The right most bit of the word of
       corresponds to repetition 0. Bit value of '1' indicates the
       repetition should be considered for training. Bit value of
       '0' indicates the repetition should not be used for training.
    */
    UINT16                  repetition_bit_mask;

} AM_SDVR_TRAIN_RECORD;


typedef struct 
{
    /* number of voice tags */
    UINT16                    voice_tag_count;
 
    /* Array of voice tags. The maximum number of voice tag packaged in
       one primitive is constrained by the Speech Coder hardware limitation
     */
    TD_VR_VOICE_TAG         voice_tag_array[ TD_SCM_MAX_VOICE_TAGS ];

} AM_VR_PLAYBACK_RECORD;


#ifdef __cplusplus         /*  Allow #include in a C++ file.  */
}
#endif

#endif        /*  End Of Definitions  */