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
|
<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_1SingWave.html">SingWave</a>
</div>
<div class="contents">
<h1>stk::SingWave Class Reference</h1><!-- doxytag: class="stk::SingWave" --><!-- doxytag: inherits="stk::Generator" -->
<p>STK "singing" looped soundfile class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="SingWave_8h_source.html">SingWave.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::SingWave:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1SingWave.png" usemap="#stk::SingWave_map" alt=""/>
<map id="stk::SingWave_map" name="stk::SingWave_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_1SingWave-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_1SingWave.html#a7a38283d4e42d5f9b96d3ce8c401183a">SingWave</a> (std::string fileName, bool raw=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor taking filename argument. <a href="#a7a38283d4e42d5f9b96d3ce8c401183a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cd0c9dc6878705b638098c425ced782"></a><!-- doxytag: member="stk::SingWave::~SingWave" ref="a0cd0c9dc6878705b638098c425ced782" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a0cd0c9dc6878705b638098c425ced782">~SingWave</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="a906a50d64292988d48aa742c80e4f572"></a><!-- doxytag: member="stk::SingWave::reset" ref="a906a50d64292988d48aa742c80e4f572" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a906a50d64292988d48aa742c80e4f572">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset file to beginning. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed07d9ebe8289abe232eb1337d0708db"></a><!-- doxytag: member="stk::SingWave::normalize" ref="aed07d9ebe8289abe232eb1337d0708db" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#aed07d9ebe8289abe232eb1337d0708db">normalize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normalize the file to a maximum of +-1.0. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeece74c720cfe97c3d7f67c01a102b3d"></a><!-- doxytag: member="stk::SingWave::normalize" ref="aeece74c720cfe97c3d7f67c01a102b3d" args="(StkFloat peak)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#aeece74c720cfe97c3d7f67c01a102b3d">normalize</a> (StkFloat peak)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normalize the file to a maximum of <em>+-</em> peak. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1ac4a84551f89570ff0842d032a3cba"></a><!-- doxytag: member="stk::SingWave::setFrequency" ref="ae1ac4a84551f89570ff0842d032a3cba" args="(StkFloat frequency)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ae1ac4a84551f89570ff0842d032a3cba">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set looping parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9143162e223ad86682c099d2a6c79ea0"></a><!-- doxytag: member="stk::SingWave::setVibratoRate" ref="a9143162e223ad86682c099d2a6c79ea0" args="(StkFloat rate)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a9143162e223ad86682c099d2a6c79ea0">setVibratoRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the vibrato frequency in Hz. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5276e1e244551d1ca1dcc70ed42e9228"></a><!-- doxytag: member="stk::SingWave::setVibratoGain" ref="a5276e1e244551d1ca1dcc70ed42e9228" args="(StkFloat gain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a5276e1e244551d1ca1dcc70ed42e9228">setVibratoGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the vibrato gain. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a287cf0feecb7eda88328fb2bc0edff92"></a><!-- doxytag: member="stk::SingWave::setRandomGain" ref="a287cf0feecb7eda88328fb2bc0edff92" args="(StkFloat gain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a287cf0feecb7eda88328fb2bc0edff92">setRandomGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the random-ness amount. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab80c50b3c8fc05f056221452504aa150"></a><!-- doxytag: member="stk::SingWave::setSweepRate" ref="ab80c50b3c8fc05f056221452504aa150" args="(StkFloat rate)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ab80c50b3c8fc05f056221452504aa150">setSweepRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the sweep rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2a4183704bea50f9d793bd998d6554"></a><!-- doxytag: member="stk::SingWave::setGainRate" ref="a7e2a4183704bea50f9d793bd998d6554" args="(StkFloat rate)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a7e2a4183704bea50f9d793bd998d6554">setGainRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac248b298dd095bd7c9ed2c84a229a55f"></a><!-- doxytag: member="stk::SingWave::setGainTarget" ref="ac248b298dd095bd7c9ed2c84a229a55f" args="(StkFloat target)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ac248b298dd095bd7c9ed2c84a229a55f">setGainTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain target value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bd638590605e5b5eb679467506e42ff"></a><!-- doxytag: member="stk::SingWave::noteOn" ref="a9bd638590605e5b5eb679467506e42ff" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a9bd638590605e5b5eb679467506e42ff">noteOn</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac81240ee79f64b90a9c37d45c0aa3a7f"></a><!-- doxytag: member="stk::SingWave::noteOff" ref="ac81240ee79f64b90a9c37d45c0aa3a7f" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ac81240ee79f64b90a9c37d45c0aa3a7f">noteOff</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1c5286c4a58904241d7b73ff29d4be0"></a><!-- doxytag: member="stk::SingWave::lastOut" ref="af1c5286c4a58904241d7b73ff29d4be0" args="(void) const " -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#af1c5286c4a58904241d7b73ff29d4be0">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="a45136f9bf5b6f58433d4d65864d9db78"></a><!-- doxytag: member="stk::SingWave::tick" ref="a45136f9bf5b6f58433d4d65864d9db78" args="(void)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78">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_1SingWave.html#ab74d7a305510eec92a9aa1a26bcb5e94">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="#ab74d7a305510eec92a9aa1a26bcb5e94"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK "singing" looped soundfile class. </p>
<p>This class loops a specified soundfile and modulates it both periodically and randomly to produce a pitched musical sound, like a simple voice or violin. In general, it is not be used alone because of "munchkinification" effects from pitch shifting. Within STK, it is used as an excitation source for other instruments.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7a38283d4e42d5f9b96d3ce8c401183a"></a><!-- doxytag: member="stk::SingWave::SingWave" ref="a7a38283d4e42d5f9b96d3ce8c401183a" args="(std::string fileName, bool raw=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::SingWave::SingWave </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>raw</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class constructor taking filename argument. </p>
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. If the soundfile has no header, the second argument should be <em>true</em> and the file data will be assumed to consist of 16-bit signed integers in big-endian byte order at a sample rate of 22050 Hz. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab74d7a305510eec92a9aa1a26bcb5e94"></a><!-- doxytag: member="stk::SingWave::tick" ref="ab74d7a305510eec92a9aa1a26bcb5e94" 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::SingWave::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="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
<a name="l00121"></a>00121 oStream_ << <span class="stringliteral">"SingWave::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00122"></a>00122 <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="l00123"></a>00123 }
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00126"></a>00126 StkFloat *samples = &frames[channel];
<a name="l00127"></a>00127 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00128"></a>00128 <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="l00129"></a>00129 *samples = <a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">SingWave::tick</a>();
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordflow">return</span> frames;
<a name="l00132"></a>00132 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SingWave_8h_source.html">SingWave.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>
|
