mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
102 lines
6.3 KiB
HTML
102 lines
6.3 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_1BeeThree.html">BeeThree</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::BeeThree Class Reference</h1><!-- doxytag: class="stk::BeeThree" --><!-- doxytag: inherits="stk::FM" -->
|
|
<p>STK Hammond-oid organ <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>
|
|
|
|
<p><code>#include <<a class="el" href="BeeThree_8h_source.html">BeeThree.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::BeeThree:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1BeeThree.png" usemap="#stk::BeeThree_map" alt=""/>
|
|
<map id="stk::BeeThree_map" name="stk::BeeThree_map">
|
|
<area href="classstk_1_1FM.html" alt="stk::FM" shape="rect" coords="0,112,88,136"/>
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,88,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,88,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1BeeThree-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#ab4534210b85a2c4798bf1c88b348c20a">BeeThree</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#ab4534210b85a2c4798bf1c88b348c20a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2a0c982731438cf6200b3e5642a288d"></a><!-- doxytag: member="stk::BeeThree::~BeeThree" ref="af2a0c982731438cf6200b3e5642a288d" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#af2a0c982731438cf6200b3e5642a288d">~BeeThree</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a480c0fe8d4c2df9c00b82b192dd7eae4"></a><!-- doxytag: member="stk::BeeThree::noteOn" ref="a480c0fe8d4c2df9c00b82b192dd7eae4" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#a480c0fe8d4c2df9c00b82b192dd7eae4">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </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="a4649b9471bde3b978c20fcafcbef0fc7"></a><!-- doxytag: member="stk::BeeThree::tick" ref="a4649b9471bde3b978c20fcafcbef0fc7" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#a4649b9471bde3b978c20fcafcbef0fc7">tick</a> (unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK Hammond-oid organ <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> synthesis instrument. </p>
|
|
<p>This class implements a simple 4 operator topology, also referred to as algorithm 8 of the TX81Z.</p>
|
|
<div class="fragment"><pre class="fragment"> Algorithm 8 is :
|
|
1 --.
|
|
2 -\|
|
|
+-> Out
|
|
3 -/|
|
|
4 --
|
|
</pre></div><p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li>Operator 4 (feedback) Gain = 2</li>
|
|
<li>Operator 3 Gain = 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 & 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>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ab4534210b85a2c4798bf1c88b348c20a"></a><!-- doxytag: member="stk::BeeThree::BeeThree" ref="ab4534210b85a2c4798bf1c88b348c20a" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::BeeThree::BeeThree </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<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>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="BeeThree_8h_source.html">BeeThree.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>
|