File: classstk_1_1ADSR.html

package info (click to toggle)
stk 4.4.4-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 24,856 kB
  • sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (214 lines) | stat: -rw-r--r-- 21,390 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<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"> &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="faq.html">FAQ</a> &nbsp; <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_1ADSR.html">ADSR</a>
  </div>
<div class="contents">
<h1>stk::ADSR Class Reference</h1><!-- doxytag: class="stk::ADSR" --><!-- doxytag: inherits="stk::Generator" -->
<p>STK <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ADSR_8h_source.html">ADSR.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::ADSR:</div>
<div class="dynsection">
 <div class="center">
  <img src="classstk_1_1ADSR.png" usemap="#stk::ADSR_map" alt=""/>
  <map id="stk::ADSR_map" name="stk::ADSR_map">
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
</map>
 </div>
</div>

<p><a href="classstk_1_1ADSR-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br/>
&nbsp;&nbsp;<a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e">ATTACK</a>, 
<a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa75e1deeb861fe2989250b1977018cacf">DECAY</a>, 
<a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad">SUSTAIN</a>, 
<a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756">RELEASE</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8">IDLE</a>
<br/>
 }</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p><a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope states. </p>
 <a href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154ba">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7473272021307b0dcf1ef602143e144"></a><!-- doxytag: member="stk::ADSR::ADSR" ref="ac7473272021307b0dcf1ef602143e144" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#ac7473272021307b0dcf1ef602143e144">ADSR</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a714f0b9deb325050eba819bc1fe22127"></a><!-- doxytag: member="stk::ADSR::~ADSR" ref="a714f0b9deb325050eba819bc1fe22127" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a714f0b9deb325050eba819bc1fe22127">~ADSR</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad03e82009a20cfb49c1f04bae791631"></a><!-- doxytag: member="stk::ADSR::keyOn" ref="aad03e82009a20cfb49c1f04bae791631" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#aad03e82009a20cfb49c1f04bae791631">keyOn</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set target = 1, state = <em><a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e">ADSR::ATTACK</a></em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9400e04b313ab8900a3ba9b693f448e6"></a><!-- doxytag: member="stk::ADSR::keyOff" ref="a9400e04b313ab8900a3ba9b693f448e6" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a9400e04b313ab8900a3ba9b693f448e6">keyOff</a> (void)</td></tr>
<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 (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 (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 (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 (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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91c14442557cb65286a327f8b297237a"></a><!-- doxytag: member="stk::ADSR::setReleaseTime" ref="a91c14442557cb65286a327f8b297237a" args="(StkFloat time)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a91c14442557cb65286a327f8b297237a">setReleaseTime</a> (StkFloat time)</td></tr>
<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 (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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87f9918cfa4104a841dc5b44f26f8904"></a><!-- doxytag: member="stk::ADSR::getState" ref="a87f9918cfa4104a841dc5b44f26f8904" args="(void) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a87f9918cfa4104a841dc5b44f26f8904">getState</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the current envelope <em>state</em> (ATTACK, DECAY, SUSTAIN, RELEASE, IDLE). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa99bf5fca3885bf8d99a3edc4072a4b5"></a><!-- doxytag: member="stk::ADSR::setValue" ref="aa99bf5fca3885bf8d99a3edc4072a4b5" args="(StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#aa99bf5fca3885bf8d99a3edc4072a4b5">setValue</a> (StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set to state = <a class="el" href="classstk_1_1ADSR.html#ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad">ADSR::SUSTAIN</a> with current and target values of <em>value</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedbcb85346c354139f139b3232f36f39"></a><!-- doxytag: member="stk::ADSR::lastOut" ref="aedbcb85346c354139f139b3232f36f39" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#aedbcb85346c354139f139b3232f36f39">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2c0869f86210a55f4f668172373c975"></a><!-- doxytag: member="stk::ADSR::tick" ref="af2c0869f86210a55f4f668172373c975" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#af2c0869f86210a55f4f668172373c975">tick</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ADSR.html#a97a617c65e62aadb4f88bd10cf437a6a">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs.  <a href="#a97a617c65e62aadb4f88bd10cf437a6a"></a><br/></td></tr>
</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 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">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope states. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e"></a><!-- doxytag: member="ATTACK" ref="ae1cdd1f2886d69a76fcd5b1e0e9154baa9518c737b76795fa49f997c09e074c8e" args="" -->ATTACK</em>&nbsp;</td><td>
<p>Attack </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154baa75e1deeb861fe2989250b1977018cacf"></a><!-- doxytag: member="DECAY" ref="ae1cdd1f2886d69a76fcd5b1e0e9154baa75e1deeb861fe2989250b1977018cacf" args="" -->DECAY</em>&nbsp;</td><td>
<p>Decay </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad"></a><!-- doxytag: member="SUSTAIN" ref="ae1cdd1f2886d69a76fcd5b1e0e9154baa139dc35648a28ddc99a7a606e185f6ad" args="" -->SUSTAIN</em>&nbsp;</td><td>
<p>Sustain </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756"></a><!-- doxytag: member="RELEASE" ref="ae1cdd1f2886d69a76fcd5b1e0e9154baa7efc189b0b53e581201fd64f357a1756" args="" -->RELEASE</em>&nbsp;</td><td>
<p>Release </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8"></a><!-- doxytag: member="IDLE" ref="ae1cdd1f2886d69a76fcd5b1e0e9154baa1ed3238253daecbdba14da71759392d8" args="" -->IDLE</em>&nbsp;</td><td>
<p>Before attack / after release </p>
</td></tr>
</table>
</dd>
</dl>

<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>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a97a617c65e62aadb4f88bd10cf437a6a"></a><!-- doxytag: member="stk::ADSR::tick" ref="a97a617c65e62aadb4f88bd10cf437a6a" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::ADSR::tick </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>frames</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>channel</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>

<p>Implements <a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>

<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>
</div>
<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></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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>