Edit

HDAUDIO_CONVERTER_FORMAT structure (hdaudio.h)

  • Article

The HDAUDIO_CONVERTER_FORMAT structure specifies the 16-bit encoded stream format for an input or output converter, as defined in the Intel High Definition Audio Specification (see the Intel HD Audio website).

Syntax

typedef struct _HDAUDIO_CONVERTER_FORMAT {
  union {
    struct {
      USHORT NumberOfChannels : 4;
      USHORT BitsPerSample : 3;
      USHORT SampleRate : 7;
      USHORT StreamType : 1;
    };
    USHORT ConverterFormat;
  };
} HDAUDIO_CONVERTER_FORMAT, *PHDAUDIO_CONVERTER_FORMAT;

Members

NumberOfChannels

Specifies the number of channels in the stream's data format. For more information, see the following Remarks section.

BitsPerSample

Specifies the number of bits per sample. For more information, see the following Remarks section.

SampleRate

Specifies the stream's sample rate. For more information, see the following Remarks section.

StreamType

Specifies the stream type. If StreamType=0, the stream contains PCM data. If StreamType=1, the stream contains non-PCM data.

ConverterFormat

Specifies the stream's data format as an encoded 16-bit value. For more information, see the following Remarks section.

Remarks

For information about the encoding of the individual bitfields in the structure definition, see the discussion of the stream descriptor in the Intel High Definition Audio Specification at the Intel HD Audio website.

The HD Audio bus driver sets the unnamed bitfield in the structure definition to zero.

The AllocateCaptureDmaEngine, AllocateRenderDmaEngine, and ChangeBandwidthAllocation routines take as an input parameter an HDAUDIO_STREAM_FORMAT structure and output the corresponding HDAUDIO_CONVERTER_FORMAT structure. The caller can use the output value to program the input or output converters.

Each valid HDAUDIO_CONVERTER_FORMAT encoding has a one-to-one correspondence to an HDAUDIO_STREAM_FORMAT structure that contains a valid set of parameters.

Requirements

Requirement Value
Header hdaudio.h (include Hdaudio.h)

See also

AllocateCaptureDmaEngine

AllocateRenderDmaEngine

ChangeBandwidthAllocation

HDAUDIO_STREAM_FORMAT