e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-20 07:51:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:49:37 +02:00
committed by Stephen Sinclair
parent cfdfe7736a
commit f13d5bb3cd
632 changed files with 12236 additions and 19041 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
doc/html/classstk_1_1ReedTable.html
View File

@@ -51,7 +51,7 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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 - 2010. </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">
@@ -72,6 +72,9 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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)" -->
@@ -93,6 +96,9 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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)" -->
@@ -123,6 +129,27 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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)" -->
@@ -165,6 +192,28 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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>
@@ -175,7 +224,7 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>