ISPHDEC1_Status Struct Reference
[XDM ISPHDEC1 Speech/Voice Decoder Interface]

Defines instance status parameters. More...

#include <isphdec1.h>

Collaboration diagram for ISPHDEC1_Status:

[legend]

Data Fields
XDAS_Int16	size
XDAS_Int16	postFilter
XDAS_Int32	extendedError
XDM1_SingleBufDesc	data
XDAS_Int16	compandingLaw
XDAS_Int16	packingType
XDM_AlgBufInfo	bufInfo
XDAS_Int16	codecSelection
XDAS_Int16	bitRate

---

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. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

ISPHDEC1_Fxns::control()

---

Field Documentation

XDAS_Int16 ISPHDEC1_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 ISPHDEC1_Status::postFilter

Provides the current postFilter setting.

See also:

ISPEECH1_PostFilter

XDAS_Int32 ISPHDEC1_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 ISPHDEC1_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 ISPHDEC1_Fxns.control() call. The algorithm must not retain a pointer to this data.

See also:

XDM_GETVERSION

XDAS_Int16 ISPHDEC1_Status::compandingLaw

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

See also:

ISPEECH1_PCM_CompandingLaw

ISPEECH1_G726_CompandingLaw

XDAS_Int16 ISPHDEC1_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

XDM_AlgBufInfo ISPHDEC1_Status::bufInfo

Input and output buffer information.

See also:

XDM_AlgBufInfo

XDAS_Int16 ISPHDEC1_Status::codecSelection

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

See also:

ISPEECH1_AMR_CodecSelect

ISPHDEC1_Params.codecSelection

XDAS_Int16 ISPHDEC1_Status::bitRate

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

See also:

ISPEECH1_AMR_BitRate

ISPEECH1_G723_BitRate

ISPEECH1_G726_BitRate

ISPEECH1_WBAMR_BitRate

---

The documentation for this struct was generated from the following file:

• isphdec1.h