mirror of
https://github.com/thestk/stk
synced 2026-01-16 06:21:51 +00:00
97 lines
9.3 KiB
HTML
97 lines
9.3 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="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Resonate.html">Resonate</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Resonate Class Reference</h1><!-- doxytag: class="stk::Resonate" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK noise driven formant filter.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Resonate_8h_source.html">Resonate.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Resonate:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Resonate.png" usemap="#stk::Resonate_map" alt=""/>
|
|
<map id="stk::Resonate_map" name="stk::Resonate_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,85,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,85,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Resonate-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab273b41ec296f776a41cfa66bb1e430e"></a><!-- doxytag: member="stk::Resonate::Resonate" ref="ab273b41ec296f776a41cfa66bb1e430e" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#ab273b41ec296f776a41cfa66bb1e430e">Resonate</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a634ab2db8eabad147fa90fb1bf72a580"></a><!-- doxytag: member="stk::Resonate::~Resonate" ref="a634ab2db8eabad147fa90fb1bf72a580" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a634ab2db8eabad147fa90fb1bf72a580">~Resonate</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a534740efbbde171d790309e85c96017d"></a><!-- doxytag: member="stk::Resonate::clear" ref="a534740efbbde171d790309e85c96017d" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a534740efbbde171d790309e85c96017d">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8767e6c05862c183483776ac4cf354f9"></a><!-- doxytag: member="stk::Resonate::setResonance" ref="a8767e6c05862c183483776ac4cf354f9" args="(StkFloat frequency, StkFloat radius)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a8767e6c05862c183483776ac4cf354f9">setResonance</a> (StkFloat frequency, StkFloat radius)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter for a resonance at the given frequency (Hz) and radius. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4476301fba545cbbfc773150ca6901d"></a><!-- doxytag: member="stk::Resonate::setNotch" ref="ad4476301fba545cbbfc773150ca6901d" args="(StkFloat frequency, StkFloat radius)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#ad4476301fba545cbbfc773150ca6901d">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter for a notch at the given frequency (Hz) and radius. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8000ad734634ac7334f4fab09a13a7e"></a><!-- doxytag: member="stk::Resonate::setEqualGainZeroes" ref="ad8000ad734634ac7334f4fab09a13a7e" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#ad8000ad734634ac7334f4fab09a13a7e">setEqualGainZeroes</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter zero coefficients for contant resonance gain. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afebf784a302eb0043b4a453b0d1d852c"></a><!-- doxytag: member="stk::Resonate::keyOn" ref="afebf784a302eb0043b4a453b0d1d852c" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#afebf784a302eb0043b4a453b0d1d852c">keyOn</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate the envelope with a key-on event. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0008e1fdd7611b769b72b52c8bfb1e6a"></a><!-- doxytag: member="stk::Resonate::keyOff" ref="a0008e1fdd7611b769b72b52c8bfb1e6a" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a0008e1fdd7611b769b72b52c8bfb1e6a">keyOff</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal a key-off event to the envelope. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76bfadc70f4163f9767e7864d322d144"></a><!-- doxytag: member="stk::Resonate::noteOn" ref="a76bfadc70f4163f9767e7864d322d144" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a76bfadc70f4163f9767e7864d322d144">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0454a8e9d6ef3a2394b6c348edf0195f"></a><!-- doxytag: member="stk::Resonate::noteOff" ref="a0454a8e9d6ef3a2394b6c348edf0195f" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#a0454a8e9d6ef3a2394b6c348edf0195f">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af55feabf25f1f6f996c32574656ffd68"></a><!-- doxytag: member="stk::Resonate::controlChange" ref="af55feabf25f1f6f996c32574656ffd68" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#af55feabf25f1f6f996c32574656ffd68">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab917279f4f57d5d305481426e9bffd98"></a><!-- doxytag: member="stk::Resonate::tick" ref="ab917279f4f57d5d305481426e9bffd98" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Resonate.html#ab917279f4f57d5d305481426e9bffd98">tick</a> (unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK noise driven formant filter. </p>
|
|
<p>This instrument contains a noise source, which excites a biquad resonance filter, with volume controlled by an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a>.</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li>Resonance Frequency (0-Nyquist) = 2</li>
|
|
<li>Pole Radii = 4</li>
|
|
<li>Notch Frequency (0-Nyquist) = 11</li>
|
|
<li>Zero Radii = 1</li>
|
|
<li><a class="el" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> Gain = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Resonate_8h_source.html">Resonate.h</a></li>
|
|
</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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|