Files
stk/doc/html/classstk_1_1PercFlut.html
2013-09-29 23:44:33 +02:00

102 lines
6.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"> &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 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1PercFlut.html">PercFlut</a>
</div>
<div class="contents">
<h1>stk::PercFlut Class Reference</h1><!-- doxytag: class="stk::PercFlut" --><!-- doxytag: inherits="stk::FM" -->STK percussive flute <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> synthesis instrument.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PercFlut_8h-source.html">PercFlut.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for stk::PercFlut:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1PercFlut.png" usemap="#stk::PercFlut_map" border="0" alt=""></center>
<map name="stk::PercFlut_map">
<area href="classstk_1_1FM.html" alt="stk::FM" shape="rect" coords="0,112,81,136">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,81,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,81,24">
</map>
</div>
<p>
<a href="classstk_1_1PercFlut-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_1PercFlut.html#b51f05b79d818ed8ba80fd827a4839c2">PercFlut</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#b51f05b79d818ed8ba80fd827a4839c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd2a18e8835d665d505521e0298bd2f0"></a><!-- doxytag: member="stk::PercFlut::~PercFlut" ref="dd2a18e8835d665d505521e0298bd2f0" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PercFlut.html#dd2a18e8835d665d505521e0298bd2f0">~PercFlut</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="24197fb4ae0bf806d8e3f6fe4eb5598c"></a><!-- doxytag: member="stk::PercFlut::setFrequency" ref="24197fb4ae0bf806d8e3f6fe4eb5598c" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PercFlut.html#24197fb4ae0bf806d8e3f6fe4eb5598c">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="7ebfc19d4c41482a699f43b2c06dc02d"></a><!-- doxytag: member="stk::PercFlut::noteOn" ref="7ebfc19d4c41482a699f43b2c06dc02d" args="(StkFloat frequency, StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PercFlut.html#7ebfc19d4c41482a699f43b2c06dc02d">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="c2b2958902c044413a1c7ff3bd0f8054"></a><!-- doxytag: member="stk::PercFlut::tick" ref="c2b2958902c044413a1c7ff3bd0f8054" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PercFlut.html#c2b2958902c044413a1c7ff3bd0f8054">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 percussive flute <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> synthesis instrument.
<p>
This class implements algorithm 4 of the TX81Z.<p>
<div class="fragment"><pre class="fragment"> Algorithm 4 is : 4-&gt;3--\
2-- + --&gt;1--&gt;Out
</pre></div><p>
Control Change Numbers:<ul>
<li>Total Modulator Index = 2</li><li>Modulator Crossfade = 4</li><li>LFO Speed = 11</li><li>LFO Depth = 1</li><li><a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> 2 &amp; 4 Target = 128</li></ul>
<p>
The basic Chowning/Stanford <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> patent expired in 1995, but there exist follow-on patents, mostly assigned to Yamaha. If you are of the type who should worry about this (making money) worry away.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b51f05b79d818ed8ba80fd827a4839c2"></a><!-- doxytag: member="stk::PercFlut::PercFlut" ref="b51f05b79d818ed8ba80fd827a4839c2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::PercFlut::PercFlut </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</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.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PercFlut_8h-source.html">PercFlut.h</a></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>
</table>
</BODY>
</HTML>