e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 06:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.4 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:51:11 +02:00
committed by Stephen Sinclair
parent 899303d7c4
commit 18730391e8
413 changed files with 6241 additions and 4445 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
doc/html/classstk_1_1ADSR.html
View File

@@ -58,22 +58,22 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set target = 0, state = <em><a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">ADSR::RELEASE</a></em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff18347235fd52ce307c4b5de18a9c62"></a><!-- doxytag: member="stk::ADSR::setAttackRate" ref="aff18347235fd52ce307c4b5de18a9c62" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#aff18347235fd52ce307c4b5de18a9c62">setAttackRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the attack rate. <br/></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the attack rate (gain / sample). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0af300e39f83f79776c04a3e83a85b1"></a><!-- doxytag: member="stk::ADSR::setAttackTarget" ref="ae0af300e39f83f79776c04a3e83a85b1" args="(StkFloat target)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#ae0af300e39f83f79776c04a3e83a85b1">setAttackTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the target value for the attack (default = 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a285f500b1e149aed48dba2a155b95cdd"></a><!-- doxytag: member="stk::ADSR::setDecayRate" ref="a285f500b1e149aed48dba2a155b95cdd" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a285f500b1e149aed48dba2a155b95cdd">setDecayRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the decay rate. <br/></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the decay rate (gain / sample). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85138fb6bbcc7b7cd85ec8449d68f7d8"></a><!-- doxytag: member="stk::ADSR::setSustainLevel" ref="a85138fb6bbcc7b7cd85ec8449d68f7d8" args="(StkFloat level)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a85138fb6bbcc7b7cd85ec8449d68f7d8">setSustainLevel</a> (StkFloat level)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sustain level. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29da04231df73c2968c0e9387b43be6e"></a><!-- doxytag: member="stk::ADSR::setReleaseRate" ref="a29da04231df73c2968c0e9387b43be6e" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a29da04231df73c2968c0e9387b43be6e">setReleaseRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the release rate. <br/></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the release rate (gain / sample). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48885319b8175cd4d6312fdf7980f116"></a><!-- doxytag: member="stk::ADSR::setAttackTime" ref="a48885319b8175cd4d6312fdf7980f116" args="(StkFloat time)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a48885319b8175cd4d6312fdf7980f116">setAttackTime</a> (StkFloat time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the attack rate based on a time duration. <br/></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the attack rate based on a time duration (seconds). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a450703c45384ae27eb766551843ce82d"></a><!-- doxytag: member="stk::ADSR::setDecayTime" ref="a450703c45384ae27eb766551843ce82d" args="(StkFloat time)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a450703c45384ae27eb766551843ce82d">setDecayTime</a> (StkFloat time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the decay rate based on a time duration (seconds). <br/></td></tr>
@@ -82,7 +82,7 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the release rate based on a time duration (seconds). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3567b02a0e8ab82d18eb949d362f9708"></a><!-- doxytag: member="stk::ADSR::setAllTimes" ref="a3567b02a0e8ab82d18eb949d362f9708" args="(StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a3567b02a0e8ab82d18eb949d362f9708">setAllTimes</a> (StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sustain level and attack, decay, and release time durations. <br/></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sustain level and attack, decay, and release time durations (seconds). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a428eebd510e464ccd7bb4e5728f80d63"></a><!-- doxytag: member="stk::ADSR::setTarget" ref="a428eebd510e464ccd7bb4e5728f80d63" args="(StkFloat target)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a428eebd510e464ccd7bb4e5728f80d63">setTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a sustain target value and attack or decay from current value to target. <br/></td></tr>
@@ -103,8 +103,8 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope class. </p>
<p>This class implements a traditional <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> (Attack, Decay, Sustain, Release) envelope. It responds to simple keyOn and keyOff messages, keeping track of its state. The <em>state</em> = <a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8">ADSR::IDLE</a> before being triggered and after the envelope value reaches 0.0 in the <a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">ADSR::RELEASE</a> state. All rate, target and level settings must be non-negative. All time settings must be positive.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<p>This class implements a traditional <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> (Attack, Decay, Sustain, Release) envelope. It responds to simple keyOn and keyOff messages, keeping track of its state. The <em>state</em> = <a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8">ADSR::IDLE</a> before being triggered and after the envelope value reaches 0.0 in the <a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">ADSR::RELEASE</a> state. All rate, target and level settings must be non-negative. All time settings are in seconds and must be positive.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154ba"></a><!-- doxytag: member="stk::ADSR::@0" ref="ae1cdd1f2886d69a76fcd5b1e0e9154ba" args="" -->
<div class="memitem">
@@ -138,13 +138,13 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
</dd>
</dl>
<p><div class="fragment"><pre class="fragment"><a name="l00028"></a>00028 {
<a name="l00029"></a>00029 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e">ATTACK</a>,
<a name="l00030"></a>00030 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa75e1deeb861fe2989250b1977018cacf">DECAY</a>,
<a name="l00031"></a>00031 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad">SUSTAIN</a>,
<a name="l00032"></a>00032 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">RELEASE</a>,
<a name="l00033"></a>00033 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8">IDLE</a>
<a name="l00034"></a>00034 };
<p><div class="fragment"><pre class="fragment"><a name="l00029"></a>00029 {
<a name="l00030"></a>00030 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e">ATTACK</a>,
<a name="l00031"></a>00031 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa75e1deeb861fe2989250b1977018cacf">DECAY</a>,
<a name="l00032"></a>00032 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad">SUSTAIN</a>,
<a name="l00033"></a>00033 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">RELEASE</a>,
<a name="l00034"></a>00034 <a class="code" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8">IDLE</a>
<a name="l00035"></a>00035 };
</pre></div></p>
</div>
@@ -180,21 +180,21 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<p>Implements <a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00160"></a>00160 {
<a name="l00161"></a>00161 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= frames.channels() ) {
<a name="l00163"></a>00163 oStream_ &lt;&lt; <span class="stringliteral">&quot;ADSR::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00164"></a>00164 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 <span class="preprocessor">#endif</span>
<a name="l00167"></a>00167 <span class="preprocessor"></span>
<a name="l00168"></a>00168 StkFloat *samples = &amp;frames[channel];
<a name="l00169"></a>00169 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00170"></a>00170 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop )
<a name="l00171"></a>00171 *samples = <a class="code" href="classstk_1_1ADSR.html#af2c0869f86210a55f4f668172373c975" title="Compute and return one output sample.">ADSR::tick</a>();
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keywordflow">return</span> frames;
<a name="l00174"></a>00174 }
<p><div class="fragment"><pre class="fragment"><a name="l00161"></a>00161 {
<a name="l00162"></a>00162 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= frames.channels() ) {
<a name="l00164"></a>00164 oStream_ &lt;&lt; <span class="stringliteral">&quot;ADSR::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00165"></a>00165 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167 <span class="preprocessor">#endif</span>
<a name="l00168"></a>00168 <span class="preprocessor"></span>
<a name="l00169"></a>00169 StkFloat *samples = &amp;frames[channel];
<a name="l00170"></a>00170 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00171"></a>00171 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop )
<a name="l00172"></a>00172 *samples = <a class="code" href="classstk_1_1ADSR.html#af2c0869f86210a55f4f668172373c975" title="Compute and return one output sample.">ADSR::tick</a>();
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="keywordflow">return</span> frames;
<a name="l00175"></a>00175 }
</pre></div></p>
</div>
@@ -207,7 +207,7 @@ StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>