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

191 lines
15 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_1Cubic.html">Cubic</a>
</div>
<div class="contents">
<h1>stk::Cubic Class Reference</h1><!-- doxytag: class="stk::Cubic" --><!-- doxytag: inherits="stk::Function" -->
<p>STK cubic non-linearity class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Cubic_8h_source.html">Cubic.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Cubic:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Cubic.png" usemap="#stk::Cubic_map" alt=""/>
<map id="stk::Cubic_map" name="stk::Cubic_map">
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,82,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,82,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Cubic-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="a2059a20146f6d7ec0854dc860ca90895"></a><!-- doxytag: member="stk::Cubic::Cubic" ref="a2059a20146f6d7ec0854dc860ca90895" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#a2059a20146f6d7ec0854dc860ca90895">Cubic</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"><a class="anchor" id="af4604c69f138415f9b9ee6944d2b54ef"></a><!-- doxytag: member="stk::Cubic::setA1" ref="af4604c69f138415f9b9ee6944d2b54ef" args="(StkFloat a1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#af4604c69f138415f9b9ee6944d2b54ef">setA1</a> (StkFloat a1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a1 coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa16d53e6a720936543d0e0ea778f0eb"></a><!-- doxytag: member="stk::Cubic::setA2" ref="afa16d53e6a720936543d0e0ea778f0eb" args="(StkFloat a2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#afa16d53e6a720936543d0e0ea778f0eb">setA2</a> (StkFloat a2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a2 coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add4a05676471c4c09b76f5fe430b80fa"></a><!-- doxytag: member="stk::Cubic::setA3" ref="add4a05676471c4c09b76f5fe430b80fa" args="(StkFloat a3)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#add4a05676471c4c09b76f5fe430b80fa">setA3</a> (StkFloat a3)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a3 coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3eca8ac3f81301592476aad7a2e1ec50"></a><!-- doxytag: member="stk::Cubic::setGain" ref="a3eca8ac3f81301592476aad7a2e1ec50" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#a3eca8ac3f81301592476aad7a2e1ec50">setGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10ba2b5c858fc2d656d49c676d5561b4"></a><!-- doxytag: member="stk::Cubic::setThreshold" ref="a10ba2b5c858fc2d656d49c676d5561b4" args="(StkFloat threshold)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#a10ba2b5c858fc2d656d49c676d5561b4">setThreshold</a> (StkFloat threshold)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the threshold value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24e2270a347e0a6721bc0f7e0040117c"></a><!-- doxytag: member="stk::Cubic::tick" ref="a24e2270a347e0a6721bc0f7e0040117c" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Cubic.html#a24e2270a347e0a6721bc0f7e0040117c">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the function and return one 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_1Cubic.html#af3e8a1d6ffe5e9788d841343bd5722cc">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 function and replace with corresponding outputs. <a href="#af3e8a1d6ffe5e9788d841343bd5722cc"></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_1Cubic.html#aef7887fe7e5131ce48c8488a21d295b9">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 function and write outputs to the <code>oFrames</code> object. <a href="#aef7887fe7e5131ce48c8488a21d295b9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK cubic non-linearity class. </p>
<p>This class implements the cubic non-linearity that was used in SynthBuilder.</p>
<p>The formula implemented is:</p>
<div class="fragment"><pre class="fragment"> output = gain * (a1 * input + a2 * input^2 + a3 * input^3)
</pre></div><p>followed by a limiter for values outside +-threshold.</p>
<p>Ported to STK by Nick Porcaro, 2007. Updated for inclusion in STK distribution by Gary Scavone, 2011. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af3e8a1d6ffe5e9788d841343bd5722cc"></a><!-- doxytag: member="stk::Cubic::tick" ref="af3e8a1d6ffe5e9788d841343bd5722cc" 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::Cubic::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 function 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="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= frames.channels() ) {
<a name="l00103"></a>00103 oStream_ &lt;&lt; <span class="stringliteral">&quot;Cubic::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00104"></a>00104 <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="l00105"></a>00105 }
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>
<a name="l00108"></a>00108 StkFloat *samples = &amp;frames[channel];
<a name="l00109"></a>00109 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00110"></a>00110 <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="l00111"></a>00111 *samples = <a class="code" href="classstk_1_1Cubic.html#a24e2270a347e0a6721bc0f7e0040117c" title="Input one sample to the function and return one output.">tick</a>( *samples );
<a name="l00112"></a>00112
<a name="l00113"></a>00113 lastFrame_[0] = *(samples-hop);
<a name="l00114"></a>00114 <span class="keywordflow">return</span> frames;
<a name="l00115"></a>00115 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="aef7887fe7e5131ce48c8488a21d295b9"></a><!-- doxytag: member="stk::Cubic::tick" ref="aef7887fe7e5131ce48c8488a21d295b9" 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::Cubic::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 function 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="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel &gt;= iFrames.channels() || oChannel &gt;= oFrames.channels() ) {
<a name="l00121"></a>00121 oStream_ &lt;&lt; <span class="stringliteral">&quot;Cubic::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00122"></a>00122 <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="l00123"></a>00123 }
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00126"></a>00126 StkFloat *iSamples = &amp;iFrames[iChannel];
<a name="l00127"></a>00127 StkFloat *oSamples = &amp;oFrames[oChannel];
<a name="l00128"></a>00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.channels(), oHop = oFrames.channels();
<a name="l00129"></a>00129 <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="l00130"></a>00130 *oSamples = <a class="code" href="classstk_1_1Cubic.html#a24e2270a347e0a6721bc0f7e0040117c" title="Input one sample to the function and return one output.">tick</a>( *iSamples );
<a name="l00131"></a>00131
<a name="l00132"></a>00132 lastFrame_[0] = *(oSamples-oHop);
<a name="l00133"></a>00133 <span class="keywordflow">return</span> iFrames;
<a name="l00134"></a>00134 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Cubic_8h_source.html">Cubic.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