<!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.5"/>
<title>SDL_sound: SDL_sound.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">SDL_sound
 <span id="projectnumber">1.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SDL_sound.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="SDL__sound_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> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SDL_sound -- An abstract sound format decoding API.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (C) 2001 Ryan C. Gordon.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</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> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#ifndef _INCLUDE_SDL_SOUND_H_</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"></span><span class="preprocessor">#define _INCLUDE_SDL_SOUND_H_</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#include "SDL.h"</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#include "SDL_endian.h"</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_IGNORE_THIS</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#ifndef SDLCALL </span><span class="comment">/* may not be defined with older SDL releases. */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span><span class="preprocessor">#define SDLCALL</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#ifdef SDL_SOUND_DLL_EXPORTS</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span><span class="preprocessor"># define SNDDECLSPEC __declspec(dllexport)</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span><span class="preprocessor"># define SNDDECLSPEC</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#define SOUND_VER_MAJOR 1</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span><span class="preprocessor">#define SOUND_VER_MINOR 0</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span><span class="preprocessor">#define SOUND_VER_PATCH 3</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625"> 107</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> {</div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a192a6518e94eabf9cd5c45babc9635ee"> 109</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a192a6518e94eabf9cd5c45babc9635ee">SOUND_SAMPLEFLAG_NONE</a> = 0, </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">/* these are set at sample creation time... */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a334d72e6e376dae44baa66746398bbaa"> 112</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a334d72e6e376dae44baa66746398bbaa">SOUND_SAMPLEFLAG_CANSEEK</a> = 1, </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">/* these are set during decoding... */</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ae0b562eebb0bf6cdf3da87eb1b4914be"> 115</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ae0b562eebb0bf6cdf3da87eb1b4914be">SOUND_SAMPLEFLAG_EOF</a> = 1 << 29, </div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a5d6c02e3276932f2217ee09a51eed65f"> 116</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a5d6c02e3276932f2217ee09a51eed65f">SOUND_SAMPLEFLAG_ERROR</a> = 1 << 30, </div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ab269a22d877556f5569dc737ad984e1a"> 117</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ab269a22d877556f5569dc737ad984e1a">SOUND_SAMPLEFLAG_EAGAIN</a> = 1 << 31 </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> } <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="structSound__AudioInfo.html"> 133</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> {</div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="structSound__AudioInfo.html#afc1f02fd774a0e1d35109360496390eb"> 135</a></span>  Uint16 <a class="code" href="structSound__AudioInfo.html#afc1f02fd774a0e1d35109360496390eb">format</a>; </div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="structSound__AudioInfo.html#a2a7fe880d009e698eb0d52cde3ddfc80"> 136</a></span>  Uint8 <a class="code" href="structSound__AudioInfo.html#a2a7fe880d009e698eb0d52cde3ddfc80">channels</a>; </div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="structSound__AudioInfo.html#abc8310e37ae527e5d92e675655d944ee"> 137</a></span>  Uint32 <a class="code" href="structSound__AudioInfo.html#abc8310e37ae527e5d92e675655d944ee">rate</a>; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> } <a class="code" href="structSound__AudioInfo.html">Sound_AudioInfo</a>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="structSound__DecoderInfo.html"> 160</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> {</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="structSound__DecoderInfo.html#a9f11db9acb555302fd84509198683e2a"> 162</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="structSound__DecoderInfo.html#a9f11db9acb555302fd84509198683e2a">extensions</a>; </div>
<div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="structSound__DecoderInfo.html#ac1241b30e4121aedd4286351b27f93d5"> 163</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structSound__DecoderInfo.html#ac1241b30e4121aedd4286351b27f93d5">description</a>; </div>
<div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="structSound__DecoderInfo.html#a1d3c5d5d46b0f5e5026944002e1d6e36"> 164</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structSound__DecoderInfo.html#a1d3c5d5d46b0f5e5026944002e1d6e36">author</a>; </div>
<div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="structSound__DecoderInfo.html#aa983be8195cd74f7dcaab2f4788309fb"> 165</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structSound__DecoderInfo.html#aa983be8195cd74f7dcaab2f4788309fb">url</a>; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> } <a class="code" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a>;</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> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="structSound__Sample.html"> 179</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</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"><a class="line" href="structSound__Sample.html#af9b14d108498631919187832d74efa11"> 181</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structSound__Sample.html#af9b14d108498631919187832d74efa11">opaque</a>; </div>
<div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="structSound__Sample.html#a03ef7710992520e65edacc9ad694b034"> 182</a></span>  <span class="keyword">const</span> <a class="code" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a> *<a class="code" href="structSound__Sample.html#a03ef7710992520e65edacc9ad694b034">decoder</a>; </div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="structSound__Sample.html#aca3059080501599b2fef90032122108d"> 183</a></span>  <a class="code" href="structSound__AudioInfo.html">Sound_AudioInfo</a> <a class="code" href="structSound__Sample.html#aca3059080501599b2fef90032122108d">desired</a>; </div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="structSound__Sample.html#a4862ebaacdb0d4ec3aa3f7874ef2b903"> 184</a></span>  <a class="code" href="structSound__AudioInfo.html">Sound_AudioInfo</a> <a class="code" href="structSound__Sample.html#a4862ebaacdb0d4ec3aa3f7874ef2b903">actual</a>; </div>
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="structSound__Sample.html#a160959b8f33b039d54e6a64452d3d9e7"> 185</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structSound__Sample.html#a160959b8f33b039d54e6a64452d3d9e7">buffer</a>; </div>
<div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="structSound__Sample.html#a7bd0273a97a4044e8dbf2bbba36ca176"> 186</a></span>  Uint32 <a class="code" href="structSound__Sample.html#a7bd0273a97a4044e8dbf2bbba36ca176">buffer_size</a>; </div>
<div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="structSound__Sample.html#a0aa7f52ce553407fdff6947b50626b2b"> 187</a></span>  <a class="code" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a> <a class="code" href="structSound__Sample.html#a0aa7f52ce553407fdff6947b50626b2b">flags</a>; </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> } <a class="code" href="structSound__Sample.html">Sound_Sample</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="l00204"></a><span class="lineno"><a class="line" href="structSound__Version.html"> 204</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> {</div>
<div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="structSound__Version.html#a68ed43edb6114f117edd45084baae1b4"> 206</a></span>  <span class="keywordtype">int</span> <a class="code" href="structSound__Version.html#a68ed43edb6114f117edd45084baae1b4">major</a>; </div>
<div class="line"><a name="l00207"></a><span class="lineno"><a class="line" href="structSound__Version.html#a095420931df560c545e0cf0d6fecf56a"> 207</a></span>  <span class="keywordtype">int</span> <a class="code" href="structSound__Version.html#a095420931df560c545e0cf0d6fecf56a">minor</a>; </div>
<div class="line"><a name="l00208"></a><span class="lineno"><a class="line" href="structSound__Version.html#a7ebc29f83c1a812ee24b556ad6dfc1f4"> 208</a></span>  <span class="keywordtype">int</span> <a class="code" href="structSound__Version.html#a7ebc29f83c1a812ee24b556ad6dfc1f4">patch</a>; </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> } <a class="code" href="structSound__Version.html">Sound_Version</a>;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/* functions and macros... */</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div>
<div class="line"><a name="l00230"></a><span class="lineno"><a class="line" href="SDL__sound_8h.html#a059b1c022acec0abbdab4a981b6e8e7d"> 230</a></span> <span class="preprocessor">#define SOUND_VERSION(x) \</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor">{ \</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="preprocessor"> (x)->major = SOUND_VER_MAJOR; \</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="preprocessor"> (x)->minor = SOUND_VER_MINOR; \</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor"> (x)->patch = SOUND_VER_PATCH; \</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">}</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> SNDDECLSPEC <span class="keywordtype">void</span> SDLCALL <a class="code" href="SDL__sound_8h.html#abda6027ae5b226e626a9e1ea1f6e626c">Sound_GetLinkedVersion</a>(<a class="code" href="structSound__Version.html">Sound_Version</a> *ver);</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> </div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> SNDDECLSPEC <span class="keywordtype">int</span> SDLCALL <a class="code" href="SDL__sound_8h.html#a44e4cafdb81fc9f9135796bcfd3fb44f">Sound_Init</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> SNDDECLSPEC <span class="keywordtype">int</span> SDLCALL <a class="code" href="SDL__sound_8h.html#a94408f49764dc122b0fad0397dccc941">Sound_Quit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> SNDDECLSPEC <span class="keyword">const</span> <a class="code" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a> ** SDLCALL <a class="code" href="SDL__sound_8h.html#abbae3fccdec9fad347aa71a29bd4f074">Sound_AvailableDecoders</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> SNDDECLSPEC <span class="keyword">const</span> <span class="keywordtype">char</span> * SDLCALL <a class="code" href="SDL__sound_8h.html#adb99dd3e7266c234e437bebf3be9e061">Sound_GetError</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> </div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> </div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> SNDDECLSPEC <span class="keywordtype">void</span> SDLCALL <a class="code" href="SDL__sound_8h.html#a7c0a82fc646c5b819b8d0e81bea029fb">Sound_ClearError</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> </div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> SNDDECLSPEC <a class="code" href="structSound__Sample.html">Sound_Sample</a> * SDLCALL <a class="code" href="SDL__sound_8h.html#a10b9c44cc1cc2ff8a93977b43870cb53">Sound_NewSample</a>(SDL_RWops *rw,</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *ext,</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <a class="code" href="structSound__AudioInfo.html">Sound_AudioInfo</a> *desired,</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  Uint32 bufferSize);</div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> </div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> SNDDECLSPEC <a class="code" href="structSound__Sample.html">Sound_Sample</a> * SDLCALL <a class="code" href="SDL__sound_8h.html#a0869896a4bb39ee002257aa1cb3c39ec">Sound_NewSampleFromFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname,</div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <a class="code" href="structSound__AudioInfo.html">Sound_AudioInfo</a> *desired,</div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  Uint32 bufferSize);</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> </div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> SNDDECLSPEC <span class="keywordtype">void</span> SDLCALL <a class="code" href="SDL__sound_8h.html#a7f16cbb883e57b772bae0507ac4d5488">Sound_FreeSample</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample);</div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> </div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> </div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> SNDDECLSPEC <span class="keywordtype">int</span> SDLCALL <a class="code" href="SDL__sound_8h.html#ac09076aa2bdc14d08130e25a6915279d">Sound_SetBufferSize</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample,</div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  Uint32 new_size);</div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> </div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> </div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> SNDDECLSPEC Uint32 SDLCALL <a class="code" href="SDL__sound_8h.html#a6dbdf33dc4bc6b832fec2f4ffe5d546e">Sound_Decode</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample);</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> </div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> </div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> SNDDECLSPEC Uint32 SDLCALL <a class="code" href="SDL__sound_8h.html#a07f8d77bb5449be3707625f58de1aba7">Sound_DecodeAll</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample);</div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> </div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> </div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> SNDDECLSPEC <span class="keywordtype">int</span> SDLCALL <a class="code" href="SDL__sound_8h.html#a720f92a75c0340c879c945ec3e9fdf70">Sound_Rewind</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample);</div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> </div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> </div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> SNDDECLSPEC <span class="keywordtype">int</span> SDLCALL <a class="code" href="SDL__sound_8h.html#ad8b48e7fdb78c95e7ff88cea097af18b">Sound_Seek</a>(<a class="code" href="structSound__Sample.html">Sound_Sample</a> *sample, Uint32 ms);</div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> </div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="preprocessor">#endif </span><span class="comment">/* !defined _INCLUDE_SDL_SOUND_H_ */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment">/* end of SDL_sound.h ... */</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> </div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625a5d6c02e3276932f2217ee09a51eed65f"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a5d6c02e3276932f2217ee09a51eed65f">SOUND_SAMPLEFLAG_ERROR</a></div><div class="ttdef"><b>Definition:</b> SDL_sound.h:116</div></div>
<div class="ttc" id="structSound__Version_html"><div class="ttname"><a href="structSound__Version.html">Sound_Version</a></div><div class="ttdoc">Information the version of SDL_sound in use. </div><div class="ttdef"><b>Definition:</b> SDL_sound.h:204</div></div>
<div class="ttc" id="SDL__sound_8h_html_a6dbdf33dc4bc6b832fec2f4ffe5d546e"><div class="ttname"><a href="SDL__sound_8h.html#a6dbdf33dc4bc6b832fec2f4ffe5d546e">Sound_Decode</a></div><div class="ttdeci">Uint32 Sound_Decode(Sound_Sample *sample)</div><div class="ttdoc">Decode more of the sound data in a Sound_Sample. </div></div>
<div class="ttc" id="structSound__Version_html_a095420931df560c545e0cf0d6fecf56a"><div class="ttname"><a href="structSound__Version.html#a095420931df560c545e0cf0d6fecf56a">Sound_Version::minor</a></div><div class="ttdeci">int minor</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:207</div></div>
<div class="ttc" id="structSound__Version_html_a68ed43edb6114f117edd45084baae1b4"><div class="ttname"><a href="structSound__Version.html#a68ed43edb6114f117edd45084baae1b4">Sound_Version::major</a></div><div class="ttdeci">int major</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:206</div></div>
<div class="ttc" id="structSound__AudioInfo_html_a2a7fe880d009e698eb0d52cde3ddfc80"><div class="ttname"><a href="structSound__AudioInfo.html#a2a7fe880d009e698eb0d52cde3ddfc80">Sound_AudioInfo::channels</a></div><div class="ttdeci">Uint8 channels</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:136</div></div>
<div class="ttc" id="structSound__AudioInfo_html"><div class="ttname"><a href="structSound__AudioInfo.html">Sound_AudioInfo</a></div><div class="ttdoc">Information about an existing sample&#39;s format. </div><div class="ttdef"><b>Definition:</b> SDL_sound.h:133</div></div>
<div class="ttc" id="structSound__Sample_html"><div class="ttname"><a href="structSound__Sample.html">Sound_Sample</a></div><div class="ttdoc">Represents sound data in the process of being decoded. </div><div class="ttdef"><b>Definition:</b> SDL_sound.h:179</div></div>
<div class="ttc" id="structSound__DecoderInfo_html_aa983be8195cd74f7dcaab2f4788309fb"><div class="ttname"><a href="structSound__DecoderInfo.html#aa983be8195cd74f7dcaab2f4788309fb">Sound_DecoderInfo::url</a></div><div class="ttdeci">const char * url</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:165</div></div>
<div class="ttc" id="SDL__sound_8h_html_adb99dd3e7266c234e437bebf3be9e061"><div class="ttname"><a href="SDL__sound_8h.html#adb99dd3e7266c234e437bebf3be9e061">Sound_GetError</a></div><div class="ttdeci">const char * Sound_GetError(void)</div><div class="ttdoc">Get the last SDL_sound error message as a null-terminated string. </div></div>
<div class="ttc" id="SDL__sound_8h_html_a10b9c44cc1cc2ff8a93977b43870cb53"><div class="ttname"><a href="SDL__sound_8h.html#a10b9c44cc1cc2ff8a93977b43870cb53">Sound_NewSample</a></div><div class="ttdeci">Sound_Sample * Sound_NewSample(SDL_RWops *rw, const char *ext, Sound_AudioInfo *desired, Uint32 bufferSize)</div><div class="ttdoc">Start decoding a new sound sample. </div></div>
<div class="ttc" id="SDL__sound_8h_html_abda6027ae5b226e626a9e1ea1f6e626c"><div class="ttname"><a href="SDL__sound_8h.html#abda6027ae5b226e626a9e1ea1f6e626c">Sound_GetLinkedVersion</a></div><div class="ttdeci">void Sound_GetLinkedVersion(Sound_Version *ver)</div><div class="ttdoc">Get the version of SDL_sound that is linked against your program. </div></div>
<div class="ttc" id="SDL__sound_8h_html_a94408f49764dc122b0fad0397dccc941"><div class="ttname"><a href="SDL__sound_8h.html#a94408f49764dc122b0fad0397dccc941">Sound_Quit</a></div><div class="ttdeci">int Sound_Quit(void)</div><div class="ttdoc">Shutdown SDL_sound. </div></div>
<div class="ttc" id="structSound__DecoderInfo_html_a1d3c5d5d46b0f5e5026944002e1d6e36"><div class="ttname"><a href="structSound__DecoderInfo.html#a1d3c5d5d46b0f5e5026944002e1d6e36">Sound_DecoderInfo::author</a></div><div class="ttdeci">const char * author</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:164</div></div>
<div class="ttc" id="SDL__sound_8h_html_ac09076aa2bdc14d08130e25a6915279d"><div class="ttname"><a href="SDL__sound_8h.html#ac09076aa2bdc14d08130e25a6915279d">Sound_SetBufferSize</a></div><div class="ttdeci">int Sound_SetBufferSize(Sound_Sample *sample, Uint32 new_size)</div><div class="ttdoc">Change the current buffer size for a sample. </div></div>
<div class="ttc" id="structSound__DecoderInfo_html_ac1241b30e4121aedd4286351b27f93d5"><div class="ttname"><a href="structSound__DecoderInfo.html#ac1241b30e4121aedd4286351b27f93d5">Sound_DecoderInfo::description</a></div><div class="ttdeci">const char * description</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:163</div></div>
<div class="ttc" id="structSound__AudioInfo_html_abc8310e37ae527e5d92e675655d944ee"><div class="ttname"><a href="structSound__AudioInfo.html#abc8310e37ae527e5d92e675655d944ee">Sound_AudioInfo::rate</a></div><div class="ttdeci">Uint32 rate</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:137</div></div>
<div class="ttc" id="SDL__sound_8h_html_a44e4cafdb81fc9f9135796bcfd3fb44f"><div class="ttname"><a href="SDL__sound_8h.html#a44e4cafdb81fc9f9135796bcfd3fb44f">Sound_Init</a></div><div class="ttdeci">int Sound_Init(void)</div><div class="ttdoc">Initialize SDL_sound. </div></div>
<div class="ttc" id="SDL__sound_8h_html_a7f16cbb883e57b772bae0507ac4d5488"><div class="ttname"><a href="SDL__sound_8h.html#a7f16cbb883e57b772bae0507ac4d5488">Sound_FreeSample</a></div><div class="ttdeci">void Sound_FreeSample(Sound_Sample *sample)</div><div class="ttdoc">Dispose of a Sound_Sample. </div></div>
<div class="ttc" id="structSound__Version_html_a7ebc29f83c1a812ee24b556ad6dfc1f4"><div class="ttname"><a href="structSound__Version.html#a7ebc29f83c1a812ee24b556ad6dfc1f4">Sound_Version::patch</a></div><div class="ttdeci">int patch</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:208</div></div>
<div class="ttc" id="SDL__sound_8h_html_abbae3fccdec9fad347aa71a29bd4f074"><div class="ttname"><a href="SDL__sound_8h.html#abbae3fccdec9fad347aa71a29bd4f074">Sound_AvailableDecoders</a></div><div class="ttdeci">const Sound_DecoderInfo ** Sound_AvailableDecoders(void)</div><div class="ttdoc">Get a list of sound formats supported by this version of SDL_sound. </div></div>
<div class="ttc" id="structSound__Sample_html_a4862ebaacdb0d4ec3aa3f7874ef2b903"><div class="ttname"><a href="structSound__Sample.html#a4862ebaacdb0d4ec3aa3f7874ef2b903">Sound_Sample::actual</a></div><div class="ttdeci">Sound_AudioInfo actual</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:184</div></div>
<div class="ttc" id="SDL__sound_8h_html_a7c0a82fc646c5b819b8d0e81bea029fb"><div class="ttname"><a href="SDL__sound_8h.html#a7c0a82fc646c5b819b8d0e81bea029fb">Sound_ClearError</a></div><div class="ttdeci">void Sound_ClearError(void)</div><div class="ttdoc">Clear the current error message. </div></div>
<div class="ttc" id="SDL__sound_8h_html_a07f8d77bb5449be3707625f58de1aba7"><div class="ttname"><a href="SDL__sound_8h.html#a07f8d77bb5449be3707625f58de1aba7">Sound_DecodeAll</a></div><div class="ttdeci">Uint32 Sound_DecodeAll(Sound_Sample *sample)</div><div class="ttdoc">Decode the remainder of the sound data in a Sound_Sample. </div></div>
<div class="ttc" id="structSound__Sample_html_af9b14d108498631919187832d74efa11"><div class="ttname"><a href="structSound__Sample.html#af9b14d108498631919187832d74efa11">Sound_Sample::opaque</a></div><div class="ttdeci">void * opaque</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:181</div></div>
<div class="ttc" id="structSound__Sample_html_a0aa7f52ce553407fdff6947b50626b2b"><div class="ttname"><a href="structSound__Sample.html#a0aa7f52ce553407fdff6947b50626b2b">Sound_Sample::flags</a></div><div class="ttdeci">Sound_SampleFlags flags</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:187</div></div>
<div class="ttc" id="SDL__sound_8h_html_a720f92a75c0340c879c945ec3e9fdf70"><div class="ttname"><a href="SDL__sound_8h.html#a720f92a75c0340c879c945ec3e9fdf70">Sound_Rewind</a></div><div class="ttdeci">int Sound_Rewind(Sound_Sample *sample)</div><div class="ttdoc">Rewind a sample to the start. </div></div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625ae0b562eebb0bf6cdf3da87eb1b4914be"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ae0b562eebb0bf6cdf3da87eb1b4914be">SOUND_SAMPLEFLAG_EOF</a></div><div class="ttdef"><b>Definition:</b> SDL_sound.h:115</div></div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625ab269a22d877556f5569dc737ad984e1a"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625ab269a22d877556f5569dc737ad984e1a">SOUND_SAMPLEFLAG_EAGAIN</a></div><div class="ttdef"><b>Definition:</b> SDL_sound.h:117</div></div>
<div class="ttc" id="SDL__sound_8h_html_ad8b48e7fdb78c95e7ff88cea097af18b"><div class="ttname"><a href="SDL__sound_8h.html#ad8b48e7fdb78c95e7ff88cea097af18b">Sound_Seek</a></div><div class="ttdeci">int Sound_Seek(Sound_Sample *sample, Uint32 ms)</div><div class="ttdoc">Seek to a different point in a sample. </div></div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625a334d72e6e376dae44baa66746398bbaa"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a334d72e6e376dae44baa66746398bbaa">SOUND_SAMPLEFLAG_CANSEEK</a></div><div class="ttdef"><b>Definition:</b> SDL_sound.h:112</div></div>
<div class="ttc" id="structSound__Sample_html_a160959b8f33b039d54e6a64452d3d9e7"><div class="ttname"><a href="structSound__Sample.html#a160959b8f33b039d54e6a64452d3d9e7">Sound_Sample::buffer</a></div><div class="ttdeci">void * buffer</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:185</div></div>
<div class="ttc" id="structSound__DecoderInfo_html_a9f11db9acb555302fd84509198683e2a"><div class="ttname"><a href="structSound__DecoderInfo.html#a9f11db9acb555302fd84509198683e2a">Sound_DecoderInfo::extensions</a></div><div class="ttdeci">const char ** extensions</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:162</div></div>
<div class="ttc" id="structSound__AudioInfo_html_afc1f02fd774a0e1d35109360496390eb"><div class="ttname"><a href="structSound__AudioInfo.html#afc1f02fd774a0e1d35109360496390eb">Sound_AudioInfo::format</a></div><div class="ttdeci">Uint16 format</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:135</div></div>
<div class="ttc" id="structSound__Sample_html_a03ef7710992520e65edacc9ad694b034"><div class="ttname"><a href="structSound__Sample.html#a03ef7710992520e65edacc9ad694b034">Sound_Sample::decoder</a></div><div class="ttdeci">const Sound_DecoderInfo * decoder</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:182</div></div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a></div><div class="ttdeci">Sound_SampleFlags</div><div class="ttdoc">Flags that are used in a Sound_Sample to show various states. </div><div class="ttdef"><b>Definition:</b> SDL_sound.h:107</div></div>
<div class="ttc" id="SDL__sound_8h_html_a0869896a4bb39ee002257aa1cb3c39ec"><div class="ttname"><a href="SDL__sound_8h.html#a0869896a4bb39ee002257aa1cb3c39ec">Sound_NewSampleFromFile</a></div><div class="ttdeci">Sound_Sample * Sound_NewSampleFromFile(const char *fname, Sound_AudioInfo *desired, Uint32 bufferSize)</div><div class="ttdoc">Start decoding a new sound sample from a file on disk. </div></div>
<div class="ttc" id="structSound__Sample_html_a7bd0273a97a4044e8dbf2bbba36ca176"><div class="ttname"><a href="structSound__Sample.html#a7bd0273a97a4044e8dbf2bbba36ca176">Sound_Sample::buffer_size</a></div><div class="ttdeci">Uint32 buffer_size</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:186</div></div>
<div class="ttc" id="structSound__DecoderInfo_html"><div class="ttname"><a href="structSound__DecoderInfo.html">Sound_DecoderInfo</a></div><div class="ttdoc">Information about available soudn decoders. </div><div class="ttdef"><b>Definition:</b> SDL_sound.h:160</div></div>
<div class="ttc" id="SDL__sound_8h_html_abf2c8cef39e83f01531f0bf255bdc625a192a6518e94eabf9cd5c45babc9635ee"><div class="ttname"><a href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625a192a6518e94eabf9cd5c45babc9635ee">SOUND_SAMPLEFLAG_NONE</a></div><div class="ttdef"><b>Definition:</b> SDL_sound.h:109</div></div>
<div class="ttc" id="structSound__Sample_html_aca3059080501599b2fef90032122108d"><div class="ttname"><a href="structSound__Sample.html#aca3059080501599b2fef90032122108d">Sound_Sample::desired</a></div><div class="ttdeci">Sound_AudioInfo desired</div><div class="ttdef"><b>Definition:</b> SDL_sound.h:183</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 22:15:33 for SDL_sound by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
