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
|
<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_1StifKarp.html">StifKarp</a>
</div>
<div class="contents">
<h1>stk::StifKarp Class Reference</h1><!-- doxytag: class="stk::StifKarp" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>STK plucked stiff string instrument.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="StifKarp_8h_source.html">StifKarp.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::StifKarp:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1StifKarp.png" usemap="#stk::StifKarp_map" alt=""/>
<map id="stk::StifKarp_map" name="stk::StifKarp_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,78,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,78,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1StifKarp-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="a2ac1b3641559e787cf78a017797e9a70"></a><!-- doxytag: member="stk::StifKarp::StifKarp" ref="a2ac1b3641559e787cf78a017797e9a70" args="(StkFloat lowestFrequency=8.0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a2ac1b3641559e787cf78a017797e9a70">StifKarp</a> (StkFloat lowestFrequency=8.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="a37bc5b0bb4fe385eda862622f675bee1"></a><!-- doxytag: member="stk::StifKarp::~StifKarp" ref="a37bc5b0bb4fe385eda862622f675bee1" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a37bc5b0bb4fe385eda862622f675bee1">~StifKarp</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1015fa6d2ac1835d8be7dec0df12f6f"></a><!-- doxytag: member="stk::StifKarp::clear" ref="ad1015fa6d2ac1835d8be7dec0df12f6f" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#ad1015fa6d2ac1835d8be7dec0df12f6f">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="a51371b8592fc01aba1993ac304962f6e"></a><!-- doxytag: member="stk::StifKarp::setFrequency" ref="a51371b8592fc01aba1993ac304962f6e" args="(StkFloat frequency)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a51371b8592fc01aba1993ac304962f6e">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21a9b7407c9d6a0b2ba34c0e41bb0b57"></a><!-- doxytag: member="stk::StifKarp::setStretch" ref="a21a9b7407c9d6a0b2ba34c0e41bb0b57" args="(StkFloat stretch)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a21a9b7407c9d6a0b2ba34c0e41bb0b57">setStretch</a> (StkFloat stretch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the stretch "factor" of the string (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55ca9e1f3c205e4fb51e6d4a7393db70"></a><!-- doxytag: member="stk::StifKarp::setPickupPosition" ref="a55ca9e1f3c205e4fb51e6d4a7393db70" args="(StkFloat position)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a55ca9e1f3c205e4fb51e6d4a7393db70">setPickupPosition</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_1StifKarp.html#ad1b5de5acf487271d99903cd43e891ce">setBaseLoopGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the base loop gain. <a href="#ad1b5de5acf487271d99903cd43e891ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a016ff5971a1b51ea472f7e7fa2d677ee"></a><!-- doxytag: member="stk::StifKarp::pluck" ref="a016ff5971a1b51ea472f7e7fa2d677ee" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a016ff5971a1b51ea472f7e7fa2d677ee">pluck</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the string with the given amplitude using the current frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2831958f1dd782ccf34c4068c2b7f14"></a><!-- doxytag: member="stk::StifKarp::noteOn" ref="ae2831958f1dd782ccf34c4068c2b7f14" args="(StkFloat frequency, StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#ae2831958f1dd782ccf34c4068c2b7f14">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1806fb5c05fa5abdcd3ddb4c97d8ea78"></a><!-- doxytag: member="stk::StifKarp::noteOff" ref="a1806fb5c05fa5abdcd3ddb4c97d8ea78" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a1806fb5c05fa5abdcd3ddb4c97d8ea78">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27e76ba187140ae575c1bd2e1ba99b03"></a><!-- doxytag: member="stk::StifKarp::controlChange" ref="a27e76ba187140ae575c1bd2e1ba99b03" args="(int number, StkFloat value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a27e76ba187140ae575c1bd2e1ba99b03">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cd896c59ee01fa8e21346ebe54365fc"></a><!-- doxytag: member="stk::StifKarp::tick" ref="a5cd896c59ee01fa8e21346ebe54365fc" args="(unsigned int channel=0)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StifKarp.html#a5cd896c59ee01fa8e21346ebe54365fc">tick</a> (unsigned int channel=0)</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_1StifKarp.html#a7d4afff257faa7ad9ef630f1db1ed93f">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">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="#a7d4afff257faa7ad9ef630f1db1ed93f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK plucked stiff string instrument. </p>
<p>This class implements a simple plucked string algorithm (Karplus Strong) with enhancements (Jaffe-Smith, Smith, and others), including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.</p>
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
<p>Control Change Numbers:</p>
<ul>
<li>Pickup Position = 4</li>
<li>String Sustain = 11</li>
<li>String Stretch = 1</li>
</ul>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad1b5de5acf487271d99903cd43e891ce"></a><!-- doxytag: member="stk::StifKarp::setBaseLoopGain" ref="ad1b5de5acf487271d99903cd43e891ce" args="(StkFloat aGain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::StifKarp::setBaseLoopGain </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>aGain</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the base loop gain. </p>
<p>The actual loop gain is set according to the frequency. Because of high-frequency loop filter roll-off, higher frequency settings have greater loop gains. </p>
</div>
</div>
<a class="anchor" id="a7d4afff257faa7ad9ef630f1db1ed93f"></a><!-- doxytag: member="stk::StifKarp::tick" ref="a7d4afff257faa7ad9ef630f1db1ed93f" 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::StifKarp::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, 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_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00126"></a>00126 {
<a name="l00127"></a>00127 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00128"></a>00128 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00129"></a>00129 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
<a name="l00130"></a>00130 oStream_ << <span class="stringliteral">"StifKarp::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00131"></a>00131 <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="l00132"></a>00132 }
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>
<a name="l00135"></a>00135 StkFloat *samples = &frames[channel];
<a name="l00136"></a>00136 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00137"></a>00137 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00138"></a>00138 <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="l00139"></a>00139 *samples++ = <a class="code" href="classstk_1_1StifKarp.html#a5cd896c59ee01fa8e21346ebe54365fc" title="Compute and return one output sample.">tick</a>();
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141 <span class="keywordflow">else</span> {
<a name="l00142"></a>00142 <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="l00143"></a>00143 *samples++ = <a class="code" href="classstk_1_1StifKarp.html#a5cd896c59ee01fa8e21346ebe54365fc" title="Compute and return one output sample.">tick</a>();
<a name="l00144"></a>00144 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
<a name="l00145"></a>00145 *samples++ = lastFrame_[j];
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordflow">return</span> frames;
<a name="l00150"></a>00150 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StifKarp_8h_source.html">StifKarp.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>
|
