cannam@145: #ifndef PA_WIN_WAVEFORMAT_H
cannam@145: #define PA_WIN_WAVEFORMAT_H
cannam@145: 
cannam@145: /*
cannam@145:  * PortAudio Portable Real-Time Audio Library
cannam@145:  * Windows WAVEFORMAT* data structure utilities
cannam@145:  * portaudio.h should be included before this file.
cannam@145:  *
cannam@145:  * Copyright (c) 2007 Ross Bencina
cannam@145:  *
cannam@145:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@145:  * a copy of this software and associated documentation files
cannam@145:  * (the "Software"), to deal in the Software without restriction,
cannam@145:  * including without limitation the rights to use, copy, modify, merge,
cannam@145:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@145:  * and to permit persons to whom the Software is furnished to do so,
cannam@145:  * subject to the following conditions:
cannam@145:  *
cannam@145:  * The above copyright notice and this permission notice shall be
cannam@145:  * included in all copies or substantial portions of the Software.
cannam@145:  *
cannam@145:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@145:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@145:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@145:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@145:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@145:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@145:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@145:  */
cannam@145: 
cannam@145: /*
cannam@145:  * The text above constitutes the entire PortAudio license; however, 
cannam@145:  * the PortAudio community also makes the following non-binding requests:
cannam@145:  *
cannam@145:  * Any person wishing to distribute modifications to the Software is
cannam@145:  * requested to send the modifications to the original developer so that
cannam@145:  * they can be incorporated into the canonical version. It is also 
cannam@145:  * requested that these non-binding requests be included along with the 
cannam@145:  * license above.
cannam@145:  */
cannam@145: 
cannam@145: /** @file
cannam@145:  @ingroup public_header
cannam@145:  @brief Windows specific PortAudio API extension and utilities header file.
cannam@145: */
cannam@145: 
cannam@145: #ifdef __cplusplus
cannam@145: extern "C" {
cannam@145: #endif
cannam@145: 
cannam@145: /*
cannam@145: 	The following #defines for speaker channel masks are the same
cannam@145: 	as those in ksmedia.h, except with PAWIN_ prepended, KSAUDIO_ removed
cannam@145: 	in some cases, and casts to PaWinWaveFormatChannelMask added.
cannam@145: */
cannam@145: 
cannam@145: typedef unsigned long PaWinWaveFormatChannelMask;
cannam@145: 
cannam@145: /* Speaker Positions: */
cannam@145: #define PAWIN_SPEAKER_FRONT_LEFT				((PaWinWaveFormatChannelMask)0x1)
cannam@145: #define PAWIN_SPEAKER_FRONT_RIGHT				((PaWinWaveFormatChannelMask)0x2)
cannam@145: #define PAWIN_SPEAKER_FRONT_CENTER				((PaWinWaveFormatChannelMask)0x4)
cannam@145: #define PAWIN_SPEAKER_LOW_FREQUENCY				((PaWinWaveFormatChannelMask)0x8)
cannam@145: #define PAWIN_SPEAKER_BACK_LEFT					((PaWinWaveFormatChannelMask)0x10)
cannam@145: #define PAWIN_SPEAKER_BACK_RIGHT				((PaWinWaveFormatChannelMask)0x20)
cannam@145: #define PAWIN_SPEAKER_FRONT_LEFT_OF_CENTER		((PaWinWaveFormatChannelMask)0x40)
cannam@145: #define PAWIN_SPEAKER_FRONT_RIGHT_OF_CENTER		((PaWinWaveFormatChannelMask)0x80)
cannam@145: #define PAWIN_SPEAKER_BACK_CENTER				((PaWinWaveFormatChannelMask)0x100)
cannam@145: #define PAWIN_SPEAKER_SIDE_LEFT					((PaWinWaveFormatChannelMask)0x200)
cannam@145: #define PAWIN_SPEAKER_SIDE_RIGHT				((PaWinWaveFormatChannelMask)0x400)
cannam@145: #define PAWIN_SPEAKER_TOP_CENTER				((PaWinWaveFormatChannelMask)0x800)
cannam@145: #define PAWIN_SPEAKER_TOP_FRONT_LEFT			((PaWinWaveFormatChannelMask)0x1000)
cannam@145: #define PAWIN_SPEAKER_TOP_FRONT_CENTER			((PaWinWaveFormatChannelMask)0x2000)
cannam@145: #define PAWIN_SPEAKER_TOP_FRONT_RIGHT			((PaWinWaveFormatChannelMask)0x4000)
cannam@145: #define PAWIN_SPEAKER_TOP_BACK_LEFT				((PaWinWaveFormatChannelMask)0x8000)
cannam@145: #define PAWIN_SPEAKER_TOP_BACK_CENTER			((PaWinWaveFormatChannelMask)0x10000)
cannam@145: #define PAWIN_SPEAKER_TOP_BACK_RIGHT			((PaWinWaveFormatChannelMask)0x20000)
cannam@145: 
cannam@145: /* Bit mask locations reserved for future use */
cannam@145: #define PAWIN_SPEAKER_RESERVED					((PaWinWaveFormatChannelMask)0x7FFC0000)
cannam@145: 
cannam@145: /* Used to specify that any possible permutation of speaker configurations */
cannam@145: #define PAWIN_SPEAKER_ALL						((PaWinWaveFormatChannelMask)0x80000000)
cannam@145: 
cannam@145: /* DirectSound Speaker Config */
cannam@145: #define PAWIN_SPEAKER_DIRECTOUT					0
cannam@145: #define PAWIN_SPEAKER_MONO						(PAWIN_SPEAKER_FRONT_CENTER)
cannam@145: #define PAWIN_SPEAKER_STEREO					(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT)
cannam@145: #define PAWIN_SPEAKER_QUAD						(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_BACK_LEFT  | PAWIN_SPEAKER_BACK_RIGHT)
cannam@145: #define PAWIN_SPEAKER_SURROUND					(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_CENTER | PAWIN_SPEAKER_BACK_CENTER)
cannam@145: #define PAWIN_SPEAKER_5POINT1					(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_CENTER | PAWIN_SPEAKER_LOW_FREQUENCY | \
cannam@145: 												PAWIN_SPEAKER_BACK_LEFT  | PAWIN_SPEAKER_BACK_RIGHT)
cannam@145: #define PAWIN_SPEAKER_7POINT1					(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_CENTER | PAWIN_SPEAKER_LOW_FREQUENCY | \
cannam@145: 												PAWIN_SPEAKER_BACK_LEFT | PAWIN_SPEAKER_BACK_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_LEFT_OF_CENTER | PAWIN_SPEAKER_FRONT_RIGHT_OF_CENTER)
cannam@145: #define PAWIN_SPEAKER_5POINT1_SURROUND			(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_CENTER | PAWIN_SPEAKER_LOW_FREQUENCY | \
cannam@145: 												PAWIN_SPEAKER_SIDE_LEFT  | PAWIN_SPEAKER_SIDE_RIGHT)
cannam@145: #define PAWIN_SPEAKER_7POINT1_SURROUND			(PAWIN_SPEAKER_FRONT_LEFT | PAWIN_SPEAKER_FRONT_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_FRONT_CENTER | PAWIN_SPEAKER_LOW_FREQUENCY | \
cannam@145: 												PAWIN_SPEAKER_BACK_LEFT | PAWIN_SPEAKER_BACK_RIGHT | \
cannam@145: 												PAWIN_SPEAKER_SIDE_LEFT | PAWIN_SPEAKER_SIDE_RIGHT)
cannam@145: /*
cannam@145:  According to the Microsoft documentation:
cannam@145:  The following are obsolete 5.1 and 7.1 settings (they lack side speakers).  Note this means
cannam@145:  that the default 5.1 and 7.1 settings (KSAUDIO_SPEAKER_5POINT1 and KSAUDIO_SPEAKER_7POINT1 are
cannam@145:  similarly obsolete but are unchanged for compatibility reasons).
cannam@145: */
cannam@145: #define PAWIN_SPEAKER_5POINT1_BACK				PAWIN_SPEAKER_5POINT1
cannam@145: #define PAWIN_SPEAKER_7POINT1_WIDE				PAWIN_SPEAKER_7POINT1
cannam@145: 
cannam@145: /* DVD Speaker Positions */
cannam@145: #define PAWIN_SPEAKER_GROUND_FRONT_LEFT			PAWIN_SPEAKER_FRONT_LEFT
cannam@145: #define PAWIN_SPEAKER_GROUND_FRONT_CENTER		PAWIN_SPEAKER_FRONT_CENTER
cannam@145: #define PAWIN_SPEAKER_GROUND_FRONT_RIGHT		PAWIN_SPEAKER_FRONT_RIGHT
cannam@145: #define PAWIN_SPEAKER_GROUND_REAR_LEFT			PAWIN_SPEAKER_BACK_LEFT
cannam@145: #define PAWIN_SPEAKER_GROUND_REAR_RIGHT			PAWIN_SPEAKER_BACK_RIGHT
cannam@145: #define PAWIN_SPEAKER_TOP_MIDDLE				PAWIN_SPEAKER_TOP_CENTER
cannam@145: #define PAWIN_SPEAKER_SUPER_WOOFER				PAWIN_SPEAKER_LOW_FREQUENCY
cannam@145: 
cannam@145: 
cannam@145: /*
cannam@145: 	PaWinWaveFormat is defined here to provide compatibility with
cannam@145: 	compilation environments which don't have headers defining 
cannam@145: 	WAVEFORMATEXTENSIBLE (e.g. older versions of MSVC, Borland C++ etc.
cannam@145: 
cannam@145: 	The fields for WAVEFORMATEX and WAVEFORMATEXTENSIBLE are declared as an
cannam@145:     unsigned char array here to avoid clients who include this file having 
cannam@145:     a dependency on windows.h and mmsystem.h, and also to to avoid having
cannam@145:     to write separate packing pragmas for each compiler.
cannam@145: */
cannam@145: #define PAWIN_SIZEOF_WAVEFORMATEX   18
cannam@145: #define PAWIN_SIZEOF_WAVEFORMATEXTENSIBLE (PAWIN_SIZEOF_WAVEFORMATEX + 22)
cannam@145: 
cannam@145: typedef struct{
cannam@145:     unsigned char fields[ PAWIN_SIZEOF_WAVEFORMATEXTENSIBLE ];
cannam@145:     unsigned long extraLongForAlignment; /* ensure that compiler aligns struct to DWORD */ 
cannam@145: } PaWinWaveFormat;
cannam@145: 
cannam@145: /*
cannam@145:     WAVEFORMATEXTENSIBLE fields:
cannam@145:     
cannam@145:     union  {
cannam@145: 	    WORD  wValidBitsPerSample;    
cannam@145: 	    WORD  wSamplesPerBlock;    
cannam@145: 	    WORD  wReserved;  
cannam@145:     } Samples;
cannam@145:     DWORD  dwChannelMask;  
cannam@145:     GUID  SubFormat;
cannam@145: */
cannam@145: 
cannam@145: #define PAWIN_INDEXOF_WVALIDBITSPERSAMPLE	(PAWIN_SIZEOF_WAVEFORMATEX+0)
cannam@145: #define PAWIN_INDEXOF_DWCHANNELMASK			(PAWIN_SIZEOF_WAVEFORMATEX+2)
cannam@145: #define PAWIN_INDEXOF_SUBFORMAT				(PAWIN_SIZEOF_WAVEFORMATEX+6)
cannam@145: 
cannam@145: 
cannam@145: /*
cannam@145:     Valid values to pass for the waveFormatTag PaWin_InitializeWaveFormatEx and
cannam@145:     PaWin_InitializeWaveFormatExtensible functions below. These must match
cannam@145:     the standard Windows WAVE_FORMAT_* values.
cannam@145: */
cannam@145: #define PAWIN_WAVE_FORMAT_PCM               (1)
cannam@145: #define PAWIN_WAVE_FORMAT_IEEE_FLOAT        (3)
cannam@145: #define PAWIN_WAVE_FORMAT_DOLBY_AC3_SPDIF   (0x0092)
cannam@145: #define PAWIN_WAVE_FORMAT_WMA_SPDIF         (0x0164)
cannam@145: 
cannam@145: 
cannam@145: /*
cannam@145:     returns PAWIN_WAVE_FORMAT_PCM or PAWIN_WAVE_FORMAT_IEEE_FLOAT
cannam@145:     depending on the sampleFormat parameter.
cannam@145: */
cannam@145: int PaWin_SampleFormatToLinearWaveFormatTag( PaSampleFormat sampleFormat );
cannam@145: 
cannam@145: /*
cannam@145: 	Use the following two functions to initialize the waveformat structure.
cannam@145: */
cannam@145: 
cannam@145: void PaWin_InitializeWaveFormatEx( PaWinWaveFormat *waveFormat, 
cannam@145: 		int numChannels, PaSampleFormat sampleFormat, int waveFormatTag, double sampleRate );
cannam@145: 
cannam@145: 
cannam@145: void PaWin_InitializeWaveFormatExtensible( PaWinWaveFormat *waveFormat, 
cannam@145: 		int numChannels, PaSampleFormat sampleFormat, int waveFormatTag, double sampleRate,
cannam@145: 	    PaWinWaveFormatChannelMask channelMask );
cannam@145: 
cannam@145: 
cannam@145: /* Map a channel count to a speaker channel mask */
cannam@145: PaWinWaveFormatChannelMask PaWin_DefaultChannelMask( int numChannels );
cannam@145: 
cannam@145: 
cannam@145: #ifdef __cplusplus
cannam@145: }
cannam@145: #endif /* __cplusplus */
cannam@145: 
cannam@130: #endif /* PA_WIN_WAVEFORMAT_H */