mirror of
https://github.com/thestk/stk
synced 2026-01-12 20:41:52 +00:00
106 lines
7.8 KiB
HTML
106 lines
7.8 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="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>ADSR Class Reference</h1>STK ADSR envelope class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="ADSR_8h-source.html">ADSR.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for ADSR::
|
|
<p><center><img src="classADSR.gif" usemap="#ADSR_map" border="0"></center>
|
|
<map name="ADSR_map">
|
|
<area href="classEnvelope.html" alt="Envelope" shape="rect" coords="0,56,65,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,65,24">
|
|
</map>
|
|
<a href="classADSR-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <br>
|
|
<b>ATTACK</b>,
|
|
<b>DECAY</b>,
|
|
<b>SUSTAIN</b>,
|
|
<b>RELEASE</b>,
|
|
<br>
|
|
<b>DONE</b>
|
|
<br>
|
|
}</td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classEnvelope.html">Envelope</a> states.</em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="ADSR::ADSR"></a>
|
|
</td><td valign=bottom><a class="el" href="classADSR.html#a0">ADSR</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="ADSR::~ADSR"></a>
|
|
</td><td valign=bottom><a class="el" href="classADSR.html#a1">~ADSR</a> (void)</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="ADSR::keyOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a2">keyOn</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set target = 1, state = <em>ADSR::ATTACK</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="ADSR::keyOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a3">keyOff</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set target = 0, state = <em>ADSR::RELEASE</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="ADSR::setAttackRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a4">setAttackRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the attack rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="ADSR::setDecayRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a5">setDecayRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the decay rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="ADSR::setSustainLevel"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a6">setSustainLevel</a> (MY_FLOAT aLevel)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the sustain level.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="ADSR::setReleaseRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a7">setReleaseRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the release rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="ADSR::setAttackTime"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a8">setAttackTime</a> (MY_FLOAT aTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the attack rate based on a time duration.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="ADSR::setDecayTime"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a9">setDecayTime</a> (MY_FLOAT aTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the decay rate based on a time duration.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="ADSR::setReleaseTime"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a10">setReleaseTime</a> (MY_FLOAT aTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the release rate based on a time duration.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="ADSR::setAllTimes"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a11">setAllTimes</a> (MY_FLOAT aTime, MY_FLOAT dTime, MY_FLOAT sLevel, MY_FLOAT rTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set sustain level and attack, decay, and release state rates based on time durations.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a12" doxytag="ADSR::setTarget"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a12">setTarget</a> (MY_FLOAT aTarget)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the target value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a13" doxytag="ADSR::getState"></a>
|
|
int </td><td valign=bottom><a class="el" href="classADSR.html#a13">getState</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current envelope <em>state</em> (ATTACK, DECAY, SUSTAIN, RELEASE, DONE).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a14" doxytag="ADSR::setValue"></a>
|
|
void </td><td valign=bottom><a class="el" href="classADSR.html#a14">setValue</a> (MY_FLOAT aValue)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set to state = ADSR::SUSTAIN with current and target values of <em>aValue</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a15" doxytag="ADSR::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classADSR.html#a15">tick</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return one envelope output value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a16" doxytag="ADSR::tick"></a>
|
|
MY_FLOAT* </td><td valign=bottom><a class="el" href="classADSR.html#a16">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return <em>vectorSize</em> envelope outputs in <em>vector</em>.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK ADSR envelope class.
|
|
<p>
|
|
This <a class="el" href="classEnvelope.html">Envelope</a> subclass implements a traditional ADSR (Attack, Decay, Sustain, Release) envelope. It responds to simple keyOn and keyOff messages, keeping track of its state. The <em>state</em> = ADSR::DONE after the envelope value reaches 0.0 in the ADSR::RELEASE state.
|
|
<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>
|
|
<li><a class="el" href="ADSR_8h-source.html">ADSR.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>
|