mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
99 lines
5.5 KiB
HTML
99 lines
5.5 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>DelayA Class Reference</h1>STK allpass interpolating delay line class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="DelayA_8h-source.html">DelayA.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for DelayA::
|
|
<p><center><img src="classDelayA.gif" usemap="#DelayA_map" border="0"></center>
|
|
<map name="DelayA_map">
|
|
<area href="classDelay.html" alt="Delay" shape="rect" coords="0,112,54,136">
|
|
<area href="classFilter.html" alt="Filter" shape="rect" coords="0,56,54,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,54,24">
|
|
</map>
|
|
<a href="classDelayA-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="DelayA::DelayA"></a>
|
|
</td><td valign=bottom><a class="el" href="classDelayA.html#a0">DelayA</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor creates a delay-line with maximum length of 4095 samples and zero delay.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="DelayA::DelayA"></a>
|
|
</td><td valign=bottom><a class="el" href="classDelayA.html#a1">DelayA</a> (MY_FLOAT theDelay, long maxDelay)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Overloaded constructor which specifies the current and maximum delay-line lengths.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a2" doxytag="DelayA::~DelayA"></a>
|
|
</td><td valign=bottom><a class="el" href="classDelayA.html#a2">~DelayA</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="DelayA::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classDelayA.html#a3">clear</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Clears the internal state of the delay line.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classDelayA.html#a4">setDelay</a> (MY_FLOAT theDelay)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the delay-line length.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="DelayA::getDelay"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classDelayA.html#a5">getDelay</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current delay-line length.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="DelayA::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classDelayA.html#a6">tick</a> (MY_FLOAT sample)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Input one sample to the delay-line and return one output.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK allpass interpolating delay line class.
|
|
<p>
|
|
This <a class="el" href="classDelay.html">Delay</a> subclass implements a fractional- length digital delay-line using a first-order allpass filter. A fixed maximum length of 4095 and a delay of 0.5 is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.
|
|
<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>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a4" doxytag="DelayA::setDelay"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void DelayA::setDelay (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>theDelay</em> )
|
|
</b></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.5 to the maximum delay-line length. </td>
|
|
</tr>
|
|
</table>
|
|
<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></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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|