forked from pschatzmann/arduino-stk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSampler_8h_source.html
116 lines (116 loc) · 14.8 KB
/
Sampler_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: Sampler.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">Sampler.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_SAMPLER_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define STK_SAMPLER_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 "Instrmnt.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "ADSR.h"</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "FileLoop.h"</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "MemoryWvIn.h"</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "MemoryLoop.h"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "OnePole.h"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacestk.html">stk</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="classstk_1_1Sampler.html">Sampler</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html">Instrmnt</a></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a97dbec0c39f3307560736173b4ede4e1"> 28</a></span>  <a class="code" href="classstk_1_1Sampler.html#a97dbec0c39f3307560736173b4ede4e1">Sampler</a>( <span class="keywordtype">void</span> );</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a9262914e25d4b9fd28a760621902fd74"> 31</a></span>  <span class="keyword">virtual</span> <a class="code" href="classstk_1_1Sampler.html#a9262914e25d4b9fd28a760621902fd74">~Sampler</a>( <span class="keywordtype">void</span> );</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a746eaab88793e3e8cdac9f6e59e00ca3"> 34</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sampler.html#a746eaab88793e3e8cdac9f6e59e00ca3">setFrequency</a>( StkFloat frequency ) = 0;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#ad277ac455b3434eeb21d628d6c70141a"> 37</a></span>  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sampler.html#ad277ac455b3434eeb21d628d6c70141a">keyOn</a>( <span class="keywordtype">void</span> );</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_1Sampler.html#a808aec2bf546b01e1ef53503c5a164e1"> 40</a></span>  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sampler.html#a808aec2bf546b01e1ef53503c5a164e1">keyOff</a>( <span class="keywordtype">void</span> );</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a36c3ed945fb3e8db300b7ae01a4a4a76"> 43</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sampler.html#a36c3ed945fb3e8db300b7ae01a4a4a76">noteOff</a>( StkFloat amplitude );</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#ad9c0789f033978165226beb7c8133cc3"> 46</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sampler.html#ad9c0789f033978165226beb7c8133cc3">controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value ) = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a08502c96fa3e5f4c853c781354ed1965"> 49</a></span>  <span class="keyword">virtual</span> StkFloat <a class="code" href="classstk_1_1Sampler.html#a08502c96fa3e5f4c853c781354ed1965">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 ) = 0;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classstk_1_1Sampler.html#a30ef51142f99faf0586e2da78bc6daf6"> 59</a></span>  <span class="keyword">virtual</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Sampler.html#a30ef51142f99faf0586e2da78bc6daf6">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="l00060"></a><span class="lineno"> 60</span>  </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">protected</span>:</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>  <a class="code" href="classstk_1_1ADSR.html">ADSR</a> adsr_;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::vector<FileWvIn *> attacks_;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::vector<FileLoop *> loops_;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classstk_1_1OnePole.html">OnePole</a> filter_;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  StkFloat baseFrequency_;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::vector<StkFloat> attackRatios_;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::vector<StkFloat> loopRatios_;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  StkFloat attackGain_;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  StkFloat loopGain_;</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> };</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> } <span class="comment">// stk namespace</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstk_1_1ADSR_html"><div class="ttname"><a href="classstk_1_1ADSR.html">stk::ADSR</a></div><div class="ttdoc">STK ADSR envelope class.</div><div class="ttdef"><b>Definition:</b> ADSR.h:27</div></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_1OnePole_html"><div class="ttname"><a href="classstk_1_1OnePole.html">stk::OnePole</a></div><div class="ttdoc">STK one-pole filter class.</div><div class="ttdef"><b>Definition:</b> OnePole.h:21</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html"><div class="ttname"><a href="classstk_1_1Sampler.html">stk::Sampler</a></div><div class="ttdoc">STK sampling synthesis abstract base class.</div><div class="ttdef"><b>Definition:</b> Sampler.h:25</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a08502c96fa3e5f4c853c781354ed1965"><div class="ttname"><a href="classstk_1_1Sampler.html#a08502c96fa3e5f4c853c781354ed1965">stk::Sampler::tick</a></div><div class="ttdeci">virtual StkFloat tick(unsigned int channel=0)=0</div><div class="ttdoc">Compute and return one output sample.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a30ef51142f99faf0586e2da78bc6daf6"><div class="ttname"><a href="classstk_1_1Sampler.html#a30ef51142f99faf0586e2da78bc6daf6">stk::Sampler::tick</a></div><div class="ttdeci">virtual StkFrames & tick(StkFrames &frames, unsigned int channel=0)=0</div><div class="ttdoc">Fill a channel of the StkFrames object with computed outputs.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a36c3ed945fb3e8db300b7ae01a4a4a76"><div class="ttname"><a href="classstk_1_1Sampler.html#a36c3ed945fb3e8db300b7ae01a4a4a76">stk::Sampler::noteOff</a></div><div class="ttdeci">virtual void noteOff(StkFloat amplitude)</div><div class="ttdoc">Stop a note with the given amplitude (speed of decay).</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a746eaab88793e3e8cdac9f6e59e00ca3"><div class="ttname"><a href="classstk_1_1Sampler.html#a746eaab88793e3e8cdac9f6e59e00ca3">stk::Sampler::setFrequency</a></div><div class="ttdeci">virtual void setFrequency(StkFloat frequency)=0</div><div class="ttdoc">Set instrument parameters for a particular frequency.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a808aec2bf546b01e1ef53503c5a164e1"><div class="ttname"><a href="classstk_1_1Sampler.html#a808aec2bf546b01e1ef53503c5a164e1">stk::Sampler::keyOff</a></div><div class="ttdeci">void keyOff(void)</div><div class="ttdoc">Signal a key-off event to the envelopes.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a9262914e25d4b9fd28a760621902fd74"><div class="ttname"><a href="classstk_1_1Sampler.html#a9262914e25d4b9fd28a760621902fd74">stk::Sampler::~Sampler</a></div><div class="ttdeci">virtual ~Sampler(void)</div><div class="ttdoc">Class destructor.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_a97dbec0c39f3307560736173b4ede4e1"><div class="ttname"><a href="classstk_1_1Sampler.html#a97dbec0c39f3307560736173b4ede4e1">stk::Sampler::Sampler</a></div><div class="ttdeci">Sampler(void)</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_ad277ac455b3434eeb21d628d6c70141a"><div class="ttname"><a href="classstk_1_1Sampler.html#ad277ac455b3434eeb21d628d6c70141a">stk::Sampler::keyOn</a></div><div class="ttdeci">void keyOn(void)</div><div class="ttdoc">Initiate the envelopes with a key-on event and reset the attack waves.</div></div>
<div class="ttc" id="aclassstk_1_1Sampler_html_ad9c0789f033978165226beb7c8133cc3"><div class="ttname"><a href="classstk_1_1Sampler.html#ad9c0789f033978165226beb7c8133cc3">stk::Sampler::controlChange</a></div><div class="ttdeci">virtual void controlChange(int number, StkFloat value)=0</div><div class="ttdoc">Perform the control change specified by number and value (0.0 - 128.0).</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="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>