IAUDDEC_Status Struct Reference
[XDM IAUDDEC Audio Decoder Interface]

#include <iauddec.h>

Collaboration diagram for IAUDDEC_Status:

Collaboration graph
[legend]

Detailed Description

Defines instance status parameters (read-only).

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 also:
IAUDDEC_Fxns::control()


Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
XDAS_Int32 bitRate
XDAS_Int32 sampleRate
XDAS_Int32 numChannels
XDAS_Int32 numLFEChannels
XDAS_Int32 outputFormat
XDAS_Int32 autoPosition
XDAS_Int32 fastFwdLen
XDAS_Int32 frameLen
XDAS_Int32 outputBitsPerSample
XDM_AlgBufInfo bufInfo

Field Documentation

XDAS_Int32 IAUDDEC_Status::size

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

XDAS_Int32 IAUDDEC_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

XDAS_Int32 IAUDDEC_Status::bitRate

Average bit rate, in bits per second.

XDAS_Int32 IAUDDEC_Status::sampleRate

Sampling frequency, in Hz. For example, if the sampling frequency is 44.1 kHz, this field will be 44100.

XDAS_Int32 IAUDDEC_Status::numChannels

Number of Channels. See IAUDIO_ChannelId.

XDAS_Int32 IAUDDEC_Status::numLFEChannels

Number of LFE (Low Frequency Effects) channels in the stream.

XDAS_Int32 IAUDDEC_Status::outputFormat

The output PCM format. See IAUDIO_PcmFormat.

XDAS_Int32 IAUDDEC_Status::autoPosition

Flag to indicate support for random position decoding, which means that a stream can be decoded from any point. 0 indicates this feature is not supported, 1 indicates this feature is supported.

XDAS_Int32 IAUDDEC_Status::fastFwdLen

Recommended fast forward length in bytes in case of random position decoding.

XDAS_Int32 IAUDDEC_Status::frameLen

Number of samples decoded per process() call.

XDAS_Int32 IAUDDEC_Status::outputBitsPerSample

Number of bits per output sample. For example, if the value of the field is 16, there are 16 output bits per PCM sample.

XDM_AlgBufInfo IAUDDEC_Status::bufInfo

Input and output buffer information. See XDM_AlgBufInfo.

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