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 1115 2006-09-06 15:39:48Z 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 
00046 #include "portaudio.h"
00047 
00048 #ifdef __cplusplus
00049 extern "C"
00050 {
00051 #endif /* __cplusplus */
00052 
00053 
00054 #define paWinMmeUseLowLevelLatencyParameters            (0x01)
00055 #define paWinMmeUseMultipleDevices                      (0x02)  /* use mme specific multiple device feature */
00056 
00057 
00058 /* By default, the mme implementation drops the processing thread's priority
00059     to THREAD_PRIORITY_NORMAL and sleeps the thread if the CPU load exceeds 100%
00060     This flag disables any priority throttling. The processing thread will always
00061     run at THREAD_PRIORITY_TIME_CRITICAL.
00062 */
00063 #define paWinMmeDontThrottleOverloadedProcessingThread  (0x08)
00064 
00065 
00066 typedef struct PaWinMmeDeviceAndChannelCount{
00067     PaDeviceIndex device;
00068     int channelCount;
00069 }PaWinMmeDeviceAndChannelCount;
00070 
00071 
00072 typedef struct PaWinMmeStreamInfo{
00073     unsigned long size;             
00074     PaHostApiTypeId hostApiType;    
00075     unsigned long version;          
00077     unsigned long flags;
00078 
00079     /* low-level latency setting support
00080         These settings control the number and size of host buffers in order
00081         to set latency. They will be used instead of the generic parameters
00082         to Pa_OpenStream() if flags contains the PaWinMmeUseLowLevelLatencyParameters
00083         flag.
00084 
00085         If PaWinMmeStreamInfo structures with PaWinMmeUseLowLevelLatencyParameters
00086         are supplied for both input and output in a full duplex stream, then the
00087         input and output framesPerBuffer must be the same, or the larger of the
00088         two must be a multiple of the smaller, otherwise a
00089         paIncompatibleHostApiSpecificStreamInfo error will be returned from
00090         Pa_OpenStream().
00091     */
00092     unsigned long framesPerBuffer;
00093     unsigned long bufferCount;  /* formerly numBuffers */ 
00094 
00095     /* multiple devices per direction support
00096         If flags contains the PaWinMmeUseMultipleDevices flag,
00097         this functionality will be used, otherwise the device parameter to
00098         Pa_OpenStream() will be used instead.
00099         If devices are specified here, the corresponding device parameter
00100         to Pa_OpenStream() should be set to paUseHostApiSpecificDeviceSpecification,
00101         otherwise an paInvalidDevice error will result.
00102         The total number of channels accross all specified devices
00103         must agree with the corresponding channelCount parameter to
00104         Pa_OpenStream() otherwise a paInvalidChannelCount error will result.
00105     */
00106     PaWinMmeDeviceAndChannelCount *devices;
00107     unsigned long deviceCount;
00108 
00109 }PaWinMmeStreamInfo;
00110 
00111 
00121 int PaWinMME_GetStreamInputHandleCount( PaStream* stream );
00122 
00123 
00134 HWAVEIN PaWinMME_GetStreamInputHandle( PaStream* stream, int handleIndex );
00135 
00136 
00146 int PaWinMME_GetStreamOutputHandleCount( PaStream* stream );
00147 
00148 
00159 HWAVEOUT PaWinMME_GetStreamOutputHandle( PaStream* stream, int handleIndex );
00160 
00161 
00162 #ifdef __cplusplus
00163 }
00164 #endif /* __cplusplus */
00165 
00166 #endif /* PA_WIN_WMME_H */                                  

Generated on Mon Sep 3 11:35:44 2007 for PortAudio by  doxygen 1.5.2