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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Shakers.html">Shakers</a>
</div>
<div class="contents">
<h1>stk::Shakers Class Reference</h1><!-- doxytag: class="stk::Shakers" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>PhISEM and PhOLIES class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Shakers_8h_source.html">Shakers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Shakers:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Shakers.png" usemap="#stk::Shakers_map" alt=""/>
<map id="stk::Shakers_map" name="stk::Shakers_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Shakers-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0de428431174d08f6776ef141594d1b6"></a><!-- doxytag: member="stk::Shakers::Shakers" ref="a0de428431174d08f6776ef141594d1b6" args="(int type=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a0de428431174d08f6776ef141594d1b6">Shakers</a> (int type=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor taking instrument type argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a81ffb0ad1e350993af10b2795ec01861">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given instrument and amplitude. <a href="#a81ffb0ad1e350993af10b2795ec01861"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab63b4b57f8306eb7cf1adbf5a5cd1d05"></a><!-- doxytag: member="stk::Shakers::noteOff" ref="ab63b4b57f8306eb7cf1adbf5a5cd1d05" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#ab63b4b57f8306eb7cf1adbf5a5cd1d05">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a688d9d8318e0c69779868079a7c64157"></a><!-- doxytag: member="stk::Shakers::controlChange" ref="a688d9d8318e0c69779868079a7c64157" args="(int number, StkFloat value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a688d9d8318e0c69779868079a7c64157">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae06ebba276cef74cb8c83db4e33f21c2"></a><!-- doxytag: member="stk::Shakers::tick" ref="ae06ebba276cef74cb8c83db4e33f21c2" args="(unsigned int channel=0)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a655713b658ddeb065d755997cac4b62e">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a655713b658ddeb065d755997cac4b62e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>PhISEM and PhOLIES class. </p>
<p>PhISEM (Physically Informed Stochastic Event Modeling) is an algorithmic approach for simulating collisions of multiple independent sound producing objects. This class is a meta-model that can simulate a Maraca, Sekere, Cabasa, Bamboo Wind Chimes, Water Drops, Tambourine, Sleighbells, and a Guiro.</p>
<p>PhOLIES (Physically-Oriented Library of Imitated Environmental Sounds) is a similar approach for the synthesis of environmental sounds. This class implements simulations of breaking sticks, crunchy snow (or not), a wrench, sandpaper, and more.</p>
<p>Control Change Numbers:</p>
<ul>
<li>Shake Energy = 2</li>
<li>System Decay = 4</li>
<li>Number Of Objects = 11</li>
<li>Resonance Frequency = 1</li>
<li>Shake Energy = 128</li>
<li>Instrument Selection = 1071</li>
<li>Maraca = 0</li>
<li>Cabasa = 1</li>
<li>Sekere = 2</li>
<li>Tambourine = 3</li>
<li>Sleigh Bells = 4</li>
<li>Bamboo Chimes = 5</li>
<li>Sand Paper = 6</li>
<li>Coke Can = 7</li>
<li>Sticks = 8</li>
<li>Crunch = 9</li>
<li>Big Rocks = 10</li>
<li>Little Rocks = 11</li>
<li>Next Mug = 12</li>
<li>Penny + Mug = 13</li>
<li>Nickle + Mug = 14</li>
<li>Dime + Mug = 15</li>
<li>Quarter + Mug = 16</li>
<li>Franc + Mug = 17</li>
<li>Peso + Mug = 18</li>
<li>Guiro = 19</li>
<li>Wrench = 20</li>
<li>Water Drops = 21</li>
<li>Tuned Bamboo Chimes = 22</li>
</ul>
<p>by Perry R. Cook with updates by Gary Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a81ffb0ad1e350993af10b2795ec01861"></a><!-- doxytag: member="stk::Shakers::noteOn" ref="a81ffb0ad1e350993af10b2795ec01861" args="(StkFloat instrument, StkFloat amplitude)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Shakers::noteOn </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>instrument</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>amplitude</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start a note with the given instrument and amplitude. </p>
<p>Use the instrument numbers above, converted to frequency values as if MIDI note numbers, to select a particular instrument. </p>
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44">stk::Instrmnt</a>.</p>
</div>
</div>
<a class="anchor" id="a655713b658ddeb065d755997cac4b62e"></a><!-- doxytag: member="stk::Shakers::tick" ref="a655713b658ddeb065d755997cac4b62e" args="(StkFrames &frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::Shakers::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00304"></a>00304 {
<a name="l00305"></a>00305 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00306"></a>00306 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00307"></a>00307 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
<a name="l00308"></a>00308 oStream_ << <span class="stringliteral">"Shakers::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00309"></a>00309 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00310"></a>00310 }
<a name="l00311"></a>00311 <span class="preprocessor">#endif</span>
<a name="l00312"></a>00312 <span class="preprocessor"></span>
<a name="l00313"></a>00313 StkFloat *samples = &frames[channel];
<a name="l00314"></a>00314 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00315"></a>00315 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00316"></a>00316 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop )
<a name="l00317"></a>00317 *samples++ = <a class="code" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2" title="Compute and return one output sample.">tick</a>();
<a name="l00318"></a>00318 }
<a name="l00319"></a>00319 <span class="keywordflow">else</span> {
<a name="l00320"></a>00320 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop ) {
<a name="l00321"></a>00321 *samples++ = <a class="code" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2" title="Compute and return one output sample.">tick</a>();
<a name="l00322"></a>00322 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
<a name="l00323"></a>00323 *samples++ = lastFrame_[j];
<a name="l00324"></a>00324 }
<a name="l00325"></a>00325 }
<a name="l00326"></a>00326
<a name="l00327"></a>00327 <span class="keywordflow">return</span> frames;
<a name="l00328"></a>00328 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Shakers_8h_source.html">Shakers.h</a></li>
</ul>
</div>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
