IAUDDEC1_Status Struct Reference
[XDM IAUDDEC1 Audio Decoder Interface]

Defines instance status parameters (read-only). More...

#include <iauddec1.h>

Collaboration diagram for IAUDDEC1_Status:

[legend]

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
XDM1_SingleBufDesc	data
XDAS_Int32	validFlag
XDAS_Int32	lfeFlag
XDAS_Int32	bitRate
XDAS_Int32	sampleRate
XDAS_Int32	channelMode
XDAS_Int32	pcmFormat
XDAS_Int32	numSamples
XDAS_Int32	outputBitsPerSample
XDM_AlgBufInfo	bufInfo
XDAS_Int32	dualMonoMode

---

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

See also:

IAUDDEC1_Fxns::control()

---

Field Documentation

XDAS_Int32 IAUDDEC1_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 IAUDDEC1_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 IAUDDEC1_Status::data

Buffer descriptor for data passing.

Remarks:

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

See also:

XDM_GETVERSION

XDAS_Int32 IAUDDEC1_Status::validFlag

Reflects the validity of this status structure.

Remarks:

In some cases (e.g. erroneous data streams), just after an error has been detected, the complete status provided by the algorithm may be incorrect (e.g. because of header corruption, etc). This field can "warn" the calling application that the contents of this structure are not valid. (Ideally, the algorithm makes a best attempt to always provide valid data, and this field is always set to XDAS_TRUE.)

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDDEC1_Status::lfeFlag

Flag indicating the presence of LFE channel in the output. When the LFE channel is not in the output, this is set to XDAS_FALSE.

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDDEC1_Status::bitRate

Average bit rate, in bits per second.

XDAS_Int32 IAUDDEC1_Status::sampleRate

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

XDAS_Int32 IAUDDEC1_Status::channelMode

Output Channel Configuration.

See also:

IAUDIO_ChannelMode

XDAS_Int32 IAUDDEC1_Status::pcmFormat

Output PCM Format Block/Interleaved.

See also:

IAUDIO_PcmFormat

XDAS_Int32 IAUDDEC1_Status::numSamples

Number of samples in the output.

XDAS_Int32 IAUDDEC1_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 IAUDDEC1_Status::bufInfo

Input and output buffer information.

See also:

XDM_AlgBufInfo

XDAS_Int32 IAUDDEC1_Status::dualMonoMode

Mode to indicate type of Dual Mono. Only used in case of Dual Mono Output.

See also:

IAUDIO_DualMonoMode

---

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

• iauddec1.h