mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
128 lines
15 KiB
HTML
128 lines
15 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"> <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="dir_f14fd23bc74c76f288031ad23b3f3505.html">include</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>Twang.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_TWANG_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_TWANG_H</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include "Stk.h"</span>
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#include "DelayA.h"</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor">#include "DelayL.h"</span>
|
|
<a name="l00007"></a>00007 <span class="preprocessor">#include "Fir.h"</span>
|
|
<a name="l00008"></a>00008
|
|
<a name="l00009"></a>00009 <span class="keyword">namespace </span>stk {
|
|
<a name="l00010"></a>00010
|
|
<a name="l00011"></a>00011 <span class="comment">/***************************************************/</span>
|
|
<a name="l00032"></a>00032 <span class="comment">/***************************************************/</span>
|
|
<a name="l00033"></a>00033
|
|
<a name="l00034"></a><a class="code" href="classstk_1_1Twang.html">00034</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Twang.html" title="STK enhanced plucked string class.">Twang</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Stk.html" title="STK base class.">Stk</a>
|
|
<a name="l00035"></a>00035 {
|
|
<a name="l00036"></a>00036 <span class="keyword">public</span>:
|
|
<a name="l00038"></a>00038 <a class="code" href="classstk_1_1Twang.html#a813e99ee79974707a3afbfcab963c086" title="Class constructor, taking the lowest desired playing frequency.">Twang</a>( StkFloat lowestFrequency = 50.0 );
|
|
<a name="l00039"></a>00039
|
|
<a name="l00041"></a>00041 <a class="code" href="classstk_1_1Twang.html#adae2759ef254101f91aa3a0a5c3fba39" title="Class destructor.">~Twang</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00042"></a>00042
|
|
<a name="l00044"></a>00044 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#a7cdd4bf2e486239429f6d4f0f277cea9" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00045"></a>00045
|
|
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#ae27aa429cbf49f0dd60f0cc6ef41c832" title="Set the delayline parameters to allow frequencies as low as specified.">setLowestFrequency</a>( StkFloat frequency );
|
|
<a name="l00048"></a>00048
|
|
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#a0043b9d374b73b6660ec2d79475d602c" title="Set the delayline parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
|
|
<a name="l00051"></a>00051
|
|
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#a48008e3cd55dad6ee846b47ab32f993f" title="Set the pluck or &quot;excitation&quot; position along the string (0.0 - 1.0).">setPluckPosition</a>( StkFloat position );
|
|
<a name="l00054"></a>00054
|
|
<a name="l00056"></a>00056
|
|
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#ad7921c51f38b4e6e32d7db48cc101068" title="Set the nominal loop gain.">setLoopGain</a>( StkFloat loopGain );
|
|
<a name="l00063"></a>00063
|
|
<a name="l00065"></a>00065
|
|
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Twang.html#a7076c25dd3a06262b3bf927bc64bf89e" title="Set the loop filter coefficients.">setLoopFilter</a>( std::vector<StkFloat> coefficients );
|
|
<a name="l00071"></a>00071
|
|
<a name="l00073"></a><a class="code" href="classstk_1_1Twang.html#ab54245fcb75144a8ffcc879789abc952">00073</a> <span class="keyword">const</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Twang.html#ab54245fcb75144a8ffcc879789abc952" title="Return an StkFrames reference to the last output sample frame.">lastFrame</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_; };
|
|
<a name="l00074"></a>00074
|
|
<a name="l00076"></a>00076 StkFloat <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( StkFloat input );
|
|
<a name="l00077"></a>00077
|
|
<a name="l00079"></a>00079
|
|
<a name="l00087"></a>00087 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
|
<a name="l00088"></a>00088
|
|
<a name="l00090"></a>00090
|
|
<a name="l00098"></a>00098 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& iFrames, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> &oFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannel = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> oChannel = 0 );
|
|
<a name="l00099"></a>00099
|
|
<a name="l00100"></a>00100 <span class="keyword">protected</span>:
|
|
<a name="l00101"></a>00101
|
|
<a name="l00102"></a>00102 <a class="code" href="classstk_1_1DelayA.html" title="STK allpass interpolating delay line class.">DelayA</a> delayLine_;
|
|
<a name="l00103"></a>00103 <a class="code" href="classstk_1_1DelayL.html" title="STK linear interpolating delay line class.">DelayL</a> combDelay_;
|
|
<a name="l00104"></a>00104 <a class="code" href="classstk_1_1Fir.html" title="STK general finite impulse response filter class.">Fir</a> loopFilter_;
|
|
<a name="l00105"></a>00105
|
|
<a name="l00106"></a>00106 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> lastFrame_;
|
|
<a name="l00107"></a>00107 StkFloat frequency_;
|
|
<a name="l00108"></a>00108 StkFloat loopGain_;
|
|
<a name="l00109"></a>00109 StkFloat pluckPosition_;
|
|
<a name="l00110"></a>00110 };
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a><a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9">00112</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">Twang :: tick</a>( StkFloat input )
|
|
<a name="l00113"></a>00113 {
|
|
<a name="l00114"></a>00114 lastFrame_[0] = delayLine_.<a class="code" href="classstk_1_1DelayA.html#ae602abe91560fb5f141db52333359b74" title="Input one sample to the filter and return one output.">tick</a>( input + loopFilter_.<a class="code" href="classstk_1_1Fir.html#afc5fd95f6bf72edaf4ee3060ca947793" title="Input one sample to the filter and return one output.">tick</a>( delayLine_.<a class="code" href="classstk_1_1DelayA.html#a4372d0e178af1cb6ca465affddfb1566" title="Return the last computed output value.">lastOut</a>() ) );
|
|
<a name="l00115"></a>00115 lastFrame_[0] -= combDelay_.<a class="code" href="classstk_1_1DelayL.html#a1d01bbaf40cc20a0b70241bb8072da7f" title="Input one sample to the filter and return one output.">tick</a>( lastFrame_[0] ); <span class="comment">// comb filtering on output</span>
|
|
<a name="l00116"></a>00116
|
|
<a name="l00117"></a>00117 <span class="keywordflow">return</span> lastFrame_[0] * 0.5;
|
|
<a name="l00118"></a>00118 }
|
|
<a name="l00119"></a>00119
|
|
<a name="l00120"></a><a class="code" href="classstk_1_1Twang.html#ae9e770c446e1459a5e89c0bc8285f5e3">00120</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">Twang :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
|
|
<a name="l00121"></a>00121 {
|
|
<a name="l00122"></a>00122 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00123"></a>00123 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00124"></a>00124 oStream_ << <span class="stringliteral">"Twang::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00125"></a>00125 <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="l00126"></a>00126 }
|
|
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
|
|
<a name="l00128"></a>00128 <span class="preprocessor"></span>
|
|
<a name="l00129"></a>00129 StkFloat *samples = &frames[channel];
|
|
<a name="l00130"></a>00130 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<a name="l00131"></a>00131 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, samples += hop )
|
|
<a name="l00132"></a>00132 *samples = <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( *samples );
|
|
<a name="l00133"></a>00133
|
|
<a name="l00134"></a>00134 <span class="keywordflow">return</span> frames;
|
|
<a name="l00135"></a>00135 }
|
|
<a name="l00136"></a>00136
|
|
<a name="l00137"></a><a class="code" href="classstk_1_1Twang.html#a089ff55338a22647d94665d6adbeb7ae">00137</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">Twang :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& iFrames, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& oFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> oChannel )
|
|
<a name="l00138"></a>00138 {
|
|
<a name="l00139"></a>00139 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00140"></a>00140 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel >= iFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() || oChannel >= oFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00141"></a>00141 oStream_ << <span class="stringliteral">"Twang::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00142"></a>00142 <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="l00143"></a>00143 }
|
|
<a name="l00144"></a>00144 <span class="preprocessor">#endif</span>
|
|
<a name="l00145"></a>00145 <span class="preprocessor"></span>
|
|
<a name="l00146"></a>00146 StkFloat *iSamples = &iFrames[iChannel];
|
|
<a name="l00147"></a>00147 StkFloat *oSamples = &oFrames[oChannel];
|
|
<a name="l00148"></a>00148 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>(), oHop = oFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<a name="l00149"></a>00149 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<iFrames.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, iSamples += iHop, oSamples += oHop )
|
|
<a name="l00150"></a>00150 *oSamples = <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( *iSamples );
|
|
<a name="l00151"></a>00151
|
|
<a name="l00152"></a>00152 <span class="keywordflow">return</span> iFrames;
|
|
<a name="l00153"></a>00153 }
|
|
<a name="l00154"></a>00154
|
|
<a name="l00155"></a>00155 } <span class="comment">// stk namespace</span>
|
|
<a name="l00156"></a>00156
|
|
<a name="l00157"></a>00157 <span class="preprocessor">#endif</span>
|
|
<a name="l00158"></a>00158 <span class="preprocessor"></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>©1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|