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
|
<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="dir_221deb9bdff892d63ed1e409450a60d2.html">include</a>
</div>
<div class="contents">
<h1>SingWave.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_SINGWAVE_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_SINGWAVE_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include "FileLoop.h"</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include "Modulate.h"</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include "Envelope.h"</span>
<a name="l00007"></a>00007
<a name="l00008"></a>00008 <span class="keyword">namespace </span>stk {
<a name="l00009"></a>00009
<a name="l00010"></a>00010 <span class="comment">/***************************************************/</span>
<a name="l00023"></a>00023 <span class="comment">/***************************************************/</span>
<a name="l00024"></a>00024
<a name="l00025"></a><a class="code" href="classstk_1_1SingWave.html">00025</a> <span class="keyword">class </span><a class="code" href="classstk_1_1SingWave.html" title="STK &quot;singing&quot; looped soundfile class.">SingWave</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Generator.html" title="STK abstract unit generator parent class.">Generator</a>
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">public</span>:
<a name="l00029"></a>00029
<a name="l00036"></a>00036 <a class="code" href="classstk_1_1SingWave.html#a7a38283d4e42d5f9b96d3ce8c401183a" title="Class constructor taking filename argument.">SingWave</a>( std::string fileName, <span class="keywordtype">bool</span> raw = <span class="keyword">false</span> );
<a name="l00037"></a>00037
<a name="l00039"></a>00039 <a class="code" href="classstk_1_1SingWave.html#a0cd0c9dc6878705b638098c425ced782" title="Class destructor.">~SingWave</a>( <span class="keywordtype">void</span> );
<a name="l00040"></a>00040
<a name="l00042"></a><a class="code" href="classstk_1_1SingWave.html#a906a50d64292988d48aa742c80e4f572">00042</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a906a50d64292988d48aa742c80e4f572" title="Reset file to beginning.">reset</a>( <span class="keywordtype">void</span> ) { wave_.<a class="code" href="classstk_1_1FileLoop.html#a2c539902d697d0b87334ca7dc4f3ce69" title="Clear outputs and reset time (file) pointer to zero.">reset</a>(); lastFrame_[0] = 0.0; };
<a name="l00043"></a>00043
<a name="l00045"></a><a class="code" href="classstk_1_1SingWave.html#aed07d9ebe8289abe232eb1337d0708db">00045</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#aed07d9ebe8289abe232eb1337d0708db" title="Normalize the file to a maximum of +-1.0.">normalize</a>( <span class="keywordtype">void</span> ) { wave_.<a class="code" href="classstk_1_1FileLoop.html#a7c4a3d5c427154bf653f86a53e900b8b" title="Normalize data to a maximum of +-1.0.">normalize</a>(); };
<a name="l00046"></a>00046
<a name="l00048"></a><a class="code" href="classstk_1_1SingWave.html#aeece74c720cfe97c3d7f67c01a102b3d">00048</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#aeece74c720cfe97c3d7f67c01a102b3d" title="Normalize the file to a maximum of +- peak.">normalize</a>( StkFloat peak ) { wave_.<a class="code" href="classstk_1_1FileLoop.html#a7c4a3d5c427154bf653f86a53e900b8b" title="Normalize data to a maximum of +-1.0.">normalize</a>( peak ); };
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#ae1ac4a84551f89570ff0842d032a3cba" title="Set looping parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
<a name="l00052"></a>00052
<a name="l00054"></a><a class="code" href="classstk_1_1SingWave.html#a9143162e223ad86682c099d2a6c79ea0">00054</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a9143162e223ad86682c099d2a6c79ea0" title="Set the vibrato frequency in Hz.">setVibratoRate</a>( StkFloat rate ) { modulator_.<a class="code" href="classstk_1_1Modulate.html#a298b25f4b7cc56f2dffae5474a05999d" title="Set the periodic (vibrato) rate or frequency in Hz.">setVibratoRate</a>( rate ); };
<a name="l00055"></a>00055
<a name="l00057"></a><a class="code" href="classstk_1_1SingWave.html#a5276e1e244551d1ca1dcc70ed42e9228">00057</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a5276e1e244551d1ca1dcc70ed42e9228" title="Set the vibrato gain.">setVibratoGain</a>( StkFloat gain ) { modulator_.<a class="code" href="classstk_1_1Modulate.html#a08f2d489a3fba3a10d1f301aed869ed4" title="Set the periodic (vibrato) gain.">setVibratoGain</a>( gain ); };
<a name="l00058"></a>00058
<a name="l00060"></a><a class="code" href="classstk_1_1SingWave.html#a287cf0feecb7eda88328fb2bc0edff92">00060</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a287cf0feecb7eda88328fb2bc0edff92" title="Set the random-ness amount.">setRandomGain</a>( StkFloat gain ) { modulator_.<a class="code" href="classstk_1_1Modulate.html#ac6e7a02378facf59916f2460ed5c2fa5" title="Set the random modulation gain.">setRandomGain</a>( gain ); };
<a name="l00061"></a>00061
<a name="l00063"></a><a class="code" href="classstk_1_1SingWave.html#ab80c50b3c8fc05f056221452504aa150">00063</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#ab80c50b3c8fc05f056221452504aa150" title="Set the sweep rate.">setSweepRate</a>( StkFloat rate ) { sweepRate_ = rate; };
<a name="l00064"></a>00064
<a name="l00066"></a><a class="code" href="classstk_1_1SingWave.html#a7e2a4183704bea50f9d793bd998d6554">00066</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a7e2a4183704bea50f9d793bd998d6554" title="Set the gain rate.">setGainRate</a>( StkFloat rate ) { envelope_.<a class="code" href="classstk_1_1Envelope.html#ade99b5c7cb974f71f1d2919868d774a0" title="Set the rate.">setRate</a>( rate ); };
<a name="l00067"></a>00067
<a name="l00069"></a><a class="code" href="classstk_1_1SingWave.html#ac248b298dd095bd7c9ed2c84a229a55f">00069</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#ac248b298dd095bd7c9ed2c84a229a55f" title="Set the gain target value.">setGainTarget</a>( StkFloat target ) { envelope_.<a class="code" href="classstk_1_1Envelope.html#a5269bc5dc1d56161ab82b677b5462a3e" title="Set the target value.">setTarget</a>( target ); };
<a name="l00070"></a>00070
<a name="l00072"></a><a class="code" href="classstk_1_1SingWave.html#a9bd638590605e5b5eb679467506e42ff">00072</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#a9bd638590605e5b5eb679467506e42ff" title="Start a note.">noteOn</a>( <span class="keywordtype">void</span> ) { envelope_.<a class="code" href="classstk_1_1Envelope.html#a18cf8f21ef70227bd5cd17f53752bd0f" title="Set target = 1.">keyOn</a>(); };
<a name="l00073"></a>00073
<a name="l00075"></a><a class="code" href="classstk_1_1SingWave.html#ac81240ee79f64b90a9c37d45c0aa3a7f">00075</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1SingWave.html#ac81240ee79f64b90a9c37d45c0aa3a7f" title="Stop a note.">noteOff</a>( <span class="keywordtype">void</span> ) { envelope_.<a class="code" href="classstk_1_1Envelope.html#a9dbefb15f8d64aac3969f77d38791774" title="Set target = 0.">keyOff</a>(); };
<a name="l00076"></a>00076
<a name="l00078"></a><a class="code" href="classstk_1_1SingWave.html#af1c5286c4a58904241d7b73ff29d4be0">00078</a> StkFloat <a class="code" href="classstk_1_1SingWave.html#af1c5286c4a58904241d7b73ff29d4be0" title="Return the last computed output value.">lastOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_[0]; };
<a name="l00079"></a>00079
<a name="l00081"></a>00081 StkFloat <a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">void</span> );
<a name="l00082"></a>00082
<a name="l00084"></a>00084
<a name="l00091"></a>00091 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">protected</span>:
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <a class="code" href="classstk_1_1FileLoop.html" title="STK file looping / oscillator class.">FileLoop</a> wave_;
<a name="l00096"></a>00096 <a class="code" href="classstk_1_1Modulate.html" title="STK periodic/random modulator.">Modulate</a> modulator_;
<a name="l00097"></a>00097 <a class="code" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> envelope_;
<a name="l00098"></a>00098 <a class="code" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> pitchEnvelope_;
<a name="l00099"></a>00099 StkFloat rate_;
<a name="l00100"></a>00100 StkFloat sweepRate_;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 };
<a name="l00103"></a>00103
<a name="l00104"></a><a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78">00104</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">SingWave :: tick</a>( <span class="keywordtype">void</span> )
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="comment">// Set the wave rate.</span>
<a name="l00107"></a>00107 StkFloat newRate = pitchEnvelope_.<a class="code" href="classstk_1_1Envelope.html#a8de91b9caf10a03f52bd2247648c4601" title="Compute and return one output sample.">tick</a>();
<a name="l00108"></a>00108 newRate += newRate * modulator_.<a class="code" href="classstk_1_1Modulate.html#a237b96dd553d65253abbf00a186e293d" title="Compute and return one output sample.">tick</a>();
<a name="l00109"></a>00109 wave_.<a class="code" href="classstk_1_1FileLoop.html#a13e1f693bc8a29d9051a400087347a3c" title="Set the data read rate in samples. The rate can be negative.">setRate</a>( newRate );
<a name="l00110"></a>00110
<a name="l00111"></a>00111 lastFrame_[0] = wave_.<a class="code" href="classstk_1_1FileLoop.html#a037b31918134ed1839a8b48de774ab95" title="Compute a sample frame and return the specified channel value.">tick</a>();
<a name="l00112"></a>00112 lastFrame_[0] *= envelope_.<a class="code" href="classstk_1_1Envelope.html#a8de91b9caf10a03f52bd2247648c4601" title="Compute and return one output sample.">tick</a>();
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a><a class="code" href="classstk_1_1SingWave.html#ab74d7a305510eec92a9aa1a26bcb5e94">00117</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">SingWave :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<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.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
<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.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<a name="l00128"></a>00128 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); 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 }
<a name="l00133"></a>00133
<a name="l00134"></a>00134 } <span class="comment">// stk namespace</span>
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
</pre></div></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>
|
