e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-19 15:41:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
doc/html/classResonate.html
View File

@@ -5,76 +5,91 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Resonate Class Reference</h1>STK noise driven formant filter.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Resonate Class Reference</h1>STK noise driven formant filter.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Resonate_8h-source.html">Resonate.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Resonate::
<p><center><img src="classResonate.gif" usemap="#Resonate_map" border="0"></center>
<p>Inheritance diagram for Resonate:
<p><center><img src="classResonate.png" usemap="#Resonate_map" border="0" alt=""></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>
&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a0">Resonate</a> ()</td></tr>
<tr><td>&nbsp;</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>
&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a1">~Resonate</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a2">clear</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a3">setResonance</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a4">setNotch</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a5">setEqualGainZeroes</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a6">keyOn</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a7">keyOff</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a10">tick</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classResonate.html#a11">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td>&nbsp;</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>
<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="a0" doxytag="Resonate::Resonate" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a0">Resonate</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Resonate::~Resonate" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a1">~Resonate</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Resonate::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Resonate::setResonance" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a3">setResonance</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter for a resonance at the given frequency (Hz) and radius. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Resonate::setNotch" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a4">setNotch</a> (MY_FLOAT frequency, MY_FLOAT radius)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter for a notch at the given frequency (Hz) and radius. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Resonate::setEqualGainZeroes" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a5">setEqualGainZeroes</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter zero coefficients for contant resonance gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Resonate::keyOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a6">keyOn</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate the envelope with a key-on event. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Resonate::keyOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a7">keyOff</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signal a key-off event to the envelope. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Resonate::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Resonate::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Resonate::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a10">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Resonate::controlChange" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classResonate.html#a11">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <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>.
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>
<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="classEnvelope.html">Envelope</a> Gain = 128</li></ul>
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<p>
Definition at line <a class="el" href="Resonate_8h-source.html#l00028">28</a> of file <a class="el" href="Resonate_8h-source.html">Resonate.h</a>.<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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>