Files
stk/doc/html/NRev_8h_source.html
2013-09-29 23:49:37 +02:00

136 lines
13 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_f14fd23bc74c76f288031ad23b3f3505.html">include</a>
</div>
<div class="contents">
<h1>NRev.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_NREV_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_NREV_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;Effect.h&quot;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;Delay.h&quot;</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="keyword">namespace </span>stk {
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <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_1NRev.html">00025</a> <span class="keyword">class </span><a class="code" href="classstk_1_1NRev.html" title="CCRMA&amp;#39;s NRev reverberator class.">NRev</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Effect.html" title="STK abstract effects parent class.">Effect</a>
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">public</span>:
<a name="l00029"></a>00029 <a class="code" href="classstk_1_1NRev.html#a68757d7a44e960acfd18cb94b465c727" title="Class constructor taking a T60 decay time argument (one second default value).">NRev</a>( StkFloat T60 = 1.0 );
<a name="l00030"></a>00030
<a name="l00032"></a>00032 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1NRev.html#a4097b11b38dd00d084ae4a94bc18f02c" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
<a name="l00033"></a>00033
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1NRev.html#a9c0d41a2b9ce7fb9edb2d620ba005e3c" title="Set the reverberation T60 decay time.">setT60</a>( StkFloat T60 );
<a name="l00036"></a>00036
<a name="l00038"></a>00038
<a name="l00046"></a>00046 StkFloat <a class="code" href="classstk_1_1NRev.html#a9f9faa6542271163680c1925309ed788" title="Return the specified channel value of the last computed stereo frame.">lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00047"></a>00047
<a name="l00049"></a>00049
<a name="l00056"></a>00056 StkFloat <a class="code" href="classstk_1_1NRev.html#acfb629e4822fc5bffcf39b8f3ed9cfa1" title="Input one sample to the effect and return the specified channel value of the computed...">tick</a>( StkFloat input, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00057"></a>00057
<a name="l00059"></a>00059
<a name="l00068"></a>00068 <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_1NRev.html#acfb629e4822fc5bffcf39b8f3ed9cfa1" title="Input one sample to the effect and return the specified channel value of the computed...">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="l00069"></a>00069
<a name="l00071"></a>00071
<a name="l00080"></a>00080 <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_1NRev.html#acfb629e4822fc5bffcf39b8f3ed9cfa1" title="Input one sample to the effect and return the specified channel value of the computed...">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; iFrames, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> &amp;oFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannel = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> oChannel = 0 );
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">protected</span>:
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <a class="code" href="classstk_1_1Delay.html" title="STK non-interpolating delay line class.">Delay</a> allpassDelays_[8];
<a name="l00085"></a>00085 <a class="code" href="classstk_1_1Delay.html" title="STK non-interpolating delay line class.">Delay</a> combDelays_[6];
<a name="l00086"></a>00086 StkFloat allpassCoefficient_;
<a name="l00087"></a>00087 StkFloat combCoefficient_[6];
<a name="l00088"></a>00088 StkFloat lowpassState_;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091
<a name="l00092"></a><a class="code" href="classstk_1_1NRev.html#a9f9faa6542271163680c1925309ed788">00092</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1NRev.html#a9f9faa6542271163680c1925309ed788" title="Return the specified channel value of the last computed stereo frame.">NRev :: lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; 1 ) {
<a name="l00096"></a>00096 oStream_ &lt;&lt; <span class="stringliteral">&quot;NRev::lastOut(): channel argument must be less than 2!&quot;</span>;
<a name="l00097"></a>00097 <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="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>
<a name="l00101"></a>00101 <span class="keywordflow">return</span> lastFrame_[channel];
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103
<a name="l00104"></a><a class="code" href="classstk_1_1NRev.html#acfb629e4822fc5bffcf39b8f3ed9cfa1">00104</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1NRev.html#acfb629e4822fc5bffcf39b8f3ed9cfa1" title="Input one sample to the effect and return the specified channel value of the computed...">NRev :: tick</a>( StkFloat input, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; 1 ) {
<a name="l00108"></a>00108 oStream_ &lt;&lt; <span class="stringliteral">&quot;NRev::tick(): channel argument must be less than 2!&quot;</span>;
<a name="l00109"></a>00109 <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="l00110"></a>00110 }
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span>
<a name="l00113"></a>00113 StkFloat temp, temp0, temp1, temp2, temp3;
<a name="l00114"></a>00114 <span class="keywordtype">int</span> i;
<a name="l00115"></a>00115
<a name="l00116"></a>00116 temp0 = 0.0;
<a name="l00117"></a>00117 <span class="keywordflow">for</span> ( i=0; i&lt;6; i++ ) {
<a name="l00118"></a>00118 temp = input + (combCoefficient_[i] * combDelays_[i].<a class="code" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2" title="Return the last computed output value.">lastOut</a>());
<a name="l00119"></a>00119 temp0 += combDelays_[i].<a class="code" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick</a>(temp);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordflow">for</span> ( i=0; i&lt;3; i++ ) {
<a name="l00123"></a>00123 temp = allpassDelays_[i].<a class="code" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2" title="Return the last computed output value.">lastOut</a>();
<a name="l00124"></a>00124 temp1 = allpassCoefficient_ * temp;
<a name="l00125"></a>00125 temp1 += temp0;
<a name="l00126"></a>00126 allpassDelays_[i].<a class="code" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick</a>(temp1);
<a name="l00127"></a>00127 temp0 = -(allpassCoefficient_ * temp1) + temp;
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="comment">// One-pole lowpass filter.</span>
<a name="l00131"></a>00131 lowpassState_ = 0.7 * lowpassState_ + 0.3 * temp0;
<a name="l00132"></a>00132 temp = allpassDelays_[3].<a class="code" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2" title="Return the last computed output value.">lastOut</a>();
<a name="l00133"></a>00133 temp1 = allpassCoefficient_ * temp;
<a name="l00134"></a>00134 temp1 += lowpassState_;
<a name="l00135"></a>00135 allpassDelays_[3].<a class="code" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick</a>( temp1 );
<a name="l00136"></a>00136 temp1 = -( allpassCoefficient_ * temp1 ) + temp;
<a name="l00137"></a>00137
<a name="l00138"></a>00138 temp = allpassDelays_[4].<a class="code" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2" title="Return the last computed output value.">lastOut</a>();
<a name="l00139"></a>00139 temp2 = allpassCoefficient_ * temp;
<a name="l00140"></a>00140 temp2 += temp1;
<a name="l00141"></a>00141 allpassDelays_[4].<a class="code" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick</a>( temp2 );
<a name="l00142"></a>00142 lastFrame_[0] = effectMix_*( -( allpassCoefficient_ * temp2 ) + temp );
<a name="l00143"></a>00143
<a name="l00144"></a>00144 temp = allpassDelays_[5].<a class="code" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2" title="Return the last computed output value.">lastOut</a>();
<a name="l00145"></a>00145 temp3 = allpassCoefficient_ * temp;
<a name="l00146"></a>00146 temp3 += temp1;
<a name="l00147"></a>00147 allpassDelays_[5].<a class="code" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick</a>( temp3 );
<a name="l00148"></a>00148 lastFrame_[1] = effectMix_*( - ( allpassCoefficient_ * temp3 ) + temp );
<a name="l00149"></a>00149
<a name="l00150"></a>00150 temp = ( 1.0 - effectMix_ ) * input;
<a name="l00151"></a>00151 lastFrame_[0] += temp;
<a name="l00152"></a>00152 lastFrame_[1] += temp;
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordflow">return</span> lastFrame_[channel];
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156
<a name="l00157"></a>00157 } <span class="comment">// stk namespace</span>
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="preprocessor">#endif</span>
<a name="l00160"></a>00160 <span class="preprocessor"></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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>