mirror of
https://github.com/thestk/stk
synced 2026-01-15 14:01:52 +00:00
194 lines
14 KiB
HTML
194 lines
14 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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1PRCRev.html">PRCRev</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::PRCRev Class Reference</h1><!-- doxytag: class="stk::PRCRev" --><!-- doxytag: inherits="stk::Effect" -->
|
|
<p>Perry's simple reverberator class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PRCRev_8h_source.html">PRCRev.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::PRCRev:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1PRCRev.png" usemap="#stk::PRCRev_map" alt=""/>
|
|
<map id="stk::PRCRev_map" name="stk::PRCRev_map">
|
|
<area href="classstk_1_1Effect.html" alt="stk::Effect" shape="rect" coords="0,56,80,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,80,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1PRCRev-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb6440fb909a3091f21f31f3565014de"></a><!-- doxytag: member="stk::PRCRev::PRCRev" ref="afb6440fb909a3091f21f31f3565014de" args="(StkFloat T60=1.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#afb6440fb909a3091f21f31f3565014de">PRCRev</a> (StkFloat T60=1.0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor taking a T60 decay time argument (one second default value). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e2fa911784a02a6d7211cbe2348ffe1"></a><!-- doxytag: member="stk::PRCRev::clear" ref="a3e2fa911784a02a6d7211cbe2348ffe1" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#a3e2fa911784a02a6d7211cbe2348ffe1">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9478ed84e76d12cc66d11716ebfa8b3b"></a><!-- doxytag: member="stk::PRCRev::setT60" ref="a9478ed84e76d12cc66d11716ebfa8b3b" args="(StkFloat T60)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#a9478ed84e76d12cc66d11716ebfa8b3b">setT60</a> (StkFloat T60)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the reverberation T60 decay time. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#a47ed5fee4401f0050d6a47d1154e81c6">lastOut</a> (unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the specified channel value of the last computed stereo frame. <a href="#a47ed5fee4401f0050d6a47d1154e81c6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#ada84d5241777575b660db100a85b35a6">tick</a> (StkFloat input, unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input one sample to the effect and return the specified <code>channel</code> value of the computed stereo frame. <a href="#ada84d5241777575b660db100a85b35a6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#a8a0ddbafabeabcf780d6a6b1d5e9a6b4">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the effect and replace with stereo outputs. <a href="#a8a0ddbafabeabcf780d6a6b1d5e9a6b4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PRCRev.html#a86e9fe7b68a69326b89e924e9789a00f">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the effect and write stereo outputs to the <code>oFrames</code> object. <a href="#a86e9fe7b68a69326b89e924e9789a00f"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Perry's simple reverberator class. </p>
|
|
<p>This class takes a monophonic input signal and produces a stereo output signal. It is based on some of the famous Stanford/CCRMA reverbs (<a class="el" href="classstk_1_1NRev.html" title="CCRMA's NRev reverberator class.">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>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a47ed5fee4401f0050d6a47d1154e81c6"></a><!-- doxytag: member="stk::PRCRev::lastOut" ref="a47ed5fee4401f0050d6a47d1154e81c6" args="(unsigned int channel=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::PRCRev::lastOut </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td>
|
|
<td> ) </td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Return the specified channel value of the last computed stereo frame. </p>
|
|
<p>Use the <a class="el" href="classstk_1_1Effect.html#a3d7e2b8942bf7adcc71dfc6dccbb7aa0" title="Return an StkFrames reference to the last output sample frame.">lastFrame()</a> function to get both values of the last computed stereo frame. The <code>channel</code> argument must be 0 or 1 (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada84d5241777575b660db100a85b35a6"></a><!-- doxytag: member="stk::PRCRev::tick" ref="ada84d5241777575b660db100a85b35a6" args="(StkFloat input, unsigned int channel=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">StkFloat stk::PRCRev::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>input</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Input one sample to the effect and return the specified <code>channel</code> value of the computed stereo frame. </p>
|
|
<p>Use the <a class="el" href="classstk_1_1Effect.html#a3d7e2b8942bf7adcc71dfc6dccbb7aa0" title="Return an StkFrames reference to the last output sample frame.">lastFrame()</a> function to get both values of the computed stereo output frame. The <code>channel</code> argument must be 0 or 1 (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8a0ddbafabeabcf780d6a6b1d5e9a6b4"></a><!-- doxytag: member="stk::PRCRev::tick" ref="a8a0ddbafabeabcf780d6a6b1d5e9a6b4" args="(StkFrames &frames, unsigned int channel=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>& stk::PRCRev::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the effect and replace with stereo outputs. </p>
|
|
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The stereo outputs are written to the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument starting at the specified <code>channel</code>. Therefore, the <code>channel</code> argument must be less than ( channels() - 1 ) of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a86e9fe7b68a69326b89e924e9789a00f"></a><!-- doxytag: member="stk::PRCRev::tick" ref="a86e9fe7b68a69326b89e924e9789a00f" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>& stk::PRCRev::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>iFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>oFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>iChannel</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>oChannel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Take a channel of the <code>iFrames</code> object as inputs to the effect and write stereo outputs to the <code>oFrames</code> object. </p>
|
|
<p>The <code>iFrames</code> object reference is returned. The <code>iChannel</code> argument must be less than the number of channels in the <code>iFrames</code> argument (the first channel is specified by 0). The <code>oChannel</code> argument must be less than ( channels() - 1 ) of the <code>oFrames</code> argument. However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<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></li>
|
|
</ul>
|
|
</div>
|
|
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|