3 <TITLE>The RtAudio Tutorial</TITLE>
4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
6 <BODY BGCOLOR="#FFFFFF">
8 <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER>
10 <!-- Generated by Doxygen 1.4.4 -->
11 <h1>RtAudio.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span>
12 <a name="l00038"></a>00038 <span class="comment">/************************************************************************/</span>
13 <a name="l00039"></a>00039
14 <a name="l00040"></a>00040 <span class="comment">// RtAudio: Version 3.0.3 (18 November 2005)</span>
15 <a name="l00041"></a>00041
16 <a name="l00042"></a>00042 <span class="preprocessor">#ifndef __RTAUDIO_H</span>
17 <a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define __RTAUDIO_H</span>
18 <a name="l00044"></a>00044 <span class="preprocessor"></span>
19 <a name="l00045"></a>00045 <span class="preprocessor">#include "RtError.h"</span>
20 <a name="l00046"></a>00046 <span class="preprocessor">#include <string></span>
21 <a name="l00047"></a>00047 <span class="preprocessor">#include <vector></span>
22 <a name="l00048"></a>00048
23 <a name="l00049"></a>00049 <span class="comment">// Operating system dependent thread functionality.</span>
24 <a name="l00050"></a>00050 <span class="preprocessor">#if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__)</span>
25 <a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor"> #include <windows.h></span>
26 <a name="l00052"></a>00052 <span class="preprocessor"> #include <process.h></span>
27 <a name="l00053"></a>00053
28 <a name="l00054"></a>00054 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ThreadHandle;
29 <a name="l00055"></a>00055 <span class="keyword">typedef</span> CRITICAL_SECTION StreamMutex;
30 <a name="l00056"></a>00056
31 <a name="l00057"></a>00057 <span class="preprocessor">#else // Various unix flavors with pthread support.</span>
32 <a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor"> #include <pthread.h></span>
33 <a name="l00059"></a>00059
34 <a name="l00060"></a>00060 <span class="keyword">typedef</span> pthread_t ThreadHandle;
35 <a name="l00061"></a>00061 <span class="keyword">typedef</span> pthread_mutex_t StreamMutex;
36 <a name="l00062"></a>00062
37 <a name="l00063"></a>00063 <span class="preprocessor">#endif</span>
38 <a name="l00064"></a>00064 <span class="preprocessor"></span>
39 <a name="l00065"></a>00065 <span class="comment">// This global structure type is used to pass callback information</span>
40 <a name="l00066"></a>00066 <span class="comment">// between the private RtAudio stream structure and global callback</span>
41 <a name="l00067"></a>00067 <span class="comment">// handling functions.</span>
42 <a name="l00068"></a>00068 <span class="keyword">struct </span>CallbackInfo {
43 <a name="l00069"></a>00069 <span class="keywordtype">void</span> *object; <span class="comment">// Used as a "this" pointer.</span>
44 <a name="l00070"></a>00070 ThreadHandle thread;
45 <a name="l00071"></a>00071 <span class="keywordtype">bool</span> usingCallback;
46 <a name="l00072"></a>00072 <span class="keywordtype">void</span> *callback;
47 <a name="l00073"></a>00073 <span class="keywordtype">void</span> *userData;
48 <a name="l00074"></a>00074 <span class="keywordtype">void</span> *apiInfo; <span class="comment">// void pointer for API specific callback information</span>
49 <a name="l00075"></a>00075
50 <a name="l00076"></a>00076 <span class="comment">// Default constructor.</span>
51 <a name="l00077"></a>00077 CallbackInfo()
52 <a name="l00078"></a>00078 :object(0), usingCallback(false), callback(0),
53 <a name="l00079"></a>00079 userData(0), apiInfo(0) {}
54 <a name="l00080"></a>00080 };
55 <a name="l00081"></a>00081
56 <a name="l00082"></a>00082 <span class="comment">// Support for signed integers and floats. Audio data fed to/from</span>
57 <a name="l00083"></a>00083 <span class="comment">// the tickStream() routine is assumed to ALWAYS be in host</span>
58 <a name="l00084"></a>00084 <span class="comment">// byte order. The internal routines will automatically take care of</span>
59 <a name="l00085"></a>00085 <span class="comment">// any necessary byte-swapping between the host format and the</span>
60 <a name="l00086"></a>00086 <span class="comment">// soundcard. Thus, endian-ness is not a concern in the following</span>
61 <a name="l00087"></a>00087 <span class="comment">// format definitions.</span>
62 <a name="l00088"></a>00088 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> RtAudioFormat;
63 <a name="l00089"></a>00089 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT8 = 0x1;
64 <a name="l00090"></a>00090 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT16 = 0x2;
65 <a name="l00091"></a>00091 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT24 = 0x4;
66 <a name="l00092"></a>00092 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT32 = 0x8;
67 <a name="l00093"></a>00093 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT32 = 0x10;
68 <a name="l00094"></a>00094 <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT64 = 0x20;
69 <a name="l00096"></a>00096 <span class="keyword">typedef</span> int (*RtAudioCallback)(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> bufferSize, <span class="keywordtype">void</span> *userData);
70 <a name="l00097"></a>00097
71 <a name="l00099"></a><a class="code" href="structRtAudioDeviceInfo.html">00099</a> <span class="keyword">struct </span><a class="code" href="structRtAudioDeviceInfo.html">RtAudioDeviceInfo</a> {
72 <a name="l00100"></a><a class="code" href="structRtAudioDeviceInfo.html#o0">00100</a> std::string <a class="code" href="structRtAudioDeviceInfo.html#o0">name</a>;
73 <a name="l00101"></a><a class="code" href="structRtAudioDeviceInfo.html#o1">00101</a> <span class="keywordtype">bool</span> <a class="code" href="structRtAudioDeviceInfo.html#o1">probed</a>;
74 <a name="l00102"></a><a class="code" href="structRtAudioDeviceInfo.html#o2">00102</a> <span class="keywordtype">int</span> <a class="code" href="structRtAudioDeviceInfo.html#o2">outputChannels</a>;
75 <a name="l00103"></a><a class="code" href="structRtAudioDeviceInfo.html#o3">00103</a> <span class="keywordtype">int</span> <a class="code" href="structRtAudioDeviceInfo.html#o3">inputChannels</a>;
76 <a name="l00104"></a><a class="code" href="structRtAudioDeviceInfo.html#o4">00104</a> <span class="keywordtype">int</span> <a class="code" href="structRtAudioDeviceInfo.html#o4">duplexChannels</a>;
77 <a name="l00105"></a><a class="code" href="structRtAudioDeviceInfo.html#o5">00105</a> <span class="keywordtype">bool</span> <a class="code" href="structRtAudioDeviceInfo.html#o5">isDefault</a>;
78 <a name="l00106"></a><a class="code" href="structRtAudioDeviceInfo.html#o6">00106</a> std::vector<int> <a class="code" href="structRtAudioDeviceInfo.html#o6">sampleRates</a>;
79 <a name="l00107"></a><a class="code" href="structRtAudioDeviceInfo.html#o7">00107</a> RtAudioFormat <a class="code" href="structRtAudioDeviceInfo.html#o7">nativeFormats</a>;
80 <a name="l00109"></a>00109 <span class="comment">// Default constructor.</span>
81 <a name="l00110"></a>00110 <a class="code" href="structRtAudioDeviceInfo.html">RtAudioDeviceInfo</a>()
82 <a name="l00111"></a>00111 :<a class="code" href="structRtAudioDeviceInfo.html#o1">probed</a>(false), <a class="code" href="structRtAudioDeviceInfo.html#o2">outputChannels</a>(0), <a class="code" href="structRtAudioDeviceInfo.html#o3">inputChannels</a>(0),
83 <a name="l00112"></a>00112 <a class="code" href="structRtAudioDeviceInfo.html#o4">duplexChannels</a>(0), <a class="code" href="structRtAudioDeviceInfo.html#o5">isDefault</a>(false), <a class="code" href="structRtAudioDeviceInfo.html#o7">nativeFormats</a>(0) {}
84 <a name="l00113"></a>00113 };
85 <a name="l00114"></a>00114
86 <a name="l00115"></a>00115 <span class="comment">// **************************************************************** //</span>
87 <a name="l00116"></a>00116 <span class="comment">//</span>
88 <a name="l00117"></a>00117 <span class="comment">// RtApi class declaration.</span>
89 <a name="l00118"></a>00118 <span class="comment">//</span>
90 <a name="l00119"></a>00119 <span class="comment">// Note that RtApi is an abstract base class and cannot be</span>
91 <a name="l00120"></a>00120 <span class="comment">// explicitly instantiated. The class RtAudio will create an</span>
92 <a name="l00121"></a>00121 <span class="comment">// instance of an RtApi subclass (RtApiOss, RtApiAlsa,</span>
93 <a name="l00122"></a>00122 <span class="comment">// RtApiJack, RtApiCore, RtApiAl, RtApiDs, or RtApiAsio).</span>
94 <a name="l00123"></a>00123 <span class="comment">//</span>
95 <a name="l00124"></a>00124 <span class="comment">// **************************************************************** //</span>
96 <a name="l00125"></a>00125
97 <a name="l00126"></a>00126 <span class="keyword">class </span>RtApi
98 <a name="l00127"></a>00127 {
99 <a name="l00128"></a>00128 <span class="keyword">public</span>:
100 <a name="l00129"></a>00129
101 <a name="l00130"></a>00130 <span class="keyword">enum</span> StreamState {
102 <a name="l00131"></a>00131 STREAM_STOPPED,
103 <a name="l00132"></a>00132 STREAM_RUNNING
104 <a name="l00133"></a>00133 };
105 <a name="l00134"></a>00134
106 <a name="l00135"></a>00135 RtApi();
107 <a name="l00136"></a>00136 <span class="keyword">virtual</span> ~RtApi();
108 <a name="l00137"></a>00137 <span class="keywordtype">void</span> openStream( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
109 <a name="l00138"></a>00138 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
110 <a name="l00139"></a>00139 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
111 <a name="l00140"></a>00140 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
112 <a name="l00141"></a>00141 <span class="keywordtype">void</span> openStream( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
113 <a name="l00142"></a>00142 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
114 <a name="l00143"></a>00143 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
115 <a name="l00144"></a>00144 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> *numberOfBuffers );
116 <a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ) = 0;
117 <a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">void</span> cancelStreamCallback() = 0;
118 <a name="l00147"></a>00147 <span class="keywordtype">int</span> getDeviceCount(<span class="keywordtype">void</span>);
119 <a name="l00148"></a>00148 <a class="code" href="structRtAudioDeviceInfo.html">RtAudioDeviceInfo</a> getDeviceInfo( <span class="keywordtype">int</span> device );
120 <a name="l00149"></a>00149 <span class="keywordtype">char</span> * <span class="keyword">const</span> getStreamBuffer();
121 <a name="l00150"></a>00150 RtApi::StreamState getStreamState() <span class="keyword">const</span>;
122 <a name="l00151"></a>00151 <span class="keyword">virtual</span> <span class="keywordtype">void</span> tickStream() = 0;
123 <a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeStream();
124 <a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">void</span> startStream() = 0;
125 <a name="l00154"></a>00154 <span class="keyword">virtual</span> <span class="keywordtype">void</span> stopStream() = 0;
126 <a name="l00155"></a>00155 <span class="keyword">virtual</span> <span class="keywordtype">void</span> abortStream() = 0;
127 <a name="l00156"></a>00156
128 <a name="l00157"></a>00157 <span class="keyword">protected</span>:
129 <a name="l00158"></a>00158
130 <a name="l00159"></a>00159 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MAX_SAMPLE_RATES;
131 <a name="l00160"></a>00160 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SAMPLE_RATES[];
132 <a name="l00161"></a>00161
133 <a name="l00162"></a>00162 <span class="keyword">enum</span> { FAILURE, SUCCESS };
134 <a name="l00163"></a>00163
135 <a name="l00164"></a>00164 <span class="keyword">enum</span> StreamMode {
136 <a name="l00165"></a>00165 OUTPUT,
137 <a name="l00166"></a>00166 INPUT,
138 <a name="l00167"></a>00167 DUPLEX,
139 <a name="l00168"></a>00168 UNINITIALIZED = -75
140 <a name="l00169"></a>00169 };
141 <a name="l00170"></a>00170
142 <a name="l00171"></a>00171 <span class="comment">// A protected structure used for buffer conversion.</span>
143 <a name="l00172"></a>00172 <span class="keyword">struct </span>ConvertInfo {
144 <a name="l00173"></a>00173 <span class="keywordtype">int</span> channels;
145 <a name="l00174"></a>00174 <span class="keywordtype">int</span> inJump, outJump;
146 <a name="l00175"></a>00175 RtAudioFormat inFormat, outFormat;
147 <a name="l00176"></a>00176 std::vector<int> inOffset;
148 <a name="l00177"></a>00177 std::vector<int> outOffset;
149 <a name="l00178"></a>00178 };
150 <a name="l00179"></a>00179
151 <a name="l00180"></a>00180 <span class="comment">// A protected structure for audio streams.</span>
152 <a name="l00181"></a>00181 <span class="keyword">struct </span>RtApiStream {
153 <a name="l00182"></a>00182 <span class="keywordtype">int</span> device[2]; <span class="comment">// Playback and record, respectively.</span>
154 <a name="l00183"></a>00183 <span class="keywordtype">void</span> *apiHandle; <span class="comment">// void pointer for API specific stream handle information</span>
155 <a name="l00184"></a>00184 StreamMode mode; <span class="comment">// OUTPUT, INPUT, or DUPLEX.</span>
156 <a name="l00185"></a>00185 StreamState state; <span class="comment">// STOPPED or RUNNING</span>
157 <a name="l00186"></a>00186 <span class="keywordtype">char</span> *userBuffer;
158 <a name="l00187"></a>00187 <span class="keywordtype">char</span> *deviceBuffer;
159 <a name="l00188"></a>00188 <span class="keywordtype">bool</span> doConvertBuffer[2]; <span class="comment">// Playback and record, respectively.</span>
160 <a name="l00189"></a>00189 <span class="keywordtype">bool</span> deInterleave[2]; <span class="comment">// Playback and record, respectively.</span>
161 <a name="l00190"></a>00190 <span class="keywordtype">bool</span> doByteSwap[2]; <span class="comment">// Playback and record, respectively.</span>
162 <a name="l00191"></a>00191 <span class="keywordtype">int</span> sampleRate;
163 <a name="l00192"></a>00192 <span class="keywordtype">int</span> bufferSize;
164 <a name="l00193"></a>00193 <span class="keywordtype">int</span> nBuffers;
165 <a name="l00194"></a>00194 <span class="keywordtype">int</span> nUserChannels[2]; <span class="comment">// Playback and record, respectively.</span>
166 <a name="l00195"></a>00195 <span class="keywordtype">int</span> nDeviceChannels[2]; <span class="comment">// Playback and record channels, respectively.</span>
167 <a name="l00196"></a>00196 RtAudioFormat userFormat;
168 <a name="l00197"></a>00197 RtAudioFormat deviceFormat[2]; <span class="comment">// Playback and record, respectively.</span>
169 <a name="l00198"></a>00198 StreamMutex mutex;
170 <a name="l00199"></a>00199 CallbackInfo callbackInfo;
171 <a name="l00200"></a>00200 ConvertInfo convertInfo[2];
172 <a name="l00201"></a>00201
173 <a name="l00202"></a>00202 RtApiStream()
174 <a name="l00203"></a>00203 :apiHandle(0), userBuffer(0), deviceBuffer(0) {}
175 <a name="l00204"></a>00204 };
176 <a name="l00205"></a>00205
177 <a name="l00206"></a>00206 <span class="comment">// A protected device structure for audio devices.</span>
178 <a name="l00207"></a>00207 <span class="keyword">struct </span>RtApiDevice {
179 <a name="l00208"></a>00208 std::string name;
180 <a name="l00209"></a>00209 <span class="keywordtype">bool</span> probed;
181 <a name="l00210"></a>00210 <span class="keywordtype">void</span> *apiDeviceId; <span class="comment">// void pointer for API specific device information</span>
182 <a name="l00211"></a>00211 <span class="keywordtype">int</span> maxOutputChannels;
183 <a name="l00212"></a>00212 <span class="keywordtype">int</span> maxInputChannels;
184 <a name="l00213"></a>00213 <span class="keywordtype">int</span> maxDuplexChannels;
185 <a name="l00214"></a>00214 <span class="keywordtype">int</span> minOutputChannels;
186 <a name="l00215"></a>00215 <span class="keywordtype">int</span> minInputChannels;
187 <a name="l00216"></a>00216 <span class="keywordtype">int</span> minDuplexChannels;
188 <a name="l00217"></a>00217 <span class="keywordtype">bool</span> hasDuplexSupport;
189 <a name="l00218"></a>00218 <span class="keywordtype">bool</span> isDefault;
190 <a name="l00219"></a>00219 std::vector<int> sampleRates;
191 <a name="l00220"></a>00220 RtAudioFormat nativeFormats;
192 <a name="l00222"></a>00222 <span class="comment">// Default constructor.</span>
193 <a name="l00223"></a>00223 RtApiDevice()
194 <a name="l00224"></a>00224 :probed(false), apiDeviceId(0), maxOutputChannels(0), maxInputChannels(0),
195 <a name="l00225"></a>00225 maxDuplexChannels(0), minOutputChannels(0), minInputChannels(0),
196 <a name="l00226"></a>00226 minDuplexChannels(0), isDefault(false), nativeFormats(0) {}
197 <a name="l00227"></a>00227 };
198 <a name="l00228"></a>00228
199 <a name="l00229"></a>00229 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> Int16;
200 <a name="l00230"></a>00230 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> Int32;
201 <a name="l00231"></a>00231 <span class="keyword">typedef</span> <span class="keywordtype">float</span> Float32;
202 <a name="l00232"></a>00232 <span class="keyword">typedef</span> <span class="keywordtype">double</span> Float64;
203 <a name="l00233"></a>00233
204 <a name="l00234"></a>00234 <span class="keywordtype">char</span> message_[1024];
205 <a name="l00235"></a>00235 <span class="keywordtype">int</span> nDevices_;
206 <a name="l00236"></a>00236 std::vector<RtApiDevice> devices_;
207 <a name="l00237"></a>00237 RtApiStream stream_;
208 <a name="l00238"></a>00238
209 <a name="l00243"></a>00243 <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>) = 0;
210 <a name="l00244"></a>00244
211 <a name="l00253"></a>00253 <span class="keyword">virtual</span> <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
212 <a name="l00254"></a>00254
213 <a name="l00263"></a>00263 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
214 <a name="l00264"></a>00264 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
215 <a name="l00265"></a>00265 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
216 <a name="l00266"></a>00266
217 <a name="l00271"></a>00271 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>);
218 <a name="l00272"></a>00272
219 <a name="l00277"></a>00277 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>);
220 <a name="l00278"></a>00278
221 <a name="l00280"></a>00280 <span class="keywordtype">void</span> clearDeviceInfo( RtApiDevice *info );
222 <a name="l00281"></a>00281
223 <a name="l00283"></a>00283 <span class="keywordtype">void</span> clearStreamInfo();
224 <a name="l00284"></a>00284
225 <a name="l00286"></a>00286 <span class="keywordtype">void</span> error( <a class="code" href="classRtError.html#w11">RtError::Type</a> type );
226 <a name="l00287"></a>00287
227 <a name="l00292"></a>00292 <span class="keywordtype">void</span> verifyStream();
228 <a name="l00293"></a>00293
229 <a name="l00298"></a>00298 <span class="keywordtype">void</span> convertBuffer( <span class="keywordtype">char</span> *outBuffer, <span class="keywordtype">char</span> *inBuffer, ConvertInfo &info );
230 <a name="l00299"></a>00299
231 <a name="l00301"></a>00301 <span class="keywordtype">void</span> byteSwapBuffer( <span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> samples, RtAudioFormat format );
232 <a name="l00302"></a>00302
233 <a name="l00304"></a>00304 <span class="keywordtype">int</span> formatBytes( RtAudioFormat format );
234 <a name="l00305"></a>00305 };
235 <a name="l00306"></a>00306
236 <a name="l00307"></a>00307
237 <a name="l00308"></a>00308 <span class="comment">// **************************************************************** //</span>
238 <a name="l00309"></a>00309 <span class="comment">//</span>
239 <a name="l00310"></a>00310 <span class="comment">// RtAudio class declaration.</span>
240 <a name="l00311"></a>00311 <span class="comment">//</span>
241 <a name="l00312"></a>00312 <span class="comment">// RtAudio is a "controller" used to select an available audio i/o</span>
242 <a name="l00313"></a>00313 <span class="comment">// interface. It presents a common API for the user to call but all</span>
243 <a name="l00314"></a>00314 <span class="comment">// functionality is implemented by the class RtAudioApi and its</span>
244 <a name="l00315"></a>00315 <span class="comment">// subclasses. RtAudio creates an instance of an RtAudioApi subclass</span>
245 <a name="l00316"></a>00316 <span class="comment">// based on the user's API choice. If no choice is made, RtAudio</span>
246 <a name="l00317"></a>00317 <span class="comment">// attempts to make a "logical" API selection.</span>
247 <a name="l00318"></a>00318 <span class="comment">//</span>
248 <a name="l00319"></a>00319 <span class="comment">// **************************************************************** //</span>
249 <a name="l00320"></a>00320
250 <a name="l00321"></a><a class="code" href="classRtAudio.html">00321</a> <span class="keyword">class </span><a class="code" href="classRtAudio.html">RtAudio</a>
251 <a name="l00322"></a>00322 {
252 <a name="l00323"></a>00323 <span class="keyword">public</span>:
253 <a name="l00324"></a>00324
254 <a name="l00326"></a><a class="code" href="classRtAudio.html#w8">00326</a> <span class="keyword">enum</span> <a class="code" href="classRtAudio.html#w8">RtAudioApi</a> {
255 <a name="l00327"></a>00327 <a class="code" href="classRtAudio.html#w8w0">UNSPECIFIED</a>,
256 <a name="l00328"></a>00328 <a class="code" href="classRtAudio.html#w8w1">LINUX_ALSA</a>,
257 <a name="l00329"></a>00329 <a class="code" href="classRtAudio.html#w8w2">LINUX_OSS</a>,
258 <a name="l00330"></a>00330 <a class="code" href="classRtAudio.html#w8w3">LINUX_JACK</a>,
259 <a name="l00331"></a>00331 <a class="code" href="classRtAudio.html#w8w4">MACOSX_CORE</a>,
260 <a name="l00332"></a>00332 <a class="code" href="classRtAudio.html#w8w5">IRIX_AL</a>,
261 <a name="l00333"></a>00333 <a class="code" href="classRtAudio.html#w8w6">WINDOWS_ASIO</a>,
262 <a name="l00334"></a><a class="code" href="classRtAudio.html#w8w7">00334</a> <a class="code" href="classRtAudio.html#w8w7">WINDOWS_DS</a>
263 <a name="l00335"></a>00335 };
264 <a name="l00336"></a>00336
265 <a name="l00338"></a>00338
266 <a name="l00348"></a>00348 <a class="code" href="classRtAudio.html#a0">RtAudio</a>( <a class="code" href="classRtAudio.html#w8">RtAudioApi</a> api=<a class="code" href="classRtAudio.html#w8w0">UNSPECIFIED</a> );
267 <a name="l00349"></a>00349
268 <a name="l00351"></a>00351
269 <a name="l00362"></a>00362 <a class="code" href="classRtAudio.html#a0">RtAudio</a>( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
270 <a name="l00363"></a>00363 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
271 <a name="l00364"></a>00364 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
272 <a name="l00365"></a>00365 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers, <a class="code" href="classRtAudio.html#w8">RtAudioApi</a> api=<a class="code" href="classRtAudio.html#w8w0">UNSPECIFIED</a> );
273 <a name="l00366"></a>00366
274 <a name="l00368"></a>00368
275 <a name="l00376"></a>00376 <a class="code" href="classRtAudio.html#a0">RtAudio</a>( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
276 <a name="l00377"></a>00377 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
277 <a name="l00378"></a>00378 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
278 <a name="l00379"></a>00379 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> *numberOfBuffers, <a class="code" href="classRtAudio.html#w8">RtAudioApi</a> api=<a class="code" href="classRtAudio.html#w8w0">UNSPECIFIED</a> );
279 <a name="l00380"></a>00380
280 <a name="l00382"></a>00382
281 <a name="l00386"></a>00386 <a class="code" href="classRtAudio.html#a3">~RtAudio</a>();
282 <a name="l00387"></a>00387
283 <a name="l00389"></a>00389
284 <a name="l00415"></a>00415 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a4">openStream</a>( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
285 <a name="l00416"></a>00416 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
286 <a name="l00417"></a>00417 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
287 <a name="l00418"></a>00418 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
288 <a name="l00419"></a>00419
289 <a name="l00421"></a>00421
290 <a name="l00429"></a>00429 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a4">openStream</a>( <span class="keywordtype">int</span> outputDevice, <span class="keywordtype">int</span> outputChannels,
291 <a name="l00430"></a>00430 <span class="keywordtype">int</span> inputDevice, <span class="keywordtype">int</span> inputChannels,
292 <a name="l00431"></a>00431 RtAudioFormat format, <span class="keywordtype">int</span> sampleRate,
293 <a name="l00432"></a>00432 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> *numberOfBuffers );
294 <a name="l00433"></a>00433
295 <a name="l00435"></a>00435
296 <a name="l00454"></a><a class="code" href="classRtAudio.html#a6">00454</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a6">setStreamCallback</a>(RtAudioCallback callback, <span class="keywordtype">void</span> *userData) { rtapi_->setStreamCallback( callback, userData ); };
297 <a name="l00455"></a>00455
298 <a name="l00457"></a>00457
299 <a name="l00464"></a><a class="code" href="classRtAudio.html#a7">00464</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a7">cancelStreamCallback</a>() { rtapi_->cancelStreamCallback(); };
300 <a name="l00465"></a>00465
301 <a name="l00467"></a><a class="code" href="classRtAudio.html#a8">00467</a> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a8">getDeviceCount</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> rtapi_->getDeviceCount(); };
302 <a name="l00468"></a>00468
303 <a name="l00470"></a>00470
304 <a name="l00478"></a><a class="code" href="classRtAudio.html#a9">00478</a> <a class="code" href="structRtAudioDeviceInfo.html">RtAudioDeviceInfo</a> <a class="code" href="classRtAudio.html#a9">getDeviceInfo</a>(<span class="keywordtype">int</span> device) { <span class="keywordflow">return</span> rtapi_->getDeviceInfo( device ); };
305 <a name="l00479"></a>00479
306 <a name="l00481"></a>00481
307 <a name="l00486"></a><a class="code" href="classRtAudio.html#a10">00486</a> <span class="keywordtype">char</span> * <span class="keyword">const</span> <a class="code" href="classRtAudio.html#a10">getStreamBuffer</a>() { <span class="keywordflow">return</span> rtapi_->getStreamBuffer(); };
308 <a name="l00487"></a>00487
309 <a name="l00489"></a>00489
310 <a name="l00494"></a><a class="code" href="classRtAudio.html#a11">00494</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a11">tickStream</a>() { rtapi_->tickStream(); };
311 <a name="l00495"></a>00495
312 <a name="l00497"></a>00497
313 <a name="l00501"></a><a class="code" href="classRtAudio.html#a12">00501</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a12">closeStream</a>() { rtapi_->closeStream(); };
314 <a name="l00502"></a>00502
315 <a name="l00504"></a>00504
316 <a name="l00508"></a><a class="code" href="classRtAudio.html#a13">00508</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a13">startStream</a>() { rtapi_->startStream(); };
317 <a name="l00509"></a>00509
318 <a name="l00511"></a>00511
319 <a name="l00515"></a><a class="code" href="classRtAudio.html#a14">00515</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a14">stopStream</a>() { rtapi_->stopStream(); };
320 <a name="l00516"></a>00516
321 <a name="l00518"></a>00518
322 <a name="l00522"></a><a class="code" href="classRtAudio.html#a15">00522</a> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a15">abortStream</a>() { rtapi_->abortStream(); };
323 <a name="l00523"></a>00523
324 <a name="l00524"></a>00524
325 <a name="l00525"></a>00525 <span class="keyword">protected</span>:
326 <a name="l00526"></a>00526
327 <a name="l00527"></a>00527 <span class="keywordtype">void</span> initialize( <a class="code" href="classRtAudio.html#w8">RtAudioApi</a> api );
328 <a name="l00528"></a>00528
329 <a name="l00529"></a>00529 RtApi *rtapi_;
330 <a name="l00530"></a>00530 };
331 <a name="l00531"></a>00531
332 <a name="l00532"></a>00532
333 <a name="l00533"></a>00533 <span class="comment">// RtApi Subclass prototypes.</span>
334 <a name="l00534"></a>00534
335 <a name="l00535"></a>00535 <span class="preprocessor">#if defined(__LINUX_ALSA__)</span>
336 <a name="l00536"></a>00536 <span class="preprocessor"></span>
337 <a name="l00537"></a>00537 <span class="keyword">class </span>RtApiAlsa: <span class="keyword">public</span> RtApi
338 <a name="l00538"></a>00538 {
339 <a name="l00539"></a>00539 <span class="keyword">public</span>:
340 <a name="l00540"></a>00540
341 <a name="l00541"></a>00541 RtApiAlsa();
342 <a name="l00542"></a>00542 ~RtApiAlsa();
343 <a name="l00543"></a>00543 <span class="keywordtype">void</span> tickStream();
344 <a name="l00544"></a>00544 <span class="keywordtype">void</span> closeStream();
345 <a name="l00545"></a>00545 <span class="keywordtype">void</span> startStream();
346 <a name="l00546"></a>00546 <span class="keywordtype">void</span> stopStream();
347 <a name="l00547"></a>00547 <span class="keywordtype">void</span> abortStream();
348 <a name="l00548"></a>00548 <span class="keywordtype">int</span> streamWillBlock();
349 <a name="l00549"></a>00549 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
350 <a name="l00550"></a>00550 <span class="keywordtype">void</span> cancelStreamCallback();
351 <a name="l00551"></a>00551
352 <a name="l00552"></a>00552 <span class="keyword">private</span>:
353 <a name="l00553"></a>00553
354 <a name="l00554"></a>00554 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
355 <a name="l00555"></a>00555 <span class="keywordtype">bool</span> primeOutputBuffer();
356 <a name="l00556"></a>00556 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
357 <a name="l00557"></a>00557 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
358 <a name="l00558"></a>00558 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
359 <a name="l00559"></a>00559 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
360 <a name="l00560"></a>00560 };
361 <a name="l00561"></a>00561
362 <a name="l00562"></a>00562 <span class="preprocessor">#endif</span>
363 <a name="l00563"></a>00563 <span class="preprocessor"></span>
364 <a name="l00564"></a>00564 <span class="preprocessor">#if defined(__LINUX_JACK__)</span>
365 <a name="l00565"></a>00565 <span class="preprocessor"></span>
366 <a name="l00566"></a>00566 <span class="keyword">class </span>RtApiJack: <span class="keyword">public</span> RtApi
367 <a name="l00567"></a>00567 {
368 <a name="l00568"></a>00568 <span class="keyword">public</span>:
369 <a name="l00569"></a>00569
370 <a name="l00570"></a>00570 RtApiJack();
371 <a name="l00571"></a>00571 ~RtApiJack();
372 <a name="l00572"></a>00572 <span class="keywordtype">void</span> tickStream();
373 <a name="l00573"></a>00573 <span class="keywordtype">void</span> closeStream();
374 <a name="l00574"></a>00574 <span class="keywordtype">void</span> startStream();
375 <a name="l00575"></a>00575 <span class="keywordtype">void</span> stopStream();
376 <a name="l00576"></a>00576 <span class="keywordtype">void</span> abortStream();
377 <a name="l00577"></a>00577 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
378 <a name="l00578"></a>00578 <span class="keywordtype">void</span> cancelStreamCallback();
379 <a name="l00579"></a>00579 <span class="comment">// This function is intended for internal use only. It must be</span>
380 <a name="l00580"></a>00580 <span class="comment">// public because it is called by the internal callback handler,</span>
381 <a name="l00581"></a>00581 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
382 <a name="l00582"></a>00582 <span class="comment">// will most likely produce highly undesireable results!</span>
383 <a name="l00583"></a>00583 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nframes );
384 <a name="l00584"></a>00584
385 <a name="l00585"></a>00585 <span class="keyword">private</span>:
386 <a name="l00586"></a>00586
387 <a name="l00587"></a>00587 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
388 <a name="l00588"></a>00588 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
389 <a name="l00589"></a>00589 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
390 <a name="l00590"></a>00590 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
391 <a name="l00591"></a>00591 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
392 <a name="l00592"></a>00592 };
393 <a name="l00593"></a>00593
394 <a name="l00594"></a>00594 <span class="preprocessor">#endif</span>
395 <a name="l00595"></a>00595 <span class="preprocessor"></span>
396 <a name="l00596"></a>00596 <span class="preprocessor">#if defined(__LINUX_OSS__)</span>
397 <a name="l00597"></a>00597 <span class="preprocessor"></span>
398 <a name="l00598"></a>00598 <span class="keyword">class </span>RtApiOss: <span class="keyword">public</span> RtApi
399 <a name="l00599"></a>00599 {
400 <a name="l00600"></a>00600 <span class="keyword">public</span>:
401 <a name="l00601"></a>00601
402 <a name="l00602"></a>00602 RtApiOss();
403 <a name="l00603"></a>00603 ~RtApiOss();
404 <a name="l00604"></a>00604 <span class="keywordtype">void</span> tickStream();
405 <a name="l00605"></a>00605 <span class="keywordtype">void</span> closeStream();
406 <a name="l00606"></a>00606 <span class="keywordtype">void</span> startStream();
407 <a name="l00607"></a>00607 <span class="keywordtype">void</span> stopStream();
408 <a name="l00608"></a>00608 <span class="keywordtype">void</span> abortStream();
409 <a name="l00609"></a>00609 <span class="keywordtype">int</span> streamWillBlock();
410 <a name="l00610"></a>00610 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
411 <a name="l00611"></a>00611 <span class="keywordtype">void</span> cancelStreamCallback();
412 <a name="l00612"></a>00612
413 <a name="l00613"></a>00613 <span class="keyword">private</span>:
414 <a name="l00614"></a>00614
415 <a name="l00615"></a>00615 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
416 <a name="l00616"></a>00616 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
417 <a name="l00617"></a>00617 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
418 <a name="l00618"></a>00618 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
419 <a name="l00619"></a>00619 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
420 <a name="l00620"></a>00620 };
421 <a name="l00621"></a>00621
422 <a name="l00622"></a>00622 <span class="preprocessor">#endif</span>
423 <a name="l00623"></a>00623 <span class="preprocessor"></span>
424 <a name="l00624"></a>00624 <span class="preprocessor">#if defined(__MACOSX_CORE__)</span>
425 <a name="l00625"></a>00625 <span class="preprocessor"></span>
426 <a name="l00626"></a>00626 <span class="preprocessor">#include <CoreAudio/AudioHardware.h></span>
427 <a name="l00627"></a>00627
428 <a name="l00628"></a>00628 <span class="keyword">class </span>RtApiCore: <span class="keyword">public</span> RtApi
429 <a name="l00629"></a>00629 {
430 <a name="l00630"></a>00630 <span class="keyword">public</span>:
431 <a name="l00631"></a>00631
432 <a name="l00632"></a>00632 RtApiCore();
433 <a name="l00633"></a>00633 ~RtApiCore();
434 <a name="l00634"></a>00634 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>);
435 <a name="l00635"></a>00635 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>);
436 <a name="l00636"></a>00636 <span class="keywordtype">void</span> tickStream();
437 <a name="l00637"></a>00637 <span class="keywordtype">void</span> closeStream();
438 <a name="l00638"></a>00638 <span class="keywordtype">void</span> startStream();
439 <a name="l00639"></a>00639 <span class="keywordtype">void</span> stopStream();
440 <a name="l00640"></a>00640 <span class="keywordtype">void</span> abortStream();
441 <a name="l00641"></a>00641 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
442 <a name="l00642"></a>00642 <span class="keywordtype">void</span> cancelStreamCallback();
443 <a name="l00643"></a>00643
444 <a name="l00644"></a>00644 <span class="comment">// This function is intended for internal use only. It must be</span>
445 <a name="l00645"></a>00645 <span class="comment">// public because it is called by the internal callback handler,</span>
446 <a name="l00646"></a>00646 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
447 <a name="l00647"></a>00647 <span class="comment">// will most likely produce highly undesireable results!</span>
448 <a name="l00648"></a>00648 <span class="keywordtype">void</span> callbackEvent( AudioDeviceID deviceId, <span class="keywordtype">void</span> *inData, <span class="keywordtype">void</span> *outData );
449 <a name="l00649"></a>00649
450 <a name="l00650"></a>00650 <span class="keyword">private</span>:
451 <a name="l00651"></a>00651
452 <a name="l00652"></a>00652 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
453 <a name="l00653"></a>00653 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
454 <a name="l00654"></a>00654 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
455 <a name="l00655"></a>00655 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
456 <a name="l00656"></a>00656 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
457 <a name="l00657"></a>00657 };
458 <a name="l00658"></a>00658
459 <a name="l00659"></a>00659 <span class="preprocessor">#endif</span>
460 <a name="l00660"></a>00660 <span class="preprocessor"></span>
461 <a name="l00661"></a>00661 <span class="preprocessor">#if defined(__WINDOWS_DS__)</span>
462 <a name="l00662"></a>00662 <span class="preprocessor"></span>
463 <a name="l00663"></a>00663 <span class="keyword">class </span>RtApiDs: <span class="keyword">public</span> RtApi
464 <a name="l00664"></a>00664 {
465 <a name="l00665"></a>00665 <span class="keyword">public</span>:
466 <a name="l00666"></a>00666
467 <a name="l00667"></a>00667 RtApiDs();
468 <a name="l00668"></a>00668 ~RtApiDs();
469 <a name="l00669"></a>00669 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>);
470 <a name="l00670"></a>00670 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>);
471 <a name="l00671"></a>00671 <span class="keywordtype">void</span> tickStream();
472 <a name="l00672"></a>00672 <span class="keywordtype">void</span> closeStream();
473 <a name="l00673"></a>00673 <span class="keywordtype">void</span> startStream();
474 <a name="l00674"></a>00674 <span class="keywordtype">void</span> stopStream();
475 <a name="l00675"></a>00675 <span class="keywordtype">void</span> abortStream();
476 <a name="l00676"></a>00676 <span class="keywordtype">int</span> streamWillBlock();
477 <a name="l00677"></a>00677 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
478 <a name="l00678"></a>00678 <span class="keywordtype">void</span> cancelStreamCallback();
479 <a name="l00679"></a>00679
480 <a name="l00680"></a>00680 <span class="keyword">public</span>:
481 <a name="l00681"></a>00681 <span class="comment">// \brief Internal structure that provide debug information on the state of a running DSound device.</span>
482 <a name="l00682"></a>00682 <span class="keyword">struct </span>RtDsStatistics {
483 <a name="l00683"></a>00683 <span class="comment">// \brief Sample Rate.</span>
484 <a name="l00684"></a>00684 <span class="keywordtype">long</span> sampleRate;
485 <a name="l00685"></a>00685 <span class="comment">// \brief The size of one sample * number of channels on the input device.</span>
486 <a name="l00686"></a>00686 <span class="keywordtype">int</span> inputFrameSize;
487 <a name="l00687"></a>00687 <span class="comment">// \brief The size of one sample * number of channels on the output device.</span>
488 <a name="l00688"></a>00688 <span class="keywordtype">int</span> outputFrameSize;
489 <a name="l00689"></a>00689 <span class="comment">/* \brief The number of times the read pointer had to be adjusted to avoid reading from an unsafe buffer position.</span>
490 <a name="l00690"></a>00690 <span class="comment"> *</span>
491 <a name="l00691"></a>00691 <span class="comment"> * This field is only used when running in DUPLEX mode. INPUT mode devices just wait until the data is </span>
492 <a name="l00692"></a>00692 <span class="comment"> * available.</span>
493 <a name="l00693"></a>00693 <span class="comment"> */</span>
494 <a name="l00694"></a>00694 <span class="keywordtype">int</span> numberOfReadOverruns;
495 <a name="l00695"></a>00695 <span class="comment">// \brief The number of times the write pointer had to be adjusted to avoid writing in an unsafe buffer position.</span>
496 <a name="l00696"></a>00696 <span class="keywordtype">int</span> numberOfWriteUnderruns;
497 <a name="l00697"></a>00697 <span class="comment">// \brief Number of bytes by attribute to buffer configuration by which writing must lead the current write pointer.</span>
498 <a name="l00698"></a>00698 <span class="keywordtype">int</span> writeDeviceBufferLeadBytes;
499 <a name="l00699"></a>00699 <span class="comment">// \brief Number of bytes by attributable to the device driver by which writing must lead the current write pointer on this output device.</span>
500 <a name="l00700"></a>00700 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> writeDeviceSafeLeadBytes;
501 <a name="l00701"></a>00701 <span class="comment">// \brief Number of bytes by which reading must trail the current read pointer on this input device.</span>
502 <a name="l00702"></a>00702 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> readDeviceSafeLeadBytes;
503 <a name="l00703"></a>00703 <span class="comment">/* \brief Estimated latency in seconds. </span>
504 <a name="l00704"></a>00704 <span class="comment"> *</span>
505 <a name="l00705"></a>00705 <span class="comment"> * For INPUT mode devices, based the latency of the device's safe read pointer, plus one buffer's</span>
506 <a name="l00706"></a>00706 <span class="comment"> * worth of additional latency.</span>
507 <a name="l00707"></a>00707 <span class="comment"> *</span>
508 <a name="l00708"></a>00708 <span class="comment"> * For OUTPUT mode devices, the latency of the device's safe write pointer, plus N buffers of </span>
509 <a name="l00709"></a>00709 <span class="comment"> * additional buffer latency.</span>
510 <a name="l00710"></a>00710 <span class="comment"> *</span>
511 <a name="l00711"></a>00711 <span class="comment"> * For DUPLEX devices, the sum of latencies for both input and output devices. DUPLEX devices</span>
512 <a name="l00712"></a>00712 <span class="comment"> * also back off the read pointers an additional amount in order to maintain synchronization </span>
513 <a name="l00713"></a>00713 <span class="comment"> * between out-of-phase read and write pointers. This time is also included.</span>
514 <a name="l00714"></a>00714 <span class="comment"> *</span>
515 <a name="l00715"></a>00715 <span class="comment"> * Note that most software packages report latency between the safe write pointer </span>
516 <a name="l00716"></a>00716 <span class="comment"> * and the software lead pointer, excluding the hardware device's safe write pointer </span>
517 <a name="l00717"></a>00717 <span class="comment"> * latency. Figures of 1 or 2ms of latency on Windows audio devices are invariably of this type.</span>
518 <a name="l00718"></a>00718 <span class="comment"> * The reality is that hardware devices often have latencies of 30ms or more (often much </span>
519 <a name="l00719"></a>00719 <span class="comment"> * higher for duplex operation).</span>
520 <a name="l00720"></a>00720 <span class="comment"> */</span>
521 <a name="l00721"></a>00721
522 <a name="l00722"></a>00722 <span class="keywordtype">double</span> latency;
523 <a name="l00723"></a>00723 };
524 <a name="l00724"></a>00724 <span class="comment">// \brief Report on the current state of a running DSound device.</span>
525 <a name="l00725"></a>00725 <span class="keyword">static</span> RtDsStatistics getDsStatistics();
526 <a name="l00726"></a>00726
527 <a name="l00727"></a>00727 <span class="keyword">private</span>:
528 <a name="l00728"></a>00728
529 <a name="l00729"></a>00729 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
530 <a name="l00730"></a>00730 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
531 <a name="l00731"></a>00731 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
532 <a name="l00732"></a>00732 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
533 <a name="l00733"></a>00733 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
534 <a name="l00734"></a>00734
535 <a name="l00735"></a>00735 <span class="keywordtype">bool</span> coInitialized;
536 <a name="l00736"></a>00736 <span class="keywordtype">bool</span> buffersRolling;
537 <a name="l00737"></a>00737 <span class="keywordtype">long</span> duplexPrerollBytes;
538 <a name="l00738"></a>00738 <span class="keyword">static</span> RtDsStatistics statistics;
539 <a name="l00739"></a>00739
540 <a name="l00740"></a>00740 };
541 <a name="l00741"></a>00741
542 <a name="l00742"></a>00742 <span class="preprocessor">#endif</span>
543 <a name="l00743"></a>00743 <span class="preprocessor"></span>
544 <a name="l00744"></a>00744 <span class="preprocessor">#if defined(__WINDOWS_ASIO__)</span>
545 <a name="l00745"></a>00745 <span class="preprocessor"></span>
546 <a name="l00746"></a>00746 <span class="keyword">class </span>RtApiAsio: <span class="keyword">public</span> RtApi
547 <a name="l00747"></a>00747 {
548 <a name="l00748"></a>00748 <span class="keyword">public</span>:
549 <a name="l00749"></a>00749
550 <a name="l00750"></a>00750 RtApiAsio();
551 <a name="l00751"></a>00751 ~RtApiAsio();
552 <a name="l00752"></a>00752 <span class="keywordtype">void</span> tickStream();
553 <a name="l00753"></a>00753 <span class="keywordtype">void</span> closeStream();
554 <a name="l00754"></a>00754 <span class="keywordtype">void</span> startStream();
555 <a name="l00755"></a>00755 <span class="keywordtype">void</span> stopStream();
556 <a name="l00756"></a>00756 <span class="keywordtype">void</span> abortStream();
557 <a name="l00757"></a>00757 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
558 <a name="l00758"></a>00758 <span class="keywordtype">void</span> cancelStreamCallback();
559 <a name="l00759"></a>00759
560 <a name="l00760"></a>00760 <span class="comment">// This function is intended for internal use only. It must be</span>
561 <a name="l00761"></a>00761 <span class="comment">// public because it is called by the internal callback handler,</span>
562 <a name="l00762"></a>00762 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
563 <a name="l00763"></a>00763 <span class="comment">// will most likely produce highly undesireable results!</span>
564 <a name="l00764"></a>00764 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">long</span> bufferIndex );
565 <a name="l00765"></a>00765
566 <a name="l00766"></a>00766 <span class="keyword">private</span>:
567 <a name="l00767"></a>00767
568 <a name="l00768"></a>00768 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
569 <a name="l00769"></a>00769 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
570 <a name="l00770"></a>00770 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
571 <a name="l00771"></a>00771 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
572 <a name="l00772"></a>00772 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
573 <a name="l00773"></a>00773
574 <a name="l00774"></a>00774 <span class="keywordtype">bool</span> coInitialized;
575 <a name="l00775"></a>00775
576 <a name="l00776"></a>00776 };
577 <a name="l00777"></a>00777
578 <a name="l00778"></a>00778 <span class="preprocessor">#endif</span>
579 <a name="l00779"></a>00779 <span class="preprocessor"></span>
580 <a name="l00780"></a>00780 <span class="preprocessor">#if defined(__IRIX_AL__)</span>
581 <a name="l00781"></a>00781 <span class="preprocessor"></span>
582 <a name="l00782"></a>00782 <span class="keyword">class </span>RtApiAl: <span class="keyword">public</span> RtApi
583 <a name="l00783"></a>00783 {
584 <a name="l00784"></a>00784 <span class="keyword">public</span>:
585 <a name="l00785"></a>00785
586 <a name="l00786"></a>00786 RtApiAl();
587 <a name="l00787"></a>00787 ~RtApiAl();
588 <a name="l00788"></a>00788 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>);
589 <a name="l00789"></a>00789 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>);
590 <a name="l00790"></a>00790 <span class="keywordtype">void</span> tickStream();
591 <a name="l00791"></a>00791 <span class="keywordtype">void</span> closeStream();
592 <a name="l00792"></a>00792 <span class="keywordtype">void</span> startStream();
593 <a name="l00793"></a>00793 <span class="keywordtype">void</span> stopStream();
594 <a name="l00794"></a>00794 <span class="keywordtype">void</span> abortStream();
595 <a name="l00795"></a>00795 <span class="keywordtype">int</span> streamWillBlock();
596 <a name="l00796"></a>00796 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData );
597 <a name="l00797"></a>00797 <span class="keywordtype">void</span> cancelStreamCallback();
598 <a name="l00798"></a>00798
599 <a name="l00799"></a>00799 <span class="keyword">private</span>:
600 <a name="l00800"></a>00800
601 <a name="l00801"></a>00801 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);
602 <a name="l00802"></a>00802 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info );
603 <a name="l00803"></a>00803 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels,
604 <a name="l00804"></a>00804 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format,
605 <a name="l00805"></a>00805 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers );
606 <a name="l00806"></a>00806 };
607 <a name="l00807"></a>00807
608 <a name="l00808"></a>00808 <span class="preprocessor">#endif</span>
609 <a name="l00809"></a>00809 <span class="preprocessor"></span>
610 <a name="l00810"></a>00810 <span class="comment">// Define the following flag to have extra information spewed to stderr.</span>
611 <a name="l00811"></a>00811 <span class="comment">//#define __RTAUDIO_DEBUG__</span>
612 <a name="l00812"></a>00812
613 <a name="l00813"></a>00813 <span class="preprocessor">#endif</span>
616 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
617 <td>©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.<br>
618 Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>
projects / rtaudio.git / blob