3 <TITLE>The RtAudio Home Page</TITLE>
4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
5 <LINK REL="SHORTCUT ICON" HREF="http://www.music.mcgill.ca/~gary/favicon.ico">
7 <BODY BGCOLOR="#FFFFFF">
9 <a class="qindex" href="index.html">Home</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>
11 <!-- Generated by Doxygen 1.6.2 -->
12 <h1>RtAudio.h</h1><a href="RtAudio_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span>
13 <a name="l00039"></a>00039 <span class="comment">/************************************************************************/</span>
14 <a name="l00040"></a>00040
15 <a name="l00045"></a>00045 <span class="comment">// RtAudio: Version 4.0.8</span>
16 <a name="l00046"></a>00046
17 <a name="l00047"></a>00047 <span class="preprocessor">#ifndef __RTAUDIO_H</span>
18 <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define __RTAUDIO_H</span>
19 <a name="l00049"></a>00049 <span class="preprocessor"></span>
20 <a name="l00050"></a>00050 <span class="preprocessor">#include <string></span>
21 <a name="l00051"></a>00051 <span class="preprocessor">#include <vector></span>
22 <a name="l00052"></a>00052 <span class="preprocessor">#include "RtError.h"</span>
23 <a name="l00053"></a>00053
24 <a name="l00072"></a><a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">00072</a> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a>;
25 <a name="l00073"></a>00073 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_SINT8 = 0x1; <span class="comment">// 8-bit signed integer.</span>
26 <a name="l00074"></a>00074 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_SINT16 = 0x2; <span class="comment">// 16-bit signed integer.</span>
27 <a name="l00075"></a>00075 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_SINT24 = 0x4; <span class="comment">// Lower 3 bytes of 32-bit signed integer.</span>
28 <a name="l00076"></a>00076 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_SINT32 = 0x8; <span class="comment">// 32-bit signed integer.</span>
29 <a name="l00077"></a>00077 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_FLOAT32 = 0x10; <span class="comment">// Normalized between plus/minus 1.0.</span>
30 <a name="l00078"></a>00078 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> RTAUDIO_FLOAT64 = 0x20; <span class="comment">// Normalized between plus/minus 1.0.</span>
31 <a name="l00079"></a>00079
32 <a name="l00122"></a><a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">00122</a> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a>;
33 <a name="l00123"></a>00123 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> RTAUDIO_NONINTERLEAVED = 0x1; <span class="comment">// Use non-interleaved buffers (default = interleaved).</span>
34 <a name="l00124"></a>00124 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> RTAUDIO_MINIMIZE_LATENCY = 0x2; <span class="comment">// Attempt to set stream parameters for lowest possible latency.</span>
35 <a name="l00125"></a>00125 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> RTAUDIO_HOG_DEVICE = 0x4; <span class="comment">// Attempt grab device and prevent use by others.</span>
36 <a name="l00126"></a>00126 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> RTAUDIO_SCHEDULE_REALTIME = 0x8; <span class="comment">// Try to select realtime scheduling for callback thread.</span>
37 <a name="l00127"></a>00127 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> RTAUDIO_ALSA_USE_DEFAULT = 0x10; <span class="comment">// Use the "default" PCM device (ALSA only).</span>
38 <a name="l00128"></a>00128
39 <a name="l00140"></a><a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">00140</a> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a>;
40 <a name="l00141"></a>00141 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> RTAUDIO_INPUT_OVERFLOW = 0x1; <span class="comment">// Input data was discarded because of an overflow condition at the driver.</span>
41 <a name="l00142"></a>00142 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> RTAUDIO_OUTPUT_UNDERFLOW = 0x2; <span class="comment">// The output buffer ran low, likely causing a gap in the output sound.</span>
42 <a name="l00143"></a>00143
43 <a name="l00145"></a>00145
44 <a name="l00183"></a><a class="code" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">00183</a> <span class="keyword">typedef</span> int (*<a class="code" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f" title="RtAudio callback function prototype.">RtAudioCallback</a>)( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer,
45 <a name="l00184"></a>00184 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFrames,
46 <a name="l00185"></a>00185 <span class="keywordtype">double</span> streamTime,
47 <a name="l00186"></a>00186 <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status,
48 <a name="l00187"></a>00187 <span class="keywordtype">void</span> *userData );
49 <a name="l00188"></a>00188
50 <a name="l00189"></a>00189
51 <a name="l00190"></a>00190 <span class="comment">// **************************************************************** //</span>
52 <a name="l00191"></a>00191 <span class="comment">//</span>
53 <a name="l00192"></a>00192 <span class="comment">// RtAudio class declaration.</span>
54 <a name="l00193"></a>00193 <span class="comment">//</span>
55 <a name="l00194"></a>00194 <span class="comment">// RtAudio is a "controller" used to select an available audio i/o</span>
56 <a name="l00195"></a>00195 <span class="comment">// interface. It presents a common API for the user to call but all</span>
57 <a name="l00196"></a>00196 <span class="comment">// functionality is implemented by the class RtApi and its</span>
58 <a name="l00197"></a>00197 <span class="comment">// subclasses. RtAudio creates an instance of an RtApi subclass</span>
59 <a name="l00198"></a>00198 <span class="comment">// based on the user's API choice. If no choice is made, RtAudio</span>
60 <a name="l00199"></a>00199 <span class="comment">// attempts to make a "logical" API selection.</span>
61 <a name="l00200"></a>00200 <span class="comment">//</span>
62 <a name="l00201"></a>00201 <span class="comment">// **************************************************************** //</span>
63 <a name="l00202"></a>00202
64 <a name="l00203"></a>00203 <span class="keyword">class </span>RtApi;
65 <a name="l00204"></a>00204
66 <a name="l00205"></a><a class="code" href="classRtAudio.html">00205</a> <span class="keyword">class </span><a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>
67 <a name="l00206"></a>00206 {
68 <a name="l00207"></a>00207 <span class="keyword">public</span>:
69 <a name="l00208"></a>00208
70 <a name="l00210"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">00210</a> <span class="keyword">enum</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">Api</a> {
71 <a name="l00211"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">00211</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a>,
72 <a name="l00212"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">00212</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">LINUX_ALSA</a>,
73 <a name="l00213"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">00213</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">LINUX_OSS</a>,
74 <a name="l00214"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">00214</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">UNIX_JACK</a>,
75 <a name="l00215"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">00215</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">MACOSX_CORE</a>,
76 <a name="l00216"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">00216</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">WINDOWS_ASIO</a>,
77 <a name="l00217"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">00217</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">WINDOWS_DS</a>,
78 <a name="l00218"></a><a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">00218</a> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RTAUDIO_DUMMY</a>
79 <a name="l00219"></a>00219 };
80 <a name="l00220"></a>00220
81 <a name="l00222"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html">00222</a> <span class="keyword">struct </span><a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">DeviceInfo</a> {
82 <a name="l00223"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">00223</a> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a>;
83 <a name="l00224"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">00224</a> std::string <a class="code" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a>;
84 <a name="l00225"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">00225</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a>;
85 <a name="l00226"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">00226</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a>;
86 <a name="l00227"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">00227</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a>;
87 <a name="l00228"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">00228</a> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a>;
88 <a name="l00229"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">00229</a> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a>;
89 <a name="l00230"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">00230</a> std::vector<unsigned int> <a class="code" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a>;
90 <a name="l00231"></a><a class="code" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">00231</a> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a>;
91 <a name="l00233"></a>00233 <span class="comment">// Default constructor.</span>
92 <a name="l00234"></a>00234 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">DeviceInfo</a>()
93 <a name="l00235"></a>00235 :<a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a>(false), <a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a>(0), <a class="code" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a>(0), <a class="code" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a>(0),
94 <a name="l00236"></a>00236 <a class="code" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a>(false), <a class="code" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a>(false), <a class="code" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a>(0) {}
95 <a name="l00237"></a>00237 };
96 <a name="l00238"></a>00238
97 <a name="l00240"></a><a class="code" href="structRtAudio_1_1StreamParameters.html">00240</a> <span class="keyword">struct </span><a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">StreamParameters</a> {
98 <a name="l00241"></a><a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">00241</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a>;
99 <a name="l00242"></a><a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">00242</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a>;
100 <a name="l00243"></a><a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">00243</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a>;
101 <a name="l00245"></a>00245 <span class="comment">// Default constructor.</span>
102 <a name="l00246"></a>00246 <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">StreamParameters</a>()
103 <a name="l00247"></a>00247 : <a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a>(0), <a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a>(0), <a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a>(0) {}
104 <a name="l00248"></a>00248 };
105 <a name="l00249"></a>00249
106 <a name="l00251"></a>00251
107 <a name="l00307"></a><a class="code" href="structRtAudio_1_1StreamOptions.html">00307</a> <span class="keyword">struct </span><a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">StreamOptions</a> {
108 <a name="l00308"></a><a class="code" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">00308</a> <a class="code" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41" title="RtAudio stream option flags.">RtAudioStreamFlags</a> <a class="code" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a>;
109 <a name="l00309"></a><a class="code" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">00309</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a>;
110 <a name="l00310"></a><a class="code" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">00310</a> std::string <a class="code" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">streamName</a>;
111 <a name="l00311"></a><a class="code" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">00311</a> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a>;
112 <a name="l00313"></a>00313 <span class="comment">// Default constructor.</span>
113 <a name="l00314"></a>00314 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">StreamOptions</a>()
114 <a name="l00315"></a>00315 : <a class="code" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a>(0), <a class="code" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a>(0), <a class="code" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a>(0) {}
115 <a name="l00316"></a>00316 };
116 <a name="l00317"></a>00317
117 <a name="l00319"></a>00319
118 <a name="l00324"></a>00324 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26" title="A static function to determine the available compiled audio APIs.">getCompiledApi</a>( std::vector<RtAudio::Api> &apis ) <span class="keywordflow">throw</span>();
119 <a name="l00325"></a>00325
120 <a name="l00327"></a>00327
121 <a name="l00335"></a>00335 <a class="code" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9" title="The class constructor.">RtAudio</a>( <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> api=<a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a> ) throw();
122 <a name="l00336"></a>00336
123 <a name="l00338"></a>00338
124 <a name="l00342"></a>00342 ~<a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>() throw();
125 <a name="l00343"></a>00343
126 <a name="l00345"></a>00345 <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::<a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">Api</a> <a class="code" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246" title="Returns the audio API specifier for the current instance of RtAudio.">getCurrentApi</a>( <span class="keywordtype">void</span> ) throw();
127 <a name="l00346"></a>00346
128 <a name="l00348"></a>00348
129 <a name="l00353"></a>00353 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>( <span class="keywordtype">void</span> ) throw();
130 <a name="l00354"></a>00354
131 <a name="l00356"></a>00356
132 <a name="l00366"></a>00366 <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::DeviceInfo <a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">getDeviceInfo</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
133 <a name="l00367"></a>00367
134 <a name="l00369"></a>00369
135 <a name="l00376"></a>00376 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>( <span class="keywordtype">void</span> ) throw();
136 <a name="l00377"></a>00377
137 <a name="l00379"></a>00379
138 <a name="l00386"></a>00386 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce" title="A function that returns the index of the default input device.">getDefaultInputDevice</a>( <span class="keywordtype">void</span> ) throw();
139 <a name="l00387"></a>00387
140 <a name="l00389"></a>00389
141 <a name="l00426"></a>00426 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::StreamParameters *outputParameters,
142 <a name="l00427"></a>00427 <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::StreamParameters *inputParameters,
143 <a name="l00428"></a>00428 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
144 <a name="l00429"></a>00429 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferFrames, <a class="code" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f" title="RtAudio callback function prototype.">RtAudioCallback</a> callback,
145 <a name="l00430"></a>00430 <span class="keywordtype">void</span> *userData = NULL, <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::StreamOptions *options = NULL );
146 <a name="l00431"></a>00431
147 <a name="l00433"></a>00433
148 <a name="l00437"></a>00437 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>( <span class="keywordtype">void</span> ) throw();
149 <a name="l00438"></a>00438
150 <a name="l00440"></a>00440
151 <a name="l00446"></a>00446 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>( <span class="keywordtype">void</span> );
152 <a name="l00447"></a>00447
153 <a name="l00449"></a>00449
154 <a name="l00455"></a>00455 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>( <span class="keywordtype">void</span> );
155 <a name="l00456"></a>00456
156 <a name="l00458"></a>00458
157 <a name="l00464"></a>00464 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f" title="Stop a stream, discarding any samples remaining in the input/output queue.">abortStream</a>( <span class="keywordtype">void</span> );
158 <a name="l00465"></a>00465
159 <a name="l00467"></a>00467 <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>( <span class="keywordtype">void</span> ) const throw();
160 <a name="l00468"></a>00468
161 <a name="l00470"></a>00470 <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea" title="Returns true if the stream is running and false if it is stopped or not open.">isStreamRunning</a>( <span class="keywordtype">void</span> ) const throw();
162 <a name="l00471"></a>00471
163 <a name="l00473"></a>00473
164 <a name="l00476"></a>00476 <span class="keywordtype">double</span> <a class="code" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca" title="Returns the number of elapsed seconds since the stream was started.">getStreamTime</a>( <span class="keywordtype">void</span> );
165 <a name="l00477"></a>00477
166 <a name="l00479"></a>00479
167 <a name="l00487"></a>00487 <span class="keywordtype">long</span> <a class="code" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3" title="Returns the internal stream latency in sample frames.">getStreamLatency</a>( <span class="keywordtype">void</span> );
168 <a name="l00488"></a>00488
169 <a name="l00490"></a>00490
170 <a name="l00495"></a>00495 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5" title="Returns actual sample rate in use by the stream.">getStreamSampleRate</a>( <span class="keywordtype">void</span> );
171 <a name="l00496"></a>00496
172 <a name="l00498"></a>00498 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">showWarnings</a>( <span class="keywordtype">bool</span> value = true ) throw();
173 <a name="l00499"></a>00499
174 <a name="l00500"></a>00500 protected:
175 <a name="l00501"></a>00501
176 <a name="l00502"></a>00502 <span class="keywordtype">void</span> openRtApi( <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>::<a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">Api</a> api );
177 <a name="l00503"></a>00503 RtApi *rtapi_;
178 <a name="l00504"></a>00504 };
179 <a name="l00505"></a>00505
180 <a name="l00506"></a>00506 <span class="comment">// Operating system dependent thread functionality.</span>
181 <a name="l00507"></a>00507 <span class="preprocessor">#if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__)</span>
182 <a name="l00508"></a>00508 <span class="preprocessor"></span><span class="preprocessor"> #include <windows.h></span>
183 <a name="l00509"></a>00509 <span class="preprocessor"> #include <process.h></span>
184 <a name="l00510"></a>00510
185 <a name="l00511"></a>00511 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ThreadHandle;
186 <a name="l00512"></a>00512 <span class="keyword">typedef</span> CRITICAL_SECTION StreamMutex;
187 <a name="l00513"></a>00513
188 <a name="l00514"></a>00514 <span class="preprocessor">#elif defined(__LINUX_ALSA__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)</span>
189 <a name="l00515"></a>00515 <span class="preprocessor"></span> <span class="comment">// Using pthread library for various flavors of unix.</span>
190 <a name="l00516"></a>00516 <span class="preprocessor"> #include <pthread.h></span>
191 <a name="l00517"></a>00517
192 <a name="l00518"></a>00518 <span class="keyword">typedef</span> pthread_t ThreadHandle;
193 <a name="l00519"></a>00519 <span class="keyword">typedef</span> pthread_mutex_t StreamMutex;
194 <a name="l00520"></a>00520
195 <a name="l00521"></a>00521 <span class="preprocessor">#else // Setup for "dummy" behavior</span>
196 <a name="l00522"></a>00522 <span class="preprocessor"></span>
197 <a name="l00523"></a>00523 <span class="preprocessor"> #define __RTAUDIO_DUMMY__</span>
198 <a name="l00524"></a>00524 <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> ThreadHandle;
199 <a name="l00525"></a>00525 <span class="keyword">typedef</span> <span class="keywordtype">int</span> StreamMutex;
200 <a name="l00526"></a>00526
201 <a name="l00527"></a>00527 <span class="preprocessor">#endif</span>
202 <a name="l00528"></a>00528 <span class="preprocessor"></span>
203 <a name="l00529"></a>00529 <span class="comment">// This global structure type is used to pass callback information</span>
204 <a name="l00530"></a>00530 <span class="comment">// between the private RtAudio stream structure and global callback</span>
205 <a name="l00531"></a>00531 <span class="comment">// handling functions.</span>
206 <a name="l00532"></a>00532 <span class="keyword">struct </span>CallbackInfo {
207 <a name="l00533"></a>00533 <span class="keywordtype">void</span> *object; <span class="comment">// Used as a "this" pointer.</span>
208 <a name="l00534"></a>00534 ThreadHandle thread;
209 <a name="l00535"></a>00535 <span class="keywordtype">void</span> *callback;
210 <a name="l00536"></a>00536 <span class="keywordtype">void</span> *userData;
211 <a name="l00537"></a>00537 <span class="keywordtype">void</span> *apiInfo; <span class="comment">// void pointer for API specific callback information</span>
212 <a name="l00538"></a>00538 <span class="keywordtype">bool</span> isRunning;
213 <a name="l00539"></a>00539
214 <a name="l00540"></a>00540 <span class="comment">// Default constructor.</span>
215 <a name="l00541"></a>00541 CallbackInfo()
216 <a name="l00542"></a>00542 :object(0), callback(0), userData(0), apiInfo(0), isRunning(false) {}
217 <a name="l00543"></a>00543 };
218 <a name="l00544"></a>00544
219 <a name="l00545"></a>00545 <span class="comment">// **************************************************************** //</span>
220 <a name="l00546"></a>00546 <span class="comment">//</span>
221 <a name="l00547"></a>00547 <span class="comment">// RtApi class declaration.</span>
222 <a name="l00548"></a>00548 <span class="comment">//</span>
223 <a name="l00549"></a>00549 <span class="comment">// Subclasses of RtApi contain all API- and OS-specific code necessary</span>
224 <a name="l00550"></a>00550 <span class="comment">// to fully implement the RtAudio API.</span>
225 <a name="l00551"></a>00551 <span class="comment">//</span>
226 <a name="l00552"></a>00552 <span class="comment">// Note that RtApi is an abstract base class and cannot be</span>
227 <a name="l00553"></a>00553 <span class="comment">// explicitly instantiated. The class RtAudio will create an</span>
228 <a name="l00554"></a>00554 <span class="comment">// instance of an RtApi subclass (RtApiOss, RtApiAlsa,</span>
229 <a name="l00555"></a>00555 <span class="comment">// RtApiJack, RtApiCore, RtApiAl, RtApiDs, or RtApiAsio).</span>
230 <a name="l00556"></a>00556 <span class="comment">//</span>
231 <a name="l00557"></a>00557 <span class="comment">// **************************************************************** //</span>
232 <a name="l00558"></a>00558
233 <a name="l00559"></a>00559 <span class="preprocessor">#if defined( HAVE_GETTIMEOFDAY )</span>
234 <a name="l00560"></a>00560 <span class="preprocessor"></span><span class="preprocessor"> #include <sys/time.h></span>
235 <a name="l00561"></a>00561 <span class="preprocessor">#endif</span>
236 <a name="l00562"></a>00562 <span class="preprocessor"></span>
237 <a name="l00563"></a>00563 <span class="preprocessor">#include <sstream></span>
238 <a name="l00564"></a>00564
239 <a name="l00565"></a>00565 <span class="keyword">class </span>RtApi
240 <a name="l00566"></a>00566 {
241 <a name="l00567"></a>00567 <span class="keyword">public</span>:
242 <a name="l00568"></a>00568
243 <a name="l00569"></a>00569 RtApi();
244 <a name="l00570"></a>00570 <span class="keyword">virtual</span> ~RtApi();
245 <a name="l00571"></a>00571 <span class="keyword">virtual</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> <a class="code" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246" title="Returns the audio API specifier for the current instance of RtAudio.">getCurrentApi</a>( <span class="keywordtype">void</span> ) = 0;
246 <a name="l00572"></a>00572 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>( <span class="keywordtype">void</span> ) = 0;
247 <a name="l00573"></a>00573 <span class="keyword">virtual</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> <a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">getDeviceInfo</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device ) = 0;
248 <a name="l00574"></a>00574 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce" title="A function that returns the index of the default input device.">getDefaultInputDevice</a>( <span class="keywordtype">void</span> );
249 <a name="l00575"></a>00575 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>( <span class="keywordtype">void</span> );
250 <a name="l00576"></a>00576 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> *outputParameters,
251 <a name="l00577"></a>00577 <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> *inputParameters,
252 <a name="l00578"></a>00578 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
253 <a name="l00579"></a>00579 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferFrames, <a class="code" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f" title="RtAudio callback function prototype.">RtAudioCallback</a> callback,
254 <a name="l00580"></a>00580 <span class="keywordtype">void</span> *userData, <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
255 <a name="l00581"></a>00581 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>( <span class="keywordtype">void</span> );
256 <a name="l00582"></a>00582 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>( <span class="keywordtype">void</span> ) = 0;
257 <a name="l00583"></a>00583 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>( <span class="keywordtype">void</span> ) = 0;
258 <a name="l00584"></a>00584 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f" title="Stop a stream, discarding any samples remaining in the input/output queue.">abortStream</a>( <span class="keywordtype">void</span> ) = 0;
259 <a name="l00585"></a>00585 <span class="keywordtype">long</span> <a class="code" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3" title="Returns the internal stream latency in sample frames.">getStreamLatency</a>( <span class="keywordtype">void</span> );
260 <a name="l00586"></a>00586 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5" title="Returns actual sample rate in use by the stream.">getStreamSampleRate</a>( <span class="keywordtype">void</span> );
261 <a name="l00587"></a>00587 <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca" title="Returns the number of elapsed seconds since the stream was started.">getStreamTime</a>( <span class="keywordtype">void</span> );
262 <a name="l00588"></a>00588 <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> stream_.state != STREAM_CLOSED; };
263 <a name="l00589"></a>00589 <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea" title="Returns true if the stream is running and false if it is stopped or not open.">isStreamRunning</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> stream_.state == STREAM_RUNNING; };
264 <a name="l00590"></a>00590 <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">showWarnings</a>( <span class="keywordtype">bool</span> value ) { showWarnings_ = value; };
265 <a name="l00591"></a>00591
266 <a name="l00592"></a>00592
267 <a name="l00593"></a>00593 <span class="keyword">protected</span>:
268 <a name="l00594"></a>00594
269 <a name="l00595"></a>00595 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MAX_SAMPLE_RATES;
270 <a name="l00596"></a>00596 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SAMPLE_RATES[];
271 <a name="l00597"></a>00597
272 <a name="l00598"></a>00598 <span class="keyword">enum</span> { FAILURE, SUCCESS };
273 <a name="l00599"></a>00599
274 <a name="l00600"></a>00600 <span class="keyword">enum</span> StreamState {
275 <a name="l00601"></a>00601 STREAM_STOPPED,
276 <a name="l00602"></a>00602 STREAM_RUNNING,
277 <a name="l00603"></a>00603 STREAM_CLOSED = -50
278 <a name="l00604"></a>00604 };
279 <a name="l00605"></a>00605
280 <a name="l00606"></a>00606 <span class="keyword">enum</span> StreamMode {
281 <a name="l00607"></a>00607 OUTPUT,
282 <a name="l00608"></a>00608 INPUT,
283 <a name="l00609"></a>00609 DUPLEX,
284 <a name="l00610"></a>00610 UNINITIALIZED = -75
285 <a name="l00611"></a>00611 };
286 <a name="l00612"></a>00612
287 <a name="l00613"></a>00613 <span class="comment">// A protected structure used for buffer conversion.</span>
288 <a name="l00614"></a>00614 <span class="keyword">struct </span>ConvertInfo {
289 <a name="l00615"></a>00615 <span class="keywordtype">int</span> channels;
290 <a name="l00616"></a>00616 <span class="keywordtype">int</span> inJump, outJump;
291 <a name="l00617"></a>00617 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> inFormat, outFormat;
292 <a name="l00618"></a>00618 std::vector<int> inOffset;
293 <a name="l00619"></a>00619 std::vector<int> outOffset;
294 <a name="l00620"></a>00620 };
295 <a name="l00621"></a>00621
296 <a name="l00622"></a>00622 <span class="comment">// A protected structure for audio streams.</span>
297 <a name="l00623"></a>00623 <span class="keyword">struct </span>RtApiStream {
298 <a name="l00624"></a>00624 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device[2]; <span class="comment">// Playback and record, respectively.</span>
299 <a name="l00625"></a>00625 <span class="keywordtype">void</span> *apiHandle; <span class="comment">// void pointer for API specific stream handle information</span>
300 <a name="l00626"></a>00626 StreamMode mode; <span class="comment">// OUTPUT, INPUT, or DUPLEX.</span>
301 <a name="l00627"></a>00627 StreamState state; <span class="comment">// STOPPED, RUNNING, or CLOSED</span>
302 <a name="l00628"></a>00628 <span class="keywordtype">char</span> *userBuffer[2]; <span class="comment">// Playback and record, respectively.</span>
303 <a name="l00629"></a>00629 <span class="keywordtype">char</span> *deviceBuffer;
304 <a name="l00630"></a>00630 <span class="keywordtype">bool</span> doConvertBuffer[2]; <span class="comment">// Playback and record, respectively.</span>
305 <a name="l00631"></a>00631 <span class="keywordtype">bool</span> userInterleaved;
306 <a name="l00632"></a>00632 <span class="keywordtype">bool</span> deviceInterleaved[2]; <span class="comment">// Playback and record, respectively.</span>
307 <a name="l00633"></a>00633 <span class="keywordtype">bool</span> doByteSwap[2]; <span class="comment">// Playback and record, respectively.</span>
308 <a name="l00634"></a>00634 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate;
309 <a name="l00635"></a>00635 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferSize;
310 <a name="l00636"></a>00636 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBuffers;
311 <a name="l00637"></a>00637 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nUserChannels[2]; <span class="comment">// Playback and record, respectively.</span>
312 <a name="l00638"></a>00638 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nDeviceChannels[2]; <span class="comment">// Playback and record channels, respectively.</span>
313 <a name="l00639"></a>00639 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channelOffset[2]; <span class="comment">// Playback and record, respectively.</span>
314 <a name="l00640"></a>00640 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> latency[2]; <span class="comment">// Playback and record, respectively.</span>
315 <a name="l00641"></a>00641 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> userFormat;
316 <a name="l00642"></a>00642 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> deviceFormat[2]; <span class="comment">// Playback and record, respectively.</span>
317 <a name="l00643"></a>00643 StreamMutex mutex;
318 <a name="l00644"></a>00644 CallbackInfo callbackInfo;
319 <a name="l00645"></a>00645 ConvertInfo convertInfo[2];
320 <a name="l00646"></a>00646 <span class="keywordtype">double</span> streamTime; <span class="comment">// Number of elapsed seconds since the stream started.</span>
321 <a name="l00647"></a>00647
322 <a name="l00648"></a>00648 <span class="preprocessor">#if defined(HAVE_GETTIMEOFDAY)</span>
323 <a name="l00649"></a>00649 <span class="preprocessor"></span> <span class="keyword">struct </span>timeval lastTickTimestamp;
324 <a name="l00650"></a>00650 <span class="preprocessor">#endif</span>
325 <a name="l00651"></a>00651 <span class="preprocessor"></span>
326 <a name="l00652"></a>00652 RtApiStream()
327 <a name="l00653"></a>00653 :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
328 <a name="l00654"></a>00654 };
329 <a name="l00655"></a>00655
330 <a name="l00656"></a>00656 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> Int16;
331 <a name="l00657"></a>00657 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> Int32;
332 <a name="l00658"></a>00658 <span class="keyword">typedef</span> <span class="keywordtype">float</span> Float32;
333 <a name="l00659"></a>00659 <span class="keyword">typedef</span> <span class="keywordtype">double</span> Float64;
334 <a name="l00660"></a>00660
335 <a name="l00661"></a>00661 std::ostringstream errorStream_;
336 <a name="l00662"></a>00662 std::string errorText_;
337 <a name="l00663"></a>00663 <span class="keywordtype">bool</span> showWarnings_;
338 <a name="l00664"></a>00664 RtApiStream stream_;
339 <a name="l00665"></a>00665
340 <a name="l00673"></a>00673 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
341 <a name="l00674"></a>00674 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
342 <a name="l00675"></a>00675 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
343 <a name="l00676"></a>00676 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
344 <a name="l00677"></a>00677
345 <a name="l00679"></a>00679 <span class="keywordtype">void</span> tickStreamTime( <span class="keywordtype">void</span> );
346 <a name="l00680"></a>00680
347 <a name="l00682"></a>00682 <span class="keywordtype">void</span> clearStreamInfo();
348 <a name="l00683"></a>00683
349 <a name="l00688"></a>00688 <span class="keywordtype">void</span> verifyStream( <span class="keywordtype">void</span> );
350 <a name="l00689"></a>00689
351 <a name="l00691"></a>00691 <span class="keywordtype">void</span> error( <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a> type );
352 <a name="l00692"></a>00692
353 <a name="l00697"></a>00697 <span class="keywordtype">void</span> convertBuffer( <span class="keywordtype">char</span> *outBuffer, <span class="keywordtype">char</span> *inBuffer, ConvertInfo &info );
354 <a name="l00698"></a>00698
355 <a name="l00700"></a>00700 <span class="keywordtype">void</span> byteSwapBuffer( <span class="keywordtype">char</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> samples, <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format );
356 <a name="l00701"></a>00701
357 <a name="l00703"></a>00703 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> formatBytes( <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format );
358 <a name="l00704"></a>00704
359 <a name="l00706"></a>00706 <span class="keywordtype">void</span> setConvertInfo( StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel );
360 <a name="l00707"></a>00707 };
361 <a name="l00708"></a>00708
362 <a name="l00709"></a>00709 <span class="comment">// **************************************************************** //</span>
363 <a name="l00710"></a>00710 <span class="comment">//</span>
364 <a name="l00711"></a>00711 <span class="comment">// Inline RtAudio definitions.</span>
365 <a name="l00712"></a>00712 <span class="comment">//</span>
366 <a name="l00713"></a>00713 <span class="comment">// **************************************************************** //</span>
367 <a name="l00714"></a>00714
368 <a name="l00715"></a><a class="code" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">00715</a> <span class="keyword">inline</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> <a class="code" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246" title="Returns the audio API specifier for the current instance of RtAudio.">RtAudio :: getCurrentApi</a>( <span class="keywordtype">void</span> ) throw() { <span class="keywordflow">return</span> rtapi_->getCurrentApi(); }
369 <a name="l00716"></a><a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">00716</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">RtAudio :: getDeviceCount</a>( <span class="keywordtype">void</span> ) throw() { <span class="keywordflow">return</span> rtapi_->getDeviceCount(); }
370 <a name="l00717"></a><a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">00717</a> <span class="keyword">inline</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> <a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">RtAudio :: getDeviceInfo</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device ) { <span class="keywordflow">return</span> rtapi_->getDeviceInfo( device ); }
371 <a name="l00718"></a><a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">00718</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce" title="A function that returns the index of the default input device.">RtAudio :: getDefaultInputDevice</a>( <span class="keywordtype">void</span> ) throw() { <span class="keywordflow">return</span> rtapi_->getDefaultInputDevice(); }
372 <a name="l00719"></a><a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">00719</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">RtAudio :: getDefaultOutputDevice</a>( <span class="keywordtype">void</span> ) throw() { <span class="keywordflow">return</span> rtapi_->getDefaultOutputDevice(); }
373 <a name="l00720"></a><a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">00720</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">RtAudio :: closeStream</a>( <span class="keywordtype">void</span> ) throw() { <span class="keywordflow">return</span> rtapi_->closeStream(); }
374 <a name="l00721"></a><a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">00721</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">RtAudio :: startStream</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->startStream(); }
375 <a name="l00722"></a><a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">00722</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">RtAudio :: stopStream</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->stopStream(); }
376 <a name="l00723"></a><a class="code" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">00723</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f" title="Stop a stream, discarding any samples remaining in the input/output queue.">RtAudio :: abortStream</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->abortStream(); }
377 <a name="l00724"></a><a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">00724</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">RtAudio :: isStreamOpen</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> rtapi_->isStreamOpen(); }
378 <a name="l00725"></a><a class="code" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">00725</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea" title="Returns true if the stream is running and false if it is stopped or not open.">RtAudio :: isStreamRunning</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> rtapi_->isStreamRunning(); }
379 <a name="l00726"></a><a class="code" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">00726</a> <span class="keyword">inline</span> <span class="keywordtype">long</span> <a class="code" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3" title="Returns the internal stream latency in sample frames.">RtAudio :: getStreamLatency</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->getStreamLatency(); }
380 <a name="l00727"></a><a class="code" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">00727</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5" title="Returns actual sample rate in use by the stream.">RtAudio :: getStreamSampleRate</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->getStreamSampleRate(); };
381 <a name="l00728"></a><a class="code" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">00728</a> <span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca" title="Returns the number of elapsed seconds since the stream was started.">RtAudio :: getStreamTime</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> rtapi_->getStreamTime(); }
382 <a name="l00729"></a><a class="code" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">00729</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">RtAudio :: showWarnings</a>( <span class="keywordtype">bool</span> value ) <span class="keywordflow">throw</span>() { rtapi_->showWarnings( value ); }
383 <a name="l00730"></a>00730
384 <a name="l00731"></a>00731 <span class="comment">// RtApi Subclass prototypes.</span>
385 <a name="l00732"></a>00732
386 <a name="l00733"></a>00733 <span class="preprocessor">#if defined(__MACOSX_CORE__)</span>
387 <a name="l00734"></a>00734 <span class="preprocessor"></span>
388 <a name="l00735"></a>00735 <span class="preprocessor">#include <CoreAudio/AudioHardware.h></span>
389 <a name="l00736"></a>00736
390 <a name="l00737"></a>00737 <span class="keyword">class </span>RtApiCore: <span class="keyword">public</span> RtApi
391 <a name="l00738"></a>00738 {
392 <a name="l00739"></a>00739 <span class="keyword">public</span>:
393 <a name="l00740"></a>00740
394 <a name="l00741"></a>00741 RtApiCore();
395 <a name="l00742"></a>00742 ~RtApiCore();
396 <a name="l00743"></a>00743 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">RtAudio::MACOSX_CORE</a>; };
397 <a name="l00744"></a>00744 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
398 <a name="l00745"></a>00745 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
399 <a name="l00746"></a>00746 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDefaultOutputDevice( <span class="keywordtype">void</span> );
400 <a name="l00747"></a>00747 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDefaultInputDevice( <span class="keywordtype">void</span> );
401 <a name="l00748"></a>00748 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
402 <a name="l00749"></a>00749 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
403 <a name="l00750"></a>00750 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
404 <a name="l00751"></a>00751 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
405 <a name="l00752"></a>00752 <span class="keywordtype">long</span> getStreamLatency( <span class="keywordtype">void</span> );
406 <a name="l00753"></a>00753
407 <a name="l00754"></a>00754 <span class="comment">// This function is intended for internal use only. It must be</span>
408 <a name="l00755"></a>00755 <span class="comment">// public because it is called by the internal callback handler,</span>
409 <a name="l00756"></a>00756 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
410 <a name="l00757"></a>00757 <span class="comment">// will most likely produce highly undesireable results!</span>
411 <a name="l00758"></a>00758 <span class="keywordtype">bool</span> callbackEvent( AudioDeviceID deviceId,
412 <a name="l00759"></a>00759 <span class="keyword">const</span> AudioBufferList *inBufferList,
413 <a name="l00760"></a>00760 <span class="keyword">const</span> AudioBufferList *outBufferList );
414 <a name="l00761"></a>00761
415 <a name="l00762"></a>00762 <span class="keyword">private</span>:
416 <a name="l00763"></a>00763
417 <a name="l00764"></a>00764 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
418 <a name="l00765"></a>00765 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
419 <a name="l00766"></a>00766 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
420 <a name="l00767"></a>00767 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
421 <a name="l00768"></a>00768 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* getErrorCode( OSStatus code );
422 <a name="l00769"></a>00769 };
423 <a name="l00770"></a>00770
424 <a name="l00771"></a>00771 <span class="preprocessor">#endif</span>
425 <a name="l00772"></a>00772 <span class="preprocessor"></span>
426 <a name="l00773"></a>00773 <span class="preprocessor">#if defined(__UNIX_JACK__)</span>
427 <a name="l00774"></a>00774 <span class="preprocessor"></span>
428 <a name="l00775"></a>00775 <span class="keyword">class </span>RtApiJack: <span class="keyword">public</span> RtApi
429 <a name="l00776"></a>00776 {
430 <a name="l00777"></a>00777 <span class="keyword">public</span>:
431 <a name="l00778"></a>00778
432 <a name="l00779"></a>00779 RtApiJack();
433 <a name="l00780"></a>00780 ~RtApiJack();
434 <a name="l00781"></a>00781 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">RtAudio::UNIX_JACK</a>; };
435 <a name="l00782"></a>00782 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
436 <a name="l00783"></a>00783 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
437 <a name="l00784"></a>00784 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
438 <a name="l00785"></a>00785 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
439 <a name="l00786"></a>00786 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
440 <a name="l00787"></a>00787 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
441 <a name="l00788"></a>00788 <span class="keywordtype">long</span> getStreamLatency( <span class="keywordtype">void</span> );
442 <a name="l00789"></a>00789
443 <a name="l00790"></a>00790 <span class="comment">// This function is intended for internal use only. It must be</span>
444 <a name="l00791"></a>00791 <span class="comment">// public because it is called by the internal callback handler,</span>
445 <a name="l00792"></a>00792 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
446 <a name="l00793"></a>00793 <span class="comment">// will most likely produce highly undesireable results!</span>
447 <a name="l00794"></a>00794 <span class="keywordtype">bool</span> callbackEvent( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nframes );
448 <a name="l00795"></a>00795
449 <a name="l00796"></a>00796 <span class="keyword">private</span>:
450 <a name="l00797"></a>00797
451 <a name="l00798"></a>00798 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
452 <a name="l00799"></a>00799 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
453 <a name="l00800"></a>00800 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
454 <a name="l00801"></a>00801 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
455 <a name="l00802"></a>00802 };
456 <a name="l00803"></a>00803
457 <a name="l00804"></a>00804 <span class="preprocessor">#endif</span>
458 <a name="l00805"></a>00805 <span class="preprocessor"></span>
459 <a name="l00806"></a>00806 <span class="preprocessor">#if defined(__WINDOWS_ASIO__)</span>
460 <a name="l00807"></a>00807 <span class="preprocessor"></span>
461 <a name="l00808"></a>00808 <span class="keyword">class </span>RtApiAsio: <span class="keyword">public</span> RtApi
462 <a name="l00809"></a>00809 {
463 <a name="l00810"></a>00810 <span class="keyword">public</span>:
464 <a name="l00811"></a>00811
465 <a name="l00812"></a>00812 RtApiAsio();
466 <a name="l00813"></a>00813 ~RtApiAsio();
467 <a name="l00814"></a>00814 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">RtAudio::WINDOWS_ASIO</a>; };
468 <a name="l00815"></a>00815 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
469 <a name="l00816"></a>00816 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
470 <a name="l00817"></a>00817 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
471 <a name="l00818"></a>00818 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
472 <a name="l00819"></a>00819 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
473 <a name="l00820"></a>00820 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
474 <a name="l00821"></a>00821 <span class="keywordtype">long</span> getStreamLatency( <span class="keywordtype">void</span> );
475 <a name="l00822"></a>00822
476 <a name="l00823"></a>00823 <span class="comment">// This function is intended for internal use only. It must be</span>
477 <a name="l00824"></a>00824 <span class="comment">// public because it is called by the internal callback handler,</span>
478 <a name="l00825"></a>00825 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
479 <a name="l00826"></a>00826 <span class="comment">// will most likely produce highly undesireable results!</span>
480 <a name="l00827"></a>00827 <span class="keywordtype">bool</span> callbackEvent( <span class="keywordtype">long</span> bufferIndex );
481 <a name="l00828"></a>00828
482 <a name="l00829"></a>00829 <span class="keyword">private</span>:
483 <a name="l00830"></a>00830
484 <a name="l00831"></a>00831 std::vector<RtAudio::DeviceInfo> devices_;
485 <a name="l00832"></a>00832 <span class="keywordtype">void</span> saveDeviceInfo( <span class="keywordtype">void</span> );
486 <a name="l00833"></a>00833 <span class="keywordtype">bool</span> coInitialized_;
487 <a name="l00834"></a>00834 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
488 <a name="l00835"></a>00835 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
489 <a name="l00836"></a>00836 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
490 <a name="l00837"></a>00837 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
491 <a name="l00838"></a>00838 };
492 <a name="l00839"></a>00839
493 <a name="l00840"></a>00840 <span class="preprocessor">#endif</span>
494 <a name="l00841"></a>00841 <span class="preprocessor"></span>
495 <a name="l00842"></a>00842 <span class="preprocessor">#if defined(__WINDOWS_DS__)</span>
496 <a name="l00843"></a>00843 <span class="preprocessor"></span>
497 <a name="l00844"></a>00844 <span class="keyword">class </span>RtApiDs: <span class="keyword">public</span> RtApi
498 <a name="l00845"></a>00845 {
499 <a name="l00846"></a>00846 <span class="keyword">public</span>:
500 <a name="l00847"></a>00847
501 <a name="l00848"></a>00848 RtApiDs();
502 <a name="l00849"></a>00849 ~RtApiDs();
503 <a name="l00850"></a>00850 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">RtAudio::WINDOWS_DS</a>; };
504 <a name="l00851"></a>00851 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
505 <a name="l00852"></a>00852 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDefaultOutputDevice( <span class="keywordtype">void</span> );
506 <a name="l00853"></a>00853 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDefaultInputDevice( <span class="keywordtype">void</span> );
507 <a name="l00854"></a>00854 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
508 <a name="l00855"></a>00855 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
509 <a name="l00856"></a>00856 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
510 <a name="l00857"></a>00857 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
511 <a name="l00858"></a>00858 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
512 <a name="l00859"></a>00859 <span class="keywordtype">long</span> getStreamLatency( <span class="keywordtype">void</span> );
513 <a name="l00860"></a>00860
514 <a name="l00861"></a>00861 <span class="comment">// This function is intended for internal use only. It must be</span>
515 <a name="l00862"></a>00862 <span class="comment">// public because it is called by the internal callback handler,</span>
516 <a name="l00863"></a>00863 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
517 <a name="l00864"></a>00864 <span class="comment">// will most likely produce highly undesireable results!</span>
518 <a name="l00865"></a>00865 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">void</span> );
519 <a name="l00866"></a>00866
520 <a name="l00867"></a>00867 <span class="keyword">private</span>:
521 <a name="l00868"></a>00868
522 <a name="l00869"></a>00869 <span class="keywordtype">bool</span> coInitialized_;
523 <a name="l00870"></a>00870 <span class="keywordtype">bool</span> buffersRolling;
524 <a name="l00871"></a>00871 <span class="keywordtype">long</span> duplexPrerollBytes;
525 <a name="l00872"></a>00872 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
526 <a name="l00873"></a>00873 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
527 <a name="l00874"></a>00874 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
528 <a name="l00875"></a>00875 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
529 <a name="l00876"></a>00876 };
530 <a name="l00877"></a>00877
531 <a name="l00878"></a>00878 <span class="preprocessor">#endif</span>
532 <a name="l00879"></a>00879 <span class="preprocessor"></span>
533 <a name="l00880"></a>00880 <span class="preprocessor">#if defined(__LINUX_ALSA__)</span>
534 <a name="l00881"></a>00881 <span class="preprocessor"></span>
535 <a name="l00882"></a>00882 <span class="keyword">class </span>RtApiAlsa: <span class="keyword">public</span> RtApi
536 <a name="l00883"></a>00883 {
537 <a name="l00884"></a>00884 <span class="keyword">public</span>:
538 <a name="l00885"></a>00885
539 <a name="l00886"></a>00886 RtApiAlsa();
540 <a name="l00887"></a>00887 ~RtApiAlsa();
541 <a name="l00888"></a>00888 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi() { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">RtAudio::LINUX_ALSA</a>; };
542 <a name="l00889"></a>00889 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
543 <a name="l00890"></a>00890 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
544 <a name="l00891"></a>00891 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
545 <a name="l00892"></a>00892 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
546 <a name="l00893"></a>00893 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
547 <a name="l00894"></a>00894 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
548 <a name="l00895"></a>00895
549 <a name="l00896"></a>00896 <span class="comment">// This function is intended for internal use only. It must be</span>
550 <a name="l00897"></a>00897 <span class="comment">// public because it is called by the internal callback handler,</span>
551 <a name="l00898"></a>00898 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
552 <a name="l00899"></a>00899 <span class="comment">// will most likely produce highly undesireable results!</span>
553 <a name="l00900"></a>00900 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">void</span> );
554 <a name="l00901"></a>00901
555 <a name="l00902"></a>00902 <span class="keyword">private</span>:
556 <a name="l00903"></a>00903
557 <a name="l00904"></a>00904 std::vector<RtAudio::DeviceInfo> devices_;
558 <a name="l00905"></a>00905 <span class="keywordtype">void</span> saveDeviceInfo( <span class="keywordtype">void</span> );
559 <a name="l00906"></a>00906 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
560 <a name="l00907"></a>00907 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
561 <a name="l00908"></a>00908 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
562 <a name="l00909"></a>00909 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
563 <a name="l00910"></a>00910 };
564 <a name="l00911"></a>00911
565 <a name="l00912"></a>00912 <span class="preprocessor">#endif</span>
566 <a name="l00913"></a>00913 <span class="preprocessor"></span>
567 <a name="l00914"></a>00914 <span class="preprocessor">#if defined(__LINUX_OSS__)</span>
568 <a name="l00915"></a>00915 <span class="preprocessor"></span>
569 <a name="l00916"></a>00916 <span class="keyword">class </span>RtApiOss: <span class="keyword">public</span> RtApi
570 <a name="l00917"></a>00917 {
571 <a name="l00918"></a>00918 <span class="keyword">public</span>:
572 <a name="l00919"></a>00919
573 <a name="l00920"></a>00920 RtApiOss();
574 <a name="l00921"></a>00921 ~RtApiOss();
575 <a name="l00922"></a>00922 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi() { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">RtAudio::LINUX_OSS</a>; };
576 <a name="l00923"></a>00923 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> );
577 <a name="l00924"></a>00924 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device );
578 <a name="l00925"></a>00925 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> );
579 <a name="l00926"></a>00926 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> );
580 <a name="l00927"></a>00927 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> );
581 <a name="l00928"></a>00928 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> );
582 <a name="l00929"></a>00929
583 <a name="l00930"></a>00930 <span class="comment">// This function is intended for internal use only. It must be</span>
584 <a name="l00931"></a>00931 <span class="comment">// public because it is called by the internal callback handler,</span>
585 <a name="l00932"></a>00932 <span class="comment">// which is not a member of RtAudio. External use of this function</span>
586 <a name="l00933"></a>00933 <span class="comment">// will most likely produce highly undesireable results!</span>
587 <a name="l00934"></a>00934 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">void</span> );
588 <a name="l00935"></a>00935
589 <a name="l00936"></a>00936 <span class="keyword">private</span>:
590 <a name="l00937"></a>00937
591 <a name="l00938"></a>00938 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
592 <a name="l00939"></a>00939 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
593 <a name="l00940"></a>00940 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
594 <a name="l00941"></a>00941 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options );
595 <a name="l00942"></a>00942 };
596 <a name="l00943"></a>00943
597 <a name="l00944"></a>00944 <span class="preprocessor">#endif</span>
598 <a name="l00945"></a>00945 <span class="preprocessor"></span>
599 <a name="l00946"></a>00946 <span class="preprocessor">#if defined(__RTAUDIO_DUMMY__)</span>
600 <a name="l00947"></a>00947 <span class="preprocessor"></span>
601 <a name="l00948"></a>00948 <span class="keyword">class </span>RtApiDummy: <span class="keyword">public</span> RtApi
602 <a name="l00949"></a>00949 {
603 <a name="l00950"></a>00950 <span class="keyword">public</span>:
604 <a name="l00951"></a>00951
605 <a name="l00952"></a>00952 RtApiDummy() { errorText_ = <span class="stringliteral">"RtApiDummy: This class provides no functionality."</span>; error( <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">RtError::WARNING</a> ); };
606 <a name="l00953"></a>00953 <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849" title="Audio API specifier arguments.">RtAudio::Api</a> getCurrentApi( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> <a class="code" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RtAudio::RTAUDIO_DUMMY</a>; };
607 <a name="l00954"></a>00954 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDeviceCount( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> 0; };
608 <a name="l00955"></a>00955 <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> getDeviceInfo( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device ) { <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> info; <span class="keywordflow">return</span> info; };
609 <a name="l00956"></a>00956 <span class="keywordtype">void</span> closeStream( <span class="keywordtype">void</span> ) {};
610 <a name="l00957"></a>00957 <span class="keywordtype">void</span> startStream( <span class="keywordtype">void</span> ) {};
611 <a name="l00958"></a>00958 <span class="keywordtype">void</span> stopStream( <span class="keywordtype">void</span> ) {};
612 <a name="l00959"></a>00959 <span class="keywordtype">void</span> abortStream( <span class="keywordtype">void</span> ) {};
613 <a name="l00960"></a>00960
614 <a name="l00961"></a>00961 <span class="keyword">private</span>:
615 <a name="l00962"></a>00962
616 <a name="l00963"></a>00963 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channels,
617 <a name="l00964"></a>00964 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> firstChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate,
618 <a name="l00965"></a>00965 <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> format, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferSize,
619 <a name="l00966"></a>00966 <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> *options ) { <span class="keywordflow">return</span> <span class="keyword">false</span>; };
620 <a name="l00967"></a>00967 };
621 <a name="l00968"></a>00968
622 <a name="l00969"></a>00969 <span class="preprocessor">#endif</span>
623 <a name="l00970"></a>00970 <span class="preprocessor"></span>
624 <a name="l00971"></a>00971 <span class="preprocessor">#endif</span>
625 <a name="l00972"></a>00972 <span class="preprocessor"></span>
626 <a name="l00973"></a>00973 <span class="comment">// Indentation settings for Vim and Emacs</span>
627 <a name="l00974"></a>00974 <span class="comment">//</span>
628 <a name="l00975"></a>00975 <span class="comment">// Local Variables:</span>
629 <a name="l00976"></a>00976 <span class="comment">// c-basic-offset: 2</span>
630 <a name="l00977"></a>00977 <span class="comment">// indent-tabs-mode: nil</span>
631 <a name="l00978"></a>00978 <span class="comment">// End:</span>
632 <a name="l00979"></a>00979 <span class="comment">//</span>
633 <a name="l00980"></a>00980 <span class="comment">// vim: et sts=2 sw=2</span>
637 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
638 <td>©2001-2010 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr>
projects / rtaudio.git / blob