isphenc1.h

TI Algorithm Soft Kit 5.10 仅包括实例及其原代码

/* 
 *  Copyright 2006
 *  Texas Instruments Incorporated
 *
 *  All rights reserved.  Property of Texas Instruments Incorporated
 *  Restricted rights to use, duplicate or disclose this code are
 *  granted through contract.
 * 
 */

/**
 *  @file       ti/xdais/dm/isphenc1.h
 *
 *  @brief      This header defines all types, constants, and functions
 *              shared by all implementations of the speech/voice encoder
 *              algorithms.
 */
/**
 *  @defgroup   ti_xdais_dm_ISPHENC1   xDM 1.0 Speech/Voice Encoder Interface
 *
 *  This is the xDM 1.0 Speech/Voice Encoder Interface.
 */

#ifndef ti_xdais_dm_ISPHENC1_
#define ti_xdais_dm_ISPHENC1_

#include <ti/xdais/ialg.h>
#include <ti/xdais/xdas.h>
#include "xdm.h"
#include "ispeech1.h"

#ifdef __cplusplus
extern "C" {
#endif

/** @ingroup    ti_xdais_dm_ISPHENC1 */
/*@{*/

#define ISPHENC1_ERUNTIME  XDM_ERUNTIME         /**< @copydoc XDM_ERUNTIME */
#define ISPHENC1_EOK       XDM_EOK              /**< @copydoc XDM_EOK */
#define ISPHENC1_EFAIL     XDM_EFAIL            /**< @copydoc XDM_EFAIL */
#define ISPHENC1_EUNSUPPORTED XDM_EUNSUPPORTED /**< @copydoc XDM_EUNSUPPORTED */

/**
 *  @brief      This value signifies no output being available at encoder,
 *              for example in the case of intermediate calls in 10msec
 *              frame size execution.
 */
#define ISPHENC1_ENOOUTPUT               1

/**
 *  @brief      This must be the first field of all ISPHENC1
 *              instance objects.
 */
typedef struct ISPHENC1_Obj {
    struct ISPHENC1_Fxns *fxns;
} ISPHENC1_Obj;


/**
 *  @brief      Opaque handle to an ISPHENC1 objects.
 */
typedef struct ISPHENC1_Obj  *ISPHENC1_Handle;


/**
 *  @brief      Defines the creation time parameters for
 *              all ISPHENC1 instance objects.
 *
 *  @remarks    Some of the fields in this structure are optional and depend
 *              on the class of speech encoder you're creating.
 *
 *  @extensibleStruct
 */
typedef struct ISPHENC1_Params {
    XDAS_Int16 size;            /**< @sizeField */
    XDAS_Int16 frameSize;       /**< Input frame size in bytes
                                 *   for sample based codecs.
                                 */
    XDAS_Int16 compandingLaw;   /**< Optional, codec-specific companding law.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_PCM_CompandingLaw
                                 *   @sa ISPEECH1_G726_CompandingLaw
                                 */
    XDAS_Int16 packingType;     /**< Optional, codec-specific packing type.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_AMR_PackingType
                                 *   @sa ISPEECH1_G726_PackingType
                                 *   @sa ISPEECH1_WBAMR_PackingType
                                 */
    XDAS_Int16 vadSelection;    /**< Optional, codec-specific voice activity
                                 *   detection selection.  See your
                                 *   codec-specific interface documentation
                                 *   options.
                                 *
                                 *   @sa ISPEECH1_AMR_VADSelect
                                 *   @sa ISPEECH1_SMV_VADSelect
                                 */
    XDAS_Int16 codecSelection;  /**< @copydoc ISPEECH1_CodecSelect
                                 *
                                 *   @sa ISPEECH1_CodecSelect
                                 *   @sa ISPHENC1_Status.codecSelection
                                 */
    XDAS_Int8  **tablesPtr;     /**< Optional pointer to the codec's
                                 *   initialization tables.
                                 *
                                 *   @remarks   This parameter specifies a
                                 *              pointer to the array of the
                                 *              codec's table block pointers.
                                 *              If the application requires
                                 *              the codec to select the
                                 *              default table address array
                                 *              pointer, it should set this
                                 *              to @c NULL.
                                 */
} ISPHENC1_Params;


/**
 *  @brief      This structure defines the codec parameters that can be
 *              modified after creation via ISPHENC1_Fxns.control().
 *
 *  @remarks    It is not necessary that a given implementation support all
 *              dynamic parameters to be configurable at run time.  If a
 *              particular algorithm does not support run-time updates to
 *              a parameter that the application is attempting to change
 *              at runtime, it may indicate this as an error.
 *
 *  @extensibleStruct
 */
typedef struct ISPHENC1_DynamicParams {
    XDAS_Int16 size;            /**< @sizeField */
    XDAS_Int16 frameSize;       /**< Input frame size in bytes for sample
                                 *   based codecs.
                                 */
    XDAS_Int16 bitRate;         /**< Optional, codec-specific bit rate.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_AMR_BitRate
                                 *   @sa ISPEECH1_G723_BitRate
                                 *   @sa ISPEECH1_WBAMR_BitRate
                                 */
    XDAS_Int16 mode;            /**< Optional, codec-specific mode.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_EVRC_Mode
                                 *   @sa ISPEECH1_SMV_Mode
                                 */
    XDAS_Int16 vadFlag;         /**< @copydoc ISPEECH1_VADFlag
                                 *   @sa ISPEECH1_VADFlag.
                                 */
    XDAS_Int16 noiseSuppressionMode; /**< Optional, codec-specific noise
                                 *   suppression mode.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_EVRC_NoisePreProc
                                 *   @sa ISPEECH1_G723_NoisePreProc
                                 *   @sa ISPEECH1_SMV_NoisePreProc
                                 */
    XDAS_Int16 ttyTddMode;      /**< Optional, codec-specific TTY mode.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_EVRC_TTYMode
                                 *   @sa ISPEECH1_SMV_TTYMode
                                 */
    XDAS_Int16 dtmfMode;        /**< Optional, codec-specific DTMF mode.
                                 *   See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_SMV_DTMFMode
                                 */
    XDAS_Int16 dataTransmit;    /**< Optional, codec-specific data transmit
                                 *   mode. See your codec-specific interface
                                 *   documentation options.
                                 *
                                 *   @sa ISPEECH1_SMV_DataMode
                                 */
    XDAS_Int16 reserved;        /**< Reserved - serves to pad this structure. */
} ISPHENC1_DynamicParams;


/**
 *  @brief      Defines the input arguments for all ISPHENC1 instance
 *              process function.
 */
typedef struct ISPHENC1_InArgs {
    XDM_SingleBufDesc data;     /**< Raw data input for data
                                 *   transmission.
                                 */
    XDAS_Int16 nullTrafficChannel; /**< Enable/disable the null traffic
                                 *   channel.
                                 *
                                 *   @remarks   This field is used for
                                 *              enabling/disabling the
                                 *              null traffic channel
                                 *              frames.  When enabled,
                                 *              CDMA encoders produce
                                 *              1/8th rate frames with
                                 *              all bits set to 1
                                 *              without encoding the
                                 *              actual input.
                                 *
                                 *   @sa ISPEECH1_NullTrafficMode
                                 */
    XDAS_Int16 reserved;        /**< Reserved - serves to pad this structure. */
} ISPHENC1_InArgs;


/**
 *  @brief      Defines instance status parameters.
 *
 *  @extensibleStruct
 */
typedef struct ISPHENC1_Status {
    XDAS_Int16 size;            /**< @sizeField */
    XDAS_Int16 frameSize;       /**< Input frame size in bytes for sample
                                 *   based codecs.
                                 */
    XDAS_Int32 extendedError;   /**< @extendedErrorField */
    XDM_SingleBufDesc data;     /**< Buffer descriptor for data passing.
                                 *
                                 *   @remarks   If this field is not used,
                                 *              the application <b>must</b>
                                 *              set @c data.buf to NULL.