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
|
<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_1SineWave.html">SineWave</a>
</div>
<div class="contents">
<h1>stk::SineWave Class Reference</h1><!-- doxytag: class="stk::SineWave" --><!-- doxytag: inherits="stk::Generator" -->
<p>STK sinusoid oscillator class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="SineWave_8h_source.html">SineWave.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::SineWave:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1SineWave.png" usemap="#stk::SineWave_map" alt=""/>
<map id="stk::SineWave_map" name="stk::SineWave_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_1SineWave-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="ad25afe03871430c533986b0852e04c62"></a><!-- doxytag: member="stk::SineWave::SineWave" ref="ad25afe03871430c533986b0852e04c62" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#ad25afe03871430c533986b0852e04c62">SineWave</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae192f1813531f4b2ba933bcc5b288bfb"></a><!-- doxytag: member="stk::SineWave::~SineWave" ref="ae192f1813531f4b2ba933bcc5b288bfb" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#ae192f1813531f4b2ba933bcc5b288bfb">~SineWave</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="a667b211ead65a23aa8ab89e4a9c9ae6c"></a><!-- doxytag: member="stk::SineWave::reset" ref="a667b211ead65a23aa8ab89e4a9c9ae6c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#a667b211ead65a23aa8ab89e4a9c9ae6c">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear output and reset time pointer to zero. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#ae69b232dd3a33963d25cf6215692d9d5">setRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data read rate in samples. The rate can be negative. <a href="#ae69b232dd3a33963d25cf6215692d9d5"></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_1SineWave.html#a1047a43714bc2e40c7e31e8f7e34adbc">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data interpolation rate based on a looping frequency. <a href="#a1047a43714bc2e40c7e31e8f7e34adbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc8f03d5d81cfc24c20794033aad876f"></a><!-- doxytag: member="stk::SineWave::addTime" ref="adc8f03d5d81cfc24c20794033aad876f" args="(StkFloat time)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#adc8f03d5d81cfc24c20794033aad876f">addTime</a> (StkFloat time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the read pointer by <em>time</em> in samples, modulo the table size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#a62d69af61e6905ddda203756cd6e3516">addPhase</a> (StkFloat phase)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the read pointer by a normalized <em>phase</em> value. <a href="#a62d69af61e6905ddda203756cd6e3516"></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_1SineWave.html#a87bd4c92259b9b389f568f8d7cd7524f">addPhaseOffset</a> (StkFloat phaseOffset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a normalized phase offset to the read pointer. <a href="#a87bd4c92259b9b389f568f8d7cd7524f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab788e787e5bb54445dd0769283567224"></a><!-- doxytag: member="stk::SineWave::lastOut" ref="ab788e787e5bb54445dd0769283567224" args="(void) const " -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#ab788e787e5bb54445dd0769283567224">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </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="a31a55627bf8064919b5e063059260eda"></a><!-- doxytag: member="stk::SineWave::tick" ref="a31a55627bf8064919b5e063059260eda" args="(void)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SineWave.html#a31a55627bf8064919b5e063059260eda">tick</a> (void)</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_1SineWave.html#af205d7029046af8a392341cabd58f9de">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="#af205d7029046af8a392341cabd58f9de"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK sinusoid oscillator class. </p>
<p>This class computes and saves a static sine "table" that can be shared by multiple instances. It has an interface similar to the WaveLoop class but inherits from the <a class="el" href="classstk_1_1Generator.html" title="STK abstract unit generator parent class.">Generator</a> class. Output values are computed using linear interpolation.</p>
<p>The "table" length, set in <a class="el" href="SineWave_8h_source.html">SineWave.h</a>, is 2048 samples by default.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae69b232dd3a33963d25cf6215692d9d5"></a><!-- doxytag: member="stk::SineWave::setRate" ref="ae69b232dd3a33963d25cf6215692d9d5" args="(StkFloat rate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::SineWave::setRate </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>rate</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the data read rate in samples. The rate can be negative. </p>
<p>If the rate value is negative, the data is read in reverse order. </p>
<p><div class="fragment"><pre class="fragment"><a name="l00041"></a>00041 { rate_ = rate; };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a1047a43714bc2e40c7e31e8f7e34adbc"></a><!-- doxytag: member="stk::SineWave::setFrequency" ref="a1047a43714bc2e40c7e31e8f7e34adbc" args="(StkFloat frequency)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::SineWave::setFrequency </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>frequency</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the data interpolation rate based on a looping frequency. </p>
<p>This function determines the interpolation rate based on the file size and the current <a class="el" href="classstk_1_1Stk.html#a5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate</a>. The <em>frequency</em> value corresponds to file cycles per second. The frequency can be negative, in which case the loop is read in reverse order. </p>
</div>
</div>
<a class="anchor" id="a62d69af61e6905ddda203756cd6e3516"></a><!-- doxytag: member="stk::SineWave::addPhase" ref="a62d69af61e6905ddda203756cd6e3516" args="(StkFloat phase)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::SineWave::addPhase </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>phase</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increment the read pointer by a normalized <em>phase</em> value. </p>
<p>This function increments the read pointer by a normalized phase value, such that <em>phase</em> = 1.0 corresponds to a 360 degree phase shift. Positive or negative values are possible. </p>
</div>
</div>
<a class="anchor" id="a87bd4c92259b9b389f568f8d7cd7524f"></a><!-- doxytag: member="stk::SineWave::addPhaseOffset" ref="a87bd4c92259b9b389f568f8d7cd7524f" args="(StkFloat phaseOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::SineWave::addPhaseOffset </td>
<td>(</td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>phaseOffset</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a normalized phase offset to the read pointer. </p>
<p>A <em>phaseOffset</em> = 1.0 corresponds to a 360 degree phase offset. Positive or negative values are possible. </p>
</div>
</div>
<a class="anchor" id="af205d7029046af8a392341cabd58f9de"></a><!-- doxytag: member="stk::SineWave::tick" ref="af205d7029046af8a392341cabd58f9de" 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::SineWave::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_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00121"></a>00121 {
<a name="l00122"></a>00122 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
<a name="l00124"></a>00124 oStream_ << <span class="stringliteral">"SineWave::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00125"></a>00125 <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="l00126"></a>00126 }
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>
<a name="l00129"></a>00129 StkFloat *samples = &frames[channel];
<a name="l00130"></a>00130 StkFloat tmp = 0.0;
<a name="l00131"></a>00131
<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
<a name="l00135"></a>00135 <span class="comment">// Check limits of time address ... if necessary, recalculate modulo</span>
<a name="l00136"></a>00136 <span class="comment">// TABLE_SIZE.</span>
<a name="l00137"></a>00137 <span class="keywordflow">while</span> ( time_ < 0.0 )
<a name="l00138"></a>00138 time_ += TABLE_SIZE;
<a name="l00139"></a>00139 <span class="keywordflow">while</span> ( time_ >= TABLE_SIZE )
<a name="l00140"></a>00140 time_ -= TABLE_SIZE;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 iIndex_ = (<span class="keywordtype">unsigned</span> int) time_;
<a name="l00143"></a>00143 alpha_ = time_ - iIndex_;
<a name="l00144"></a>00144 tmp = table_[ iIndex_ ];
<a name="l00145"></a>00145 tmp += ( alpha_ * ( table_[ iIndex_ + 1 ] - tmp ) );
<a name="l00146"></a>00146 *samples = tmp;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// Increment time, which can be negative.</span>
<a name="l00149"></a>00149 time_ += rate_;
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151
<a name="l00152"></a>00152 lastFrame_[0] = tmp;
<a name="l00153"></a>00153 <span class="keywordflow">return</span> frames;
<a name="l00154"></a>00154 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SineWave_8h_source.html">SineWave.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>
|
