e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-15 14:01:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
doc/html/classPRCRev.html
View File

@@ -9,24 +9,29 @@
<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.4 -->
<h1>PRCRev Class Reference</h1>Perry's simple reverberator class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PRCRev_8h-source.html">PRCRev.h</a>&gt;</code>
<h1>PRCRev Class Reference</h1><code>#include &lt;<a class="el" href="PRCRev_8h-source.html">PRCRev.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PRCRev:
<p><center><img src="classPRCRev.png" usemap="#PRCRev_map" border="0" alt=""></center>
<map name="PRCRev_map">
<area href="classReverb.html" alt="Reverb" shape="rect" coords="0,56,59,80">
<area href="classEffect.html" alt="Effect" shape="rect" coords="0,56,59,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,59,24">
</map>
<a href="classPRCRev-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classPRCRev-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Perry's simple reverberator class.
<p>
This class is based on some of the famous Stanford/CCRMA reverbs (<a class="el" href="classNRev.html">NRev</a>, KipRev), which were based on the Chowning/Moorer/Schroeder reverberators using networks of simple allpass and comb delay filters. This class implements two series allpass units and two parallel comb filters.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="PRCRev_8h-source.html#l00023">23</a> of file <a class="el" href="PRCRev_8h-source.html">PRCRev.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="PRCRev::PRCRev" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a0">PRCRev</a> (MY_FLOAT T60)</td></tr>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a0">PRCRev</a> (StkFloat T60=1.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking a T60 decay time argument. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking a T60 decay time argument (one second default value). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="PRCRev::~PRCRev" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a1">~PRCRev</a> ()</td></tr>
@@ -35,25 +40,71 @@
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="PRCRev::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a3">tick</a> (MY_FLOAT input)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="PRCRev::setT60" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a3">setT60</a> (StkFloat T60)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the reverberation T60 decay time. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="PRCRev::tick" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a4">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="PRCRev::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a5">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take <em>vectorSize</em> inputs, compute the same number of outputs and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPRCRev.html#a6">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect and replace with corresponding outputs. </em> <a href="#a6"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Perry's simple reverberator class.
<p>
This class is based on some of the famous Stanford/CCRMA reverbs (<a class="el" href="classNRev.html">NRev</a>, KipRev), which were based on the Chowning/Moorer/Schroeder reverberators using networks of simple allpass and comb delay filters. This class implements two series allpass units and two parallel comb filters.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6" doxytag="PRCRev::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"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; PRCRev::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Definition at line <a class="el" href="PRCRev_8h-source.html#l00023">23</a> of file <a class="el" href="PRCRev_8h-source.html">PRCRev.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect 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="classEffect.html#a9">Effect</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PRCRev_8h-source.html">PRCRev.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><A HREF="http://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>