e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 06:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:49:37 +02:00
committed by Stephen Sinclair
parent cfdfe7736a
commit f13d5bb3cd
632 changed files with 12236 additions and 19041 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
doc/html/classstk_1_1Plucked.html
View File

@@ -13,7 +13,7 @@
</div>
<div class="contents">
<h1>stk::Plucked Class Reference</h1><!-- doxytag: class="stk::Plucked" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>STK plucked string model class.
<p>STK basic plucked string class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Plucked_8h_source.html">Plucked.h</a>&gt;</code></p>
@@ -32,8 +32,8 @@ Inheritance diagram for stk::Plucked:</div>
<p><a href="classstk_1_1Plucked-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="a279ac82759d4184d9ad961e21dacdbca"></a><!-- doxytag: member="stk::Plucked::Plucked" ref="a279ac82759d4184d9ad961e21dacdbca" args="(StkFloat lowestFrequency)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Plucked.html#a279ac82759d4184d9ad961e21dacdbca">Plucked</a> (StkFloat lowestFrequency)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65eee23eda411e7fd82bf4a555d8dd85"></a><!-- doxytag: member="stk::Plucked::Plucked" ref="a65eee23eda411e7fd82bf4a555d8dd85" args="(StkFloat lowestFrequency=10.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Plucked.html#a65eee23eda411e7fd82bf4a555d8dd85">Plucked</a> (StkFloat lowestFrequency=10.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6232b4a1ed48407fe9e66e1835011b5e"></a><!-- doxytag: member="stk::Plucked::~Plucked" ref="a6232b4a1ed48407fe9e66e1835011b5e" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Plucked.html#a6232b4a1ed48407fe9e66e1835011b5e">~Plucked</a> (void)</td></tr>
@@ -56,12 +56,75 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb4a5d731ad2b680120313f03a020c25"></a><!-- doxytag: member="stk::Plucked::tick" ref="adb4a5d731ad2b680120313f03a020c25" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25">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_1Plucked.html#ab9bb602c6f6867cf00995bc42101c006">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="#ab9bb602c6f6867cf00995bc42101c006"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK plucked string model class. </p>
<p>STK basic plucked string class. </p>
<p>This class implements a simple plucked string physical model based on the Karplus-Strong algorithm.</p>
<p>For a more advanced plucked string implementation, see the <a class="el" href="classstk_1_1Twang.html" title="STK enhanced plucked string class.">stk::Twang</a> class.</p>
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab9bb602c6f6867cf00995bc42101c006"></a><!-- doxytag: member="stk::Plucked::tick" ref="ab9bb602c6f6867cf00995bc42101c006" 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::Plucked::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="l00088"></a>00088 {
<a name="l00089"></a>00089 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00090"></a>00090 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; frames.channels() - nChannels ) {
<a name="l00092"></a>00092 oStream_ &lt;&lt; <span class="stringliteral">&quot;Plucked::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00093"></a>00093 <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="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 StkFloat *samples = &amp;frames[channel];
<a name="l00098"></a>00098 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00099"></a>00099 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00100"></a>00100 <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="l00101"></a>00101 *samples++ = <a class="code" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" title="Compute and return one output sample.">tick</a>();
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 <span class="keywordflow">else</span> {
<a name="l00104"></a>00104 <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="l00105"></a>00105 *samples++ = <a class="code" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" title="Compute and return one output sample.">tick</a>();
<a name="l00106"></a>00106 <span class="keywordflow">for</span> ( j=1; j&lt;nChannels; j++ )
<a name="l00107"></a>00107 *samples++ = lastFrame_[j];
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keywordflow">return</span> frames;
<a name="l00112"></a>00112 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Plucked_8h_source.html">Plucked.h</a></li>
</ul>
@@ -70,7 +133,7 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>