cannam@89: #ifndef PA_WIN_WMME_H
cannam@89: #define PA_WIN_WMME_H
cannam@89: /*
cannam@89:  * $Id: pa_win_wmme.h 1592 2011-02-04 10:41:58Z rossb $
cannam@89:  * PortAudio Portable Real-Time Audio Library
cannam@89:  * MME specific extensions
cannam@89:  *
cannam@89:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@89:  *
cannam@89:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@89:  * a copy of this software and associated documentation files
cannam@89:  * (the "Software"), to deal in the Software without restriction,
cannam@89:  * including without limitation the rights to use, copy, modify, merge,
cannam@89:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@89:  * and to permit persons to whom the Software is furnished to do so,
cannam@89:  * subject to the following conditions:
cannam@89:  *
cannam@89:  * The above copyright notice and this permission notice shall be
cannam@89:  * included in all copies or substantial portions of the Software.
cannam@89:  *
cannam@89:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@89:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@89:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@89:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@89:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@89:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@89:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@89:  */
cannam@89: 
cannam@89: /*
cannam@89:  * The text above constitutes the entire PortAudio license; however, 
cannam@89:  * the PortAudio community also makes the following non-binding requests:
cannam@89:  *
cannam@89:  * Any person wishing to distribute modifications to the Software is
cannam@89:  * requested to send the modifications to the original developer so that
cannam@89:  * they can be incorporated into the canonical version. It is also 
cannam@89:  * requested that these non-binding requests be included along with the 
cannam@89:  * license above.
cannam@89:  */
cannam@89: 
cannam@89: /** @file
cannam@89:  @ingroup public_header
cannam@89:  @brief WMME-specific PortAudio API extension header file.
cannam@89: */
cannam@89: 
cannam@89: #include "portaudio.h"
cannam@89: #include "pa_win_waveformat.h"
cannam@89: 
cannam@89: #ifdef __cplusplus
cannam@89: extern "C"
cannam@89: {
cannam@89: #endif /* __cplusplus */
cannam@89: 
cannam@89: 
cannam@89: /* The following are flags which can be set in 
cannam@89:   PaWinMmeStreamInfo's flags field.
cannam@89: */
cannam@89: 
cannam@89: #define paWinMmeUseLowLevelLatencyParameters            (0x01)
cannam@89: #define paWinMmeUseMultipleDevices                      (0x02)  /* use mme specific multiple device feature */
cannam@89: #define paWinMmeUseChannelMask                          (0x04)
cannam@89: 
cannam@89: /* By default, the mme implementation drops the processing thread's priority
cannam@89:     to THREAD_PRIORITY_NORMAL and sleeps the thread if the CPU load exceeds 100%
cannam@89:     This flag disables any priority throttling. The processing thread will always
cannam@89:     run at THREAD_PRIORITY_TIME_CRITICAL.
cannam@89: */
cannam@89: #define paWinMmeDontThrottleOverloadedProcessingThread  (0x08)
cannam@89: 
cannam@89: /*  Flags for non-PCM spdif passthrough.
cannam@89: */
cannam@89: #define paWinMmeWaveFormatDolbyAc3Spdif                 (0x10)
cannam@89: #define paWinMmeWaveFormatWmaSpdif                      (0x20)
cannam@89: 
cannam@89: 
cannam@89: typedef struct PaWinMmeDeviceAndChannelCount{
cannam@89:     PaDeviceIndex device;
cannam@89:     int channelCount;
cannam@89: }PaWinMmeDeviceAndChannelCount;
cannam@89: 
cannam@89: 
cannam@89: typedef struct PaWinMmeStreamInfo{
cannam@89:     unsigned long size;             /**< sizeof(PaWinMmeStreamInfo) */
cannam@89:     PaHostApiTypeId hostApiType;    /**< paMME */
cannam@89:     unsigned long version;          /**< 1 */
cannam@89: 
cannam@89:     unsigned long flags;
cannam@89: 
cannam@89:     /* low-level latency setting support
cannam@89:         These settings control the number and size of host buffers in order
cannam@89:         to set latency. They will be used instead of the generic parameters
cannam@89:         to Pa_OpenStream() if flags contains the PaWinMmeUseLowLevelLatencyParameters
cannam@89:         flag.
cannam@89: 
cannam@89:         If PaWinMmeStreamInfo structures with PaWinMmeUseLowLevelLatencyParameters
cannam@89:         are supplied for both input and output in a full duplex stream, then the
cannam@89:         input and output framesPerBuffer must be the same, or the larger of the
cannam@89:         two must be a multiple of the smaller, otherwise a
cannam@89:         paIncompatibleHostApiSpecificStreamInfo error will be returned from
cannam@89:         Pa_OpenStream().
cannam@89:     */
cannam@89:     unsigned long framesPerBuffer;
cannam@89:     unsigned long bufferCount;  /* formerly numBuffers */ 
cannam@89: 
cannam@89:     /* multiple devices per direction support
cannam@89:         If flags contains the PaWinMmeUseMultipleDevices flag,
cannam@89:         this functionality will be used, otherwise the device parameter to
cannam@89:         Pa_OpenStream() will be used instead.
cannam@89:         If devices are specified here, the corresponding device parameter
cannam@89:         to Pa_OpenStream() should be set to paUseHostApiSpecificDeviceSpecification,
cannam@89:         otherwise an paInvalidDevice error will result.
cannam@89:         The total number of channels accross all specified devices
cannam@89:         must agree with the corresponding channelCount parameter to
cannam@89:         Pa_OpenStream() otherwise a paInvalidChannelCount error will result.
cannam@89:     */
cannam@89:     PaWinMmeDeviceAndChannelCount *devices;
cannam@89:     unsigned long deviceCount;
cannam@89: 
cannam@89:     /*
cannam@89:         support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
cannam@89:         paWinMmeUseChannelMask this allows you to specify which speakers 
cannam@89:         to address in a multichannel stream. Constants for channelMask
cannam@89:         are specified in pa_win_waveformat.h
cannam@89: 
cannam@89:     */
cannam@89:     PaWinWaveFormatChannelMask channelMask;
cannam@89: 
cannam@89: }PaWinMmeStreamInfo;
cannam@89: 
cannam@89: 
cannam@89: /** Retrieve the number of wave in handles used by a PortAudio WinMME stream.
cannam@89:  Returns zero if the stream is output only.
cannam@89: 
cannam@89:  @return A non-negative value indicating the number of wave in handles
cannam@89:  or, a PaErrorCode (which are always negative) if PortAudio is not initialized
cannam@89:  or an error is encountered.
cannam@89: 
cannam@89:  @see PaWinMME_GetStreamInputHandle
cannam@89: */
cannam@89: int PaWinMME_GetStreamInputHandleCount( PaStream* stream );
cannam@89: 
cannam@89: 
cannam@89: /** Retrieve a wave in handle used by a PortAudio WinMME stream.
cannam@89: 
cannam@89:  @param stream The stream to query.
cannam@89:  @param handleIndex The zero based index of the wave in handle to retrieve. This
cannam@89:     should be in the range [0, PaWinMME_GetStreamInputHandleCount(stream)-1].
cannam@89: 
cannam@89:  @return A valid wave in handle, or NULL if an error occurred.
cannam@89: 
cannam@89:  @see PaWinMME_GetStreamInputHandle
cannam@89: */
cannam@89: HWAVEIN PaWinMME_GetStreamInputHandle( PaStream* stream, int handleIndex );
cannam@89: 
cannam@89: 
cannam@89: /** Retrieve the number of wave out handles used by a PortAudio WinMME stream.
cannam@89:  Returns zero if the stream is input only.
cannam@89:  
cannam@89:  @return A non-negative value indicating the number of wave out handles
cannam@89:  or, a PaErrorCode (which are always negative) if PortAudio is not initialized
cannam@89:  or an error is encountered.
cannam@89: 
cannam@89:  @see PaWinMME_GetStreamOutputHandle
cannam@89: */
cannam@89: int PaWinMME_GetStreamOutputHandleCount( PaStream* stream );
cannam@89: 
cannam@89: 
cannam@89: /** Retrieve a wave out handle used by a PortAudio WinMME stream.
cannam@89: 
cannam@89:  @param stream The stream to query.
cannam@89:  @param handleIndex The zero based index of the wave out handle to retrieve.
cannam@89:     This should be in the range [0, PaWinMME_GetStreamOutputHandleCount(stream)-1].
cannam@89: 
cannam@89:  @return A valid wave out handle, or NULL if an error occurred.
cannam@89: 
cannam@89:  @see PaWinMME_GetStreamOutputHandleCount
cannam@89: */
cannam@89: HWAVEOUT PaWinMME_GetStreamOutputHandle( PaStream* stream, int handleIndex );
cannam@89: 
cannam@89: 
cannam@89: #ifdef __cplusplus
cannam@89: }
cannam@89: #endif /* __cplusplus */
cannam@89: 
cannam@89: #endif /* PA_WIN_WMME_H */