nishi/nishbox
1
Fork 0
mirror of https://github.com/nishiowo/nishbox synced 2025-04-21 20:24:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
nishbox/engine/audio_8h_source.html

171 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GoldFish Engine: include/gf_type/audio.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="goldfish.png"/></td>
<td id="projectalign">
<div id="projectname">GoldFish Engine
</div>
<div id="projectbrief">Quite simple and lightweight game engine</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('audio_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">audio.h</div></div>
</div><!--header-->
<div class="contents">
<a href="audio_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef __GF_TYPE_AUDIO_H__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define __GF_TYPE_AUDIO_H__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="code" href="gf__pre_8h.html">gf_pre.h</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;<a class="code" href="gf__macro_8h.html">gf_macro.h</a>&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#ifdef GF_EXPOSE_AUDIO</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a> <a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a> <a class="code hl_struct" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/* External library */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;miniaudio.h&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;jar_xm.h&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;jar_mod.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/* Engine */</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;<a class="code" href="core_8h.html">gf_type/core.h</a>&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">/* Standard */</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="audio_8h.html#a6d19d179e9a386872980ec047b37345c"> 31</a></span><span class="preprocessor">#define GF_AUDIO_MAX_DECODERS 64</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><a class="code hl_define" href="gf__macro_8h.html#a018031ff5fba22b9d5052a55f8c9a377">GF_DECLARE_TYPE</a>(audio_decoder, {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> ma_decoder_config <a class="code hl_variable" href="structgf__audio__decoder__t.html#a3bf94e1820e821535b56790c58c970a5">decoder_config</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> ma_decoder* <a class="code hl_variable" href="structgf__audio__decoder__t.html#ad67a57c8f3ddf0b79b18e0f1c2754581">decoder</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> jar_xm_context_t* <a class="code hl_variable" href="structgf__audio__decoder__t.html#a235fb4ae132de9acce9b313bba264393">xm</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> jar_mod_context_t* <a class="code hl_variable" href="structgf__audio__decoder__t.html#a85b2f1e6b87106f02d51ea0b91989ffc">mod</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structgf__audio__decoder__t.html#a68358269fb9d3e8501f3b2c861e08663">samples</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structgf__audio__decoder__t.html#a570e988d60764a3ce263c8185081886b">used</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structgf__audio__decoder__t.html#ad67a57c8f3ddf0b79b18e0f1c2754581"> 63</a></span>});</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><a class="code hl_define" href="gf__macro_8h.html#a018031ff5fba22b9d5052a55f8c9a377">GF_DECLARE_TYPE</a>(audio, {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_struct" href="structgf__engine__t.html">gf_engine_t</a>* engine;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> ma_device_config device_config;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> ma_device* device;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_struct" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a> <a class="code hl_variable" href="structgf__audio__decoder__t.html#ad67a57c8f3ddf0b79b18e0f1c2754581">decoder</a>[<a class="code hl_define" href="audio_8h.html#a6d19d179e9a386872980ec047b37345c">GF_AUDIO_MAX_DECODERS</a>];</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structgf__audio__t.html#a9494a0d7083e3eff5ba66d7d26cce1ac"> 87</a></span>});</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code hl_struct" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aaudio_8h_html_a6d19d179e9a386872980ec047b37345c"><div class="ttname"><a href="audio_8h.html#a6d19d179e9a386872980ec047b37345c">GF_AUDIO_MAX_DECODERS</a></div><div class="ttdeci">#define GF_AUDIO_MAX_DECODERS</div><div class="ttdoc">Max decoders audio interface can handle.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00031">audio.h:31</a></div></div>
<div class="ttc" id="acore_8h_html"><div class="ttname"><a href="core_8h.html">core.h</a></div><div class="ttdoc">Type definitions related to core.</div></div>
<div class="ttc" id="agf__macro_8h_html"><div class="ttname"><a href="gf__macro_8h.html">gf_macro.h</a></div><div class="ttdoc">Macro.</div></div>
<div class="ttc" id="agf__macro_8h_html_a018031ff5fba22b9d5052a55f8c9a377"><div class="ttname"><a href="gf__macro_8h.html#a018031ff5fba22b9d5052a55f8c9a377">GF_DECLARE_TYPE</a></div><div class="ttdeci">#define GF_DECLARE_TYPE(n, b)</div><div class="ttdoc">Macro to define engine type shorter.</div><div class="ttdef"><b>Definition</b> <a href="gf__macro_8h_source.html#l00180">gf_macro.h:180</a></div></div>
<div class="ttc" id="agf__pre_8h_html"><div class="ttname"><a href="gf__pre_8h.html">gf_pre.h</a></div><div class="ttdoc">Required headers before anything.</div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html"><div class="ttname"><a href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a></div><div class="ttdoc">Audio decoder.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_a235fb4ae132de9acce9b313bba264393"><div class="ttname"><a href="structgf__audio__decoder__t.html#a235fb4ae132de9acce9b313bba264393">gf_audio_decoder_t::xm</a></div><div class="ttdeci">jar_xm_context_t * xm</div><div class="ttdoc">XM context.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_a3bf94e1820e821535b56790c58c970a5"><div class="ttname"><a href="structgf__audio__decoder__t.html#a3bf94e1820e821535b56790c58c970a5">gf_audio_decoder_t::decoder_config</a></div><div class="ttdeci">ma_decoder_config decoder_config</div><div class="ttdoc">miniaudio decoder config</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_a570e988d60764a3ce263c8185081886b"><div class="ttname"><a href="structgf__audio__decoder__t.html#a570e988d60764a3ce263c8185081886b">gf_audio_decoder_t::used</a></div><div class="ttdeci">int used</div><div class="ttdoc">1 if used, otherwise 0</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_a68358269fb9d3e8501f3b2c861e08663"><div class="ttname"><a href="structgf__audio__decoder__t.html#a68358269fb9d3e8501f3b2c861e08663">gf_audio_decoder_t::samples</a></div><div class="ttdeci">int samples</div><div class="ttdoc">Remaining samples.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_a85b2f1e6b87106f02d51ea0b91989ffc"><div class="ttname"><a href="structgf__audio__decoder__t.html#a85b2f1e6b87106f02d51ea0b91989ffc">gf_audio_decoder_t::mod</a></div><div class="ttdeci">jar_mod_context_t * mod</div><div class="ttdoc">MOD context.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html_ad67a57c8f3ddf0b79b18e0f1c2754581"><div class="ttname"><a href="structgf__audio__decoder__t.html#ad67a57c8f3ddf0b79b18e0f1c2754581">gf_audio_decoder_t::decoder</a></div><div class="ttdeci">ma_decoder * decoder</div><div class="ttdoc">miniaudio decoder</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00063">audio.h:63</a></div></div>
<div class="ttc" id="astructgf__audio__t_html"><div class="ttname"><a href="structgf__audio__t.html">gf_audio_t</a></div><div class="ttdoc">Audio interface.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00087">audio.h:87</a></div></div>
<div class="ttc" id="astructgf__engine__t_html"><div class="ttname"><a href="structgf__engine__t.html">gf_engine_t</a></div><div class="ttdoc">Engine instance.</div><div class="ttdef"><b>Definition</b> <a href="core_8h_source.html#l00046">core.h:46</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e60f2706c8c207c5a951446d03370319.html">gf_type</a></li><li class="navelem"><a class="el" href="audio_8h.html">audio.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink