e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-16 22:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f13d5bb3cd8ba1350786b36fba9a538babb210d0
stk/doc/html/classstk_1_1Shakers.html
Gary Scavone f13d5bb3cd Release 4.4.3 tarball
2013-09-29 23:49:37 +02:00

199 lines
13 KiB
HTML
Raw Blame History

<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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <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 &lt;<a class="el" href="Shakers_8h_source.html">Shakers.h</a>&gt;</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="a34e4859c572a158d8fda15b7a5c6954d"></a><!-- doxytag: member="stk::Shakers::Shakers" ref="a34e4859c572a158d8fda15b7a5c6954d" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a34e4859c572a158d8fda15b7a5c6954d">Shakers</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1b2ab640268da68b867de1495f19a77"></a><!-- doxytag: member="stk::Shakers::~Shakers" ref="aa1b2ab640268da68b867de1495f19a77" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#aa1b2ab640268da68b867de1495f19a77">~Shakers</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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<ul>
<li>Maraca = 0</li>
<li>Cabasa = 1</li>
<li>Sekere = 2</li>
<li>Guiro = 3</li>
<li>Water Drops = 4</li>
<li>Bamboo Chimes = 5</li>
<li>Tambourine = 6</li>
<li>Sleigh Bells = 7</li>
<li>Sticks = 8</li>
<li>Crunch = 9</li>
<li>Wrench = 10</li>
<li>Sand Paper = 11</li>
<li>Coke Can = 12</li>
<li>Next Mug = 13</li>
<li>Penny + Mug = 14</li>
<li>Nickle + Mug = 15</li>
<li>Dime + Mug = 16</li>
<li>Quarter + Mug = 17</li>
<li>Franc + Mug = 18</li>
<li>Peso + Mug = 19</li>
<li>Big Rocks = 20</li>
<li>Little Rocks = 21</li>
<li>Tuned Bamboo Chimes = 22</li>
</ul>
</li>
</ul>
<p>by Perry R. Cook, 1995-2011. </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&nbsp;</td>
<td class="paramname"> <em>instrument</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>amplitude</em></td><td>&nbsp;</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 &amp;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> &amp; stk::Shakers::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td>&nbsp;</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="l00140"></a>00140 {
<a name="l00141"></a>00141 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00142"></a>00142 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; frames.channels() - nChannels ) {
<a name="l00144"></a>00144 oStream_ &lt;&lt; <span class="stringliteral">&quot;Shakers::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00145"></a>00145 <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="l00146"></a>00146 }
<a name="l00147"></a>00147 <span class="preprocessor">#endif</span>
<a name="l00148"></a>00148 <span class="preprocessor"></span>
<a name="l00149"></a>00149 StkFloat *samples = &amp;frames[channel];
<a name="l00150"></a>00150 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00151"></a>00151 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00152"></a>00152 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop )
<a name="l00153"></a>00153 *samples++ = <a class="code" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2" title="Compute and return one output sample.">tick</a>();
<a name="l00154"></a>00154 }
<a name="l00155"></a>00155 <span class="keywordflow">else</span> {
<a name="l00156"></a>00156 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop ) {
<a name="l00157"></a>00157 *samples++ = <a class="code" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2" title="Compute and return one output sample.">tick</a>();
<a name="l00158"></a>00158 <span class="keywordflow">for</span> ( j=1; j&lt;nChannels; j++ )
<a name="l00159"></a>00159 *samples++ = lastFrame_[j];
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keywordflow">return</span> frames;
<a name="l00164"></a>00164 }
</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>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink