Files
stk/doc/html/Sitar_8h_source.html
2013-09-29 23:49:37 +02:00

123 lines
13 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.6.2 -->
<div class="navpath"><a class="el" href="dir_f14fd23bc74c76f288031ad23b3f3505.html">include</a>
</div>
<div class="contents">
<h1>Sitar.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_SITAR_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_SITAR_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;Instrmnt.h&quot;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;DelayA.h&quot;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;OneZero.h&quot;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;Noise.h&quot;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &quot;ADSR.h&quot;</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &lt;cmath&gt;</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="l00030"></a>00030 <span class="comment">/***************************************************/</span>
<a name="l00031"></a>00031
<a name="l00032"></a><a class="code" href="classstk_1_1Sitar.html">00032</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Sitar.html" title="STK sitar string model class.">Sitar</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</a>
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <span class="keyword">public</span>:
<a name="l00036"></a>00036 <a class="code" href="classstk_1_1Sitar.html#a8a2c996ad8b32f98f2bca14aa742bc29" title="Class constructor, taking the lowest desired playing frequency.">Sitar</a>( StkFloat lowestFrequency = 8.0 );
<a name="l00037"></a>00037
<a name="l00039"></a>00039 <a class="code" href="classstk_1_1Sitar.html#a4bb1d8cd5c1ffc331e6c97e28f6f3000" title="Class destructor.">~Sitar</a>( <span class="keywordtype">void</span> );
<a name="l00040"></a>00040
<a name="l00042"></a>00042 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sitar.html#a52cc4d38204e6825e524228008a0e94c" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
<a name="l00043"></a>00043
<a name="l00045"></a>00045 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sitar.html#a02acfe592d8d601a37fadb94aaedb074" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
<a name="l00046"></a>00046
<a name="l00048"></a>00048 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sitar.html#afcbccba0e49bf538c190381785c90752" title="Pluck the string with the given amplitude using the current frequency.">pluck</a>( StkFloat amplitude );
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sitar.html#a02fb8c574a4ea9acd4ae7f3f3636b3b3" title="Start a note with the given frequency and amplitude.">noteOn</a>( StkFloat frequency, StkFloat amplitude );
<a name="l00052"></a>00052
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Sitar.html#ae4acf7cf5f8319fa3420133c2802e9f6" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude );
<a name="l00055"></a>00055
<a name="l00057"></a>00057 StkFloat <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00058"></a>00058
<a name="l00060"></a>00060
<a name="l00067"></a>00067 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" 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>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">protected</span>:
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <a class="code" href="classstk_1_1DelayA.html" title="STK allpass interpolating delay line class.">DelayA</a> delayLine_;
<a name="l00072"></a>00072 <a class="code" href="classstk_1_1OneZero.html" title="STK one-zero filter class.">OneZero</a> loopFilter_;
<a name="l00073"></a>00073 <a class="code" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> noise_;
<a name="l00074"></a>00074 <a class="code" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope_;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 StkFloat loopGain_;
<a name="l00077"></a>00077 StkFloat amGain_;
<a name="l00078"></a>00078 StkFloat delay_;
<a name="l00079"></a>00079 StkFloat targetDelay_;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082
<a name="l00083"></a><a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e">00083</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" title="Compute and return one output sample.">Sitar :: tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> )
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="keywordflow">if</span> ( fabs(targetDelay_ - delay_) &gt; 0.001 ) {
<a name="l00086"></a>00086 <span class="keywordflow">if</span> ( targetDelay_ &lt; delay_ )
<a name="l00087"></a>00087 delay_ *= 0.99999;
<a name="l00088"></a>00088 <span class="keywordflow">else</span>
<a name="l00089"></a>00089 delay_ *= 1.00001;
<a name="l00090"></a>00090 delayLine_.<a class="code" href="classstk_1_1DelayA.html#a83ddc9bdf2f5059159160fdac0e25eda" title="Set the delay-line length.">setDelay</a>( delay_ );
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 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>( loopFilter_.<a class="code" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" 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>() * loopGain_ ) +
<a name="l00094"></a>00094 (amGain_ * envelope_.<a class="code" href="classstk_1_1ADSR.html#af2c0869f86210a55f4f668172373c975" title="Compute and return one output sample.">tick</a>() * noise_.<a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d" title="Compute and return one output sample.">tick</a>()));
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a><a class="code" href="classstk_1_1Sitar.html#a755cc36fe9cde1942184af0b1ae88f7a">00099</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>&amp; <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" title="Compute and return one output sample.">Sitar :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<a name="l00102"></a>00102 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - nChannels ) {
<a name="l00104"></a>00104 oStream_ &lt;&lt; <span class="stringliteral">&quot;Sitar::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00105"></a>00105 <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="l00106"></a>00106 }
<a name="l00107"></a>00107 <span class="preprocessor">#endif</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span>
<a name="l00109"></a>00109 StkFloat *samples = &amp;frames[channel];
<a name="l00110"></a>00110 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - nChannels;
<a name="l00111"></a>00111 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00112"></a>00112 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;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="l00113"></a>00113 *samples++ = <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" title="Compute and return one output sample.">tick</a>();
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 <span class="keywordflow">else</span> {
<a name="l00116"></a>00116 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;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="l00117"></a>00117 *samples++ = <a class="code" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e" title="Compute and return one output sample.">tick</a>();
<a name="l00118"></a>00118 <span class="keywordflow">for</span> ( j=1; j&lt;nChannels; j++ )
<a name="l00119"></a>00119 *samples++ = lastFrame_[j];
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordflow">return</span> frames;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 } <span class="comment">// stk namespace</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#endif</span>
<a name="l00129"></a>00129 <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>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>