Files
SpaghettiKart/audio_2effects_8h_source.html
T

186 lines
19 KiB
HTML

<!-- HTML header for doxygen 1.10.0-->
<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Mario Kart 64: src/audio/effects.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</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="projectalign">
<div id="projectname">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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 */
$(function(){initNavTree('audio_2effects_8h_source.html',''); initResizable(true); });
/* @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">effects.h</div></div>
</div><!--header-->
<div class="contents">
<a href="audio_2effects_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><span class="preprocessor">#ifndef AUDIO_EFFECTS_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define AUDIO_EFFECTS_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="internal_8h.html">audio/internal.h</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#ifdef TARGET_N64</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#define IS_BIG_ENDIAN 1</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#endif</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"><a class="line" href="audio_2effects_8h.html#a23b1b4daead804264c5fd03d47889286"> 10</a></span><span class="preprocessor">#define ADSR_STATE_DISABLED 0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a8af4fa575c9fbaa74bb0a91c949b681a"> 11</a></span><span class="preprocessor">#define ADSR_STATE_INITIAL 1</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a3c95c3e3185fa03213335743064a4103"> 12</a></span><span class="preprocessor">#define ADSR_STATE_START_LOOP 2</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#ab2be41bff75fa967ef84c2144e290be5"> 13</a></span><span class="preprocessor">#define ADSR_STATE_LOOP 3</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a30dd4b4d27a91d171836e2ee82e74f70"> 14</a></span><span class="preprocessor">#define ADSR_STATE_FADE 4</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a1af83ceb357c7647abf46b599cdd25c7"> 15</a></span><span class="preprocessor">#define ADSR_STATE_HANG 5</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a309cec7aabb97d263db3f22a7b9cdd76"> 16</a></span><span class="preprocessor">#define ADSR_STATE_DECAY 6</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a0f4bf3b5191ae99db4692c97d7aaca30"> 17</a></span><span class="preprocessor">#define ADSR_STATE_RELEASE 7</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#ab3124561f1d3dafded5ed2f649b6f010"> 18</a></span><span class="preprocessor">#define ADSR_STATE_SUSTAIN 8</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a5fb66c127ca880b720cb7bab29046c16"> 20</a></span><span class="preprocessor">#define ADSR_ACTION_RELEASE 0x10</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a22aa905324ebd351c4902a6b073aae91"> 21</a></span><span class="preprocessor">#define ADSR_ACTION_DECAY 0x20</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#ab96273a1a24a139484d54ecf0275039e"> 22</a></span><span class="preprocessor">#define ADSR_ACTION_HANG 0x40</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a6c3ac05c21e6e244eab37792cc9a84ae"> 24</a></span><span class="preprocessor">#define ADSR_DISABLE 0</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a24a53d690387e93797cae96d4034cfa3"> 25</a></span><span class="preprocessor">#define ADSR_HANG -1</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a30d0dec0168d06abcd8fc0a86ec5ebb0"> 26</a></span><span class="preprocessor">#define ADSR_GOTO -2</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a2e128ab66fb03a6bdfbcb18ff3bfb39e"> 27</a></span><span class="preprocessor">#define ADSR_RESTART -3</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// Envelopes are always stored as big endian, to match sequence files which are</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// byte blobs and can embed envelopes. Hence this byteswapping macro.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#if IS_BIG_ENDIAN</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#define BSWAP16(x) (x)</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a5b9670220af6a7b1f964e53887255cab"> 34</a></span><span class="preprocessor">#define BSWAP16(x) (((x) &amp; 0xff) &lt;&lt; 8 | (((x) &gt;&gt; 8) &amp; 0xff))</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keywordtype">void</span> <a class="code hl_function" href="audio_2effects_8h.html#ad233b78e677de7deb61ad8146e56298a">sequence_channel_process_sound</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structSequenceChannel.html">SequenceChannel</a>* seqChannel, s32 recalculateVolume);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keywordtype">void</span> <a class="code hl_function" href="audio_2effects_8h.html#ac6b3be4c7d0c4a4f7f02153b12d59d38">sequence_player_process_sound</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structSequencePlayer.html">SequencePlayer</a>* seqPlayer);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>f32 <a class="code hl_function" href="audio_2effects_8h.html#a845808744962457cb36c3867fdf2457e">get_portamento_freq_scale</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structPortamento.html">Portamento</a>* p);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>s16 <a class="code hl_function" href="audio_2effects_8h.html#a928724b2f42c619cfb4bba62ffce4855">get_vibrato_pitch_change</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structVibratoState.html">VibratoState</a>* vib);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>f32 <a class="code hl_function" href="audio_2effects_8h.html#aa411cc3ba6223d8ee256d8e9861546e9">get_vibrato_freq_scale</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structVibratoState.html">VibratoState</a>* vib);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keywordtype">void</span> <a class="code hl_function" href="audio_2effects_8h.html#ab80cf39e4b3e31a75657ba722018d9b9">note_vibrato_update</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structNote.html">Note</a>* note);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keywordtype">void</span> <a class="code hl_function" href="audio_2effects_8h.html#a25e39b4b3790d36958bb854307d5f9d7">note_vibrato_init</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structNote.html">Note</a>* note);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="audio_2effects_8h.html#a60e2639f0631b10d12a682a643266614"> 44</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="audio_2effects_8h.html#a60e2639f0631b10d12a682a643266614">adsr_init</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structAdsrState.html">AdsrState</a>* adsr, <span class="keyword">struct</span> <a class="code hl_struct" href="structAdsrEnvelope.html">AdsrEnvelope</a>* envelope, s16* volOut);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>f32 <a class="code hl_function" href="audio_2effects_8h.html#a6201aa1f5129a2ef87c4d34a0cc935dc">adsr_update</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structAdsrState.html">AdsrState</a>* adsr);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#endif </span><span class="comment">/* AUDIO_EFFECTS_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aaudio_2effects_8h_html_a25e39b4b3790d36958bb854307d5f9d7"><div class="ttname"><a href="audio_2effects_8h.html#a25e39b4b3790d36958bb854307d5f9d7">note_vibrato_init</a></div><div class="ttdeci">void note_vibrato_init(struct Note *note)</div><div class="ttdef"><b>Definition</b> effects.c:166</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_a60e2639f0631b10d12a682a643266614"><div class="ttname"><a href="audio_2effects_8h.html#a60e2639f0631b10d12a682a643266614">adsr_init</a></div><div class="ttdeci">void adsr_init(struct AdsrState *adsr, struct AdsrEnvelope *envelope, s16 *volOut)</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_a6201aa1f5129a2ef87c4d34a0cc935dc"><div class="ttname"><a href="audio_2effects_8h.html#a6201aa1f5129a2ef87c4d34a0cc935dc">adsr_update</a></div><div class="ttdeci">f32 adsr_update(struct AdsrState *adsr)</div><div class="ttdef"><b>Definition</b> effects.c:206</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_a845808744962457cb36c3867fdf2457e"><div class="ttname"><a href="audio_2effects_8h.html#a845808744962457cb36c3867fdf2457e">get_portamento_freq_scale</a></div><div class="ttdeci">f32 get_portamento_freq_scale(struct Portamento *p)</div><div class="ttdef"><b>Definition</b> effects.c:86</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_a928724b2f42c619cfb4bba62ffce4855"><div class="ttname"><a href="audio_2effects_8h.html#a928724b2f42c619cfb4bba62ffce4855">get_vibrato_pitch_change</a></div><div class="ttdeci">s16 get_vibrato_pitch_change(struct VibratoState *vib)</div><div class="ttdef"><b>Definition</b> effects.c:101</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_aa411cc3ba6223d8ee256d8e9861546e9"><div class="ttname"><a href="audio_2effects_8h.html#aa411cc3ba6223d8ee256d8e9861546e9">get_vibrato_freq_scale</a></div><div class="ttdeci">f32 get_vibrato_freq_scale(struct VibratoState *vib)</div><div class="ttdef"><b>Definition</b> effects.c:108</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_ab80cf39e4b3e31a75657ba722018d9b9"><div class="ttname"><a href="audio_2effects_8h.html#ab80cf39e4b3e31a75657ba722018d9b9">note_vibrato_update</a></div><div class="ttdeci">void note_vibrato_update(struct Note *note)</div><div class="ttdef"><b>Definition</b> effects.c:157</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_ac6b3be4c7d0c4a4f7f02153b12d59d38"><div class="ttname"><a href="audio_2effects_8h.html#ac6b3be4c7d0c4a4f7f02153b12d59d38">sequence_player_process_sound</a></div><div class="ttdeci">void sequence_player_process_sound(struct SequencePlayer *seqPlayer)</div><div class="ttdef"><b>Definition</b> effects.c:50</div></div>
<div class="ttc" id="aaudio_2effects_8h_html_ad233b78e677de7deb61ad8146e56298a"><div class="ttname"><a href="audio_2effects_8h.html#ad233b78e677de7deb61ad8146e56298a">sequence_channel_process_sound</a></div><div class="ttdeci">void sequence_channel_process_sound(struct SequenceChannel *seqChannel, s32 recalculateVolume)</div><div class="ttdef"><b>Definition</b> effects.c:10</div></div>
<div class="ttc" id="ainternal_8h_html"><div class="ttname"><a href="internal_8h.html">internal.h</a></div></div>
<div class="ttc" id="astructAdsrEnvelope_html"><div class="ttname"><a href="structAdsrEnvelope.html">AdsrEnvelope</a></div><div class="ttdef"><b>Definition</b> internal.h:115</div></div>
<div class="ttc" id="astructAdsrState_html"><div class="ttname"><a href="structAdsrState.html">AdsrState</a></div><div class="ttdef"><b>Definition</b> internal.h:239</div></div>
<div class="ttc" id="astructNote_html"><div class="ttname"><a href="structNote.html">Note</a></div><div class="ttdef"><b>Definition</b> internal.h:435</div></div>
<div class="ttc" id="astructPortamento_html"><div class="ttname"><a href="structPortamento.html">Portamento</a></div><div class="ttdef"><b>Definition</b> internal.h:108</div></div>
<div class="ttc" id="astructSequenceChannel_html"><div class="ttname"><a href="structSequenceChannel.html">SequenceChannel</a></div><div class="ttdef"><b>Definition</b> internal.h:287</div></div>
<div class="ttc" id="astructSequencePlayer_html"><div class="ttname"><a href="structSequencePlayer.html">SequencePlayer</a></div><div class="ttdef"><b>Definition</b> internal.h:188</div></div>
<div class="ttc" id="astructVibratoState_html"><div class="ttname"><a href="structVibratoState.html">VibratoState</a></div><div class="ttdef"><b>Definition</b> internal.h:92</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a63dedf81f1e5ea1d42bb45ef831eb8c.html">audio</a></li><li class="navelem"><a class="el" href="audio_2effects_8h.html">effects.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.13.2 </li>
</ul>
</div>
</body>
</html>