mirror of
https://github.com/thestk/stk
synced 2026-01-12 12:31:53 +00:00
308 lines
15 KiB
HTML
308 lines
15 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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.3.4 -->
|
|
<h1>Delay Class Reference</h1><code>#include <<a class="el" href="Delay_8h-source.html">Delay.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Delay:
|
|
<p><center><img src="classDelay.png" usemap="#Delay_map" border="0" alt=""></center>
|
|
<map name="Delay_map">
|
|
<area href="classFilter.html" alt="Filter" shape="rect" coords="32,56,86,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="32,0,86,24">
|
|
<area href="classDelayA.html" alt="DelayA" shape="rect" coords="0,168,54,192">
|
|
<area href="classDelayL.html" alt="DelayL" shape="rect" coords="64,168,118,192">
|
|
</map>
|
|
<a href="classDelay-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK non-interpolating delay line class.
|
|
<p>
|
|
This protected <a class="el" href="classFilter.html">Filter</a> subclass implements a non-interpolating digital delay-line. A fixed maximum length of 4095 and a delay of zero is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.<p>
|
|
A non-interpolating delay line is typically used in fixed delay-length applications, such as for reverberation.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="Delay_8h-source.html#l00026">26</a> of file <a class="el" href="Delay_8h-source.html">Delay.h</a>.<table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="Delay::Delay" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a0">Delay</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor creates a delay-line with maximum length of 4095 samples and zero delay. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a1">Delay</a> (unsigned long delay, unsigned long maxDelay)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor which specifies the current and maximum delay-line lengths. </em> <a href="#a1"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Delay::~Delay" ></a>
|
|
virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a2">~Delay</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Delay::clear" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a3">clear</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears the internal state of the delay line. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a4">setMaximumDelay</a> (unsigned long delay)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum delay-line length. </em> <a href="#a4"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a5">setDelay</a> (unsigned long delay)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay-line length. </em> <a href="#a5"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Delay::getDelay" ></a>
|
|
unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a6">getDelay</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current delay-line length. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Delay::energy" ></a>
|
|
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a7">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><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a8">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. </em> <a href="#a8"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Delay::lastOut" ></a>
|
|
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a9">lastOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last computed output value. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a10">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="classDelay.html#a11">tick()</a>. </em> <a href="#a10"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Delay::tick" ></a>
|
|
virtual StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a11">tick</a> (StkFloat sample)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input one sample to the delayline and return one output. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Delay::tick" ></a>
|
|
virtual StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a12">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input <em>vectorSize</em> samples to the delayline and return an equal number of outputs in <em>vector</em>. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a13">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=1)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the delayline and replace with corresponding outputs. </em> <a href="#a13"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a1" doxytag="Delay::Delay" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> Delay::Delay </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned long </td>
|
|
<td class="mdname" nowrap> <em>delay</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>unsigned long </td>
|
|
<td class="mdname" nowrap> <em>maxDelay</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Overloaded constructor which specifies the current and maximum delay-line lengths.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">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. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a4" doxytag="Delay::setMaximumDelay" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Delay::setMaximumDelay </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned long </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>delay</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the maximum delay-line length.
|
|
<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="classDelay.html#a11">tick()</a> function, without a call to <a class="el" href="classDelay.html#a3">clear()</a>, a signal discontinuity will likely occur. If the current maximum length is greater than the new length, no change will be made. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a5" doxytag="Delay::setDelay" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Delay::setDelay </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned long </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>delay</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the delay-line length.
|
|
<p>
|
|
The valid range for <em>theDelay</em> is from 0 to the maximum delay-line length. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a8" doxytag="Delay::contentsAt" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> StkFloat Delay::contentsAt </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned long </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>tapDelay</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Return the value at <em>tapDelay</em> samples from the delay-line input.
|
|
<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). </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a10" doxytag="Delay::nextOut" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual StkFloat Delay::nextOut </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">void </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Return the value which will be output by the next call to <a class="el" href="classDelay.html#a11">tick()</a>.
|
|
<p>
|
|
This method is valid only for delay settings greater than zero!
|
|
<p>
|
|
Reimplemented in <a class="el" href="classDelayA.html#a6">DelayA</a>, and <a class="el" href="classDelayL.html#a5">DelayL</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a13" doxytag="Delay::tick" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>& Delay::tick </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
|
<td class="mdname" nowrap> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>channel</em> = 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the delayline and replace with corresponding outputs.
|
|
<p>
|
|
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
|
<p>
|
|
Reimplemented from <a class="el" href="classFilter.html#a12">Filter</a>.
|
|
<p>
|
|
Reimplemented in <a class="el" href="classDelayA.html#a9">DelayA</a>, and <a class="el" href="classDelayL.html#a8">DelayL</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<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></ul>
|
|
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|