e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-13 21:11:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5d63b50e85101597a7ec3cd51d0d1d7232a58de0
stk/doc/html/classDelay.html
Gary Scavone 5d63b50e85 Release 4.1.2 tarball
2013-09-29 23:37:27 +02:00

188 lines
10 KiB
HTML
Raw Blame History

<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.6 -->
<h1>Delay Class Reference</h1>STK non-interpolating delay line class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Delay_8h-source.html">Delay.h</a>&gt;</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><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>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a0">Delay</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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><a class="anchor" name="a1" doxytag="Delay::Delay" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a1">Delay</a> (long theDelay, long maxDelay)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor which specifies the current and maximum delay-line lengths. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Delay::~Delay" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a2">~Delay</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a3">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a4">setDelay</a> (long theDelay)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the delay-line length. <a href="#a4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Delay::getDelay" ></a>
long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a5">getDelay</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a6" doxytag="Delay::energy" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a6">energy</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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>MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a7">contentsAt</a> (unsigned long tapDelay) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the value at <em>tapDelay</em> samples from the delay-line input. <a href="#a7"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Delay::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a8">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a9">nextOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the value which will be output by the next call to <a class="el" href="classDelay.html#a10">tick()</a>. <a href="#a9"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Delay::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a10">tick</a> (MY_FLOAT sample)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the delay-line and return one output. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Delay::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDelay.html#a11">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input <em>vectorSize</em> samples to the delay-line and return an equal number of outputs in <em>vector</em>. <br><br></td></tr>
</table>
<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 - 2002.
<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>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>theDelay</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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="a7" 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"> MY_FLOAT Delay::contentsAt </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned long&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>tapDelay</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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="a9" 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 MY_FLOAT Delay::nextOut </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the value which will be output by the next call to <a class="el" href="classDelay.html#a10">tick()</a>.
<p>
This method is valid only for delay settings greater than zero! </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://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink