mirror of
https://github.com/thestk/stk
synced 2026-01-11 20:11:52 +00:00
101 lines
9.9 KiB
HTML
101 lines
9.9 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>PoleZero.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_POLEZERO_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_POLEZERO_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="l00019"></a>00019 <span class="comment">/***************************************************/</span>
|
|
<a name="l00020"></a>00020
|
|
<a name="l00021"></a><a class="code" href="classstk_1_1PoleZero.html">00021</a> <span class="keyword">class </span><a class="code" href="classstk_1_1PoleZero.html" title="STK one-pole, one-zero filter class.">PoleZero</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a>
|
|
<a name="l00022"></a>00022 {
|
|
<a name="l00023"></a>00023 <span class="keyword">public</span>:
|
|
<a name="l00024"></a>00024
|
|
<a name="l00026"></a>00026 <a class="code" href="classstk_1_1PoleZero.html#d9a46d21ee470d7afcd641807b5e314e" title="Default constructor creates a first-order pass-through filter.">PoleZero</a>();
|
|
<a name="l00027"></a>00027
|
|
<a name="l00029"></a>00029 <a class="code" href="classstk_1_1PoleZero.html#beb7feab68b5d8370bd9c2aef94c8541" title="Class destructor.">~PoleZero</a>();
|
|
<a name="l00030"></a>00030
|
|
<a name="l00032"></a><a class="code" href="classstk_1_1PoleZero.html#8e4a45e4a5263c66e9d447688975ca0f">00032</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#8e4a45e4a5263c66e9d447688975ca0f" title="Set the b[0] coefficient value.">setB0</a>( StkFloat b0 ) { b_[0] = b0; };
|
|
<a name="l00033"></a>00033
|
|
<a name="l00035"></a><a class="code" href="classstk_1_1PoleZero.html#e33d1e1f594b4cf9063518c7b065c5f5">00035</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#e33d1e1f594b4cf9063518c7b065c5f5" title="Set the b[1] coefficient value.">setB1</a>( StkFloat b1 ) { b_[1] = b1; };
|
|
<a name="l00036"></a>00036
|
|
<a name="l00038"></a><a class="code" href="classstk_1_1PoleZero.html#e3f0fc1182eb06730f09b8137c01779f">00038</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#e3f0fc1182eb06730f09b8137c01779f" title="Set the a[1] coefficient value.">setA1</a>( StkFloat a1 ) { a_[1] = a1; };
|
|
<a name="l00039"></a>00039
|
|
<a name="l00041"></a>00041 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#f34e485fbcaa1f4985a88a882ca9d5c5" title="Set all filter coefficients.">setCoefficients</a>( StkFloat b0, StkFloat b1, StkFloat a1, <span class="keywordtype">bool</span> clearState = <span class="keyword">false</span> );
|
|
<a name="l00042"></a>00042
|
|
<a name="l00044"></a>00044
|
|
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#51264d601b635aa0274c75ba1aa5a048" title="Set the filter for allpass behavior using coefficient.">setAllpass</a>( StkFloat coefficient );
|
|
<a name="l00050"></a>00050
|
|
<a name="l00052"></a>00052
|
|
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#cb7119d8964215546bbeeb6029f5c46f" title="Create a DC blocking filter with the given pole position in the z-plane.">setBlockZero</a>( StkFloat thePole = 0.99 );
|
|
<a name="l00059"></a>00059
|
|
<a name="l00061"></a><a class="code" href="classstk_1_1PoleZero.html#03edf036d1619bb5d33bb41701833232">00061</a> StkFloat <a class="code" href="classstk_1_1PoleZero.html#03edf036d1619bb5d33bb41701833232" 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="l00062"></a>00062
|
|
<a name="l00064"></a>00064 StkFloat <a class="code" href="classstk_1_1PoleZero.html#1a29ac6f3a2b75e71693c73554599228" title="Input one sample to the filter and return one output.">tick</a>( StkFloat input );
|
|
<a name="l00065"></a>00065
|
|
<a name="l00067"></a>00067
|
|
<a name="l00074"></a>00074 <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_1PoleZero.html#1a29ac6f3a2b75e71693c73554599228" 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="l00075"></a>00075
|
|
<a name="l00076"></a>00076 };
|
|
<a name="l00077"></a>00077
|
|
<a name="l00078"></a><a class="code" href="classstk_1_1PoleZero.html#1a29ac6f3a2b75e71693c73554599228">00078</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1PoleZero.html#1a29ac6f3a2b75e71693c73554599228" title="Input one sample to the filter and return one output.">PoleZero :: tick</a>( StkFloat input )
|
|
<a name="l00079"></a>00079 {
|
|
<a name="l00080"></a>00080 inputs_[0] = gain_ * input;
|
|
<a name="l00081"></a>00081 lastFrame_[0] = b_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];
|
|
<a name="l00082"></a>00082 inputs_[1] = inputs_[0];
|
|
<a name="l00083"></a>00083 outputs_[1] = lastFrame_[0];
|
|
<a name="l00084"></a>00084
|
|
<a name="l00085"></a>00085 <span class="keywordflow">return</span> lastFrame_[0];
|
|
<a name="l00086"></a>00086 }
|
|
<a name="l00087"></a>00087
|
|
<a name="l00088"></a><a class="code" href="classstk_1_1PoleZero.html#1b5e97a13c582d97cfaa7fcbd4211b47">00088</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_1PoleZero.html#1a29ac6f3a2b75e71693c73554599228" title="Input one sample to the filter and return one output.">PoleZero :: 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="l00089"></a>00089 {
|
|
<a name="l00090"></a>00090 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00091"></a>00091 <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="l00092"></a>00092 errorString_ << <span class="stringliteral">"PoleZero::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00093"></a>00093 <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="l00094"></a>00094 }
|
|
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
|
|
<a name="l00096"></a>00096 <span class="preprocessor"></span>
|
|
<a name="l00097"></a>00097 StkFloat *samples = &frames[channel];
|
|
<a name="l00098"></a>00098 <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="l00099"></a>00099 <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="l00100"></a>00100 inputs_[0] = gain_ * *samples;
|
|
<a name="l00101"></a>00101 *samples = b_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];
|
|
<a name="l00102"></a>00102 inputs_[1] = inputs_[0];
|
|
<a name="l00103"></a>00103 outputs_[1] = *samples;
|
|
<a name="l00104"></a>00104 }
|
|
<a name="l00105"></a>00105
|
|
<a name="l00106"></a>00106 lastFrame_[0] = outputs_[1];
|
|
<a name="l00107"></a>00107 <span class="keywordflow">return</span> frames;
|
|
<a name="l00108"></a>00108 }
|
|
<a name="l00109"></a>00109
|
|
<a name="l00110"></a>00110 } <span class="comment">// stk namespace</span>
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 <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>
|