e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 06:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
doc/html/classstk_1_1Moog.html
View File

@@ -8,80 +8,77 @@
<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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Moog.html">Moog</a>
</div>
<div class="contents">
<h1>stk::Moog Class Reference</h1><!-- doxytag: class="stk::Moog" --><!-- doxytag: inherits="stk::Sampler" -->STK moog-like swept filter sampling synthesis class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Moog_8h-source.html">Moog.h</a>&gt;</code>
<p>
<h1>stk::Moog Class Reference</h1><!-- doxytag: class="stk::Moog" --><!-- doxytag: inherits="stk::Sampler" -->
<p>STK moog-like swept filter sampling synthesis class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Moog_8h_source.html">Moog.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Moog:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Moog.png" usemap="#stk::Moog_map" border="0" alt=""></center>
<map name="stk::Moog_map">
<area href="classstk_1_1Sampler.html" alt="stk::Sampler" shape="rect" coords="0,112,79,136">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24">
<div class="center">
<img src="classstk_1_1Moog.png" usemap="#stk::Moog_map" alt=""/>
<map id="stk::Moog_map" name="stk::Moog_map">
<area href="classstk_1_1Sampler.html" alt="stk::Sampler" shape="rect" coords="0,112,79,136"/>
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1Moog-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#07c8d02638711d5f08a3b320b7274156">Moog</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#07c8d02638711d5f08a3b320b7274156"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c05815f49aab07e01ff0d4e5e8c4edba"></a><!-- doxytag: member="stk::Moog::~Moog" ref="c05815f49aab07e01ff0d4e5e8c4edba" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#c05815f49aab07e01ff0d4e5e8c4edba">~Moog</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0d66174dd734d55ef7224d6d8f2cb06"></a><!-- doxytag: member="stk::Moog::setFrequency" ref="b0d66174dd734d55ef7224d6d8f2cb06" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#b0d66174dd734d55ef7224d6d8f2cb06">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="899bc1c5c76fb29875d4df4ce594d44e"></a><!-- doxytag: member="stk::Moog::noteOn" ref="899bc1c5c76fb29875d4df4ce594d44e" args="(StkFloat frequency, StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#899bc1c5c76fb29875d4df4ce594d44e">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="feb63bf762f07851db22ae5bf18f0a81"></a><!-- doxytag: member="stk::Moog::setModulationSpeed" ref="feb63bf762f07851db22ae5bf18f0a81" args="(StkFloat mSpeed)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#feb63bf762f07851db22ae5bf18f0a81">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the modulation (vibrato) speed in Hz. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="32e5ee083d5d92494bbe9fac43c2070f"></a><!-- doxytag: member="stk::Moog::setModulationDepth" ref="32e5ee083d5d92494bbe9fac43c2070f" args="(StkFloat mDepth)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#32e5ee083d5d92494bbe9fac43c2070f">setModulationDepth</a> (StkFloat mDepth)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the modulation (vibrato) depth. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cadb54eccab35e3b18b62ffd96c18ac4"></a><!-- doxytag: member="stk::Moog::controlChange" ref="cadb54eccab35e3b18b62ffd96c18ac4" args="(int number, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#cadb54eccab35e3b18b62ffd96c18ac4">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9635044198c12a5c1b5dbb94245ab5a"></a><!-- doxytag: member="stk::Moog::tick" ref="b9635044198c12a5c1b5dbb94245ab5a" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#b9635044198c12a5c1b5dbb94245ab5a">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
<p><a href="classstk_1_1Moog-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#a07c8d02638711d5f08a3b320b7274156">Moog</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#a07c8d02638711d5f08a3b320b7274156"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac05815f49aab07e01ff0d4e5e8c4edba"></a><!-- doxytag: member="stk::Moog::~Moog" ref="ac05815f49aab07e01ff0d4e5e8c4edba" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ac05815f49aab07e01ff0d4e5e8c4edba">~Moog</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0d66174dd734d55ef7224d6d8f2cb06"></a><!-- doxytag: member="stk::Moog::setFrequency" ref="ab0d66174dd734d55ef7224d6d8f2cb06" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ab0d66174dd734d55ef7224d6d8f2cb06">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a899bc1c5c76fb29875d4df4ce594d44e"></a><!-- doxytag: member="stk::Moog::noteOn" ref="a899bc1c5c76fb29875d4df4ce594d44e" args="(StkFloat frequency, StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#a899bc1c5c76fb29875d4df4ce594d44e">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afeb63bf762f07851db22ae5bf18f0a81"></a><!-- doxytag: member="stk::Moog::setModulationSpeed" ref="afeb63bf762f07851db22ae5bf18f0a81" args="(StkFloat mSpeed)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#afeb63bf762f07851db22ae5bf18f0a81">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the modulation (vibrato) speed in Hz. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32e5ee083d5d92494bbe9fac43c2070f"></a><!-- doxytag: member="stk::Moog::setModulationDepth" ref="a32e5ee083d5d92494bbe9fac43c2070f" args="(StkFloat mDepth)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#a32e5ee083d5d92494bbe9fac43c2070f">setModulationDepth</a> (StkFloat mDepth)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the modulation (vibrato) depth. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acadb54eccab35e3b18b62ffd96c18ac4"></a><!-- doxytag: member="stk::Moog::controlChange" ref="acadb54eccab35e3b18b62ffd96c18ac4" args="(int number, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#acadb54eccab35e3b18b62ffd96c18ac4">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9635044198c12a5c1b5dbb94245ab5a"></a><!-- doxytag: member="stk::Moog::tick" ref="ab9635044198c12a5c1b5dbb94245ab5a" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ab9635044198c12a5c1b5dbb94245ab5a">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK moog-like swept filter sampling synthesis class.
<p>
This instrument uses one attack wave, one looped wave, and an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope (inherited from the <a class="el" href="classstk_1_1Sampler.html" title="STK sampling synthesis abstract base class.">Sampler</a> class) and adds two sweepable formant (<a class="el" href="classstk_1_1FormSwep.html" title="STK sweepable formant filter class.">FormSwep</a>) filters.<p>
Control Change Numbers:<ul>
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Q = 2</li><li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Sweep Rate = 4</li><li>Vibrato Frequency = 11</li><li>Vibrato Gain = 1</li><li>Gain = 128</li></ul>
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="07c8d02638711d5f08a3b320b7274156"></a><!-- doxytag: member="stk::Moog::Moog" ref="07c8d02638711d5f08a3b320b7274156" args="(void)" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK moog-like swept filter sampling synthesis class. </p>
<p>This instrument uses one attack wave, one looped wave, and an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope (inherited from the <a class="el" href="classstk_1_1Sampler.html" title="STK sampling synthesis abstract base class.">Sampler</a> class) and adds two sweepable formant (<a class="el" href="classstk_1_1FormSwep.html" title="STK sweepable formant filter class.">FormSwep</a>) filters.</p>
<p>Control Change Numbers:</p>
<ul>
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Q = 2</li>
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Sweep Rate = 4</li>
<li>Vibrato Frequency = 11</li>
<li>Vibrato Gain = 1</li>
<li>Gain = 128</li>
</ul>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a07c8d02638711d5f08a3b320b7274156"></a><!-- doxytag: member="stk::Moog::Moog" ref="a07c8d02638711d5f08a3b320b7274156" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::Moog::Moog </td>
<td class="memname">stk::Moog::Moog </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
@@ -89,20 +86,20 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Des
</div>
<div class="memdoc">
<p>
Class constructor.
<p>
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set.
<p>Class constructor. </p>
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set. </p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Moog_8h-source.html">Moog.h</a></ul>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Moog_8h_source.html">Moog.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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>