IAUDENC1_Params Struct Reference
[XDM IAUDENC1 Audio Encoder Interface]

#include <iaudenc1.h>

Detailed Description

Defines the creation time parameters for all IAUDENC1 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.


Data Fields

XDAS_Int32 size
XDAS_Int32 sampleRate
XDAS_Int32 bitRate
XDAS_Int32 channelMode
XDAS_Int32 dataEndianness
XDAS_Int32 encMode
XDAS_Int32 inputFormat
XDAS_Int32 inputBitsPerSample
XDAS_Int32 maxBitRate
XDAS_Int32 dualMonoMode
XDAS_Int32 crcFlag
XDAS_Int32 ancFlag
XDAS_Int32 lfeFlag

Field Documentation

XDAS_Int32 IAUDENC1_Params::size

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

XDAS_Int32 IAUDENC1_Params::sampleRate

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

See also:
IAUDENC1_DynamicParams.sampleRate

IAUDENC1_Status.sampleRate

XDAS_Int32 IAUDENC1_Params::bitRate

Average bit rate, in bits per second.

See also:
IAUDENC1_DynamicParams.bitRate

IAUDENC1_Status.bitRate

XDAS_Int32 IAUDENC1_Params::channelMode

Input Channel Mode.

See also:
IAUDIO_ChannelMode

IAUDENC1_DynamicParams.channelMode

XDAS_Int32 IAUDENC1_Params::dataEndianness

Endianness of input data.

See also:
XDM_DataFormat

XDAS_Int32 IAUDENC1_Params::encMode

Encoding mode.

See also:
IAUDIO_EncMode

IAUDENC1_Status.encMode

XDAS_Int32 IAUDENC1_Params::inputFormat

Input format block/interleaved.

See also:
IAUDIO_PcmFormat

XDAS_Int32 IAUDENC1_Params::inputBitsPerSample

Number of input bits per output sample. For example, if there are 16 bits per PCM input sample, this should be set to 16.

See also:
IAUDENC1_DynamicParams.inputBitsPerSample

XDAS_Int32 IAUDENC1_Params::maxBitRate

Maximum bit rate in case of VBR. Some of the encoders allow you to specify max bit rate in case of VBR mode

XDAS_Int32 IAUDENC1_Params::dualMonoMode

Mode to indicate type of Dual Mono. Applicable only if channelMode is dualMono

See also:
IAUDIO_DualMonoMode

IAUDENC1_DynamicParams.dualMonoMode

XDAS_Int32 IAUDENC1_Params::crcFlag

Flag indicating whether the encoder should insert CRC bits into the bitstream or not.

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDENC1_Params::ancFlag

Ancillary Data Flag.

Remarks:
This flag indicates to the encoder that Ancillary data needs to be encoded along with the normal audio data. The ancillary data can be provided for each input frame.
Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDENC1_Params::lfeFlag

Flag indicating whether LFE channel data is present or not in the input.

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

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