File: PoleZero_8h_source.html

package info (click to toggle)
stk 4.4.4-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 24,856 kB
  • sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (100 lines) | stat: -rw-r--r-- 10,149 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<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="dir_221deb9bdff892d63ed1e409450a60d2.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 &quot;Filter.h&quot;</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#ad9a46d21ee470d7afcd641807b5e314e" 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#abeb7feab68b5d8370bd9c2aef94c8541" title="Class destructor.">~PoleZero</a>();
<a name="l00030"></a>00030 
<a name="l00032"></a><a class="code" href="classstk_1_1PoleZero.html#a8e4a45e4a5263c66e9d447688975ca0f">00032</a>   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#a8e4a45e4a5263c66e9d447688975ca0f" 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#ae33d1e1f594b4cf9063518c7b065c5f5">00035</a>   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#ae33d1e1f594b4cf9063518c7b065c5f5" 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#ae3f0fc1182eb06730f09b8137c01779f">00038</a>   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#ae3f0fc1182eb06730f09b8137c01779f" 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#af34e485fbcaa1f4985a88a882ca9d5c5" 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="l00050"></a>00050   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#a51264d601b635aa0274c75ba1aa5a048" title="Set the filter for allpass behavior using coefficient.">setAllpass</a>( StkFloat coefficient );
<a name="l00051"></a>00051 
<a name="l00053"></a>00053 
<a name="l00059"></a>00059   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#acb7119d8964215546bbeeb6029f5c46f" title="Create a DC blocking filter with the given pole position in the z-plane.">setBlockZero</a>( StkFloat thePole = 0.99 );
<a name="l00060"></a>00060 
<a name="l00062"></a><a class="code" href="classstk_1_1PoleZero.html#a03edf036d1619bb5d33bb41701833232">00062</a>   StkFloat <a class="code" href="classstk_1_1PoleZero.html#a03edf036d1619bb5d33bb41701833232" 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_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228" 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="l00075"></a>00075   <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228" 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>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 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_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">00079</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228" title="Input one sample to the filter and return one output.">PoleZero :: 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_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];
<a name="l00083"></a>00083   inputs_[1] = inputs_[0];
<a name="l00084"></a>00084   outputs_[1] = lastFrame_[0];
<a name="l00085"></a>00085 
<a name="l00086"></a>00086   <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088 
<a name="l00089"></a><a class="code" href="classstk_1_1PoleZero.html#a1b5e97a13c582d97cfaa7fcbd4211b47">00089</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>&amp; <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228" 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>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span>  <span class="keywordflow">if</span> ( channel &gt;= frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
<a name="l00093"></a>00093     oStream_ &lt;&lt; <span class="stringliteral">&quot;PoleZero::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00094"></a>00094     <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="l00095"></a>00095   }
<a name="l00096"></a>00096 <span class="preprocessor">#endif</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>
<a name="l00098"></a>00098   StkFloat *samples = &amp;frames[channel];
<a name="l00099"></a>00099   <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="l00100"></a>00100   <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;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="l00101"></a>00101     inputs_[0] = gain_ * *samples;
<a name="l00102"></a>00102     *samples = b_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];
<a name="l00103"></a>00103     inputs_[1] = inputs_[0];
<a name="l00104"></a>00104     outputs_[1] = *samples;
<a name="l00105"></a>00105   }
<a name="l00106"></a>00106 
<a name="l00107"></a>00107   lastFrame_[0] = outputs_[1];
<a name="l00108"></a>00108   <span class="keywordflow">return</span> frames;
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 } <span class="comment">// stk namespace</span>
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>