IAUDDEC1_OutArgs Struct Reference
[XDM IAUDDEC1 Audio Decoder Interface]

#include <iauddec1.h>

Detailed Description

Defines the run time output arguments for all IAUDDEC1 instance objects.

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:
IAUDDEC1_Fxns::process()


Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
XDAS_Int32 bytesConsumed
XDAS_Int32 numSamples
XDAS_Int32 channelMode
XDAS_Int32 lfeFlag
XDAS_Int32 dualMonoMode
XDAS_Int32 sampleRate

Field Documentation

XDAS_Int32 IAUDDEC1_OutArgs::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_OutArgs::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 IAUDDEC1_OutArgs::bytesConsumed

Number of bytes consumed during the process() call.

XDAS_Int32 IAUDDEC1_OutArgs::numSamples

Number of output samples per channel.

XDAS_Int32 IAUDDEC1_OutArgs::channelMode

Output Channel Configuration.

See also:
IAUDIO_ChannelMode

XDAS_Int32 IAUDDEC1_OutArgs::lfeFlag

Flag indicating the precense 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_OutArgs::dualMonoMode

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

See also:
IAUDIO_DualMonoMode

XDAS_Int32 IAUDDEC1_OutArgs::sampleRate

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

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