mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
82 lines
6.1 KiB
HTML
82 lines
6.1 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Resonate Class Reference</h1>STK noise driven formant filter.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Resonate_8h-source.html">Resonate.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Resonate::
|
|
<p><center><img src="classResonate.gif" usemap="#Resonate_map" border="0"></center>
|
|
<map name="Resonate_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,64,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,64,24">
|
|
</map>
|
|
<a href="classResonate-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Resonate::Resonate"></a>
|
|
</td><td valign=bottom><a class="el" href="classResonate.html#a0">Resonate</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Resonate::~Resonate"></a>
|
|
</td><td valign=bottom><a class="el" href="classResonate.html#a1">~Resonate</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Resonate::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a2">clear</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Resonate::setResonance"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a3">setResonance</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the filter for a resonance at the given frequency (Hz) and radius.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Resonate::setNotch"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a4">setNotch</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the filter for a notch at the given frequency (Hz) and radius.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Resonate::setEqualGainZeroes"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a5">setEqualGainZeroes</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the filter zero coefficients for contant resonance gain.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Resonate::keyOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a6">keyOn</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Initiate the envelope with a key-on event.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Resonate::keyOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a7">keyOff</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Signal a key-off event to the envelope.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Resonate::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="Resonate::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classResonate.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="Resonate::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classResonate.html#a10">tick</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="Resonate::controlChange"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classResonate.html#a11">controlChange</a> (int number, MY_FLOAT value)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK noise driven formant filter.
|
|
<p>
|
|
This instrument contains a noise source, which excites a biquad resonance filter, with volume controlled by an <a class="el" href="classADSR.html">ADSR</a>.
|
|
<p>
|
|
Control Change Numbers:<ul>
|
|
<li>Resonance Frequency (0-Nyquist) = 2<li>Pole Radii = 4<li>Notch Frequency (0-Nyquist) = 11<li>Zero Radii = 1<li><a class="el" href="classEnvelope.html">Envelope</a> Gain = 128</ul>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<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></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|