mirror of
https://github.com/thestk/stk
synced 2026-01-12 04:21:52 +00:00
129 lines
15 KiB
HTML
129 lines
15 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.5.8 -->
|
|
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>TwoPole.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_TWOPOLE_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_TWOPOLE_H</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include "Filter.h"</span>
|
|
<a name="l00005"></a>00005
|
|
<a name="l00006"></a>00006 <span class="keyword">namespace </span>stk {
|
|
<a name="l00007"></a>00007
|
|
<a name="l00008"></a>00008 <span class="comment">/***************************************************/</span>
|
|
<a name="l00018"></a>00018 <span class="comment">/***************************************************/</span>
|
|
<a name="l00019"></a>00019
|
|
<a name="l00020"></a><a class="code" href="classstk_1_1TwoPole.html">00020</a> <span class="keyword">class </span><a class="code" href="classstk_1_1TwoPole.html" title="STK two-pole filter class.">TwoPole</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a>
|
|
<a name="l00021"></a>00021 {
|
|
<a name="l00022"></a>00022 <span class="keyword">public</span>:
|
|
<a name="l00023"></a>00023
|
|
<a name="l00025"></a>00025 <a class="code" href="classstk_1_1TwoPole.html#01a2b3b3d286e00a097918ec5f8a287b" title="Default constructor creates a second-order pass-through filter.">TwoPole</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00026"></a>00026
|
|
<a name="l00028"></a>00028 <a class="code" href="classstk_1_1TwoPole.html#abc2e1046f8f908fc78a53b50b00ed9f" title="Class destructor.">~TwoPole</a>();
|
|
<a name="l00029"></a>00029
|
|
<a name="l00031"></a><a class="code" href="classstk_1_1TwoPole.html#d0a3ac1b5d4e651a7ff1efb1d5362c0b">00031</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#d0a3ac1b5d4e651a7ff1efb1d5362c0b" title="A function to enable/disable the automatic updating of class data when the STK sample...">ignoreSampleRateChange</a>( <span class="keywordtype">bool</span> ignore = <span class="keyword">true</span> ) { ignoreSampleRateChange_ = ignore; };
|
|
<a name="l00032"></a>00032
|
|
<a name="l00034"></a><a class="code" href="classstk_1_1TwoPole.html#0a5bfc68061c1dbaa40bfbb9ddb67b7d">00034</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#0a5bfc68061c1dbaa40bfbb9ddb67b7d" title="Set the b[0] coefficient value.">setB0</a>( StkFloat b0 ) { b_[0] = b0; };
|
|
<a name="l00035"></a>00035
|
|
<a name="l00037"></a><a class="code" href="classstk_1_1TwoPole.html#d0c2f8ddc09ca1eb864515d816ebacdd">00037</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#d0c2f8ddc09ca1eb864515d816ebacdd" title="Set the a[1] coefficient value.">setA1</a>( StkFloat a1 ) { a_[1] = a1; };
|
|
<a name="l00038"></a>00038
|
|
<a name="l00040"></a><a class="code" href="classstk_1_1TwoPole.html#309960a8b2cf6858f43f43dc739146ea">00040</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#309960a8b2cf6858f43f43dc739146ea" title="Set the a[2] coefficient value.">setA2</a>( StkFloat a2 ) { a_[2] = a2; };
|
|
<a name="l00041"></a>00041
|
|
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#f9b68df9cc424a09e3ecb7f078bcacd3" title="Set all filter coefficients.">setCoefficients</a>( StkFloat b0, StkFloat a1, StkFloat a2, <span class="keywordtype">bool</span> clearState = <span class="keyword">false</span> );
|
|
<a name="l00044"></a>00044
|
|
<a name="l00046"></a>00046
|
|
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TwoPole.html#00997b12a1cf0a04888124eaf85c565d" title="Sets the filter coefficients for a resonance at frequency (in Hz).">setResonance</a>(StkFloat frequency, StkFloat radius, <span class="keywordtype">bool</span> normalize = <span class="keyword">false</span>);
|
|
<a name="l00060"></a>00060
|
|
<a name="l00062"></a><a class="code" href="classstk_1_1TwoPole.html#8a4fb4afe3e06c689827ecaec478aad1">00062</a> StkFloat <a class="code" href="classstk_1_1TwoPole.html#8a4fb4afe3e06c689827ecaec478aad1" title="Return the last computed output value.">lastOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_[0]; };
|
|
<a name="l00063"></a>00063
|
|
<a name="l00065"></a>00065 StkFloat <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">tick</a>( StkFloat input );
|
|
<a name="l00066"></a>00066
|
|
<a name="l00068"></a>00068
|
|
<a name="l00076"></a>00076 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
|
<a name="l00077"></a>00077
|
|
<a name="l00079"></a>00079
|
|
<a name="l00087"></a>00087 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& iFrames, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> &oFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannel = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> oChannel = 0 );
|
|
<a name="l00088"></a>00088
|
|
<a name="l00089"></a>00089 <span class="keyword">protected</span>:
|
|
<a name="l00090"></a>00090
|
|
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> sampleRateChanged( StkFloat newRate, StkFloat oldRate );
|
|
<a name="l00092"></a>00092 };
|
|
<a name="l00093"></a>00093
|
|
<a name="l00094"></a><a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc">00094</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">TwoPole :: tick</a>( StkFloat input )
|
|
<a name="l00095"></a>00095 {
|
|
<a name="l00096"></a>00096 inputs_[0] = gain_ * input;
|
|
<a name="l00097"></a>00097 lastFrame_[0] = b_[0] * inputs_[0] - a_[1] * outputs_[1] - a_[2] * outputs_[2];
|
|
<a name="l00098"></a>00098 outputs_[2] = outputs_[1];
|
|
<a name="l00099"></a>00099 outputs_[1] = lastFrame_[0];
|
|
<a name="l00100"></a>00100
|
|
<a name="l00101"></a>00101 <span class="keywordflow">return</span> lastFrame_[0];
|
|
<a name="l00102"></a>00102 }
|
|
<a name="l00103"></a>00103
|
|
<a name="l00104"></a><a class="code" href="classstk_1_1TwoPole.html#9e8bd9ed925a1c4966fbc0b0799ce46b">00104</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">TwoPole :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
|
|
<a name="l00105"></a>00105 {
|
|
<a name="l00106"></a>00106 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00107"></a>00107 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00108"></a>00108 errorString_ << <span class="stringliteral">"TwoPole::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00109"></a>00109 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
|
|
<a name="l00110"></a>00110 }
|
|
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
|
|
<a name="l00112"></a>00112 <span class="preprocessor"></span>
|
|
<a name="l00113"></a>00113 StkFloat *samples = &frames[channel];
|
|
<a name="l00114"></a>00114 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<a name="l00115"></a>00115 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.<a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, samples += hop ) {
|
|
<a name="l00116"></a>00116 inputs_[0] = gain_ * *samples;
|
|
<a name="l00117"></a>00117 *samples = b_[0] * inputs_[0] - a_[1] * outputs_[1] - a_[2] * outputs_[2];
|
|
<a name="l00118"></a>00118 outputs_[2] = outputs_[1];
|
|
<a name="l00119"></a>00119 outputs_[1] = *samples;
|
|
<a name="l00120"></a>00120 }
|
|
<a name="l00121"></a>00121
|
|
<a name="l00122"></a>00122 lastFrame_[0] = outputs_[1];
|
|
<a name="l00123"></a>00123 <span class="keywordflow">return</span> frames;
|
|
<a name="l00124"></a>00124 }
|
|
<a name="l00125"></a>00125
|
|
<a name="l00126"></a><a class="code" href="classstk_1_1TwoPole.html#5c9b52082c0d2845a5ca01ca276fe8f8">00126</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1TwoPole.html#d4612f9b6f971a4dd76b23bb2b9fefbc" title="Input one sample to the filter and return one output.">TwoPole :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& iFrames, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& oFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> oChannel )
|
|
<a name="l00127"></a>00127 {
|
|
<a name="l00128"></a>00128 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00129"></a>00129 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel >= iFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() || oChannel >= oFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00130"></a>00130 errorString_ << <span class="stringliteral">"TwoPole::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00131"></a>00131 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
|
|
<a name="l00132"></a>00132 }
|
|
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
|
|
<a name="l00134"></a>00134 <span class="preprocessor"></span>
|
|
<a name="l00135"></a>00135 StkFloat *iSamples = &iFrames[iChannel];
|
|
<a name="l00136"></a>00136 StkFloat *oSamples = &oFrames[oChannel];
|
|
<a name="l00137"></a>00137 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>(), oHop = oFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<a name="l00138"></a>00138 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<iFrames.<a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, iSamples += iHop, oSamples += oHop ) {
|
|
<a name="l00139"></a>00139 inputs_[0] = gain_ * *iSamples;
|
|
<a name="l00140"></a>00140 *oSamples = b_[0] * inputs_[0] - a_[1] * outputs_[1] - a_[2] * outputs_[2];
|
|
<a name="l00141"></a>00141 outputs_[2] = outputs_[1];
|
|
<a name="l00142"></a>00142 outputs_[1] = *oSamples;
|
|
<a name="l00143"></a>00143 }
|
|
<a name="l00144"></a>00144
|
|
<a name="l00145"></a>00145 lastFrame_[0] = outputs_[1];
|
|
<a name="l00146"></a>00146 <span class="keywordflow">return</span> iFrames;
|
|
<a name="l00147"></a>00147 }
|
|
<a name="l00148"></a>00148
|
|
<a name="l00149"></a>00149 } <span class="comment">// stk namespace</span>
|
|
<a name="l00150"></a>00150
|
|
<a name="l00151"></a>00151 <span class="preprocessor">#endif</span>
|
|
</pre></div></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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|