mirror of
https://github.com/thestk/stk
synced 2026-01-15 22:11:52 +00:00
305 lines
20 KiB
HTML
305 lines
20 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_1Delay.html">Delay</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Delay Class Reference</h1><!-- doxytag: class="stk::Delay" --><!-- doxytag: inherits="stk::Filter" -->
|
|
<p>STK non-interpolating delay line class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Delay_8h_source.html">Delay.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Delay:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Delay.png" usemap="#stk::Delay_map" alt=""/>
|
|
<map id="stk::Delay_map" name="stk::Delay_map">
|
|
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,66,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,66,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Delay-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_1Delay.html#a9644532bfea44fae046e54f2509cf1ef">Delay</a> (unsigned long delay=0, unsigned long maxDelay=4095)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor creates a delay-line with maximum length of 4095 samples and zero delay. <a href="#a9644532bfea44fae046e54f2509cf1ef"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b6ed6c7c5fc6d15935ec2a118b6b4f"></a><!-- doxytag: member="stk::Delay::~Delay" ref="a24b6ed6c7c5fc6d15935ec2a118b6b4f" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#a24b6ed6c7c5fc6d15935ec2a118b6b4f">~Delay</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#a0cf4c8da14bd4105eef06e35caaf1532">setMaximumDelay</a> (unsigned long delay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum delay-line length. <a href="#a0cf4c8da14bd4105eef06e35caaf1532"></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_1Delay.html#a5eaeed55ea0c7b30ed66fedd6ef52fc2">setDelay</a> (unsigned long delay)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay-line length. <a href="#a5eaeed55ea0c7b30ed66fedd6ef52fc2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ae307dc997ff07ff986ca5c4d287441"></a><!-- doxytag: member="stk::Delay::getDelay" ref="a7ae307dc997ff07ff986ca5c4d287441" args="(void) const " -->
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#a7ae307dc997ff07ff986ca5c4d287441">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_1Delay.html#a7d4c9c21e752f860ba683e9849d14665">contentsAt</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="#a7d4c9c21e752f860ba683e9849d14665"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#aea5580dd84ea6982d1f7b92b53314118">addTo</a> (unsigned long tapDelay, StkFloat value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sum the provided value into the delay line at <em>tapDelay</em> samples from the input. <a href="#aea5580dd84ea6982d1f7b92b53314118"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b563a37eec1773e8e82f9e328aed9b2"></a><!-- doxytag: member="stk::Delay::lastOut" ref="a7b563a37eec1773e8e82f9e328aed9b2" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#a7b563a37eec1773e8e82f9e328aed9b2">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_1Delay.html#a2433e3246551f4fdf1366884cd2ae426">nextOut</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value that will be output by the next call to <a class="el" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick()</a>. <a href="#a2433e3246551f4fdf1366884cd2ae426"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a240830690cd8fa26e0604fd82c65dda1"></a><!-- doxytag: member="stk::Delay::energy" ref="a240830690cd8fa26e0604fd82c65dda1" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#a240830690cd8fa26e0604fd82c65dda1">energy</a> (void) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate and return the signal energy in the delay-line. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1a929e0e324417b8a55cbf8770532e9"></a><!-- doxytag: member="stk::Delay::tick" ref="aa1a929e0e324417b8a55cbf8770532e9" args="(StkFloat input)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9">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_1Delay.html#a93fe8e45acb933889be812f35810f977">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="#a93fe8e45acb933889be812f35810f977"></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_1Delay.html#ade0d544e45e535fd792fe70a2a22da6f">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="#ade0d544e45e535fd792fe70a2a22da6f"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK non-interpolating delay line class. </p>
|
|
<p>This class implements a non-interpolating digital delay-line. If the delay and maximum length are not specified during instantiation, a fixed maximum length of 4095 and a delay of zero is set.</p>
|
|
<p>A non-interpolating delay line is typically used in fixed delay-length applications, such as for reverberation.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a9644532bfea44fae046e54f2509cf1ef"></a><!-- doxytag: member="stk::Delay::Delay" ref="a9644532bfea44fae046e54f2509cf1ef" args="(unsigned long delay=0, unsigned long maxDelay=4095)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Delay::Delay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"> <em>delay</em> = <code>0</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>The default constructor creates a delay-line with maximum length of 4095 samples and zero delay. </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="a0cf4c8da14bd4105eef06e35caaf1532"></a><!-- doxytag: member="stk::Delay::setMaximumDelay" ref="a0cf4c8da14bd4105eef06e35caaf1532" args="(unsigned long delay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::Delay::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_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" title="Input one sample to the filter and return one output.">tick()</a> function, without a call to <a class="el" href="classstk_1_1Filter.html#a670b9cc23ac798d3239cb819e801363c" title="Clears all internal states of the filter.">clear()</a>, a signal discontinuity will likely occur. If the current maximum length is greater than the new length, no change will be made. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5eaeed55ea0c7b30ed66fedd6ef52fc2"></a><!-- doxytag: member="stk::Delay::setDelay" ref="a5eaeed55ea0c7b30ed66fedd6ef52fc2" args="(unsigned long delay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::Delay::setDelay </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 delay-line length. </p>
|
|
<p>The valid range for <em>delay</em> is from 0 to the maximum delay-line length. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7d4c9c21e752f860ba683e9849d14665"></a><!-- doxytag: member="stk::Delay::contentsAt" ref="a7d4c9c21e752f860ba683e9849d14665" args="(unsigned long tapDelay)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::Delay::contentsAt </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="aea5580dd84ea6982d1f7b92b53314118"></a><!-- doxytag: member="stk::Delay::addTo" ref="aea5580dd84ea6982d1f7b92b53314118" args="(unsigned long tapDelay, StkFloat value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::Delay::addTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"> <em>tapDelay</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>value</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sum the provided value into the delay line at <em>tapDelay</em> samples from the input. </p>
|
|
<p>The new value is returned. The tap point is determined modulo the delay-line length and is relative to the last input value (i.e., a tapDelay of zero sums into the last input value). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2433e3246551f4fdf1366884cd2ae426"></a><!-- doxytag: member="stk::Delay::nextOut" ref="a2433e3246551f4fdf1366884cd2ae426" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::Delay::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 that will be output by the next call to <a class="el" href="classstk_1_1Delay.html#aa1a929e0e324417b8a55cbf8770532e9" 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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a93fe8e45acb933889be812f35810f977"></a><!-- doxytag: member="stk::Delay::tick" ref="a93fe8e45acb933889be812f35810f977" 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::Delay::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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ade0d544e45e535fd792fe70a2a22da6f"></a><!-- doxytag: member="stk::Delay::tick" ref="ade0d544e45e535fd792fe70a2a22da6f" 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::Delay::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>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Delay_8h_source.html">Delay.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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|