forked from pschatzmann/arduino-stk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNoise_8h_source.html
116 lines (116 loc) · 14.2 KB
/
Noise_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!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>Arduino STK: Noise.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino STK
 <span id="projectnumber">4.6.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Noise.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef STK_NOISE_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define STK_NOISE_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "Generator.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <stdlib.h></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespacestk.html">stk</a> {</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html"> 21</a></span> <span class="keyword">class </span><a class="code" href="classstk_1_1Noise.html">Noise</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Generator.html">Generator</a></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html#a2d442a08883be25f10952dff4e515f98"> 30</a></span>  <a class="code" href="classstk_1_1Noise.html#a2d442a08883be25f10952dff4e515f98">Noise</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seed = 0 );</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html#a9507ae6eb261c577a64b4ecb5c1805dc"> 37</a></span>  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Noise.html#a9507ae6eb261c577a64b4ecb5c1805dc">setSeed</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seed = 0 );</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html#a618499832b5d7c8915efc472a7cd01a3"> 40</a></span>  StkFloat <a class="code" href="classstk_1_1Noise.html#a618499832b5d7c8915efc472a7cd01a3">lastOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_[0]; };</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  StkFloat <a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">tick</a>( <span class="keywordtype">void</span> );</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">tick</a>( <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d"> 59</a></span> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">Noise :: tick</a>( <span class="keywordtype">void</span> )</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> lastFrame_[0] = (StkFloat) ( 2.0 * rand() / (RAND_MAX + 1.0) - 1.0 );</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classstk_1_1Noise.html#a2f92e91787dc19309305cf246632cd50"> 64</a></span> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">Noise :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#if defined(_STK_DEBUG_)</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">if</span> ( channel >= frames.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>() ) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  oStream_ << <span class="stringliteral">"Noise::tick(): channel and StkFrames arguments are incompatible!"</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a>( StkError::FUNCTION_ARGUMENT );</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  StkFloat *samples = &frames[channel];</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.<a class="code" href="classstk_1_1StkFrames.html#a0fc22e21feecdee966f0203722b9c168">frames</a>(); i++, samples += hop )</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  *samples = (StkFloat) ( 2.0 * rand() / (RAND_MAX + 1.0) - 1.0 );</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  lastFrame_[0] = *(samples-hop);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> frames;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> } <span class="comment">// stk namespace</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstk_1_1Generator_html"><div class="ttname"><a href="classstk_1_1Generator.html">stk::Generator</a></div><div class="ttdoc">STK abstract unit generator parent class.</div><div class="ttdef"><b>Definition:</b> Generator.h:21</div></div>
<div class="ttc" id="aclassstk_1_1Noise_html"><div class="ttname"><a href="classstk_1_1Noise.html">stk::Noise</a></div><div class="ttdoc">STK noise generator.</div><div class="ttdef"><b>Definition:</b> Noise.h:22</div></div>
<div class="ttc" id="aclassstk_1_1Noise_html_a2d442a08883be25f10952dff4e515f98"><div class="ttname"><a href="classstk_1_1Noise.html#a2d442a08883be25f10952dff4e515f98">stk::Noise::Noise</a></div><div class="ttdeci">Noise(unsigned int seed=0)</div><div class="ttdoc">Default constructor that can also take a specific seed value.</div></div>
<div class="ttc" id="aclassstk_1_1Noise_html_a618499832b5d7c8915efc472a7cd01a3"><div class="ttname"><a href="classstk_1_1Noise.html#a618499832b5d7c8915efc472a7cd01a3">stk::Noise::lastOut</a></div><div class="ttdeci">StkFloat lastOut(void) const</div><div class="ttdoc">Return the last computed output value.</div><div class="ttdef"><b>Definition:</b> Noise.h:40</div></div>
<div class="ttc" id="aclassstk_1_1Noise_html_a8ac40f69475eb744e803d557e8438a6d"><div class="ttname"><a href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">stk::Noise::tick</a></div><div class="ttdeci">StkFloat tick(void)</div><div class="ttdoc">Compute and return one output sample.</div><div class="ttdef"><b>Definition:</b> Noise.h:59</div></div>
<div class="ttc" id="aclassstk_1_1Noise_html_a9507ae6eb261c577a64b4ecb5c1805dc"><div class="ttname"><a href="classstk_1_1Noise.html#a9507ae6eb261c577a64b4ecb5c1805dc">stk::Noise::setSeed</a></div><div class="ttdeci">void setSeed(unsigned int seed=0)</div><div class="ttdoc">Seed the random number generator with a specific seed value.</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html"><div class="ttname"><a href="classstk_1_1StkFrames.html">stk::StkFrames</a></div><div class="ttdoc">An STK class to handle vectorized audio data.</div><div class="ttdef"><b>Definition:</b> Stk.h:287</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a0340d9e76707282658e49509a568f60e"><div class="ttname"><a href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">stk::StkFrames::channels</a></div><div class="ttdeci">unsigned int channels(void) const</div><div class="ttdoc">Return the number of channels represented by the data.</div><div class="ttdef"><b>Definition:</b> Stk.h:415</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a0fc22e21feecdee966f0203722b9c168"><div class="ttname"><a href="classstk_1_1StkFrames.html#a0fc22e21feecdee966f0203722b9c168">stk::StkFrames::frames</a></div><div class="ttdeci">unsigned int frames(void) const</div><div class="ttdoc">Return the number of sample frames represented by the data.</div><div class="ttdef"><b>Definition:</b> Stk.h:418</div></div>
<div class="ttc" id="aclassstk_1_1Stk_html_a48ac73a0d8ca28445ba1a054e1f061ff"><div class="ttname"><a href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">stk::Stk::handleError</a></div><div class="ttdeci">static void handleError(const char *message, StkError::Type type)</div><div class="ttdoc">Static function for error reporting and handling using c-strings.</div></div>
<div class="ttc" id="anamespacestk_html"><div class="ttname"><a href="namespacestk.html">stk</a></div><div class="ttdoc">The STK namespace.</div><div class="ttdef"><b>Definition:</b> ADSR.h:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>