Files
stk/doc/html/TapDelay_8h-source.html
2013-09-29 23:44:33 +02:00

174 lines
21 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.5.8 -->
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
</div>
<div class="contents">
<h1>TapDelay.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_TAPDELAY_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_TAPDELAY_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include "Filter.h"</span>
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="keyword">namespace </span>stk {
<a name="l00007"></a>00007
<a name="l00008"></a>00008 <span class="comment">/***************************************************/</span>
<a name="l00022"></a>00022 <span class="comment">/***************************************************/</span>
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="classstk_1_1TapDelay.html">00024</a> <span class="keyword">class </span><a class="code" href="classstk_1_1TapDelay.html" title="STK non-interpolating tapped delay line class.">TapDelay</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a>
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 <span class="keyword">public</span>:
<a name="l00027"></a>00027
<a name="l00029"></a>00029
<a name="l00034"></a>00034 <a class="code" href="classstk_1_1TapDelay.html#24913411dff23e05995979e42cc51ecc" title="The default constructor creates a delay-line with maximum length of 4095 samples...">TapDelay</a>( std::vector&lt;unsigned long&gt; taps = std::vector&lt;unsigned long&gt;( 1, 0 ), <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxDelay = 4095 );
<a name="l00035"></a>00035
<a name="l00037"></a>00037 <a class="code" href="classstk_1_1TapDelay.html#6980be10c3d3cb9633af1733b40e49cc" title="Class destructor.">~TapDelay</a>();
<a name="l00038"></a>00038
<a name="l00040"></a>00040
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TapDelay.html#104b7bd81435a38191e1e43a24cb471d" title="Set the maximum delay-line length.">setMaximumDelay</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> delay );
<a name="l00048"></a>00048
<a name="l00050"></a>00050
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1TapDelay.html#a2bbab19ae277dc3689471d4250f00ad" title="Set the delay-line tap lengths.">setTapDelays</a>( std::vector&lt;unsigned long&gt; taps );
<a name="l00054"></a>00054
<a name="l00056"></a><a class="code" href="classstk_1_1TapDelay.html#ad3736becdec6059f2986f873d69b971">00056</a> std::vector&lt;unsigned long&gt; <a class="code" href="classstk_1_1TapDelay.html#ad3736becdec6059f2986f873d69b971" title="Return the current delay-line length.">getTapDelays</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> delays_; };
<a name="l00057"></a>00057
<a name="l00059"></a>00059
<a name="l00067"></a>00067 StkFloat <a class="code" href="classstk_1_1TapDelay.html#517399ddf52455ef083481cbb77c0b5c" title="Return the specified tap value of the last computed frame.">lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tap = 0 ) <span class="keyword">const</span>;
<a name="l00068"></a>00068
<a name="l00070"></a>00070
<a name="l00079"></a>00079 <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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">tick</a>( StkFloat input, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; outputs );
<a name="l00080"></a>00080
<a name="l00082"></a>00082
<a name="l00091"></a>00091 <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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">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="l00092"></a>00092
<a name="l00094"></a>00094
<a name="l00105"></a>00105 <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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">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 );
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">protected</span>:
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> inPoint_;
<a name="l00110"></a>00110 std::vector&lt;unsigned long&gt; outPoint_;
<a name="l00111"></a>00111 std::vector&lt;unsigned long&gt; delays_;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114
<a name="l00115"></a><a class="code" href="classstk_1_1TapDelay.html#517399ddf52455ef083481cbb77c0b5c">00115</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1TapDelay.html#517399ddf52455ef083481cbb77c0b5c" title="Return the specified tap value of the last computed frame.">TapDelay :: lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tap )<span class="keyword"> const</span>
<a name="l00116"></a>00116 <span class="keyword"></span>{
<a name="l00117"></a>00117 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( tap &gt;= lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() ) ) {
<a name="l00119"></a>00119 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::lastOut(): tap argument and number of taps are incompatible!"</span>;
<a name="l00120"></a>00120 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122 <span class="preprocessor">#endif</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span>
<a name="l00124"></a>00124 <span class="keywordflow">return</span> lastFrame_[tap];
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a><a class="code" href="classstk_1_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b">00127</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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">TapDelay :: tick</a>( StkFloat input, <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; outputs )
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( outputs.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() &lt; outPoint_.size() ) {
<a name="l00131"></a>00131 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::tick(): number of taps &gt; channels in StkFrames argument!"</span>;
<a name="l00132"></a>00132 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134 <span class="preprocessor">#endif</span>
<a name="l00135"></a>00135 <span class="preprocessor"></span>
<a name="l00136"></a>00136 inputs_[inPoint_++] = input * gain_;
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// Check for end condition</span>
<a name="l00139"></a>00139 <span class="keywordflow">if</span> ( inPoint_ == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() )
<a name="l00140"></a>00140 inPoint_ = 0;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">// Read out next values</span>
<a name="l00143"></a>00143 StkFloat *outs = &amp;outputs[0];
<a name="l00144"></a>00144 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;outPoint_.size(); i++ ) {
<a name="l00145"></a>00145 *outs++ = inputs_[outPoint_[i]];
<a name="l00146"></a>00146 lastFrame_[i] = *outs;
<a name="l00147"></a>00147 <span class="keywordflow">if</span> ( ++outPoint_[i] == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() )
<a name="l00148"></a>00148 outPoint_[i] = 0;
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keywordflow">return</span> outputs;
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153
<a name="l00154"></a><a class="code" href="classstk_1_1TapDelay.html#9255a00f0d7588ba5b51a12ba5db08c0">00154</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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">TapDelay :: 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="l00155"></a>00155 {
<a name="l00156"></a>00156 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00157"></a>00157 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
<a name="l00158"></a>00158 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00159"></a>00159 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161 <span class="keywordflow">if</span> ( frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() &lt; outPoint_.size() ) {
<a name="l00162"></a>00162 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::tick(): number of taps &gt; channels in StkFrames argument!"</span>;
<a name="l00163"></a>00163 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165 <span class="preprocessor">#endif</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span>
<a name="l00167"></a>00167 StkFloat *iSamples = &amp;frames[channel];
<a name="l00168"></a>00168 StkFloat *oSamples = &amp;frames[0];
<a name="l00169"></a>00169 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, iHop = frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>(), oHop = frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - outPoint_.size();
<a name="l00170"></a>00170 <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#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, iSamples += iHop, oSamples += oHop ) {
<a name="l00171"></a>00171 inputs_[inPoint_++] = *iSamples * gain_;
<a name="l00172"></a>00172 <span class="keywordflow">if</span> ( inPoint_ == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() ) inPoint_ = 0;
<a name="l00173"></a>00173 <span class="keywordflow">for</span> ( j=0; j&lt;outPoint_.size(); j++ ) {
<a name="l00174"></a>00174 *oSamples++ = inputs_[outPoint_[j]];
<a name="l00175"></a>00175 <span class="keywordflow">if</span> ( ++outPoint_[j] == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() ) outPoint_[j] = 0;
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178
<a name="l00179"></a>00179 oSamples -= frames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<a name="l00180"></a>00180 <span class="keywordflow">for</span> ( j=0; j&lt;outPoint_.size(); j++ ) lastFrame_[j] = *oSamples++;
<a name="l00181"></a>00181 <span class="keywordflow">return</span> frames;
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183
<a name="l00184"></a><a class="code" href="classstk_1_1TapDelay.html#d8250d2802326bd3778c00642266d201">00184</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_1TapDelay.html#add431e206dd1e4133e2ff0d49aa639b" title="Input one sample to the delayline and return outputs at all tap positions.">TapDelay :: 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 )
<a name="l00185"></a>00185 {
<a name="l00186"></a>00186 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00187"></a>00187 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel &gt;= iFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
<a name="l00188"></a>00188 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00189"></a>00189 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00190"></a>00190 }
<a name="l00191"></a>00191 <span class="keywordflow">if</span> ( oFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() &lt; outPoint_.size() ) {
<a name="l00192"></a>00192 errorString_ &lt;&lt; <span class="stringliteral">"TapDelay::tick(): number of taps &gt; channels in output StkFrames argument!"</span>;
<a name="l00193"></a>00193 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195 <span class="preprocessor">#endif</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>
<a name="l00197"></a>00197 StkFloat *iSamples = &amp;iFrames[iChannel];
<a name="l00198"></a>00198 StkFloat *oSamples = &amp;oFrames[0];
<a name="l00199"></a>00199 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, iHop = iFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>(), oHop = oFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - outPoint_.size();
<a name="l00200"></a>00200 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;iFrames.<a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); i++, iSamples += iHop, oSamples += oHop ) {
<a name="l00201"></a>00201 inputs_[inPoint_++] = *iSamples * gain_;
<a name="l00202"></a>00202 <span class="keywordflow">if</span> ( inPoint_ == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() ) inPoint_ = 0;
<a name="l00203"></a>00203 <span class="keywordflow">for</span> ( j=0; j&lt;outPoint_.size(); j++ ) {
<a name="l00204"></a>00204 *oSamples++ = inputs_[outPoint_[j]];
<a name="l00205"></a>00205 <span class="keywordflow">if</span> ( ++outPoint_[j] == inputs_.<a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>() ) outPoint_[j] = 0;
<a name="l00206"></a>00206 }
<a name="l00207"></a>00207 }
<a name="l00208"></a>00208
<a name="l00209"></a>00209 oSamples -= oFrames.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<a name="l00210"></a>00210 <span class="keywordflow">for</span> ( j=0; j&lt;outPoint_.size(); j++ ) lastFrame_[j] = *oSamples++;
<a name="l00211"></a>00211 <span class="keywordflow">return</span> iFrames;
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213
<a name="l00214"></a>00214 <span class="preprocessor">#endif</span>
<a name="l00215"></a>00215 <span class="preprocessor"></span>
<a name="l00216"></a>00216 } <span class="comment">// stk namespace</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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>