mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
141 lines
7.7 KiB
HTML
141 lines
7.7 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.6 -->
|
|
<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.png" usemap="#DelayA_map" border="0" alt=""></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></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="DelayA::DelayA" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a0">DelayA</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><a class="anchor" name="a1" doxytag="DelayA::DelayA" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a1">DelayA</a> (MY_FLOAT theDelay, long maxDelay)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="DelayA::~DelayA" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a2">~DelayA</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="DelayA::clear" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.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="classDelayA.html#a4">setDelay</a> (MY_FLOAT theDelay)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="DelayA::getDelay" ></a>
|
|
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a5">getDelay</a> (void)</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>MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a6">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="classDelayA.html#a7">tick()</a>. <a href="#a6"></a><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="DelayA::tick" ></a>
|
|
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classDelayA.html#a7">tick</a> (MY_FLOAT sample)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input one sample to the delay-line and return one output. <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>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="DelayA_8h-source.html#l00030">30</a> of file <a class="el" href="DelayA_8h-source.html">DelayA.h</a>.<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a4" doxytag="DelayA::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 DelayA::setDelay </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">MY_FLOAT </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>theDelay</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.5 to the maximum delay-line length. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6" doxytag="DelayA::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"> MY_FLOAT DelayA::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></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="classDelayA.html#a7">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="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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|