• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List
  • Globals

pa_win_wmme.h

Go to the documentation of this file.
00001 #ifndef PA_WIN_WMME_H
00002 #define PA_WIN_WMME_H
00003 /*
00004  * $Id: pa_win_wmme.h 1405 2009-03-08 08:10:55Z rossb $
00005  * PortAudio Portable Real-Time Audio Library
00006  * MME specific extensions
00007  *
00008  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
00009  *
00010  * Permission is hereby granted, free of charge, to any person obtaining
00011  * a copy of this software and associated documentation files
00012  * (the "Software"), to deal in the Software without restriction,
00013  * including without limitation the rights to use, copy, modify, merge,
00014  * publish, distribute, sublicense, and/or sell copies of the Software,
00015  * and to permit persons to whom the Software is furnished to do so,
00016  * subject to the following conditions:
00017  *
00018  * The above copyright notice and this permission notice shall be
00019  * included in all copies or substantial portions of the Software.
00020  *
00021  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00022  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00023  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00024  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
00025  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
00026  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00027  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00028  */
00029 
00030 /*
00031  * The text above constitutes the entire PortAudio license; however, 
00032  * the PortAudio community also makes the following non-binding requests:
00033  *
00034  * Any person wishing to distribute modifications to the Software is
00035  * requested to send the modifications to the original developer so that
00036  * they can be incorporated into the canonical version. It is also 
00037  * requested that these non-binding requests be included along with the 
00038  * license above.
00039  */
00040 
00047 #include "portaudio.h"
00048 #include "pa_win_waveformat.h"
00049 
00050 #ifdef __cplusplus
00051 extern "C"
00052 {
00053 #endif /* __cplusplus */
00054 
00055 
00056 /* The following are flags which can be set in 
00057   PaWinMmeStreamInfo's flags field.
00058 */
00059 
00060 #define paWinMmeUseLowLevelLatencyParameters            (0x01)
00061 #define paWinMmeUseMultipleDevices                      (0x02)  /* use mme specific multiple device feature */
00062 #define paWinMmeUseChannelMask                          (0x04)
00063 
00064 /* By default, the mme implementation drops the processing thread's priority
00065     to THREAD_PRIORITY_NORMAL and sleeps the thread if the CPU load exceeds 100%
00066     This flag disables any priority throttling. The processing thread will always
00067     run at THREAD_PRIORITY_TIME_CRITICAL.
00068 */
00069 #define paWinMmeDontThrottleOverloadedProcessingThread  (0x08)
00070 
00071 /*  Flags for non-PCM spdif passthrough.
00072 */
00073 #define paWinMmeWaveFormatDolbyAc3Spdif                 (0x10)
00074 #define paWinMmeWaveFormatWmaSpdif                      (0x20)
00075 
00076 
00077 typedef struct PaWinMmeDeviceAndChannelCount{
00078     PaDeviceIndex device;
00079     int channelCount;
00080 }PaWinMmeDeviceAndChannelCount;
00081 
00082 
00083 typedef struct PaWinMmeStreamInfo{
00084     unsigned long size;             
00085     PaHostApiTypeId hostApiType;    
00086     unsigned long version;          
00088     unsigned long flags;
00089 
00090     /* low-level latency setting support
00091         These settings control the number and size of host buffers in order
00092         to set latency. They will be used instead of the generic parameters
00093         to Pa_OpenStream() if flags contains the PaWinMmeUseLowLevelLatencyParameters
00094         flag.
00095 
00096         If PaWinMmeStreamInfo structures with PaWinMmeUseLowLevelLatencyParameters
00097         are supplied for both input and output in a full duplex stream, then the
00098         input and output framesPerBuffer must be the same, or the larger of the
00099         two must be a multiple of the smaller, otherwise a
00100         paIncompatibleHostApiSpecificStreamInfo error will be returned from
00101         Pa_OpenStream().
00102     */
00103     unsigned long framesPerBuffer;
00104     unsigned long bufferCount;  /* formerly numBuffers */ 
00105 
00106     /* multiple devices per direction support
00107         If flags contains the PaWinMmeUseMultipleDevices flag,
00108         this functionality will be used, otherwise the device parameter to
00109         Pa_OpenStream() will be used instead.
00110         If devices are specified here, the corresponding device parameter
00111         to Pa_OpenStream() should be set to paUseHostApiSpecificDeviceSpecification,
00112         otherwise an paInvalidDevice error will result.
00113         The total number of channels accross all specified devices
00114         must agree with the corresponding channelCount parameter to
00115         Pa_OpenStream() otherwise a paInvalidChannelCount error will result.
00116     */
00117     PaWinMmeDeviceAndChannelCount *devices;
00118     unsigned long deviceCount;
00119 
00120     /*
00121         support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
00122         paWinMmeUseChannelMask this allows you to specify which speakers 
00123         to address in a multichannel stream. Constants for channelMask
00124         are specified in pa_win_waveformat.h
00125 
00126     */
00127     PaWinWaveFormatChannelMask channelMask;
00128 
00129 }PaWinMmeStreamInfo;
00130 
00131 
00141 int PaWinMME_GetStreamInputHandleCount( PaStream* stream );
00142 
00143 
00154 HWAVEIN PaWinMME_GetStreamInputHandle( PaStream* stream, int handleIndex );
00155 
00156 
00166 int PaWinMME_GetStreamOutputHandleCount( PaStream* stream );
00167 
00168 
00179 HWAVEOUT PaWinMME_GetStreamOutputHandle( PaStream* stream, int handleIndex );
00180 
00181 
00182 #ifdef __cplusplus
00183 }
00184 #endif /* __cplusplus */
00185 
00186 #endif /* PA_WIN_WMME_H */                                  

Generated on Tue Aug 3 2010 05:17:30 for PortAudio by  doxygen 1.7.1