mirror of
https://github.com/thestk/stk
synced 2026-01-11 20:11:52 +00:00
120 lines
13 KiB
HTML
120 lines
13 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.6.2 -->
|
|
<div class="navpath"><a class="el" href="dir_f14fd23bc74c76f288031ad23b3f3505.html">include</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>OneZero.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_ONEZERO_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_ONEZERO_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_1OneZero.html">00020</a> <span class="keyword">class </span><a class="code" href="classstk_1_1OneZero.html" title="STK one-zero filter class.">OneZero</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_1OneZero.html#ada639198d28be5d170508a301ba854da" title="The default constructor creates a low-pass filter (zero at z = -1.0).">OneZero</a>( StkFloat theZero = -1.0 );
|
|
<a name="l00026"></a>00026
|
|
<a name="l00028"></a>00028 <a class="code" href="classstk_1_1OneZero.html#a8abe6156bad57d3a5cfebcf2ddc9b703" title="Class destructor.">~OneZero</a>();
|
|
<a name="l00029"></a>00029
|
|
<a name="l00031"></a><a class="code" href="classstk_1_1OneZero.html#aef2a8aa1759762649a74fc031198ebca">00031</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1OneZero.html#aef2a8aa1759762649a74fc031198ebca" title="Set the b[0] coefficient value.">setB0</a>( StkFloat b0 ) { b_[0] = b0; };
|
|
<a name="l00032"></a>00032
|
|
<a name="l00034"></a><a class="code" href="classstk_1_1OneZero.html#ad4eda332f920e43a33871c8beb6f3042">00034</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1OneZero.html#ad4eda332f920e43a33871c8beb6f3042" title="Set the b[1] coefficient value.">setB1</a>( StkFloat b1 ) { b_[1] = b1; };
|
|
<a name="l00035"></a>00035
|
|
<a name="l00037"></a>00037 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1OneZero.html#a6113bf1dce0cb23719e30ee29e7c6735" title="Set all filter coefficients.">setCoefficients</a>( StkFloat b0, StkFloat b1, <span class="keywordtype">bool</span> clearState = <span class="keyword">false</span> );
|
|
<a name="l00038"></a>00038
|
|
<a name="l00040"></a>00040
|
|
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1OneZero.html#af8301fdb6a893ec6eb74fbcbeeaa463c" title="Set the zero position in the z-plane.">setZero</a>( StkFloat theZero );
|
|
<a name="l00048"></a>00048
|
|
<a name="l00050"></a><a class="code" href="classstk_1_1OneZero.html#a54e160f62354939876477d9c5a65890c">00050</a> StkFloat <a class="code" href="classstk_1_1OneZero.html#a54e160f62354939876477d9c5a65890c" 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="l00051"></a>00051
|
|
<a name="l00053"></a>00053 StkFloat <a class="code" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">tick</a>( StkFloat input );
|
|
<a name="l00054"></a>00054
|
|
<a name="l00056"></a>00056
|
|
<a name="l00064"></a>00064 <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_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" 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="l00065"></a>00065
|
|
<a name="l00067"></a>00067
|
|
<a name="l00075"></a>00075 <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_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" 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="l00076"></a>00076
|
|
<a name="l00077"></a>00077 };
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a><a class="code" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da">00079</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">OneZero :: tick</a>( StkFloat input )
|
|
<a name="l00080"></a>00080 {
|
|
<a name="l00081"></a>00081 inputs_[0] = gain_ * input;
|
|
<a name="l00082"></a>00082 lastFrame_[0] = b_[1] * inputs_[1] + b_[0] * inputs_[0];
|
|
<a name="l00083"></a>00083 inputs_[1] = inputs_[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_1OneZero.html#a2ca42a158bed919d8578c4a2dd184b3d">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_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">OneZero :: 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#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00092"></a>00092 oStream_ << <span class="stringliteral">"OneZero::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00093"></a>00093 <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="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#aec7ef9c46675a24111aa6e2fda3ba870" 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#a05b1ab6fa750a8221a7d65c30e0cdab9" 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_[1] * inputs_[1] + b_[0] * inputs_[0];
|
|
<a name="l00102"></a>00102 inputs_[1] = inputs_[0];
|
|
<a name="l00103"></a>00103 }
|
|
<a name="l00104"></a>00104
|
|
<a name="l00105"></a>00105 lastFrame_[0] = *(samples-hop);
|
|
<a name="l00106"></a>00106 <span class="keywordflow">return</span> frames;
|
|
<a name="l00107"></a>00107 }
|
|
<a name="l00108"></a>00108
|
|
<a name="l00109"></a><a class="code" href="classstk_1_1OneZero.html#a8568a0d8c4aacc64b656b9fe46f217a4">00109</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_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">OneZero :: 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="l00110"></a>00110 {
|
|
<a name="l00111"></a>00111 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00112"></a>00112 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel >= iFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() || oChannel >= oFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
|
<a name="l00113"></a>00113 oStream_ << <span class="stringliteral">"OneZero::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00114"></a>00114 <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="l00115"></a>00115 }
|
|
<a name="l00116"></a>00116 <span class="preprocessor">#endif</span>
|
|
<a name="l00117"></a>00117 <span class="preprocessor"></span>
|
|
<a name="l00118"></a>00118 StkFloat *iSamples = &iFrames[iChannel];
|
|
<a name="l00119"></a>00119 StkFloat *oSamples = &oFrames[oChannel];
|
|
<a name="l00120"></a>00120 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>(), oHop = oFrames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<a name="l00121"></a>00121 <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#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, iSamples += iHop, oSamples += oHop ) {
|
|
<a name="l00122"></a>00122 inputs_[0] = gain_ * *iSamples;
|
|
<a name="l00123"></a>00123 *oSamples = b_[1] * inputs_[1] + b_[0] * inputs_[0];
|
|
<a name="l00124"></a>00124 inputs_[1] = inputs_[0];
|
|
<a name="l00125"></a>00125 }
|
|
<a name="l00126"></a>00126
|
|
<a name="l00127"></a>00127 lastFrame_[0] = *(oSamples-oHop);
|
|
<a name="l00128"></a>00128 <span class="keywordflow">return</span> iFrames;
|
|
<a name="l00129"></a>00129 }
|
|
<a name="l00130"></a>00130
|
|
<a name="l00131"></a>00131 } <span class="comment">// stk namespace</span>
|
|
<a name="l00132"></a>00132
|
|
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
|
|
<a name="l00134"></a>00134 <span class="preprocessor"></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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|