Mercurial > hg > sv-dependency-builds

annotate src/portaudio/include/pa_win_wmme.h @ 89:8a15ff55d9af

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add bzip2, zlib, liblo, portaudio sources
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 20 Mar 2013 13:59:52 +0000
parents
children
rev   line source
cannam@89 1 #ifndef PA_WIN_WMME_H
cannam@89 2 #define PA_WIN_WMME_H
cannam@89 3 /*
cannam@89 4 * $Id: pa_win_wmme.h 1592 2011-02-04 10:41:58Z rossb $
cannam@89 5 * PortAudio Portable Real-Time Audio Library
cannam@89 6 * MME specific extensions
cannam@89 7 *
cannam@89 8 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@89 9 *
cannam@89 10 * Permission is hereby granted, free of charge, to any person obtaining
cannam@89 11 * a copy of this software and associated documentation files
cannam@89 12 * (the "Software"), to deal in the Software without restriction,
cannam@89 13 * including without limitation the rights to use, copy, modify, merge,
cannam@89 14 * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@89 15 * and to permit persons to whom the Software is furnished to do so,
cannam@89 16 * subject to the following conditions:
cannam@89 17 *
cannam@89 18 * The above copyright notice and this permission notice shall be
cannam@89 19 * included in all copies or substantial portions of the Software.
cannam@89 20 *
cannam@89 21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@89 22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@89 23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@89 24 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@89 25 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@89 26 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@89 27 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@89 28 */
cannam@89 29
cannam@89 30 /*
cannam@89 31 * The text above constitutes the entire PortAudio license; however,
cannam@89 32 * the PortAudio community also makes the following non-binding requests:
cannam@89 33 *
cannam@89 34 * Any person wishing to distribute modifications to the Software is
cannam@89 35 * requested to send the modifications to the original developer so that
cannam@89 36 * they can be incorporated into the canonical version. It is also
cannam@89 37 * requested that these non-binding requests be included along with the
cannam@89 38 * license above.
cannam@89 39 */
cannam@89 40
cannam@89 41 /** @file
cannam@89 42 @ingroup public_header
cannam@89 43 @brief WMME-specific PortAudio API extension header file.
cannam@89 44 */
cannam@89 45
cannam@89 46 #include "portaudio.h"
cannam@89 47 #include "pa_win_waveformat.h"
cannam@89 48
cannam@89 49 #ifdef __cplusplus
cannam@89 50 extern "C"
cannam@89 51 {
cannam@89 52 #endif /* __cplusplus */
cannam@89 53
cannam@89 54
cannam@89 55 /* The following are flags which can be set in
cannam@89 56 PaWinMmeStreamInfo's flags field.
cannam@89 57 */
cannam@89 58
cannam@89 59 #define paWinMmeUseLowLevelLatencyParameters (0x01)
cannam@89 60 #define paWinMmeUseMultipleDevices (0x02) /* use mme specific multiple device feature */
cannam@89 61 #define paWinMmeUseChannelMask (0x04)
cannam@89 62
cannam@89 63 /* By default, the mme implementation drops the processing thread's priority
cannam@89 64 to THREAD_PRIORITY_NORMAL and sleeps the thread if the CPU load exceeds 100%
cannam@89 65 This flag disables any priority throttling. The processing thread will always
cannam@89 66 run at THREAD_PRIORITY_TIME_CRITICAL.
cannam@89 67 */
cannam@89 68 #define paWinMmeDontThrottleOverloadedProcessingThread (0x08)
cannam@89 69
cannam@89 70 /* Flags for non-PCM spdif passthrough.
cannam@89 71 */
cannam@89 72 #define paWinMmeWaveFormatDolbyAc3Spdif (0x10)
cannam@89 73 #define paWinMmeWaveFormatWmaSpdif (0x20)
cannam@89 74
cannam@89 75
cannam@89 76 typedef struct PaWinMmeDeviceAndChannelCount{
cannam@89 77 PaDeviceIndex device;
cannam@89 78 int channelCount;
cannam@89 79 }PaWinMmeDeviceAndChannelCount;
cannam@89 80
cannam@89 81
cannam@89 82 typedef struct PaWinMmeStreamInfo{
cannam@89 83 unsigned long size; /**< sizeof(PaWinMmeStreamInfo) */
cannam@89 84 PaHostApiTypeId hostApiType; /**< paMME */
cannam@89 85 unsigned long version; /**< 1 */
cannam@89 86
cannam@89 87 unsigned long flags;
cannam@89 88
cannam@89 89 /* low-level latency setting support
cannam@89 90 These settings control the number and size of host buffers in order
cannam@89 91 to set latency. They will be used instead of the generic parameters
cannam@89 92 to Pa_OpenStream() if flags contains the PaWinMmeUseLowLevelLatencyParameters
cannam@89 93 flag.
cannam@89 94
cannam@89 95 If PaWinMmeStreamInfo structures with PaWinMmeUseLowLevelLatencyParameters
cannam@89 96 are supplied for both input and output in a full duplex stream, then the
cannam@89 97 input and output framesPerBuffer must be the same, or the larger of the
cannam@89 98 two must be a multiple of the smaller, otherwise a
cannam@89 99 paIncompatibleHostApiSpecificStreamInfo error will be returned from
cannam@89 100 Pa_OpenStream().
cannam@89 101 */
cannam@89 102 unsigned long framesPerBuffer;
cannam@89 103 unsigned long bufferCount; /* formerly numBuffers */
cannam@89 104
cannam@89 105 /* multiple devices per direction support
cannam@89 106 If flags contains the PaWinMmeUseMultipleDevices flag,
cannam@89 107 this functionality will be used, otherwise the device parameter to
cannam@89 108 Pa_OpenStream() will be used instead.
cannam@89 109 If devices are specified here, the corresponding device parameter
cannam@89 110 to Pa_OpenStream() should be set to paUseHostApiSpecificDeviceSpecification,
cannam@89 111 otherwise an paInvalidDevice error will result.
cannam@89 112 The total number of channels accross all specified devices
cannam@89 113 must agree with the corresponding channelCount parameter to
cannam@89 114 Pa_OpenStream() otherwise a paInvalidChannelCount error will result.
cannam@89 115 */
cannam@89 116 PaWinMmeDeviceAndChannelCount *devices;
cannam@89 117 unsigned long deviceCount;
cannam@89 118
cannam@89 119 /*
cannam@89 120 support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
cannam@89 121 paWinMmeUseChannelMask this allows you to specify which speakers
cannam@89 122 to address in a multichannel stream. Constants for channelMask
cannam@89 123 are specified in pa_win_waveformat.h
cannam@89 124
cannam@89 125 */
cannam@89 126 PaWinWaveFormatChannelMask channelMask;
cannam@89 127
cannam@89 128 }PaWinMmeStreamInfo;
cannam@89 129
cannam@89 130
cannam@89 131 /** Retrieve the number of wave in handles used by a PortAudio WinMME stream.
cannam@89 132 Returns zero if the stream is output only.
cannam@89 133
cannam@89 134 @return A non-negative value indicating the number of wave in handles
cannam@89 135 or, a PaErrorCode (which are always negative) if PortAudio is not initialized
cannam@89 136 or an error is encountered.
cannam@89 137
cannam@89 138 @see PaWinMME_GetStreamInputHandle
cannam@89 139 */
cannam@89 140 int PaWinMME_GetStreamInputHandleCount( PaStream* stream );
cannam@89 141
cannam@89 142
cannam@89 143 /** Retrieve a wave in handle used by a PortAudio WinMME stream.
cannam@89 144
cannam@89 145 @param stream The stream to query.
cannam@89 146 @param handleIndex The zero based index of the wave in handle to retrieve. This
cannam@89 147 should be in the range [0, PaWinMME_GetStreamInputHandleCount(stream)-1].
cannam@89 148
cannam@89 149 @return A valid wave in handle, or NULL if an error occurred.
cannam@89 150
cannam@89 151 @see PaWinMME_GetStreamInputHandle
cannam@89 152 */
cannam@89 153 HWAVEIN PaWinMME_GetStreamInputHandle( PaStream* stream, int handleIndex );
cannam@89 154
cannam@89 155
cannam@89 156 /** Retrieve the number of wave out handles used by a PortAudio WinMME stream.
cannam@89 157 Returns zero if the stream is input only.
cannam@89 158
cannam@89 159 @return A non-negative value indicating the number of wave out handles
cannam@89 160 or, a PaErrorCode (which are always negative) if PortAudio is not initialized
cannam@89 161 or an error is encountered.
cannam@89 162
cannam@89 163 @see PaWinMME_GetStreamOutputHandle
cannam@89 164 */
cannam@89 165 int PaWinMME_GetStreamOutputHandleCount( PaStream* stream );
cannam@89 166
cannam@89 167
cannam@89 168 /** Retrieve a wave out handle used by a PortAudio WinMME stream.
cannam@89 169
cannam@89 170 @param stream The stream to query.
cannam@89 171 @param handleIndex The zero based index of the wave out handle to retrieve.
cannam@89 172 This should be in the range [0, PaWinMME_GetStreamOutputHandleCount(stream)-1].
cannam@89 173
cannam@89 174 @return A valid wave out handle, or NULL if an error occurred.
cannam@89 175
cannam@89 176 @see PaWinMME_GetStreamOutputHandleCount
cannam@89 177 */
cannam@89 178 HWAVEOUT PaWinMME_GetStreamOutputHandle( PaStream* stream, int handleIndex );
cannam@89 179
cannam@89 180
cannam@89 181 #ifdef __cplusplus
cannam@89 182 }
cannam@89 183 #endif /* __cplusplus */
cannam@89 184
cannam@89 185 #endif /* PA_WIN_WMME_H */