Files
stk/doc/html/StifKarp_8h-source.html
2013-09-29 23:44:33 +02:00

106 lines
9.7 KiB
HTML

<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.5.8 -->
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
</div>
<div class="contents">
<h1>StifKarp.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_STIFKARP_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_STIFKARP_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include "Instrmnt.h"</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include "DelayL.h"</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include "DelayA.h"</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include "OneZero.h"</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include "Noise.h"</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include "BiQuad.h"</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="keyword">namespace </span>stk {
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="comment">/***************************************************/</span>
<a name="l00034"></a>00034 <span class="comment">/***************************************************/</span>
<a name="l00035"></a>00035
<a name="l00036"></a><a class="code" href="classstk_1_1StifKarp.html">00036</a> <span class="keyword">class </span><a class="code" href="classstk_1_1StifKarp.html" title="STK plucked stiff string instrument.">StifKarp</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00040"></a>00040 <a class="code" href="classstk_1_1StifKarp.html#946fb588b5b18b12ea2dca221150da66" title="Class constructor, taking the lowest desired playing frequency.">StifKarp</a>( StkFloat lowestFrequency );
<a name="l00041"></a>00041
<a name="l00043"></a>00043 <a class="code" href="classstk_1_1StifKarp.html#37bc5b0bb4fe385eda862622f675bee1" title="Class destructor.">~StifKarp</a>( <span class="keywordtype">void</span> );
<a name="l00044"></a>00044
<a name="l00046"></a>00046 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#d1015fa6d2ac1835d8be7dec0df12f6f" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
<a name="l00047"></a>00047
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#51371b8592fc01aba1993ac304962f6e" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
<a name="l00050"></a>00050
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#21a9b7407c9d6a0b2ba34c0e41bb0b57" title="Set the stretch &amp;quot;factor&amp;quot; of the string (0.0 - 1.0).">setStretch</a>( StkFloat stretch );
<a name="l00053"></a>00053
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#55ca9e1f3c205e4fb51e6d4a7393db70" title="Set the pluck or &amp;quot;excitation&amp;quot; position along the string (0.0 - 1.0).">setPickupPosition</a>( StkFloat position );
<a name="l00056"></a>00056
<a name="l00058"></a>00058
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#d1b5de5acf487271d99903cd43e891ce" title="Set the base loop gain.">setBaseLoopGain</a>( StkFloat aGain );
<a name="l00064"></a>00064
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#016ff5971a1b51ea472f7e7fa2d677ee" title="Pluck the string with the given amplitude using the current frequency.">pluck</a>( StkFloat amplitude );
<a name="l00067"></a>00067
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#e2831958f1dd782ccf34c4068c2b7f14" title="Start a note with the given frequency and amplitude.">noteOn</a>( StkFloat frequency, StkFloat amplitude );
<a name="l00070"></a>00070
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#1806fb5c05fa5abdcd3ddb4c97d8ea78" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude );
<a name="l00073"></a>00073
<a name="l00075"></a>00075 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StifKarp.html#27e76ba187140ae575c1bd2e1ba99b03" title="Perform the control change specified by number and value (0.0 - 128.0).">controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value );
<a name="l00076"></a>00076
<a name="l00078"></a>00078 StkFloat <a class="code" href="classstk_1_1StifKarp.html#5cd896c59ee01fa8e21346ebe54365fc" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">protected</span>:
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <a class="code" href="classstk_1_1DelayA.html" title="STK allpass interpolating delay line class.">DelayA</a> delayLine_;
<a name="l00083"></a>00083 <a class="code" href="classstk_1_1DelayL.html" title="STK linear interpolating delay line class.">DelayL</a> combDelay_;
<a name="l00084"></a>00084 <a class="code" href="classstk_1_1OneZero.html" title="STK one-zero filter class.">OneZero</a> filter_;
<a name="l00085"></a>00085 <a class="code" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> noise_;
<a name="l00086"></a>00086 <a class="code" href="classstk_1_1BiQuad.html" title="STK biquad (two-pole, two-zero) filter class.">BiQuad</a> biquad_[4];
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> length_;
<a name="l00089"></a>00089 StkFloat loopGain_;
<a name="l00090"></a>00090 StkFloat baseLoopGain_;
<a name="l00091"></a>00091 StkFloat lastFrequency_;
<a name="l00092"></a>00092 StkFloat lastLength_;
<a name="l00093"></a>00093 StkFloat stretching_;
<a name="l00094"></a>00094 StkFloat pluckAmplitude_;
<a name="l00095"></a>00095 StkFloat pickupPosition_;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 };
<a name="l00098"></a>00098
<a name="l00099"></a><a class="code" href="classstk_1_1StifKarp.html#5cd896c59ee01fa8e21346ebe54365fc">00099</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1StifKarp.html#5cd896c59ee01fa8e21346ebe54365fc" title="Compute and return one output sample.">StifKarp :: tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> )
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 StkFloat temp = delayLine_.<a class="code" href="classstk_1_1DelayA.html#4372d0e178af1cb6ca465affddfb1566" title="Return the last computed output value.">lastOut</a>() * loopGain_;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// Calculate allpass stretching.</span>
<a name="l00104"></a>00104 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i=0; i&lt;4; i++)
<a name="l00105"></a>00105 temp = biquad_[i].<a class="code" href="classstk_1_1StifKarp.html#5cd896c59ee01fa8e21346ebe54365fc" title="Compute and return one output sample.">tick</a>(temp);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">// Moving average filter.</span>
<a name="l00108"></a>00108 temp = filter_.<a class="code" href="classstk_1_1OneZero.html#9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">tick</a>(temp);
<a name="l00109"></a>00109
<a name="l00110"></a>00110 lastFrame_[0] = delayLine_.<a class="code" href="classstk_1_1DelayA.html#e602abe91560fb5f141db52333359b74" title="Input one sample to the filter and return one output.">tick</a>(temp);
<a name="l00111"></a>00111 lastFrame_[0] = lastFrame_[0] - combDelay_.<a class="code" href="classstk_1_1DelayL.html#1d01bbaf40cc20a0b70241bb8072da7f" title="Input one sample to the filter and return one output.">tick</a>( lastFrame_[0] );
<a name="l00112"></a>00112 <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a>00115 } <span class="comment">// stk namespace</span>
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="preprocessor">#endif</span>
</pre></div></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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>