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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
<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"> <img src="mcgill.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="faq.html">FAQ</a> <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_1Twang.html">Twang</a>
</div>
<div class="contents">
<h1>stk::Twang Class Reference</h1><!-- doxytag: class="stk::Twang" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK enhanced plucked string class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Twang_8h_source.html">Twang.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Twang:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Twang.png" usemap="#stk::Twang_map" alt=""/>
<map id="stk::Twang_map" name="stk::Twang_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,70,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Twang-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a813e99ee79974707a3afbfcab963c086"></a><!-- doxytag: member="stk::Twang::Twang" ref="a813e99ee79974707a3afbfcab963c086" args="(StkFloat lowestFrequency=50.0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a813e99ee79974707a3afbfcab963c086">Twang</a> (StkFloat lowestFrequency=50.0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cdd4bf2e486239429f6d4f0f277cea9"></a><!-- doxytag: member="stk::Twang::clear" ref="a7cdd4bf2e486239429f6d4f0f277cea9" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a7cdd4bf2e486239429f6d4f0f277cea9">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae27aa429cbf49f0dd60f0cc6ef41c832"></a><!-- doxytag: member="stk::Twang::setLowestFrequency" ref="ae27aa429cbf49f0dd60f0cc6ef41c832" args="(StkFloat frequency)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ae27aa429cbf49f0dd60f0cc6ef41c832">setLowestFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delayline parameters to allow frequencies as low as specified. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0043b9d374b73b6660ec2d79475d602c"></a><!-- doxytag: member="stk::Twang::setFrequency" ref="a0043b9d374b73b6660ec2d79475d602c" args="(StkFloat frequency)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a0043b9d374b73b6660ec2d79475d602c">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delayline parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48008e3cd55dad6ee846b47ab32f993f"></a><!-- doxytag: member="stk::Twang::setPluckPosition" ref="a48008e3cd55dad6ee846b47ab32f993f" args="(StkFloat position)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a48008e3cd55dad6ee846b47ab32f993f">setPluckPosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pluck or "excitation" position along the string (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ad7921c51f38b4e6e32d7db48cc101068">setLoopGain</a> (StkFloat loopGain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the nominal loop gain. <a href="#ad7921c51f38b4e6e32d7db48cc101068"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a7076c25dd3a06262b3bf927bc64bf89e">setLoopFilter</a> (std::vector< StkFloat > coefficients)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the loop filter coefficients. <a href="#a7076c25dd3a06262b3bf927bc64bf89e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#aa25943e277f1cc396074d6be2969f0be">lastOut</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. <a href="#aa25943e277f1cc396074d6be2969f0be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3441ff449e3f7a451873e67d4c680ce9"></a><!-- doxytag: member="stk::Twang::tick" ref="a3441ff449e3f7a451873e67d4c680ce9" args="(StkFloat input)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#ae9e770c446e1459a5e89c0bc8285f5e3">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the class and write outputs to the <code>oFrames</code> object. <a href="#ae9e770c446e1459a5e89c0bc8285f5e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Twang.html#a089ff55338a22647d94665d6adbeb7ae">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the effect and write outputs to the <code>oFrames</code> object. <a href="#a089ff55338a22647d94665d6adbeb7ae"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK enhanced plucked string class. </p>
<p>This class implements an enhanced plucked-string physical model, a la Jaffe-Smith, Smith, Karjalainen and others. It includes a comb filter to simulate pluck position. The <a class="el" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick()</a> function takes an input sample, which is added to the delayline input. This can be used to implement commuted synthesis (if the input samples are derived from the impulse response of a body filter) and/or feedback (as in an electric guitar model).</p>
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad7921c51f38b4e6e32d7db48cc101068"></a><!-- doxytag: member="stk::Twang::setLoopGain" ref="ad7921c51f38b4e6e32d7db48cc101068" args="(StkFloat loopGain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Twang::setLoopGain </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>loopGain</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the nominal loop gain. </p>
<p>The actual loop gain is based on the value set with this function, but scaled slightly according to the frequency. Higher frequency settings have greater loop gains because of high-frequency loop-filter roll-off. </p>
</div>
</div>
<a class="anchor" id="a7076c25dd3a06262b3bf927bc64bf89e"></a><!-- doxytag: member="stk::Twang::setLoopFilter" ref="a7076c25dd3a06262b3bf927bc64bf89e" args="(std::vector< StkFloat > coefficients)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Twang::setLoopFilter </td>
<td>(</td>
<td class="paramtype">std::vector< StkFloat > </td>
<td class="paramname"> <em>coefficients</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the loop filter coefficients. </p>
<p>The loop filter can be any arbitrary FIR filter. By default, the coefficients are set for a first-order lowpass filter with coefficients b = [0.5 0.5]. </p>
</div>
</div>
<a class="anchor" id="aa25943e277f1cc396074d6be2969f0be"></a><!-- doxytag: member="stk::Twang::lastOut" ref="aa25943e277f1cc396074d6be2969f0be" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StkFloat stk::Twang::lastOut </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. </p>
<p>Return the last computed output value. </p>
<p><div class="fragment"><pre class="fragment"><a name="l00074"></a>00074 { <span class="keywordflow">return</span> lastOutput_; };
</pre></div></p>
</div>
</div>
<a class="anchor" id="ae9e770c446e1459a5e89c0bc8285f5e3"></a><!-- doxytag: member="stk::Twang::tick" ref="ae9e770c446e1459a5e89c0bc8285f5e3" args="(StkFrames &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> & stk::Twang::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Take a channel of the <code>iFrames</code> object as inputs to the class and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <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><div class="fragment"><pre class="fragment"><a name="l00123"></a>00123 {
<a name="l00124"></a>00124 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
<a name="l00126"></a>00126 oStream_ << <span class="stringliteral">"Twang::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00127"></a>00127 <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="l00128"></a>00128 }
<a name="l00129"></a>00129 <span class="preprocessor">#endif</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span>
<a name="l00131"></a>00131 StkFloat *samples = &frames[channel];
<a name="l00132"></a>00132 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00133"></a>00133 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop )
<a name="l00134"></a>00134 *samples = <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( *samples );
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keywordflow">return</span> frames;
<a name="l00137"></a>00137 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="a089ff55338a22647d94665d6adbeb7ae"></a><!-- doxytag: member="stk::Twang::tick" ref="a089ff55338a22647d94665d6adbeb7ae" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::Twang::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>iFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>oFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>iChannel</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>oChannel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Take a channel of the <code>iFrames</code> object as inputs to the effect and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <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><div class="fragment"><pre class="fragment"><a name="l00140"></a>00140 {
<a name="l00141"></a>00141 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
<a name="l00143"></a>00143 oStream_ << <span class="stringliteral">"Twang::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00144"></a>00144 <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="l00145"></a>00145 }
<a name="l00146"></a>00146 <span class="preprocessor">#endif</span>
<a name="l00147"></a>00147 <span class="preprocessor"></span>
<a name="l00148"></a>00148 StkFloat *iSamples = &iFrames[iChannel];
<a name="l00149"></a>00149 StkFloat *oSamples = &oFrames[oChannel];
<a name="l00150"></a>00150 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.channels(), oHop = oFrames.channels();
<a name="l00151"></a>00151 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop )
<a name="l00152"></a>00152 *oSamples = <a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( *iSamples );
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordflow">return</span> iFrames;
<a name="l00155"></a>00155 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Twang_8h_source.html">Twang.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>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
