Files
stk/doc/html/VoicForm_8h_source.html
2013-09-29 23:51:11 +02:00

138 lines
17 KiB
HTML

<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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <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>VoicForm.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_VOICFORM_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_VOICFORM_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;Instrmnt.h&quot;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;Envelope.h&quot;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;Noise.h&quot;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;SingWave.h&quot;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &quot;FormSwep.h&quot;</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &quot;OnePole.h&quot;</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &quot;OneZero.h&quot;</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="keyword">namespace </span>stk {
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="comment">/***************************************************/</span>
<a name="l00039"></a>00039 <span class="comment">/***************************************************/</span>
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="classstk_1_1VoicForm.html">00041</a> <span class="keyword">class </span><a class="code" href="classstk_1_1VoicForm.html" title="Four formant synthesis instrument.">VoicForm</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">public</span>:
<a name="l00045"></a>00045
<a name="l00048"></a>00048 <a class="code" href="classstk_1_1VoicForm.html#a9462c5ba6b627f5508c336153510de4c" title="Class constructor.">VoicForm</a>( <span class="keywordtype">void</span> );
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <a class="code" href="classstk_1_1VoicForm.html#a298da1434bf38e6bf83c2f9db78f01ac" title="Class destructor.">~VoicForm</a>( <span class="keywordtype">void</span> );
<a name="l00052"></a>00052
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#ad62987970200d4e9720190b884fb689d" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
<a name="l00055"></a>00055
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#aeb2b7ffe130e016c847cd7aebfd628ee" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
<a name="l00058"></a>00058
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1VoicForm.html#a6ee860f09b9598c1251a9653b50139bb" title="Set instrument parameters for the given phoneme. Returns false if phoneme not found...">setPhoneme</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* phoneme );
<a name="l00061"></a>00061
<a name="l00063"></a><a class="code" href="classstk_1_1VoicForm.html#acd504d4d29134a778b08b2229dd0c0c9">00063</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#acd504d4d29134a778b08b2229dd0c0c9" title="Set the voiced component gain.">setVoiced</a>( StkFloat vGain ) { voiced_-&gt;<a class="code" href="classstk_1_1SingWave.html#ac248b298dd095bd7c9ed2c84a229a55f" title="Set the gain target value.">setGainTarget</a>(vGain); };
<a name="l00064"></a>00064
<a name="l00066"></a><a class="code" href="classstk_1_1VoicForm.html#aa4fa86def4ded3698f75c0e4bdbdf638">00066</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#aa4fa86def4ded3698f75c0e4bdbdf638" title="Set the unvoiced component gain.">setUnVoiced</a>( StkFloat nGain ) { noiseEnv_.<a class="code" href="classstk_1_1Envelope.html#a5269bc5dc1d56161ab82b677b5462a3e" title="Set the target value.">setTarget</a>(nGain); };
<a name="l00067"></a>00067
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a14d8323edda6e8c82ab39d633b8064a8" title="Set the sweep rate for a particular formant filter (0-3).">setFilterSweepRate</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> whichOne, StkFloat rate );
<a name="l00070"></a>00070
<a name="l00072"></a><a class="code" href="classstk_1_1VoicForm.html#a2e4adfe6542f6103a8ac85c7ea2f2ce5">00072</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a2e4adfe6542f6103a8ac85c7ea2f2ce5" title="Set voiced component pitch sweep rate.">setPitchSweepRate</a>( StkFloat rate ) { voiced_-&gt;<a class="code" href="classstk_1_1SingWave.html#ab80c50b3c8fc05f056221452504aa150" title="Set the sweep rate.">setSweepRate</a>(rate); };
<a name="l00073"></a>00073
<a name="l00075"></a><a class="code" href="classstk_1_1VoicForm.html#a425c88ad505e260604771cfe3de6ed47">00075</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a425c88ad505e260604771cfe3de6ed47" title="Start the voice.">speak</a>( <span class="keywordtype">void</span> ) { voiced_-&gt;<a class="code" href="classstk_1_1SingWave.html#a9bd638590605e5b5eb679467506e42ff" title="Start a note.">noteOn</a>(); };
<a name="l00076"></a>00076
<a name="l00078"></a>00078 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a33cacda32d42f3282312043c54b3cee7" title="Stop the voice.">quiet</a>( <span class="keywordtype">void</span> );
<a name="l00079"></a>00079
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a9f8431ef3c7588c0d032e821d4dd1ad9" title="Start a note with the given frequency and amplitude.">noteOn</a>( StkFloat frequency, StkFloat amplitude );
<a name="l00082"></a>00082
<a name="l00084"></a><a class="code" href="classstk_1_1VoicForm.html#ab9e54927b3bec7b9727c32791bbb9b19">00084</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#ab9e54927b3bec7b9727c32791bbb9b19" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude ) { this-&gt;<a class="code" href="classstk_1_1VoicForm.html#a33cacda32d42f3282312043c54b3cee7" title="Stop the voice.">quiet</a>(); };
<a name="l00085"></a>00085
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1VoicForm.html#a427ca45d3e44e093c11f16e30fc2b550" title="Perform the control change specified by number and value (0.0 - 128.0).">controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value );
<a name="l00088"></a>00088
<a name="l00090"></a>00090 StkFloat <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00091"></a>00091
<a name="l00093"></a>00093
<a name="l00100"></a>00100 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" 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>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">protected</span>:
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <a class="code" href="classstk_1_1SingWave.html" title="STK &amp;quot;singing&amp;quot; looped soundfile class.">SingWave</a> *voiced_;
<a name="l00105"></a>00105 <a class="code" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> noise_;
<a name="l00106"></a>00106 <a class="code" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> noiseEnv_;
<a name="l00107"></a>00107 <a class="code" href="classstk_1_1FormSwep.html" title="STK sweepable formant filter class.">FormSwep</a> filters_[4];
<a name="l00108"></a>00108 <a class="code" href="classstk_1_1OnePole.html" title="STK one-pole filter class.">OnePole</a> onepole_;
<a name="l00109"></a>00109 <a class="code" href="classstk_1_1OneZero.html" title="STK one-zero filter class.">OneZero</a> onezero_;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 };
<a name="l00112"></a>00112
<a name="l00113"></a><a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29">00113</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" title="Compute and return one output sample.">VoicForm :: tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> )
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 StkFloat temp;
<a name="l00116"></a>00116 temp = onepole_.<a class="code" href="classstk_1_1OnePole.html#a3c83b6d43f76bec06f11caa9de76881e" title="Input one sample to the filter and return one output.">tick</a>( onezero_.<a class="code" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da" title="Input one sample to the filter and return one output.">tick</a>( voiced_-&gt;<a class="code" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78" title="Compute and return one output sample.">tick</a>() ) );
<a name="l00117"></a>00117 temp += noiseEnv_.<a class="code" href="classstk_1_1Envelope.html#a8de91b9caf10a03f52bd2247648c4601" title="Compute and return one output sample.">tick</a>() * noise_.<a class="code" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d" title="Compute and return one output sample.">tick</a>();
<a name="l00118"></a>00118 lastFrame_[0] = filters_[0].<a class="code" href="classstk_1_1FormSwep.html#aba0d15e1d102cb0fee0806e1bb05c774" title="Input one sample to the filter and return a reference to one output.">tick</a>(temp);
<a name="l00119"></a>00119 lastFrame_[0] += filters_[1].<a class="code" href="classstk_1_1FormSwep.html#aba0d15e1d102cb0fee0806e1bb05c774" title="Input one sample to the filter and return a reference to one output.">tick</a>(temp);
<a name="l00120"></a>00120 lastFrame_[0] += filters_[2].<a class="code" href="classstk_1_1FormSwep.html#aba0d15e1d102cb0fee0806e1bb05c774" title="Input one sample to the filter and return a reference to one output.">tick</a>(temp);
<a name="l00121"></a>00121 lastFrame_[0] += filters_[3].<a class="code" href="classstk_1_1FormSwep.html#aba0d15e1d102cb0fee0806e1bb05c774" title="Input one sample to the filter and return a reference to one output.">tick</a>(temp);
<a name="l00122"></a>00122 <span class="comment">/*</span>
<a name="l00123"></a>00123 <span class="comment"> temp += noiseEnv_.tick() * noise_.tick();</span>
<a name="l00124"></a>00124 <span class="comment"> lastFrame_[0] = filters_[0].tick(temp);</span>
<a name="l00125"></a>00125 <span class="comment"> lastFrame_[0] = filters_[1].tick(lastFrame_[0]);</span>
<a name="l00126"></a>00126 <span class="comment"> lastFrame_[0] = filters_[2].tick(lastFrame_[0]);</span>
<a name="l00127"></a>00127 <span class="comment"> lastFrame_[0] = filters_[3].tick(lastFrame_[0]);</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a><a class="code" href="classstk_1_1VoicForm.html#a619d2995894216181c2dc38fd863fe33">00132</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>&amp; <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" title="Compute and return one output sample.">VoicForm :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<a name="l00135"></a>00135 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - nChannels ) {
<a name="l00137"></a>00137 oStream_ &lt;&lt; <span class="stringliteral">&quot;VoicForm::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00138"></a>00138 <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="l00139"></a>00139 }
<a name="l00140"></a>00140 <span class="preprocessor">#endif</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span>
<a name="l00142"></a>00142 StkFloat *samples = &amp;frames[channel];
<a name="l00143"></a>00143 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - nChannels;
<a name="l00144"></a>00144 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00145"></a>00145 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;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="l00146"></a>00146 *samples++ = <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" title="Compute and return one output sample.">tick</a>();
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148 <span class="keywordflow">else</span> {
<a name="l00149"></a>00149 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;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="l00150"></a>00150 *samples++ = <a class="code" href="classstk_1_1VoicForm.html#ac12629d2730f582e405b221e1d7b6f29" title="Compute and return one output sample.">tick</a>();
<a name="l00151"></a>00151 <span class="keywordflow">for</span> ( j=1; j&lt;nChannels; j++ )
<a name="l00152"></a>00152 *samples++ = lastFrame_[j];
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154 }
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keywordflow">return</span> frames;
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158
<a name="l00159"></a>00159 } <span class="comment">// stk namespace</span>
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>