mirror of
https://github.com/thestk/stk
synced 2026-01-15 22:11:52 +00:00
140 lines
12 KiB
HTML
140 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="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Sitar.html">Sitar</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Sitar Class Reference</h1><!-- doxytag: class="stk::Sitar" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK sitar string model class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Sitar_8h_source.html">Sitar.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Sitar:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Sitar.png" usemap="#stk::Sitar_map" alt=""/>
|
|
<map id="stk::Sitar_map" name="stk::Sitar_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,76,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,76,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Sitar-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="a8a2c996ad8b32f98f2bca14aa742bc29"></a><!-- doxytag: member="stk::Sitar::Sitar" ref="a8a2c996ad8b32f98f2bca14aa742bc29" args="(StkFloat lowestFrequency=8.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a8a2c996ad8b32f98f2bca14aa742bc29">Sitar</a> (StkFloat lowestFrequency=8.0)</td></tr>
|
|
<tr><td class="mdescLeft"> </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="a4bb1d8cd5c1ffc331e6c97e28f6f3000"></a><!-- doxytag: member="stk::Sitar::~Sitar" ref="a4bb1d8cd5c1ffc331e6c97e28f6f3000" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a4bb1d8cd5c1ffc331e6c97e28f6f3000">~Sitar</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52cc4d38204e6825e524228008a0e94c"></a><!-- doxytag: member="stk::Sitar::clear" ref="a52cc4d38204e6825e524228008a0e94c" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a52cc4d38204e6825e524228008a0e94c">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02acfe592d8d601a37fadb94aaedb074"></a><!-- doxytag: member="stk::Sitar::setFrequency" ref="a02acfe592d8d601a37fadb94aaedb074" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a02acfe592d8d601a37fadb94aaedb074">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcbccba0e49bf538c190381785c90752"></a><!-- doxytag: member="stk::Sitar::pluck" ref="afcbccba0e49bf538c190381785c90752" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#afcbccba0e49bf538c190381785c90752">pluck</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the string with the given amplitude using the current frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02fb8c574a4ea9acd4ae7f3f3636b3b3"></a><!-- doxytag: member="stk::Sitar::noteOn" ref="a02fb8c574a4ea9acd4ae7f3f3636b3b3" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a02fb8c574a4ea9acd4ae7f3f3636b3b3">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4acf7cf5f8319fa3420133c2802e9f6"></a><!-- doxytag: member="stk::Sitar::noteOff" ref="ae4acf7cf5f8319fa3420133c2802e9f6" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#ae4acf7cf5f8319fa3420133c2802e9f6">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a811c8d08d78cfbd5061396af7027043e"></a><!-- doxytag: member="stk::Sitar::tick" ref="a811c8d08d78cfbd5061396af7027043e" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e">tick</a> (unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a755cc36fe9cde1942184af0b1ae88f7a">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </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="#a755cc36fe9cde1942184af0b1ae88f7a"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK sitar string model class. </p>
|
|
<p>This class implements a sitar plucked string physical model based on the Karplus-Strong algorithm.</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-2011. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a755cc36fe9cde1942184af0b1ae88f7a"></a><!-- doxytag: member="stk::Sitar::tick" ref="a755cc36fe9cde1942184af0b1ae88f7a" args="(StkFrames &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> & stk::Sitar::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </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="l00100"></a>00100 {
|
|
<a name="l00101"></a>00101 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<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 > frames.channels() - nChannels ) {
|
|
<a name="l00104"></a>00104 oStream_ << <span class="stringliteral">"Sitar::tick(): channel and StkFrames arguments are incompatible!"</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 = &frames[channel];
|
|
<a name="l00110"></a>00110 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - 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<frames.frames(); 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<frames.frames(); 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<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 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Sitar_8h_source.html">Sitar.h</a></li>
|
|
</ul>
|
|
</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>
|