<!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_wasapi.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_wasapi.h</div> </div> </div><!--header--> <div class="contents"> <a href="pa__win__wasapi_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_WASAPI_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_WASAPI_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: $</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"> * DirectSound 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-2007 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">/* Setup flags */</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiFlags</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">/* puts WASAPI into exclusive mode */</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  paWinWasapiExclusive = (1 << 0),</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">/* allows to skip internal PA processing completely */</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  paWinWasapiRedirectHostProcessor = (1 << 1),</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">/* assigns custom channel mask */</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  paWinWasapiUseChannelMask = (1 << 2),</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">/* selects non-Event driven method of data read/write</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> Note: WASAPI Event driven core is capable of 2ms latency!!!, but Polling</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> method can only provide 15-20ms latency. */</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  paWinWasapiPolling = (1 << 3),</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">/* forces custom thread priority setting. must be used if PaWasapiStreamInfo::threadPriority </span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> is set to custom value. */</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  paWinWasapiThreadPriority = (1 << 4)</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> PaWasapiFlags;</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#define paWinWasapiExclusive (paWinWasapiExclusive)</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinWasapiRedirectHostProcessor (paWinWasapiRedirectHostProcessor)</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinWasapiUseChannelMask (paWinWasapiUseChannelMask)</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinWasapiPolling (paWinWasapiPolling)</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span><span class="preprocessor">#define paWinWasapiThreadPriority (paWinWasapiThreadPriority)</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/* Host processor. Allows to skip internal PA processing completely. </span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> You must set paWinWasapiRedirectHostProcessor flag to PaWasapiStreamInfo::flags member</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> in order to have host processor redirected to your callback.</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> Use with caution! inputFrames and outputFrames depend solely on final device setup.</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> To query maximal values of inputFrames/outputFrames use PaWasapi_GetFramesPerHostBuffer.</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">*/</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">typedef</span> void (*PaWasapiHostProcessorCallback) (<span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">long</span> inputFrames,</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">long</span> outputFrames,</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">void</span> *userData);</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/* Device role */</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiDeviceRole</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> {</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  eRoleRemoteNetworkDevice = 0,</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  eRoleSpeakers,</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  eRoleLineLevel,</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  eRoleHeadphones,</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  eRoleMicrophone,</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  eRoleHeadset,</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  eRoleHandset,</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  eRoleUnknownDigitalPassthrough,</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  eRoleSPDIF,</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  eRoleHDMI,</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  eRoleUnknownFormFactor</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> PaWasapiDeviceRole;</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/* Jack connection type */</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiJackConnectionType</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> {</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  eJackConnTypeUnknown,</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  eJackConnType3Point5mm,</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  eJackConnTypeQuarter,</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  eJackConnTypeAtapiInternal,</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  eJackConnTypeRCA,</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  eJackConnTypeOptical,</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  eJackConnTypeOtherDigital,</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  eJackConnTypeOtherAnalog,</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  eJackConnTypeMultichannelAnalogDIN,</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  eJackConnTypeXlrProfessional,</div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  eJackConnTypeRJ11Modem,</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  eJackConnTypeCombination</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> PaWasapiJackConnectionType;</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="l00131"></a><span class="lineno"> 131</span> <span class="comment">/* Jack geometric location */</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiJackGeoLocation</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> {</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  eJackGeoLocUnk = 0,</div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  eJackGeoLocRear = 0x1, <span class="comment">/* matches EPcxGeoLocation::eGeoLocRear */</span></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  eJackGeoLocFront,</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  eJackGeoLocLeft,</div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  eJackGeoLocRight,</div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  eJackGeoLocTop,</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  eJackGeoLocBottom,</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  eJackGeoLocRearPanel,</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  eJackGeoLocRiser,</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  eJackGeoLocInsideMobileLid,</div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  eJackGeoLocDrivebay,</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  eJackGeoLocHDMI,</div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  eJackGeoLocOutsideMobileLid,</div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  eJackGeoLocATAPI,</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  eJackGeoLocReserved5,</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  eJackGeoLocReserved6,</div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> } </div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> PaWasapiJackGeoLocation;</div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/* Jack general location */</span></div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiJackGenLocation</div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> {</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  eJackGenLocPrimaryBox = 0,</div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  eJackGenLocInternal,</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  eJackGenLocSeparate,</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  eJackGenLocOther</div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> } </div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> PaWasapiJackGenLocation;</div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">/* Jack's type of port */</span></div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> PaWasapiJackPortConnection</div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> {</div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  eJackPortConnJack = 0,</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  eJackPortConnIntegratedDevice,</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  eJackPortConnBothIntegratedAndJack,</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  eJackPortConnUnknown</div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> } </div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> PaWasapiJackPortConnection;</div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/* Thread priority */</span></div> <div class="line"><a name="l00177"></a><span class="lineno"><a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661"> 177</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661">PaWasapiThreadPriority</a></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> {</div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  eThreadPriorityNone = 0,</div> <div class="line"><a name="l00180"></a><span class="lineno"><a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661a06c9f997fd5d9e11d4ef8bf67342f031"> 180</a></span>  <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661a06c9f997fd5d9e11d4ef8bf67342f031" title="Default for Shared mode.">eThreadPriorityAudio</a>, </div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  eThreadPriorityCapture,</div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  eThreadPriorityDistribution,</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  eThreadPriorityGames,</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  eThreadPriorityPlayback,</div> <div class="line"><a name="l00185"></a><span class="lineno"><a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661a9a34413b0a045f4c44d10a49d3357187"> 185</a></span>  <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661a9a34413b0a045f4c44d10a49d3357187" title="Default for Exclusive mode.">eThreadPriorityProAudio</a>, </div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  eThreadPriorityWindowManager</div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> }</div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661">PaWasapiThreadPriority</a>;</div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">/* Stream descriptor. */</span></div> <div class="line"><a name="l00192"></a><span class="lineno"><a class="code" href="structPaWasapiJackDescription.html"> 192</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPaWasapiJackDescription.html">PaWasapiJackDescription</a> </div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> {</div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> channelMapping;</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> color; <span class="comment">/* derived from macro: #define RGB(r,g,b) ((COLORREF)(((BYTE)(r)|((WORD)((BYTE)(g))<<8))|(((DWORD)(BYTE)(b))<<16))) */</span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  PaWasapiJackConnectionType connectionType;</div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  PaWasapiJackGeoLocation geoLocation;</div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  PaWasapiJackGenLocation genLocation;</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  PaWasapiJackPortConnection portConnection;</div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> isConnected;</div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> }</div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <a class="code" href="structPaWasapiJackDescription.html">PaWasapiJackDescription</a>;</div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">/* Stream descriptor. */</span></div> <div class="line"><a name="l00206"></a><span class="lineno"><a class="code" href="structPaWasapiStreamInfo.html"> 206</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPaWasapiStreamInfo.html">PaWasapiStreamInfo</a> </div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> {</div> <div class="line"><a name="l00208"></a><span class="lineno"><a class="code" href="structPaWasapiStreamInfo.html#ae491f41ce5954cddd438624dc69eba1b"> 208</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPaWasapiStreamInfo.html#ae491f41ce5954cddd438624dc69eba1b">size</a>; </div> <div class="line"><a name="l00209"></a><span class="lineno"><a class="code" href="structPaWasapiStreamInfo.html#a931bf93691d5b36b621d49402d1d2255"> 209</a></span>  <a class="code" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> <a class="code" href="structPaWasapiStreamInfo.html#a931bf93691d5b36b621d49402d1d2255">hostApiType</a>; </div> <div class="line"><a name="l00210"></a><span class="lineno"><a class="code" href="structPaWasapiStreamInfo.html#a3045f4432a92d761e4a1b95eba97ae49"> 210</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPaWasapiStreamInfo.html#a3045f4432a92d761e4a1b95eba97ae49">version</a>; </div> <div class="line"><a name="l00212"></a><span class="lineno"><a class="code" href="structPaWasapiStreamInfo.html#a85bfbe1a00e6b48df75528eb6f967a2c"> 212</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPaWasapiStreamInfo.html#a85bfbe1a00e6b48df75528eb6f967a2c">flags</a>; </div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="comment">/* Support for WAVEFORMATEXTENSIBLE channel masks. If flags contains</span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> paWinWasapiUseChannelMask this allows you to specify which speakers </span></div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> to address in a multichannel stream. Constants for channelMask</span></div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> are specified in pa_win_waveformat.h. Will be used only if </span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> paWinWasapiUseChannelMask flag is specified.</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> */</span></div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  PaWinWaveFormatChannelMask channelMask;</div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="comment">/* Delivers raw data to callback obtained from GetBuffer() methods skipping </span></div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> internal PortAudio processing inventory completely. userData parameter will </span></div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> be the same that was passed to Pa_OpenStream method. Will be used only if </span></div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> paWinWasapiRedirectHostProcessor flag is specified.</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> */</span></div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  PaWasapiHostProcessorCallback hostProcessorOutput;</div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  PaWasapiHostProcessorCallback hostProcessorInput;</div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div> <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">/* Specifies thread priority explicitly. Will be used only if paWinWasapiThreadPriority flag</span></div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> is specified.</span></div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"></span></div> <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> Please note, if Input/Output streams are opened simultaniously (Full-Duplex mode)</span></div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> you shall specify same value for threadPriority or othervise one of the values will be used</span></div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> to setup thread priority.</span></div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> */</span></div> <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661">PaWasapiThreadPriority</a> threadPriority;</div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> } </div> <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <a class="code" href="structPaWasapiStreamInfo.html">PaWasapiStreamInfo</a>;</div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> </div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="keywordtype">int</span> <a class="code" href="pa__win__wasapi_8h.html#aa42c66da0ae19959d25a190e9dd82005">PaWasapi_GetDeviceDefaultFormat</a>( <span class="keywordtype">void</span> *pFormat, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFormatSize, <a class="code" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> nDevice );</div> <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> </div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div> <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="keywordtype">int</span><span class="comment">/*PaWasapiDeviceRole*/</span> <a class="code" href="pa__win__wasapi_8h.html#a6a8c5307dff661ae7ee0d7bb8bf73469">PaWasapi_GetDeviceRole</a>( <a class="code" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> nDevice );</div> <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div> <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <a class="code" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> <a class="code" href="pa__win__wasapi_8h.html#a2d48ae4d2124209ed8a6264c6febedc7">PaWasapi_ThreadPriorityBoost</a>( <span class="keywordtype">void</span> **hTask, <a class="code" href="pa__win__wasapi_8h.html#a561291b0188f6f29246ea669b48e2661">PaWasapiThreadPriority</a> nPriorityClass );</div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div> <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <a class="code" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> <a class="code" href="pa__win__wasapi_8h.html#ac5c875fb9165712ff696512f750f7de3">PaWasapi_ThreadPriorityRevert</a>( <span class="keywordtype">void</span> *hTask );</div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div> <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div> <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <a class="code" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> <a class="code" href="pa__win__wasapi_8h.html#af8f04003c6123e6fdcfdf7308761a75e">PaWasapi_GetFramesPerHostBuffer</a>( <a class="code" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *pStream, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *nInput, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *nOutput );</div> <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <a class="code" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> <a class="code" href="pa__win__wasapi_8h.html#a46583f8e4b1132c198e2451fd48f7490">PaWasapi_GetJackCount</a>(<a class="code" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> nDevice, <span class="keywordtype">int</span> *jcount);</div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> </div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div> <div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <a class="code" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> <a class="code" href="pa__win__wasapi_8h.html#a042829efac1aca1d77608d136a523465">PaWasapi_GetJackDescription</a>(<a class="code" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> nDevice, <span class="keywordtype">int</span> jindex, <a class="code" href="structPaWasapiJackDescription.html">PaWasapiJackDescription</a> *pJackDescription);</div> <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> </div> <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">/*</span></div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> IMPORTANT:</span></div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"></span></div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> WASAPI is implemented for Callback and Blocking interfaces. It supports Shared and Exclusive</span></div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> share modes. </span></div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> </span></div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> Exclusive Mode:</span></div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"></span></div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> Exclusive mode allows to deliver audio data directly to hardware bypassing</span></div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> software mixing.</span></div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> Exclusive mode is specified by 'paWinWasapiExclusive' flag.</span></div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"></span></div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> Callback Interface:</span></div> <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"></span></div> <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> Provides best audio quality with low latency. Callback interface is implemented in </span></div> <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> two versions:</span></div> <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"></span></div> <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> 1) Event-Driven:</span></div> <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> This is the most powerful WASAPI implementation which provides glitch-free</span></div> <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> audio at around 3ms latency in Exclusive mode. Lowest possible latency for this mode is </span></div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> 3 ms for HD Audio class audio chips. For the Shared mode latency can not be </span></div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> lower than 20 ms.</span></div> <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"></span></div> <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> 2) Poll-Driven:</span></div> <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> Polling is another 2-nd method to operate with WASAPI. It is less efficient than Event-Driven</span></div> <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> and provides latency at around 10-13ms. Polling must be used to overcome a system bug</span></div> <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> under Windows Vista x64 when application is WOW64(32-bit) and Event-Driven method simply </span></div> <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> times out (event handle is never signalled on buffer completion). Please note, such WOW64 bug </span></div> <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> does not exist in Vista x86 or Windows 7.</span></div> <div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> Polling can be setup by speciying 'paWinWasapiPolling' flag. Our WASAPI implementation detects</span></div> <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> WOW64 bug and sets 'paWinWasapiPolling' automatically.</span></div> <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"></span></div> <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> Thread priority:</span></div> <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"></span></div> <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> Normally thread priority is set automatically and does not require modification. Although</span></div> <div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> if user wants some tweaking thread priority can be modified by setting 'paWinWasapiThreadPriority'</span></div> <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> flag and specifying 'PaWasapiStreamInfo::threadPriority' with value from PaWasapiThreadPriority </span></div> <div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> enum.</span></div> <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"></span></div> <div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> Blocking Interface:</span></div> <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"></span></div> <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> Blocking interface is implemented but due to above described Poll-Driven method can not</span></div> <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> deliver lowest possible latency. Specifying too low latency in Shared mode will result in </span></div> <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> distorted audio although Exclusive mode adds stability.</span></div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"></span></div> <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> Pa_IsFormatSupported:</span></div> <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"></span></div> <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> To check format with correct Share Mode (Exclusive/Shared) you must supply</span></div> <div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> PaWasapiStreamInfo with flags paWinWasapiExclusive set through member of </span></div> <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> PaStreamParameters::hostApiSpecificStreamInfo structure.</span></div> <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"></span></div> <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> Pa_OpenStream:</span></div> <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"></span></div> <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> To set desired Share Mode (Exclusive/Shared) you must supply</span></div> <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> PaWasapiStreamInfo with flags paWinWasapiExclusive set through member of </span></div> <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> PaStreamParameters::hostApiSpecificStreamInfo structure.</span></div> <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment">*/</span></div> <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> </div> <div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="preprocessor">#endif </span><span class="comment">/* PA_WIN_WASAPI_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>