Share via


WAVEFORMATEXTENSIBLE Structure

 
Microsoft DirectShow 9.0

WAVEFORMATEXTENSIBLE Structure

The WAVEFORMATEXTENSIBLE structure defines the format of waveform-audio data for formats having more than two channels or higher sample resolutions than allowed by WAVEFORMATEX.

This structure is not part of DirectShow but is documented here for convenience.

Syntax

typedef struct {
  WAVEFORMATEX  Format;
  union {
    WORD  wValidBitsPerSample;
    WORD  wSamplesPerBlock;
    WORD  wReserved;
  } Samples;
  DWORD   dwChannelMask; 
  GUID    SubFormat;
} WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE;

Members

Format

WAVEFORMATEX structure that specifies the basic format. The wFormatTag member must be WAVE_FORMAT_EXTENSIBLE, defined in Mmreg.h. The cbSize member must be at least 22.

wValidBitsPerSample

Number of bits of precision in the signal. Usually equal to WAVEFORMATEX.wBitsPerSample. However, wBitsPerSample is the container size and must be a multiple of 8, whereas wValidBitsPerSample can be any value not exceeding the container size. For example, if the format uses 20-bit samples, wBitsPerSample must be at least 24, but wValidBitsPerSample is 20.

wSamplesPerBlock

Number of samples contained in one compressed block of audio data. This value is used in buffer estimation. This value is used with compressed formats that have a fixed number of samples within each block. This value can be set to zero if a variable number of samples is contained in each block of compressed audio data. In this case, buffer estimation and position information needs to be obtained in other ways.

wReserved

Reserved for internal use by operating system. Set to zero.

dwChannelMask

Bitmask specifying the assignment of channels in the stream to speaker positions. See Remarks.

SubFormat

Subformat of the data, such as KSDATAFORMAT_SUBTYPE_PCM. The subformat information is similar to that provided by the tag in the WAVEFORMATEX structure's wFormatTag member.

Remarks

WAVEFORMATEXTENSIBLE can describe any format that can be described by WAVEFORMATEX, but provides additional support for more than two channels, for greater precision in the number of bits per sample, and for new compression schemes.

The dwChannelMask member specifies which channels are present in the multichannel stream. The least significant bit corresponds with the front left speaker, the next least significant bit corresponds to the front right speaker, and so on. The bits, in order of significance, are defined in Ksmedia.h and Mmreg.h as follows:

Speaker position Flag bit
SPEAKER_FRONT_LEFT 0x1
SPEAKER_FRONT_RIGHT 0x2
SPEAKER_FRONT_CENTER 0x4
SPEAKER_LOW_FREQUENCY 0x8
SPEAKER_BACK_LEFT 0x10
SPEAKER_BACK_RIGHT 0x20
SPEAKER_FRONT_LEFT_OF_CENTER 0x40
SPEAKER_FRONT_RIGHT_OF_CENTER 0x80
SPEAKER_BACK_CENTER 0x100
SPEAKER_SIDE_LEFT 0x200
SPEAKER_SIDE_RIGHT 0x400
SPEAKER_TOP_CENTER 0x800
SPEAKER_TOP_FRONT_LEFT 0x1000
SPEAKER_TOP_FRONT_CENTER 0x2000
SPEAKER_TOP_FRONT_RIGHT 0x4000
SPEAKER_TOP_BACK_LEFT 0x8000
SPEAKER_TOP_BACK_CENTER 0x10000
SPEAKER_TOP_BACK_RIGHT 0x20000

The following constants define some standard speaker configurations as bitwise ORs of the flags shown in the previous table:

Value Description Speakers
KSAUDIO_SPEAKER_MONO Mono Front center (C)
KSAUDIO_SPEAKER_STEREO Stereo Front left (L), front right (R)
KSAUDIO_SPEAKER_QUAD Quadraphonic L, R, back left (Lb), back right (Rb)
KSAUDIO_SPEAKER_SURROUND Surround L, R, front center (C), back center (Cb)
KSAUDIO_SPEAKER_5POINT1 5.1 channel L, R, C, Lb, Rb, low frequency (LFE)
KSAUDIO_SPEAKER_7POINT1 7.1 channel L, R, C, Lb, Rb, front left-of-center, front right-of-center, LFE
KSAUDIO_SPEAKER_5POINT1_SURROUND 5.1 channel surround L, R, C, side left (Ls), side right (Rs), LFE
KSAUDIO_SPEAKER_7POINT1_SURROUND 7.1 channel surround L, R, C, Lb, Rb, Ls, Rs, LFE

For more information on this structure, see the document Multiple Channel Audio Data and WAVE Files, available at www.microsoft.com.

Requirements

**  Header:** Declared in Mmreg.h, Ksproxy.h.