<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>PortAudio: pa_win_wmme.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">PortAudio  <span id="projectnumber">2.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">pa_win_wmme.h</div> </div> </div><!--header--> <div class="contents"> <a href="pa__win__wmme_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PA_WIN_WMME_H</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define PA_WIN_WMME_H</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="comment">/*</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * $Id: pa_win_wmme.h 1592 2011-02-04 10:41:58Z rossb $</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * PortAudio Portable Real-Time Audio Library</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * MME specific extensions</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Copyright (c) 1999-2000 Ross Bencina and Phil Burk</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * a copy of this software and associated documentation files</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * (the "Software"), to deal in the Software without restriction,</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * including without limitation the rights to use, copy, modify, merge,</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * publish, distribute, sublicense, and/or sell copies of the Software,</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * and to permit persons to whom the Software is furnished to do so,</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * subject to the following conditions:</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> *</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * The above copyright notice and this permission notice shall be</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * included in all copies or substantial portions of the Software.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> *</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> */</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/*</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * The text above constitutes the entire PortAudio license; however, </span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * the PortAudio community also makes the following non-binding requests:</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * Any person wishing to distribute modifications to the Software is</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * requested to send the modifications to the original developer so that</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * they can be incorporated into the canonical version. It is also </span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * requested that these non-binding requests be included along with the </span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * license above.</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="portaudio_8h.html" title="The portable PortAudio API.">portaudio.h</a>"</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "<a class="code" href="pa__win__waveformat_8h.html" title="Windows specific PortAudio API extension and utilities header file.">pa_win_waveformat.h</a>"</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/* The following are flags which can be set in </span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> PaWinMmeStreamInfo's flags field.</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">*/</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define paWinMmeUseLowLevelLatencyParameters (0x01)</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinMmeUseMultipleDevices (0x02) </span><span class="comment">/* use mme specific multiple device feature */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinMmeUseChannelMask (0x04)</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/* By default, the mme implementation drops the processing thread's priority</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> to THREAD_PRIORITY_NORMAL and sleeps the thread if the CPU load exceeds 100%</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> This flag disables any priority throttling. The processing thread will always</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> run at THREAD_PRIORITY_TIME_CRITICAL.</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">*/</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define paWinMmeDontThrottleOverloadedProcessingThread (0x08)</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/* Flags for non-PCM spdif passthrough.</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">*/</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#define paWinMmeWaveFormatDolbyAc3Spdif (0x10)</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinMmeWaveFormatWmaSpdif (0x20)</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="structPaWinMmeDeviceAndChannelCount.html"> 76</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPaWinMmeDeviceAndChannelCount.html">PaWinMmeDeviceAndChannelCount</a>{</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">int</span> channelCount;</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }<a class="code" href="structPaWinMmeDeviceAndChannelCount.html">PaWinMmeDeviceAndChannelCount</a>;</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="structPaWinMmeStreamInfo.html"> 82</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPaWinMmeStreamInfo.html">PaWinMmeStreamInfo</a>{</div> <div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="structPaWinMmeStreamInfo.html#a62c0f8888229904962efdbec924d2527"> 83</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPaWinMmeStreamInfo.html#a62c0f8888229904962efdbec924d2527">size</a>; </div> <div class="line"><a name="l00084"></a><span class="lineno"><a class="code" href="structPaWinMmeStreamInfo.html#a393237910fb36b3f42396a365184ce01"> 84</a></span>  <a class="code" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> <a class="code" href="structPaWinMmeStreamInfo.html#a393237910fb36b3f42396a365184ce01">hostApiType</a>; </div> <div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="structPaWinMmeStreamInfo.html#a881694ff44db0af4d0f3067453c3db38"> 85</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPaWinMmeStreamInfo.html#a881694ff44db0af4d0f3067453c3db38">version</a>; </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags;</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">/* low-level latency setting support</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> These settings control the number and size of host buffers in order</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> to set latency. They will be used instead of the generic parameters</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> to Pa_OpenStream() if flags contains the PaWinMmeUseLowLevelLatencyParameters</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> flag.</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> If PaWinMmeStreamInfo structures with PaWinMmeUseLowLevelLatencyParameters</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> are supplied for both input and output in a full duplex stream, then the</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> input and output framesPerBuffer must be the same, or the larger of the</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> two must be a multiple of the smaller, otherwise a</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> paIncompatibleHostApiSpecificStreamInfo error will be returned from</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> Pa_OpenStream().</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> framesPerBuffer;</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> bufferCount; <span class="comment">/* formerly numBuffers */</span> </div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">/* multiple devices per direction support</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> If flags contains the PaWinMmeUseMultipleDevices flag,</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> this functionality will be used, otherwise the device parameter to</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> Pa_OpenStream() will be used instead.</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> If devices are specified here, the corresponding device parameter</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> to Pa_OpenStream() should be set to paUseHostApiSpecificDeviceSpecification,</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> otherwise an paInvalidDevice error will result.</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> The total number of channels accross all specified devices</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> must agree with the corresponding channelCount parameter to</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> Pa_OpenStream() otherwise a paInvalidChannelCount error will result.</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="structPaWinMmeDeviceAndChannelCount.html">PaWinMmeDeviceAndChannelCount</a> *devices;</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> deviceCount;</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="comment">/*</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> support for WAVEFORMATEXTENSIBLE channel masks. If flags contains</span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> paWinMmeUseChannelMask this allows you to specify which speakers </span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> to address in a multichannel stream. Constants for channelMask</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> are specified in pa_win_waveformat.h</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> */</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  PaWinWaveFormatChannelMask channelMask;</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> }<a class="code" href="structPaWinMmeStreamInfo.html">PaWinMmeStreamInfo</a>;</div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">int</span> <a class="code" href="pa__win__wmme_8h.html#aaa47c87fb51f29024ad2db1c3ba85db5">PaWinMME_GetStreamInputHandleCount</a>( <a class="code" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a>* stream );</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> HWAVEIN <a class="code" href="pa__win__wmme_8h.html#a67a4c1e3b4d2a5830c11bc1c4e7d2caa">PaWinMME_GetStreamInputHandle</a>( <a class="code" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a>* stream, <span class="keywordtype">int</span> handleIndex );</div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keywordtype">int</span> <a class="code" href="pa__win__wmme_8h.html#a8eae212f83c77fc92eb3e8e95216ede7">PaWinMME_GetStreamOutputHandleCount</a>( <a class="code" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a>* stream );</div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> HWAVEOUT <a class="code" href="pa__win__wmme_8h.html#ac7311604a84f712ef70fe90510f96be6">PaWinMME_GetStreamOutputHandle</a>( <a class="code" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a>* stream, <span class="keywordtype">int</span> handleIndex );</div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#endif </span><span class="comment">/* PA_WIN_WMME_H */</span><span class="preprocessor"> </span></div> </div><!-- fragment --></div><!-- contents --> <hr size="1"><address style="text-align: right;"><small>Generated for PortAudio by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>1.8.3.1</small></address> </body> </html>