e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-17 06:41:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f13d5bb3cd8ba1350786b36fba9a538babb210d0
stk/doc/html/classstk_1_1Twang.html
Gary Scavone f13d5bb3cd Release 4.4.3 tarball
2013-09-29 23:49:37 +02:00

235 lines
18 KiB
HTML
Raw Blame History

<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="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Twang.html">Twang</a>
</div>
<div class="contents">
<h1>stk::Twang Class Reference</h1><!-- doxytag: class="stk::Twang" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK enhanced plucked string class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Twang_8h_source.html">Twang.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Twang:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Twang.png" usemap="#stk::Twang_map" alt=""/>
<map id="stk::Twang_map" name="stk::Twang_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,70,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Twang-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="a813e99ee79974707a3afbfcab963c086"></a><!-- doxytag: member="stk::Twang::Twang" ref="a813e99ee79974707a3afbfcab963c086" args="(StkFloat lowestFrequency=50.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a813e99ee79974707a3afbfcab963c086">Twang</a> (StkFloat lowestFrequency=50.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="adae2759ef254101f91aa3a0a5c3fba39"></a><!-- doxytag: member="stk::Twang::~Twang" ref="adae2759ef254101f91aa3a0a5c3fba39" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#adae2759ef254101f91aa3a0a5c3fba39">~Twang</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cdd4bf2e486239429f6d4f0f277cea9"></a><!-- doxytag: member="stk::Twang::clear" ref="a7cdd4bf2e486239429f6d4f0f277cea9" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a7cdd4bf2e486239429f6d4f0f277cea9">clear</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="ae27aa429cbf49f0dd60f0cc6ef41c832"></a><!-- doxytag: member="stk::Twang::setLowestFrequency" ref="ae27aa429cbf49f0dd60f0cc6ef41c832" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ae27aa429cbf49f0dd60f0cc6ef41c832">setLowestFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the delayline parameters to allow frequencies as low as specified. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0043b9d374b73b6660ec2d79475d602c"></a><!-- doxytag: member="stk::Twang::setFrequency" ref="a0043b9d374b73b6660ec2d79475d602c" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a0043b9d374b73b6660ec2d79475d602c">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the delayline parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48008e3cd55dad6ee846b47ab32f993f"></a><!-- doxytag: member="stk::Twang::setPluckPosition" ref="a48008e3cd55dad6ee846b47ab32f993f" args="(StkFloat position)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a48008e3cd55dad6ee846b47ab32f993f">setPluckPosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the pluck or "excitation" position along the string (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ad7921c51f38b4e6e32d7db48cc101068">setLoopGain</a> (StkFloat loopGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the nominal loop gain. <a href="#ad7921c51f38b4e6e32d7db48cc101068"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a7076c25dd3a06262b3bf927bc64bf89e">setLoopFilter</a> (std::vector&lt; StkFloat &gt; coefficients)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the loop filter coefficients. <a href="#a7076c25dd3a06262b3bf927bc64bf89e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab54245fcb75144a8ffcc879789abc952"></a><!-- doxytag: member="stk::Twang::lastFrame" ref="ab54245fcb75144a8ffcc879789abc952" args="(void) const " -->
const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ab54245fcb75144a8ffcc879789abc952">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3441ff449e3f7a451873e67d4c680ce9"></a><!-- doxytag: member="stk::Twang::tick" ref="a3441ff449e3f7a451873e67d4c680ce9" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ae9e770c446e1459a5e89c0bc8285f5e3">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the class and write outputs to the <code>oFrames</code> object. <a href="#ae9e770c446e1459a5e89c0bc8285f5e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a089ff55338a22647d94665d6adbeb7ae">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the effect and write outputs to the <code>oFrames</code> object. <a href="#a089ff55338a22647d94665d6adbeb7ae"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK enhanced plucked string class. </p>
<p>This class implements an enhanced plucked-string physical model, a la Jaffe-Smith, Smith, Karjalainen and others. It includes a comb filter to simulate pluck position. The <a class="el" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick()</a> function takes an input sample, which is added to the delayline input. This can be used to implement commuted synthesis (if the input samples are derived from the impulse response of a body filter) and/or feedback (as in an electric guitar model).</p>
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad7921c51f38b4e6e32d7db48cc101068"></a><!-- doxytag: member="stk::Twang::setLoopGain" ref="ad7921c51f38b4e6e32d7db48cc101068" args="(StkFloat loopGain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Twang::setLoopGain </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>loopGain</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the nominal loop gain. </p>
<p>The actual loop gain is based on the value set with this function, but scaled slightly according to the frequency. Higher frequency settings have greater loop gains because of high-frequency loop-filter roll-off. </p>
</div>
</div>
<a class="anchor" id="a7076c25dd3a06262b3bf927bc64bf89e"></a><!-- doxytag: member="stk::Twang::setLoopFilter" ref="a7076c25dd3a06262b3bf927bc64bf89e" args="(std::vector&lt; StkFloat &gt; coefficients)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Twang::setLoopFilter </td>
<td>(</td>
<td class="paramtype">std::vector&lt; StkFloat &gt;&nbsp;</td>
<td class="paramname"> <em>coefficients</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the loop filter coefficients. </p>
<p>The loop filter can be any arbitrary FIR filter. By default, the coefficients are set for a first-order lowpass filter with coefficients b = [0.5 0.5]. </p>
</div>
</div>
<a class="anchor" id="ae9e770c446e1459a5e89c0bc8285f5e3"></a><!-- doxytag: member="stk::Twang::tick" ref="ae9e770c446e1459a5e89c0bc8285f5e3" args="(StkFrames &amp;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> &amp; stk::Twang::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Take a channel of the <code>iFrames</code> object as inputs to the class and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <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><div class="fragment"><pre class="fragment"><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 &gt;= frames.channels() ) {
<a name="l00124"></a>00124 oStream_ &lt;&lt; <span class="stringliteral">&quot;Twang::tick(): channel and StkFrames arguments are incompatible!&quot;</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 = &amp;frames[channel];
<a name="l00130"></a>00130 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00131"></a>00131 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); 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 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="a089ff55338a22647d94665d6adbeb7ae"></a><!-- doxytag: member="stk::Twang::tick" ref="a089ff55338a22647d94665d6adbeb7ae" args="(StkFrames &amp;iFrames, StkFrames &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::Twang::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>iFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>oFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>iChannel</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>oChannel</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Take a channel of the <code>iFrames</code> object as inputs to the effect and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <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><div class="fragment"><pre class="fragment"><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 &gt;= iFrames.channels() || oChannel &gt;= oFrames.channels() ) {
<a name="l00141"></a>00141 oStream_ &lt;&lt; <span class="stringliteral">&quot;Twang::tick(): channel and StkFrames arguments are incompatible!&quot;</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 = &amp;iFrames[iChannel];
<a name="l00147"></a>00147 StkFloat *oSamples = &amp;oFrames[oChannel];
<a name="l00148"></a>00148 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.channels(), oHop = oFrames.channels();
<a name="l00149"></a>00149 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;iFrames.frames(); 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 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Twang_8h_source.html">Twang.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>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink