Jamoma API  0.6.0.a19
pa_win_ds.h
Go to the documentation of this file.
1 #ifndef PA_WIN_DS_H
2 #define PA_WIN_DS_H
3 /*
4  * $Id: $
5  * PortAudio Portable Real-Time Audio Library
6  * DirectSound specific extensions
7  *
8  * Copyright (c) 1999-2007 Ross Bencina and Phil Burk
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining
11  * a copy of this software and associated documentation files
12  * (the "Software"), to deal in the Software without restriction,
13  * including without limitation the rights to use, copy, modify, merge,
14  * publish, distribute, sublicense, and/or sell copies of the Software,
15  * and to permit persons to whom the Software is furnished to do so,
16  * subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
25  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
26  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28  */
29 
30 /*
31  * The text above constitutes the entire PortAudio license; however,
32  * the PortAudio community also makes the following non-binding requests:
33  *
34  * Any person wishing to distribute modifications to the Software is
35  * requested to send the modifications to the original developer so that
36  * they can be incorporated into the canonical version. It is also
37  * requested that these non-binding requests be included along with the
38  * license above.
39  */
40 
41 /** @file
42  @brief DirectSound-specific PortAudio API extension header file.
43 */
44 
45 
46 #include "portaudio.h"
47 #include "pa_win_waveformat.h"
48 
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif /* __cplusplus */
53 
54 
55 #define paWinDirectSoundUseLowLevelLatencyParameters (0x01)
56 #define paWinDirectSoundUseChannelMask (0x04)
57 
58 
59 typedef struct PaWinDirectSoundStreamInfo{
60  unsigned long size; /**< sizeof(PaWinDirectSoundStreamInfo) */
61  PaHostApiTypeId hostApiType; /**< paDirectSound */
62  unsigned long version; /**< 1 */
63 
64  unsigned long flags;
65 
66  /* low-level latency setting support
67  TODO ** NOT IMPLEMENTED **
68  These settings control the number and size of host buffers in order
69  to set latency. They will be used instead of the generic parameters
70  to Pa_OpenStream() if flags contains the paWinDirectSoundUseLowLevelLatencyParameters
71  flag.
72 
73  If PaWinDirectSoundStreamInfo structures with paWinDirectSoundUseLowLevelLatencyParameters
74  are supplied for both input and output in a full duplex stream, then the
75  input and output framesPerBuffer must be the same, or the larger of the
76  two must be a multiple of the smaller, otherwise a
77  paIncompatibleHostApiSpecificStreamInfo error will be returned from
78  Pa_OpenStream().
79 
80  unsigned long framesPerBuffer;
81  */
82 
83  /*
84  support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
85  paWinDirectSoundUseChannelMask this allows you to specify which speakers
86  to address in a multichannel stream. Constants for channelMask
87  are specified in pa_win_waveformat.h
88 
89  */
90  PaWinWaveFormatChannelMask channelMask;
91 
92 }PaWinDirectSoundStreamInfo;
93 
94 
95 
96 #ifdef __cplusplus
97 }
98 #endif /* __cplusplus */
99 
100 #endif /* PA_WIN_DS_H */
The PortAudio API.
PaHostApiTypeId
Unchanging unique identifiers for each supported host API.
Definition: portaudio.h:223
Windows specific PortAudio API extension and utilities header file.