mirror of
https://github.com/thestk/stk
synced 2026-01-14 05:21:53 +00:00
278 lines
19 KiB
HTML
278 lines
19 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="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1BiQuad.html">BiQuad</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::BiQuad Class Reference</h1><!-- doxytag: class="stk::BiQuad" --><!-- doxytag: inherits="stk::Filter" -->STK biquad (two-pole, two-zero) filter class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="BiQuad_8h-source.html">BiQuad.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::BiQuad:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1BiQuad.png" usemap="#stk::BiQuad_map" border="0" alt=""></center>
|
|
<map name="stk::BiQuad_map">
|
|
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,75,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,75,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1BiQuad-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91aab9d1b4833e156edcf59cbe276e3f"></a><!-- doxytag: member="stk::BiQuad::BiQuad" ref="91aab9d1b4833e156edcf59cbe276e3f" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#91aab9d1b4833e156edcf59cbe276e3f">BiQuad</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor creates a second-order pass-through filter. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7e81be1c4e5c5ab69474f6df2610984"></a><!-- doxytag: member="stk::BiQuad::~BiQuad" ref="d7e81be1c4e5c5ab69474f6df2610984" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#d7e81be1c4e5c5ab69474f6df2610984">~BiQuad</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab468cd1aa79b95442b15bb04d8bb211"></a><!-- doxytag: member="stk::BiQuad::ignoreSampleRateChange" ref="ab468cd1aa79b95442b15bb04d8bb211" args="(bool ignore=true)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ab468cd1aa79b95442b15bb04d8bb211">ignoreSampleRateChange</a> (bool ignore=true)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A function to enable/disable the automatic updating of class data when the STK sample rate changes. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eed58196cf798f664cddbb9a8564c7b5"></a><!-- doxytag: member="stk::BiQuad::setCoefficients" ref="eed58196cf798f664cddbb9a8564c7b5" args="(StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#eed58196cf798f664cddbb9a8564c7b5">setCoefficients</a> (StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all filter coefficients. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26ee25d08116b20f326001166f087853"></a><!-- doxytag: member="stk::BiQuad::setB0" ref="26ee25d08116b20f326001166f087853" args="(StkFloat b0)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#26ee25d08116b20f326001166f087853">setB0</a> (StkFloat b0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the b[0] coefficient value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd364ed410b3ed2a2b29b8a5fea127c8"></a><!-- doxytag: member="stk::BiQuad::setB1" ref="dd364ed410b3ed2a2b29b8a5fea127c8" args="(StkFloat b1)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#dd364ed410b3ed2a2b29b8a5fea127c8">setB1</a> (StkFloat b1)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the b[1] coefficient value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="208a654dd3393ed0b2b86ad56d9cf3e1"></a><!-- doxytag: member="stk::BiQuad::setB2" ref="208a654dd3393ed0b2b86ad56d9cf3e1" args="(StkFloat b2)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#208a654dd3393ed0b2b86ad56d9cf3e1">setB2</a> (StkFloat b2)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the b[2] coefficient value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c9799e47163fe8a59fd85196c089cb3"></a><!-- doxytag: member="stk::BiQuad::setA1" ref="1c9799e47163fe8a59fd85196c089cb3" args="(StkFloat a1)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#1c9799e47163fe8a59fd85196c089cb3">setA1</a> (StkFloat a1)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the a[1] coefficient value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e28afd560df11435ea54f128d23b9383"></a><!-- doxytag: member="stk::BiQuad::setA2" ref="e28afd560df11435ea54f128d23b9383" args="(StkFloat a2)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#e28afd560df11435ea54f128d23b9383">setA2</a> (StkFloat a2)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the a[2] coefficient value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#55aaa01fd4156f1fac1168f526e3d969">setResonance</a> (StkFloat frequency, StkFloat radius, bool normalize=false)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz). <a href="#55aaa01fd4156f1fac1168f526e3d969"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#e10a26fc319ba357bc92df4e528c2d8f">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter coefficients for a notch at <em>frequency</em> (in Hz). <a href="#e10a26fc319ba357bc92df4e528c2d8f"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#28881f5876ce5bdcc846367cca9363f7">setEqualGainZeroes</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the filter zeroes for equal resonance gain. <a href="#28881f5876ce5bdcc846367cca9363f7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="412f224363b1a222423ecf0cd7be9063"></a><!-- doxytag: member="stk::BiQuad::lastOut" ref="412f224363b1a222423ecf0cd7be9063" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#412f224363b1a222423ecf0cd7be9063">lastOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last computed output value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="648086962c3cddcaa09c46a002c3e635"></a><!-- doxytag: member="stk::BiQuad::tick" ref="648086962c3cddcaa09c46a002c3e635" args="(StkFloat input)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#648086962c3cddcaa09c46a002c3e635">tick</a> (StkFloat input)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input one sample to the filter and return a reference to one output. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#f903e41217838470a5f267a20b905a12">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 filter and replace with corresponding outputs. <a href="#f903e41217838470a5f267a20b905a12"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#c9836f0e074ea9516727f27eb9b411aa">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#c9836f0e074ea9516727f27eb9b411aa"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK biquad (two-pole, two-zero) filter class.
|
|
<p>
|
|
This class implements a two-pole, two-zero digital filter. Methods are provided for creating a resonance or notch in the frequency response while maintaining a constant filter gain.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="55aaa01fd4156f1fac1168f526e3d969"></a><!-- doxytag: member="stk::BiQuad::setResonance" ref="55aaa01fd4156f1fac1168f526e3d969" args="(StkFloat frequency, StkFloat radius, bool normalize=false)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::BiQuad::setResonance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>frequency</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>radius</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>normalize</em> = <code>false</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz).
|
|
<p>
|
|
This method determines the filter coefficients corresponding to two complex-conjugate poles with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. If <em>normalize</em> is true, the filter zeros are placed at z = 1, z = -1, and the coefficients are then normalized to produce a constant unity peak gain (independent of the filter <em>gain</em> parameter). The resulting filter frequency response has a resonance at the given <em>frequency</em>. The closer the poles are to the unit-circle (<em>radius</em> close to one), the narrower the resulting resonance width.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e10a26fc319ba357bc92df4e528c2d8f"></a><!-- doxytag: member="stk::BiQuad::setNotch" ref="e10a26fc319ba357bc92df4e528c2d8f" args="(StkFloat frequency, StkFloat radius)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::BiQuad::setNotch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>frequency</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>radius</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the filter coefficients for a notch at <em>frequency</em> (in Hz).
|
|
<p>
|
|
This method determines the filter coefficients corresponding to two complex-conjugate zeros with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. No filter normalization is attempted.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="28881f5876ce5bdcc846367cca9363f7"></a><!-- doxytag: member="stk::BiQuad::setEqualGainZeroes" ref="28881f5876ce5bdcc846367cca9363f7" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::BiQuad::setEqualGainZeroes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Sets the filter zeroes for equal resonance gain.
|
|
<p>
|
|
When using the filter as a resonator, zeroes places at z = 1, z = -1 will result in a constant gain at resonance of 1 / (1 - R), where R is the pole radius setting.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f903e41217838470a5f267a20b905a12"></a><!-- doxytag: member="stk::BiQuad::tick" ref="f903e41217838470a5f267a20b905a12" args="(StkFrames &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> & stk::BiQuad::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline, virtual]</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 filter and replace with corresponding outputs.
|
|
<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>Implements <a class="el" href="classstk_1_1Filter.html#3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c9836f0e074ea9516727f27eb9b411aa"></a><!-- doxytag: member="stk::BiQuad::tick" ref="c9836f0e074ea9516727f27eb9b411aa" args="(StkFrames &iFrames, StkFrames &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> & stk::BiQuad::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </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> & </td>
|
|
<td class="paramname"> <em>oFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>iChannel</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>oChannel</em> = <code>0</code></td><td> </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 filter and write outputs to the <code>oFrames</code> object.
|
|
<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.
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="BiQuad_8h-source.html">BiQuad.h</a></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>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|