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
|
<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_1Modal.html">Modal</a>
</div>
<div class="contents">
<h1>stk::Modal Class Reference</h1><!-- doxytag: class="stk::Modal" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>STK resonance model abstract base class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Modal_8h_source.html">Modal.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Modal:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Modal.png" usemap="#stk::Modal_map" alt=""/>
<map id="stk::Modal_map" name="stk::Modal_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,88,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,88,24"/>
<area href="classstk_1_1ModalBar.html" alt="stk::ModalBar" shape="rect" coords="0,168,88,192"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Modal-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#af6bfea135e80abb5537e62cf099c989a">Modal</a> (unsigned int modes=4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the desired number of modes to create. <a href="#af6bfea135e80abb5537e62cf099c989a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f45379ae10495b7a864cade0063705a"></a><!-- doxytag: member="stk::Modal::~Modal" ref="a7f45379ae10495b7a864cade0063705a" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a7f45379ae10495b7a864cade0063705a">~Modal</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="af064dc6ee4290fd51b4a6dc8a1f0909d"></a><!-- doxytag: member="stk::Modal::clear" ref="af064dc6ee4290fd51b4a6dc8a1f0909d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#af064dc6ee4290fd51b4a6dc8a1f0909d">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="a503092926e66667227bb46312a82a264"></a><!-- doxytag: member="stk::Modal::setFrequency" ref="a503092926e66667227bb46312a82a264" args="(StkFloat frequency)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a503092926e66667227bb46312a82a264">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="a7e4f9a875e60485d07d50386ff63117f"></a><!-- doxytag: member="stk::Modal::setRatioAndRadius" ref="a7e4f9a875e60485d07d50386ff63117f" args="(unsigned int modeIndex, StkFloat ratio, StkFloat radius)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a7e4f9a875e60485d07d50386ff63117f">setRatioAndRadius</a> (unsigned int modeIndex, StkFloat ratio, StkFloat radius)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the ratio and radius for a specified mode filter. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e8d79358a5024b2e9a6c6f7c69a43c1"></a><!-- doxytag: member="stk::Modal::setMasterGain" ref="a6e8d79358a5024b2e9a6c6f7c69a43c1" args="(StkFloat aGain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a6e8d79358a5024b2e9a6c6f7c69a43c1">setMasterGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the master gain. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70006135da2ecdc46eff4156504d94e1"></a><!-- doxytag: member="stk::Modal::setDirectGain" ref="a70006135da2ecdc46eff4156504d94e1" args="(StkFloat aGain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a70006135da2ecdc46eff4156504d94e1">setDirectGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the direct gain. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08bdfedf10d00dcf19e82809926eab2f"></a><!-- doxytag: member="stk::Modal::setModeGain" ref="a08bdfedf10d00dcf19e82809926eab2f" args="(unsigned int modeIndex, StkFloat gain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a08bdfedf10d00dcf19e82809926eab2f">setModeGain</a> (unsigned int modeIndex, StkFloat gain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain for a specified mode filter. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3bac00a47fa6fef70cf3ea442e9b121"></a><!-- doxytag: member="stk::Modal::strike" ref="ab3bac00a47fa6fef70cf3ea442e9b121" args="(StkFloat amplitude)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#ab3bac00a47fa6fef70cf3ea442e9b121">strike</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate a strike with the given amplitude (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1884c49b76ec8b902f22d50e26a7e365"></a><!-- doxytag: member="stk::Modal::damp" ref="a1884c49b76ec8b902f22d50e26a7e365" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a1884c49b76ec8b902f22d50e26a7e365">damp</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Damp modes with a given decay factor (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44ce41e8e24e591f382914d00a259c7f"></a><!-- doxytag: member="stk::Modal::noteOn" ref="a44ce41e8e24e591f382914d00a259c7f" args="(StkFloat frequency, StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a44ce41e8e24e591f382914d00a259c7f">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="a3483dafe33fa37e98781279810ea808f"></a><!-- doxytag: member="stk::Modal::noteOff" ref="a3483dafe33fa37e98781279810ea808f" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a3483dafe33fa37e98781279810ea808f">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="a9fab49ec164852c381758f5d333f8891"></a><!-- doxytag: member="stk::Modal::controlChange" ref="a9fab49ec164852c381758f5d333f8891" args="(int number, StkFloat value)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#a9fab49ec164852c381758f5d333f8891">controlChange</a> (int number, StkFloat value)=0</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="ac1fd3f5dcb9b5cbb8bed0bff330c3890"></a><!-- doxytag: member="stk::Modal::tick" ref="ac1fd3f5dcb9b5cbb8bed0bff330c3890" args="(unsigned int channel=0)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#ac1fd3f5dcb9b5cbb8bed0bff330c3890">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_1Modal.html#ad2a28e7bd5fdae7d2a6d9fb79bbfb7b0">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="#ad2a28e7bd5fdae7d2a6d9fb79bbfb7b0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK resonance model abstract base class. </p>
<p>This class contains an excitation wavetable, an envelope, an oscillator, and N resonances (non-sweeping <a class="el" href="classstk_1_1BiQuad.html" title="STK biquad (two-pole, two-zero) filter class.">BiQuad</a> filters), where N is set during instantiation.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af6bfea135e80abb5537e62cf099c989a"></a><!-- doxytag: member="stk::Modal::Modal" ref="af6bfea135e80abb5537e62cf099c989a" args="(unsigned int modes=4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::Modal::Modal </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>modes</em> = <code>4</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class constructor, taking the desired number of modes to create. </p>
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad2a28e7bd5fdae7d2a6d9fb79bbfb7b0"></a><!-- doxytag: member="stk::Modal::tick" ref="ad2a28e7bd5fdae7d2a6d9fb79bbfb7b0" 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::Modal::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">"Modal::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_1Modal.html#ac1fd3f5dcb9b5cbb8bed0bff330c3890" 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_1Modal.html#ac1fd3f5dcb9b5cbb8bed0bff330c3890" 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="Modal_8h_source.html">Modal.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>
|
