Google Git
Sign in
pigweed/third_party/github/32blit/32blit-sdk/refs/heads/upstream/gh-pages/./audio_8hpp_source.html
blob: 0d356a6f42aea682bfa5e81bc55af08a85195cec [file] [log] [blame] [edit]
<!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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>32blit API: audio/audio.hpp 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">32blit API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('audio_8hpp_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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">audio.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblit.html">blit</a> {</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <span class="comment">// The duration a note is played is determined by the amount of attack,</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; <span class="comment">// decay, and release, combined with the length of the note as defined by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="comment">// the user.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="comment">// - Attack: number of milliseconds it takes for a note to hit full volume</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="comment">// - Decay: number of milliseconds it takes for a note to settle to sustain volume</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="comment">// - Sustain: percentage of full volume that the note sustains at (duration implied by other factors)</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="comment">// - Release: number of milliseconds it takes for a note to reduce to zero volume after it has ended</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="comment">// Attack (750ms) - Decay (500ms) -------- Sustain ----- Release (250ms)</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// + + + +</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// | | | |</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="comment">// | | | |</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">// | | | |</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// v v v v</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// 0ms 1000ms 2000ms 3000ms 4000ms</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// | XXXX | | | |</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// | X X|XX | | |</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">// | X | XXX | | |</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="comment">// | X | XXXXXXXXXXXXXX|XXXXXXXXXXXXXXXXXXX| |</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// | X | | |X |</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// | X | | |X |</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// | X | | | X |</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// | X + + + | + + + | + + + | + + + | +</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// | X | | | | | | | | | | | | | | | | |</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// |X | | | | | | | | | | | | | | | | |</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// +----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+---&gt;</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor"> #define CHANNEL_COUNT 8</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> uint32_t sample_rate = 22050;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">extern</span> uint16_t volume;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">enum</span> Waveform {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; NOISE = 128,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; SQUARE = 64,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; SAW = 32,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; TRIANGLE = 16,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; SINE = 8,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; WAVE = 1</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; };</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">enum class</span> ADSRPhase : uint8_t {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; ATTACK,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; DECAY,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; SUSTAIN,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; RELEASE,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; OFF</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; };</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structblit_1_1AudioChannel.html"> 64</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1AudioChannel.html">AudioChannel</a> {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint8_t waveforms = 0; <span class="comment">// bitmask for enabled waveforms (see AudioWaveform enum for values)</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint16_t frequency = 660; <span class="comment">// frequency of the voice (Hz)</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; uint16_t volume = 0xffff; <span class="comment">// channel volume (default 50%)</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; uint16_t attack_ms = 2; <span class="comment">// attack period</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint16_t decay_ms = 6; <span class="comment">// decay period</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; uint16_t sustain = 0xffff; <span class="comment">// sustain volume</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint16_t release_ms = 1; <span class="comment">// release period</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; uint16_t pulse_width = 0x7fff; <span class="comment">// duty cycle of square wave (default 50%)</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; int16_t noise = 0; <span class="comment">// current noise value</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; uint32_t waveform_offset = 0; <span class="comment">// voice offset (Q8)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; int32_t filter_last_sample = 0;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">bool</span> filter_enable = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; uint16_t filter_cutoff_frequency = 0;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; uint32_t adsr_frame = 0; <span class="comment">// number of frames into the current ADSR phase</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; uint32_t adsr_end_frame = 0; <span class="comment">// frame target at which the ADSR changes to the next phase</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; uint32_t adsr = 0;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; int32_t adsr_step = 0;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; ADSRPhase adsr_phase = ADSRPhase::OFF;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; uint8_t wave_buf_pos = 0; <span class="comment">//</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; int16_t wave_buffer[64]; <span class="comment">// buffer for arbitrary waveforms. small as it&#39;s filled by user callback</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">void</span> *user_data = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; void (*wave_buffer_callback)(<a class="code" href="structblit_1_1AudioChannel.html">AudioChannel</a> &amp;channel);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> trigger_attack() {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; adsr_frame = 0;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; adsr_phase = ADSRPhase::ATTACK;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; adsr_end_frame = (attack_ms * sample_rate) / 1000;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; adsr_step = (int32_t(0xffffff) - int32_t(adsr)) / int32_t(adsr_end_frame);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordtype">void</span> trigger_decay() {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; adsr_frame = 0;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; adsr_phase = ADSRPhase::DECAY;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; adsr_end_frame = (decay_ms * sample_rate) / 1000;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; adsr_step = (int32_t(sustain &lt;&lt; 8) - int32_t(adsr)) / int32_t(adsr_end_frame);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">void</span> trigger_sustain() {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">if</span>(sustain == 0) {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; off();</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; adsr_frame = 0;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; adsr_phase = ADSRPhase::SUSTAIN;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; adsr_end_frame = 0;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; adsr_step = 0;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; adsr = int32_t(sustain &lt;&lt; 8);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordtype">void</span> trigger_release() {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; adsr_frame = 0;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; adsr_phase = ADSRPhase::RELEASE;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; adsr_end_frame = (release_ms * sample_rate) / 1000;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; adsr_step = (int32_t(0) - int32_t(adsr)) / int32_t(adsr_end_frame);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> off() {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; adsr_frame = 0;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; adsr_phase = ADSRPhase::OFF;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; adsr_step = 0;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; }</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; };</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">extern</span> <a class="code" href="structblit_1_1AudioChannel.html">AudioChannel</a> * <span class="keyword">const</span> &amp;channels;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; uint16_t get_audio_frame();</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">bool</span> is_audio_playing();</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;}</div>
<div class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div>
<div class="ttc" id="astructblit_1_1AudioChannel_html"><div class="ttname"><a href="structblit_1_1AudioChannel.html">blit::AudioChannel</a></div><div class="ttdef"><b>Definition:</b> audio.hpp:64</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_a5f32cf82ad289a7dac212f63f40f55b.html">audio</a></li><li class="navelem"><b>audio.hpp</b></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.1 </li>
</ul>
</div>
</body>
</html>