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
|
<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_1BandedWG.html">BandedWG</a>
</div>
<div class="contents">
<h1>stk::BandedWG Class Reference</h1><!-- doxytag: class="stk::BandedWG" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>Banded waveguide modeling class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="BandedWG_8h_source.html">BandedWG.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::BandedWG:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1BandedWG.png" usemap="#stk::BandedWG_map" alt=""/>
<map id="stk::BandedWG_map" name="stk::BandedWG_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,96,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,96,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1BandedWG-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="ad449f248adaa49344c2bd25be4a7872d"></a><!-- doxytag: member="stk::BandedWG::BandedWG" ref="ad449f248adaa49344c2bd25be4a7872d" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#ad449f248adaa49344c2bd25be4a7872d">BandedWG</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4044055c28bad672c9537b985d18289"></a><!-- doxytag: member="stk::BandedWG::~BandedWG" ref="ac4044055c28bad672c9537b985d18289" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#ac4044055c28bad672c9537b985d18289">~BandedWG</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="a182dbf5d75aebf5714bd6df15b0df90c"></a><!-- doxytag: member="stk::BandedWG::clear" ref="a182dbf5d75aebf5714bd6df15b0df90c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a182dbf5d75aebf5714bd6df15b0df90c">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="a4394ee4cd1c84a8b3f92713e60715c4d"></a><!-- doxytag: member="stk::BandedWG::setStrikePosition" ref="a4394ee4cd1c84a8b3f92713e60715c4d" args="(StkFloat position)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a4394ee4cd1c84a8b3f92713e60715c4d">setStrikePosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set strike position (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1e3a367eef86e6cb372b4ee232e1804"></a><!-- doxytag: member="stk::BandedWG::setPreset" ref="ab1e3a367eef86e6cb372b4ee232e1804" args="(int preset)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#ab1e3a367eef86e6cb372b4ee232e1804">setPreset</a> (int preset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a preset. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf104d4ed663b5f0cd034c8025f4d420"></a><!-- doxytag: member="stk::BandedWG::setFrequency" ref="acf104d4ed663b5f0cd034c8025f4d420" args="(StkFloat frequency)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#acf104d4ed663b5f0cd034c8025f4d420">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="a37b20c2554e7100241a99758f5a4433e"></a><!-- doxytag: member="stk::BandedWG::startBowing" ref="a37b20c2554e7100241a99758f5a4433e" args="(StkFloat amplitude, StkFloat rate)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a37b20c2554e7100241a99758f5a4433e">startBowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply bow velocity/pressure to instrument with given amplitude and rate of increase. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa14786c32af030311e2118db3b68a892"></a><!-- doxytag: member="stk::BandedWG::stopBowing" ref="aa14786c32af030311e2118db3b68a892" args="(StkFloat rate)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#aa14786c32af030311e2118db3b68a892">stopBowing</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease bow velocity/breath pressure with given rate of decrease. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a271573afaa2dc655446482bad6745cc1"></a><!-- doxytag: member="stk::BandedWG::pluck" ref="a271573afaa2dc655446482bad6745cc1" args="(StkFloat amp)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a271573afaa2dc655446482bad6745cc1">pluck</a> (StkFloat amp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the instrument with given amplitude. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f334ae49b7baf561d74a0b6ec3c4f9a"></a><!-- doxytag: member="stk::BandedWG::noteOn" ref="a8f334ae49b7baf561d74a0b6ec3c4f9a" args="(StkFloat frequency, StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a8f334ae49b7baf561d74a0b6ec3c4f9a">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="ac9c3c3ec0e821b1a080774bb55d3b881"></a><!-- doxytag: member="stk::BandedWG::noteOff" ref="ac9c3c3ec0e821b1a080774bb55d3b881" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#ac9c3c3ec0e821b1a080774bb55d3b881">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="a16baac1cc6612332d6d0aa40a661c137"></a><!-- doxytag: member="stk::BandedWG::controlChange" ref="a16baac1cc6612332d6d0aa40a661c137" args="(int number, StkFloat value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a16baac1cc6612332d6d0aa40a661c137">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="a44f37146d33354afb085806bd8340497"></a><!-- doxytag: member="stk::BandedWG::tick" ref="a44f37146d33354afb085806bd8340497" args="(unsigned int channel=0)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a44f37146d33354afb085806bd8340497">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_1BandedWG.html#a6c2ebb66862b173c4835add6847801c9">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="#a6c2ebb66862b173c4835add6847801c9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Banded waveguide modeling class. </p>
<p>This class uses banded waveguide techniques to model a variety of sounds, including bowed bars, glasses, and bowls. For more information, see Essl, G. and Cook, P. "Banded Waveguides: Towards Physical Modelling of Bar Percussion Instruments", Proceedings of the 1999 International Computer Music Conference.</p>
<p>Control Change Numbers:</p>
<ul>
<li>Bow Pressure = 2</li>
<li>Bow Motion = 4</li>
<li>Strike Position = 8 (not implemented)</li>
<li>Vibrato Frequency = 11</li>
<li>Gain = 1</li>
<li>Bow Velocity = 128</li>
<li>Set Striking = 64</li>
<li>Instrument Presets = 16<ul>
<li>Uniform Bar = 0</li>
<li>Tuned Bar = 1</li>
<li>Glass Harmonica = 2</li>
<li>Tibetan Bowl = 3</li>
</ul>
</li>
</ul>
<p>by Georg Essl, 1999 - 2004. Modified for STK 4.0 by Gary Scavone. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6c2ebb66862b173c4835add6847801c9"></a><!-- doxytag: member="stk::BandedWG::tick" ref="a6c2ebb66862b173c4835add6847801c9" 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::BandedWG::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="l00125"></a>00125 {
<a name="l00126"></a>00126 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00127"></a>00127 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
<a name="l00129"></a>00129 oStream_ << <span class="stringliteral">"BandedWG::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00130"></a>00130 <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="l00131"></a>00131 }
<a name="l00132"></a>00132 <span class="preprocessor">#endif</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span>
<a name="l00134"></a>00134 StkFloat *samples = &frames[channel];
<a name="l00135"></a>00135 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00136"></a>00136 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00137"></a>00137 <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="l00138"></a>00138 *samples++ = <a class="code" href="classstk_1_1BandedWG.html#a44f37146d33354afb085806bd8340497" title="Compute and return one output sample.">tick</a>();
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140 <span class="keywordflow">else</span> {
<a name="l00141"></a>00141 <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="l00142"></a>00142 *samples++ = <a class="code" href="classstk_1_1BandedWG.html#a44f37146d33354afb085806bd8340497" title="Compute and return one output sample.">tick</a>();
<a name="l00143"></a>00143 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
<a name="l00144"></a>00144 *samples++ = lastFrame_[j];
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keywordflow">return</span> frames;
<a name="l00149"></a>00149 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BandedWG_8h_source.html">BandedWG.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>
|
