mirror of
https://github.com/thestk/stk
synced 2026-01-15 14:01:52 +00:00
108 lines
12 KiB
HTML
108 lines
12 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>Plucked.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_PLUCKED_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_PLUCKED_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 "DelayA.h"</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor">#include "OneZero.h"</span>
|
|
<a name="l00007"></a>00007 <span class="preprocessor">#include "OnePole.h"</span>
|
|
<a name="l00008"></a>00008 <span class="preprocessor">#include "Noise.h"</span>
|
|
<a name="l00009"></a>00009
|
|
<a name="l00010"></a>00010 <span class="keyword">namespace </span>stk {
|
|
<a name="l00011"></a>00011
|
|
<a name="l00012"></a>00012 <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_1Plucked.html">00034</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Plucked.html" title="STK basic plucked string class.">Plucked</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</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_1Plucked.html#a65eee23eda411e7fd82bf4a555d8dd85" title="Class constructor, taking the lowest desired playing frequency.">Plucked</a>( StkFloat lowestFrequency = 10.0 );
|
|
<a name="l00039"></a>00039
|
|
<a name="l00041"></a>00041 <a class="code" href="classstk_1_1Plucked.html#a6232b4a1ed48407fe9e66e1835011b5e" title="Class destructor.">~Plucked</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_1Plucked.html#a32a7063198af354fc007e3d903e21208" 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_1Plucked.html#a1864c705b85633542621ba3ba4491331" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
|
|
<a name="l00048"></a>00048
|
|
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Plucked.html#a9c8741ae249b590d24937743caf11f6c" title="Pluck the string with the given amplitude using the current frequency.">pluck</a>( StkFloat amplitude );
|
|
<a name="l00051"></a>00051
|
|
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Plucked.html#a1a8ce6b094c8e2b5c6dda805c032cd44" title="Start a note with the given frequency and amplitude.">noteOn</a>( StkFloat frequency, StkFloat amplitude );
|
|
<a name="l00054"></a>00054
|
|
<a name="l00056"></a>00056 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Plucked.html#aba5a6b6850874da55c32388e9857d6fc" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude );
|
|
<a name="l00057"></a>00057
|
|
<a name="l00059"></a>00059 StkFloat <a class="code" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
|
<a name="l00060"></a>00060
|
|
<a name="l00062"></a>00062
|
|
<a name="l00069"></a>00069 <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_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" 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="l00070"></a>00070
|
|
<a name="l00071"></a>00071 <span class="keyword">protected</span>:
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <a class="code" href="classstk_1_1DelayA.html" title="STK allpass interpolating delay line class.">DelayA</a> delayLine_;
|
|
<a name="l00074"></a>00074 <a class="code" href="classstk_1_1OneZero.html" title="STK one-zero filter class.">OneZero</a> loopFilter_;
|
|
<a name="l00075"></a>00075 <a class="code" href="classstk_1_1OnePole.html" title="STK one-pole filter class.">OnePole</a> pickFilter_;
|
|
<a name="l00076"></a>00076 <a class="code" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> noise_;
|
|
<a name="l00077"></a>00077
|
|
<a name="l00078"></a>00078 StkFloat loopGain_;
|
|
<a name="l00079"></a>00079 };
|
|
<a name="l00080"></a>00080
|
|
<a name="l00081"></a><a class="code" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25">00081</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" title="Compute and return one output sample.">Plucked :: tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> )
|
|
<a name="l00082"></a>00082 {
|
|
<a name="l00083"></a>00083 <span class="comment">// Here's the whole inner loop of the instrument!!</span>
|
|
<a name="l00084"></a>00084 <span class="keywordflow">return</span> lastFrame_[0] = 3.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="l00085"></a>00085 }
|
|
<a name="l00086"></a>00086
|
|
<a name="l00087"></a><a class="code" href="classstk_1_1Plucked.html#ab9bb602c6f6867cf00995bc42101c006">00087</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_1Plucked.html#adb4a5d731ad2b680120313f03a020c25" title="Compute and return one output sample.">Plucked :: 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="l00088"></a>00088 {
|
|
<a name="l00089"></a>00089 <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="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 > 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="l00092"></a>00092 oStream_ << <span class="stringliteral">"Plucked::tick(): channel and StkFrames arguments are incompatible!"</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 = &frames[channel];
|
|
<a name="l00098"></a>00098 <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="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<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="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<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="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<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 }
|
|
<a name="l00113"></a>00113
|
|
<a name="l00114"></a>00114 } <span class="comment">// stk namespace</span>
|
|
<a name="l00115"></a>00115
|
|
<a name="l00116"></a>00116 <span class="preprocessor">#endif</span>
|
|
<a name="l00117"></a>00117 <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>
|