mirror of
https://github.com/thestk/stk
synced 2026-01-16 22:31:52 +00:00
340 lines
24 KiB
HTML
340 lines
24 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"> <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_1DelayA.html">DelayA</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::DelayA Class Reference</h1><!-- doxytag: class="stk::DelayA" --><!-- doxytag: inherits="stk::Filter" -->
|
|
<p>STK allpass interpolating delay line class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="DelayA_8h_source.html">DelayA.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::DelayA:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1DelayA.png" usemap="#stk::DelayA_map" alt=""/>
|
|
<map id="stk::DelayA_map" name="stk::DelayA_map">
|
|
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,75,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,75,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1DelayA-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_1DelayA.html#a9beb31f924bca961df99c1ea7789c42d">DelayA</a> (StkFloat delay=0.5, unsigned long maxDelay=4095)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor creates a delay-line with maximum length of 4095 samples and delay = 0.5. <a href="#a9beb31f924bca961df99c1ea7789c42d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6f2ee45d350b4bb3515fcdaf25a986a"></a><!-- doxytag: member="stk::DelayA::~DelayA" ref="ab6f2ee45d350b4bb3515fcdaf25a986a" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#ab6f2ee45d350b4bb3515fcdaf25a986a">~DelayA</a> ()</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="ae5e59f497eb84280fd94d60257ffae69"></a><!-- doxytag: member="stk::DelayA::clear" ref="ae5e59f497eb84280fd94d60257ffae69" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#ae5e59f497eb84280fd94d60257ffae69">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all internal states of the delay line. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ac5c818b6669bf904a4a5a81358bd28"></a><!-- doxytag: member="stk::DelayA::getMaximumDelay" ref="a6ac5c818b6669bf904a4a5a81358bd28" args="(void)" -->
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#a6ac5c818b6669bf904a4a5a81358bd28">getMaximumDelay</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum delay-line length. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#ab10bb5eb8316ce8b3c6667bdf4c98389">setMaximumDelay</a> (unsigned long delay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum delay-line length. <a href="#ab10bb5eb8316ce8b3c6667bdf4c98389"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#a83ddc9bdf2f5059159160fdac0e25eda">setDelay</a> (StkFloat delay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay-line length. <a href="#a83ddc9bdf2f5059159160fdac0e25eda"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a363d9ccc50acbd1f3bb533aa1ab3d9c7"></a><!-- doxytag: member="stk::DelayA::getDelay" ref="a363d9ccc50acbd1f3bb533aa1ab3d9c7" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#a363d9ccc50acbd1f3bb533aa1ab3d9c7">getDelay</a> (void) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current delay-line length. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#aab723097f4634b23b0cd4ba8762271dc">tapOut</a> (unsigned long tapDelay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value at <em>tapDelay</em> samples from the delay-line input. <a href="#aab723097f4634b23b0cd4ba8762271dc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf33f950e60d31d355ea865ae3efd44e"></a><!-- doxytag: member="stk::DelayA::tapIn" ref="adf33f950e60d31d355ea865ae3efd44e" args="(StkFloat value, unsigned long tapDelay)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#adf33f950e60d31d355ea865ae3efd44e">tapIn</a> (StkFloat value, unsigned long tapDelay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <em>value</em> at <em>tapDelay</em> samples from the delay-line input. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4372d0e178af1cb6ca465affddfb1566"></a><!-- doxytag: member="stk::DelayA::lastOut" ref="a4372d0e178af1cb6ca465affddfb1566" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#a4372d0e178af1cb6ca465affddfb1566">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">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#a08c8ade17cea4a54844f90d976b14314">nextOut</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value which will be output by the next call to <a class="el" href="classstk_1_1DelayA.html#ae602abe91560fb5f141db52333359b74" title="Input one sample to the filter and return one output.">tick()</a>. <a href="#a08c8ade17cea4a54844f90d976b14314"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae602abe91560fb5f141db52333359b74"></a><!-- doxytag: member="stk::DelayA::tick" ref="ae602abe91560fb5f141db52333359b74" args="(StkFloat input)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1DelayA.html#ae602abe91560fb5f141db52333359b74">tick</a> (StkFloat input)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input one sample to the filter and return one output. <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_1DelayA.html#a57c568d56e5ed35926cfc23f83d48d98">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">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#a57c568d56e5ed35926cfc23f83d48d98"></a><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_1DelayA.html#a94a2998c9b2d1697ed9a747973be0a89">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#a94a2998c9b2d1697ed9a747973be0a89"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK allpass interpolating delay line class. </p>
|
|
<p>This class implements a fractional-length digital delay-line using a first-order allpass filter. If the delay and maximum length are not specified during instantiation, a fixed maximum length of 4095 and a delay of 0.5 is set.</p>
|
|
<p>An allpass filter has unity magnitude gain but variable phase delay properties, making it useful in achieving fractional delays without affecting a signal's frequency magnitude response. In order to achieve a maximally flat phase delay response, the minimum delay possible in this implementation is limited to a value of 0.5.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a9beb31f924bca961df99c1ea7789c42d"></a><!-- doxytag: member="stk::DelayA::DelayA" ref="a9beb31f924bca961df99c1ea7789c42d" args="(StkFloat delay=0.5, unsigned long maxDelay=4095)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::DelayA::DelayA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>delay</em> = <code>0.5</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"> <em>maxDelay</em> = <code>4095</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Default constructor creates a delay-line with maximum length of 4095 samples and delay = 0.5. </p>
|
|
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the delay parameter is less than zero, the maximum delay parameter is less than one, or the delay parameter is greater than the maxDelay value. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="ab10bb5eb8316ce8b3c6667bdf4c98389"></a><!-- doxytag: member="stk::DelayA::setMaximumDelay" ref="ab10bb5eb8316ce8b3c6667bdf4c98389" args="(unsigned long delay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::DelayA::setMaximumDelay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"> <em>delay</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Set the maximum delay-line length. </p>
|
|
<p>This method should generally only be used during initial setup of the delay line. If it is used between calls to the <a class="el" href="classstk_1_1DelayA.html#ae602abe91560fb5f141db52333359b74" title="Input one sample to the filter and return one output.">tick()</a> function, without a call to <a class="el" href="classstk_1_1DelayA.html#ae5e59f497eb84280fd94d60257ffae69" title="Clears all internal states of the delay line.">clear()</a>, a signal discontinuity will likely occur. If the current maximum length is greater than the new length, no memory allocation change is made. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a83ddc9bdf2f5059159160fdac0e25eda"></a><!-- doxytag: member="stk::DelayA::setDelay" ref="a83ddc9bdf2f5059159160fdac0e25eda" args="(StkFloat delay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::DelayA::setDelay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>delay</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Set the delay-line length. </p>
|
|
<p>The valid range for <em>delay</em> is from 0.5 to the maximum delay-line length. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aab723097f4634b23b0cd4ba8762271dc"></a><!-- doxytag: member="stk::DelayA::tapOut" ref="aab723097f4634b23b0cd4ba8762271dc" args="(unsigned long tapDelay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::DelayA::tapOut </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"> <em>tapDelay</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Return the value at <em>tapDelay</em> samples from the delay-line input. </p>
|
|
<p>The tap point is determined modulo the delay-line length and is relative to the last input value (i.e., a tapDelay of zero returns the last input value). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a08c8ade17cea4a54844f90d976b14314"></a><!-- doxytag: member="stk::DelayA::nextOut" ref="a08c8ade17cea4a54844f90d976b14314" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::DelayA::nextOut </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Return the value which will be output by the next call to <a class="el" href="classstk_1_1DelayA.html#ae602abe91560fb5f141db52333359b74" title="Input one sample to the filter and return one output.">tick()</a>. </p>
|
|
<p>This method is valid only for delay settings greater than zero! </p>
|
|
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00126"></a>00126 {
|
|
<a name="l00127"></a>00127 <span class="keywordflow">if</span> ( doNextOut_ ) {
|
|
<a name="l00128"></a>00128 <span class="comment">// Do allpass interpolation delay.</span>
|
|
<a name="l00129"></a>00129 nextOutput_ = -coeff_ * lastFrame_[0];
|
|
<a name="l00130"></a>00130 nextOutput_ += apInput_ + ( coeff_ * inputs_[outPoint_] );
|
|
<a name="l00131"></a>00131 doNextOut_ = <span class="keyword">false</span>;
|
|
<a name="l00132"></a>00132 }
|
|
<a name="l00133"></a>00133
|
|
<a name="l00134"></a>00134 <span class="keywordflow">return</span> nextOutput_;
|
|
<a name="l00135"></a>00135 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a57c568d56e5ed35926cfc23f83d48d98"></a><!-- doxytag: member="stk::DelayA::tick" ref="a57c568d56e5ed35926cfc23f83d48d98" 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::DelayA::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>Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. </p>
|
|
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. 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_1Filter.html#a3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
|
|
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00157"></a>00157 {
|
|
<a name="l00158"></a>00158 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00159"></a>00159 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
|
|
<a name="l00160"></a>00160 oStream_ << <span class="stringliteral">"DelayA::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00161"></a>00161 <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="l00162"></a>00162 }
|
|
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span>
|
|
<a name="l00164"></a>00164 <span class="preprocessor"></span>
|
|
<a name="l00165"></a>00165 StkFloat *samples = &frames[channel];
|
|
<a name="l00166"></a>00166 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
|
|
<a name="l00167"></a>00167 <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="l00168"></a>00168 inputs_[inPoint_++] = *samples * gain_;
|
|
<a name="l00169"></a>00169 <span class="keywordflow">if</span> ( inPoint_ == inputs_.size() ) inPoint_ = 0;
|
|
<a name="l00170"></a>00170 *samples = <a class="code" href="classstk_1_1DelayA.html#a08c8ade17cea4a54844f90d976b14314" title="Return the value which will be output by the next call to tick().">nextOut</a>();
|
|
<a name="l00171"></a>00171 lastFrame_[0] = *samples;
|
|
<a name="l00172"></a>00172 doNextOut_ = <span class="keyword">true</span>;
|
|
<a name="l00173"></a>00173 apInput_ = inputs_[outPoint_++];
|
|
<a name="l00174"></a>00174 <span class="keywordflow">if</span> ( outPoint_ == inputs_.size() ) outPoint_ = 0;
|
|
<a name="l00175"></a>00175 }
|
|
<a name="l00176"></a>00176
|
|
<a name="l00177"></a>00177 <span class="keywordflow">return</span> frames;
|
|
<a name="l00178"></a>00178 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a94a2998c9b2d1697ed9a747973be0a89"></a><!-- doxytag: member="stk::DelayA::tick" ref="a94a2998c9b2d1697ed9a747973be0a89" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=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::DelayA::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>iFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>oFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>iChannel</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>oChannel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. </p>
|
|
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <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><div class="fragment"><pre class="fragment"><a name="l00181"></a>00181 {
|
|
<a name="l00182"></a>00182 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00183"></a>00183 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
|
|
<a name="l00184"></a>00184 oStream_ << <span class="stringliteral">"DelayA::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00185"></a>00185 <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="l00186"></a>00186 }
|
|
<a name="l00187"></a>00187 <span class="preprocessor">#endif</span>
|
|
<a name="l00188"></a>00188 <span class="preprocessor"></span>
|
|
<a name="l00189"></a>00189 StkFloat *iSamples = &iFrames[iChannel];
|
|
<a name="l00190"></a>00190 StkFloat *oSamples = &oFrames[oChannel];
|
|
<a name="l00191"></a>00191 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iHop = iFrames.channels(), oHop = oFrames.channels();
|
|
<a name="l00192"></a>00192 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop ) {
|
|
<a name="l00193"></a>00193 inputs_[inPoint_++] = *iSamples * gain_;
|
|
<a name="l00194"></a>00194 <span class="keywordflow">if</span> ( inPoint_ == inputs_.size() ) inPoint_ = 0;
|
|
<a name="l00195"></a>00195 *oSamples = <a class="code" href="classstk_1_1DelayA.html#a08c8ade17cea4a54844f90d976b14314" title="Return the value which will be output by the next call to tick().">nextOut</a>();
|
|
<a name="l00196"></a>00196 lastFrame_[0] = *oSamples;
|
|
<a name="l00197"></a>00197 doNextOut_ = <span class="keyword">true</span>;
|
|
<a name="l00198"></a>00198 apInput_ = inputs_[outPoint_++];
|
|
<a name="l00199"></a>00199 <span class="keywordflow">if</span> ( outPoint_ == inputs_.size() ) outPoint_ = 0;
|
|
<a name="l00200"></a>00200 }
|
|
<a name="l00201"></a>00201
|
|
<a name="l00202"></a>00202 <span class="keywordflow">return</span> iFrames;
|
|
<a name="l00203"></a>00203 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DelayA_8h_source.html">DelayA.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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|