ISPHENC1_Status Struct Reference
[XDM ISPHENC1 Speech/Voice Encoder Interface]

#include <isphenc1.h>

Collaboration diagram for ISPHENC1_Status:

Collaboration graph
[legend]

Detailed Description

Defines instance status parameters.

Remarks:
This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.

The size field must be correctly set by the caller.


Data Fields

XDAS_Int16 size
XDAS_Int16 frameSize
XDAS_Int32 extendedError
XDM1_SingleBufDesc data
XDAS_Int16 bitRate
XDAS_Int16 mode
XDAS_Int16 vadFlag
XDAS_Int16 noiseSuppressionMode
XDAS_Int16 ttyTddMode
XDAS_Int16 dataTransmit
XDAS_Int16 compandingLaw
XDAS_Int16 packingType
XDAS_Int16 vadSelection
XDAS_Int16 codecSelection
XDM_AlgBufInfo bufInfo

Field Documentation

XDAS_Int16 ISPHENC1_Status::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int16 ISPHENC1_Status::frameSize

Input frame size in bytes for sample based codecs.

XDAS_Int32 ISPHENC1_Status::extendedError

Extended error information.

Remarks:
When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)

The value of each enum is the bit which is set.

Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.

The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:
XDM_ErrorBit

XDM1_SingleBufDesc ISPHENC1_Status::data

Buffer descriptor for data passing.

Remarks:
If this field is not used, the application must set data.buf to NULL.

This buffer can be used as either input or output, depending on the command.

The buffer will be provided by the application, and returned to the application upon return of the ISPHENC1_Fxns.control() call. The algorithm must not retain a pointer to this data.

See also:
XDM_GETVERSION

XDAS_Int16 ISPHENC1_Status::bitRate

Optional, codec-specific bit rate. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_BitRate

ISPEECH1_G723_BitRate

ISPEECH1_WBAMR_BitRate

XDAS_Int16 ISPHENC1_Status::mode

Optional, codec-specific mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_Mode

ISPEECH1_SMV_Mode

XDAS_Int16 ISPHENC1_Status::vadFlag

Voice Activity Detection (VAD) setting.

See also:
ISPEECH1_VADFlag

XDAS_Int16 ISPHENC1_Status::noiseSuppressionMode

Optional, codec-specific noise suppression mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_NoisePreProc

ISPEECH1_G723_NoisePreProc

ISPEECH1_SMV_NoisePreProc

XDAS_Int16 ISPHENC1_Status::ttyTddMode

Optional, codec-specific TTY mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_TTYMode

ISPEECH1_SMV_TTYMode

XDAS_Int16 ISPHENC1_Status::dataTransmit

Optional, codec-specific data transmit mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_SMV_DataMode

XDAS_Int16 ISPHENC1_Status::compandingLaw

Optional, codec-specific companding law. See your codec-specific interface documentation options.

See also:
ISPEECH1_PCM_CompandingLaw

ISPEECH1_G726_CompandingLaw

XDAS_Int16 ISPHENC1_Status::packingType

Optional, codec-specific packing type. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_PackingType

ISPEECH1_G726_PackingType

ISPEECH1_WBAMR_PackingType

XDAS_Int16 ISPHENC1_Status::vadSelection

Optional, codec-specific voice activity detection selection. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_VADSelect

ISPEECH1_SMV_VADSelect

XDAS_Int16 ISPHENC1_Status::codecSelection

Optional, codec-specific codec selection. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_CodecSelect

ISPHENC1_Params.codecSelection

XDM_AlgBufInfo ISPHENC1_Status::bufInfo

Input and output buffer information.

See also:
XDM_AlgBufInfo

The documentation for this struct was generated from the following file:
Copyright 2009, Texas Instruments Incorporated