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

232 lines
16 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_1ReedTable.html">ReedTable</a>
</div>
<div class="contents">
<h1>stk::ReedTable Class Reference</h1><!-- doxytag: class="stk::ReedTable" --><!-- doxytag: inherits="stk::Function" -->
<p>STK reed table class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ReedTable_8h_source.html">ReedTable.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::ReedTable:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1ReedTable.png" usemap="#stk::ReedTable_map" alt=""/>
<map id="stk::ReedTable_map" name="stk::ReedTable_map">
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,93,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,93,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1ReedTable-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="a138db7619ec28a4feeaf2a00988e4f0d"></a><!-- doxytag: member="stk::ReedTable::ReedTable" ref="a138db7619ec28a4feeaf2a00988e4f0d" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a138db7619ec28a4feeaf2a00988e4f0d">ReedTable</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <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_1ReedTable.html#ab40ffd675bd7242a210e8630f8919556">setOffset</a> (StkFloat offset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the table offset value. <a href="#ab40ffd675bd7242a210e8630f8919556"></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_1ReedTable.html#a968a97400ec6bd424634ff377fc6417a">setSlope</a> (StkFloat slope)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the table slope value. <a href="#a968a97400ec6bd424634ff377fc6417a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c1607ed5712e2ab010d8c5e55e431f2"></a><!-- doxytag: member="stk::ReedTable::tick" ref="a3c1607ed5712e2ab010d8c5e55e431f2" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a3c1607ed5712e2ab010d8c5e55e431f2">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take one sample input and map to one sample of output. <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_1ReedTable.html#a3455fa2dedb2c86fc825ec48296822be">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 <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. <a href="#a3455fa2dedb2c86fc825ec48296822be"></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_1ReedTable.html#ae682fdc0a6ec68a9f858f5cd6889113d">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 table and write outputs to the <code>oFrames</code> object. <a href="#ae682fdc0a6ec68a9f858f5cd6889113d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK reed table class. </p>
<p>This class implements a simple one breakpoint, non-linear reed function, as described by Smith (1986). This function is based on a memoryless non-linear spring model of the reed (the reed mass is ignored) which saturates when the reed collides with the mouthpiece facing.</p>
<p>See McIntyre, Schumacher, &amp; Woodhouse (1983), Smith (1986), Hirschman, Cook, Scavone, and others for more information.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab40ffd675bd7242a210e8630f8919556"></a><!-- doxytag: member="stk::ReedTable::setOffset" ref="ab40ffd675bd7242a210e8630f8919556" args="(StkFloat offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::ReedTable::setOffset </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>offset</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the table offset value. </p>
<p>The table offset roughly corresponds to the size of the initial reed tip opening (a greater offset represents a smaller opening). </p>
<p><div class="fragment"><pre class="fragment"><a name="l00039"></a>00039 { offset_ = offset; };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a968a97400ec6bd424634ff377fc6417a"></a><!-- doxytag: member="stk::ReedTable::setSlope" ref="a968a97400ec6bd424634ff377fc6417a" args="(StkFloat slope)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::ReedTable::setSlope </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>slope</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the table slope value. </p>
<p>The table slope roughly corresponds to the reed stiffness (a greater slope represents a harder reed). </p>
<p><div class="fragment"><pre class="fragment"><a name="l00047"></a>00047 { slope_ = slope; };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a3455fa2dedb2c86fc825ec48296822be"></a><!-- doxytag: member="stk::ReedTable::tick" ref="a3455fa2dedb2c86fc825ec48296822be" 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::ReedTable::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 <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. </p>
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. 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><div class="fragment"><pre class="fragment"><a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= frames.channels() ) {
<a name="l00102"></a>00102 oStream_ &lt;&lt; <span class="stringliteral">&quot;ReedTable::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00103"></a>00103 <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="l00104"></a>00104 }
<a name="l00105"></a>00105 <span class="preprocessor">#endif</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span>
<a name="l00107"></a>00107 StkFloat *samples = &amp;frames[channel];
<a name="l00108"></a>00108 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00109"></a>00109 <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="l00110"></a>00110 *samples = offset_ + (slope_ * *samples);
<a name="l00111"></a>00111 <span class="keywordflow">if</span> ( *samples &gt; 1.0) *samples = 1.0;
<a name="l00112"></a>00112 <span class="keywordflow">if</span> ( *samples &lt; -1.0) *samples = -1.0;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a>00115 lastFrame_[0] = *(samples-hop);
<a name="l00116"></a>00116 <span class="keywordflow">return</span> frames;
<a name="l00117"></a>00117 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="ae682fdc0a6ec68a9f858f5cd6889113d"></a><!-- doxytag: member="stk::ReedTable::tick" ref="ae682fdc0a6ec68a9f858f5cd6889113d" 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::ReedTable::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 table 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="l00120"></a>00120 {
<a name="l00121"></a>00121 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel &gt;= iFrames.channels() || oChannel &gt;= oFrames.channels() ) {
<a name="l00123"></a>00123 oStream_ &lt;&lt; <span class="stringliteral">&quot;ReedTable::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00124"></a>00124 <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="l00125"></a>00125 }
<a name="l00126"></a>00126 <span class="preprocessor">#endif</span>
<a name="l00127"></a>00127 <span class="preprocessor"></span>
<a name="l00128"></a>00128 StkFloat *iSamples = &amp;iFrames[iChannel];
<a name="l00129"></a>00129 StkFloat *oSamples = &amp;oFrames[oChannel];
<a name="l00130"></a>00130 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.channels(), oHop = oFrames.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;iFrames.frames(); i++, iSamples += iHop, oSamples += oHop ) {
<a name="l00132"></a>00132 *oSamples = offset_ + (slope_ * *iSamples);
<a name="l00133"></a>00133 <span class="keywordflow">if</span> ( *oSamples &gt; 1.0) *oSamples = 1.0;
<a name="l00134"></a>00134 <span class="keywordflow">if</span> ( *oSamples &lt; -1.0) *oSamples = -1.0;
<a name="l00135"></a>00135 }
<a name="l00136"></a>00136
<a name="l00137"></a>00137 lastFrame_[0] = *(oSamples-oHop);
<a name="l00138"></a>00138 <span class="keywordflow">return</span> iFrames;
<a name="l00139"></a>00139 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ReedTable_8h_source.html">ReedTable.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