forked from pschatzmann/arduino-stk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathInstrmnt_8h_source.html
137 lines (137 loc) · 20.5 KB
/
Instrmnt_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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!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: Instrmnt.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">Instrmnt.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_INSTRMNT_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define STK_INSTRMNT_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 "Stk.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">namespace </span><a class="code" href="namespacestk.html">stk</a> {</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="classstk_1_1Instrmnt.html">Instrmnt</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Stk.html">Stk</a></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a6f3c4dc01e0484f0ca4a3b14f1b7caf0"> 23</a></span>  <a class="code" href="classstk_1_1Instrmnt.html#a6f3c4dc01e0484f0ca4a3b14f1b7caf0">Instrmnt</a>( <span class="keywordtype">void</span> ) { lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#a386e1b86cf48f7a8117313f9e41fc0fe">resize</a>( 1, 1, 0.0 ); };</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="l00029"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a6506dcf2fd63805dc893cdb6d032d1fa"> 29</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a6506dcf2fd63805dc893cdb6d032d1fa">clear</a>( <span class="keywordtype">void</span> ) {};</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44"> 32</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44">noteOn</a>( StkFloat frequency, StkFloat amplitude ) = 0;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a582c77e71cd2c5cb46ba6f78fa0ac6a2"> 35</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a582c77e71cd2c5cb46ba6f78fa0ac6a2">noteOff</a>( StkFloat amplitude ) = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a597efc508ad367a308fa11b8cbdc96a7">setFrequency</a>( StkFloat frequency );</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a5aecf9f4d4dcecdbef8271c7fe62b2cf">controlChange</a>(<span class="keywordtype">int</span> number, StkFloat value);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a6e996529193c44b76679b88532bd8f0a"> 44</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classstk_1_1Instrmnt.html#a6e996529193c44b76679b88532bd8f0a">channelsOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>(); };</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a70faa1dab1e3707d057a53fd84eaba4b"> 47</a></span>  <span class="keyword">const</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Instrmnt.html#a70faa1dab1e3707d057a53fd84eaba4b">lastFrame</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_; };</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  StkFloat <a class="code" href="classstk_1_1Instrmnt.html#aaa6bd5e4a5be7f9b0be967daf012872e">lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#ad5d070c1fc6f93124dfed2a27b8e3cf1"> 64</a></span>  <span class="keyword">virtual</span> StkFloat <a class="code" href="classstk_1_1Instrmnt.html#ad5d070c1fc6f93124dfed2a27b8e3cf1">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 ) = 0;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6"> 74</a></span>  <span class="keyword">virtual</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">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 ) = 0;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">protected</span>:</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>  <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a> lastFrame_;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </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"><a class="line" href="classstk_1_1Instrmnt.html#a597efc508ad367a308fa11b8cbdc96a7"> 82</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a597efc508ad367a308fa11b8cbdc96a7">Instrmnt :: setFrequency</a>( StkFloat frequency )</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>  oStream_ << <span class="stringliteral">"Instrmnt::setFrequency: virtual setFrequency function call!"</span>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a>( StkError::WARNING );</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#aaa6bd5e4a5be7f9b0be967daf012872e"> 88</a></span> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Instrmnt.html#aaa6bd5e4a5be7f9b0be967daf012872e">Instrmnt :: lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#if defined(_STK_DEBUG_)</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">if</span> ( channel >= lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>() ) {</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  oStream_ << <span class="stringliteral">"Instrmnt::lastOut(): channel argument is invalid!"</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a>( StkError::FUNCTION_ARGUMENT );</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> lastFrame_[channel];</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classstk_1_1Instrmnt.html#a5aecf9f4d4dcecdbef8271c7fe62b2cf"> 100</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Instrmnt.html#a5aecf9f4d4dcecdbef8271c7fe62b2cf">Instrmnt :: controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value )</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  oStream_ << <span class="stringliteral">"Instrmnt::controlChange: virtual function call!"</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a>( StkError::WARNING );</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> } <span class="comment">// stk namespace</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html"><div class="ttname"><a href="classstk_1_1Instrmnt.html">stk::Instrmnt</a></div><div class="ttdoc">STK instrument abstract base class.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:20</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a0736ccd253b446660938d51909a32f44"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44">stk::Instrmnt::noteOn</a></div><div class="ttdeci">virtual void noteOn(StkFloat frequency, StkFloat amplitude)=0</div><div class="ttdoc">Start a note with the given frequency and amplitude.</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a34c6733ca145763462d9e44ae3c772b6"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt::tick</a></div><div class="ttdeci">virtual StkFrames & tick(StkFrames &frames, unsigned int channel=0)=0</div><div class="ttdoc">Fill the StkFrames object with computed sample frames, starting at the specified channel.</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a582c77e71cd2c5cb46ba6f78fa0ac6a2"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a582c77e71cd2c5cb46ba6f78fa0ac6a2">stk::Instrmnt::noteOff</a></div><div class="ttdeci">virtual void noteOff(StkFloat amplitude)=0</div><div class="ttdoc">Stop a note with the given amplitude (speed of decay).</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a597efc508ad367a308fa11b8cbdc96a7"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a597efc508ad367a308fa11b8cbdc96a7">stk::Instrmnt::setFrequency</a></div><div class="ttdeci">virtual void setFrequency(StkFloat frequency)</div><div class="ttdoc">Set instrument parameters for a particular frequency.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:82</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a5aecf9f4d4dcecdbef8271c7fe62b2cf"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a5aecf9f4d4dcecdbef8271c7fe62b2cf">stk::Instrmnt::controlChange</a></div><div class="ttdeci">virtual void controlChange(int number, StkFloat value)</div><div class="ttdoc">Perform the control change specified by number and value (0.0 - 128.0).</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:100</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a6506dcf2fd63805dc893cdb6d032d1fa"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a6506dcf2fd63805dc893cdb6d032d1fa">stk::Instrmnt::clear</a></div><div class="ttdeci">virtual void clear(void)</div><div class="ttdoc">Reset and clear all internal state (for subclasses).</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:29</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a6e996529193c44b76679b88532bd8f0a"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a6e996529193c44b76679b88532bd8f0a">stk::Instrmnt::channelsOut</a></div><div class="ttdeci">unsigned int channelsOut(void) const</div><div class="ttdoc">Return the number of output channels for the class.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:44</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a6f3c4dc01e0484f0ca4a3b14f1b7caf0"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a6f3c4dc01e0484f0ca4a3b14f1b7caf0">stk::Instrmnt::Instrmnt</a></div><div class="ttdeci">Instrmnt(void)</div><div class="ttdoc">Class constructor.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:23</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_a70faa1dab1e3707d057a53fd84eaba4b"><div class="ttname"><a href="classstk_1_1Instrmnt.html#a70faa1dab1e3707d057a53fd84eaba4b">stk::Instrmnt::lastFrame</a></div><div class="ttdeci">const StkFrames & lastFrame(void) const</div><div class="ttdoc">Return an StkFrames reference to the last output sample frame.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:47</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_aaa6bd5e4a5be7f9b0be967daf012872e"><div class="ttname"><a href="classstk_1_1Instrmnt.html#aaa6bd5e4a5be7f9b0be967daf012872e">stk::Instrmnt::lastOut</a></div><div class="ttdeci">StkFloat lastOut(unsigned int channel=0)</div><div class="ttdoc">Return the specified channel value of the last computed frame.</div><div class="ttdef"><b>Definition:</b> Instrmnt.h:88</div></div>
<div class="ttc" id="aclassstk_1_1Instrmnt_html_ad5d070c1fc6f93124dfed2a27b8e3cf1"><div class="ttname"><a href="classstk_1_1Instrmnt.html#ad5d070c1fc6f93124dfed2a27b8e3cf1">stk::Instrmnt::tick</a></div><div class="ttdeci">virtual StkFloat tick(unsigned int channel=0)=0</div><div class="ttdoc">Compute one sample frame and return the specified channel 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_a386e1b86cf48f7a8117313f9e41fc0fe"><div class="ttname"><a href="classstk_1_1StkFrames.html#a386e1b86cf48f7a8117313f9e41fc0fe">stk::StkFrames::resize</a></div><div class="ttdeci">void resize(size_t nFrames, unsigned int nChannels=1)</div><div class="ttdoc">Resize self to represent the specified number of channels and frames.</div></div>
<div class="ttc" id="aclassstk_1_1Stk_html"><div class="ttname"><a href="classstk_1_1Stk.html">stk::Stk</a></div><div class="ttdoc">STK base class.</div><div class="ttdef"><b>Definition:</b> Stk.h:144</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>