e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 21:41:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f13d5bb3cd8ba1350786b36fba9a538babb210d0
stk/doc/html/classstk_1_1BeeThree.html
Gary Scavone f13d5bb3cd Release 4.4.3 tarball
2013-09-29 23:49:37 +02:00

164 lines
11 KiB
HTML
Raw Blame History

<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.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 &lt;<a class="el" href="BeeThree_8h_source.html">BeeThree.h</a>&gt;</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#ab4534210b85a2c4798bf1c88b348c20a">BeeThree</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#af2a0c982731438cf6200b3e5642a288d">~BeeThree</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="a480c0fe8d4c2df9c00b82b192dd7eae4"></a><!-- doxytag: member="stk::BeeThree::noteOn" ref="a480c0fe8d4c2df9c00b82b192dd7eae4" args="(StkFloat frequency, StkFloat amplitude)" -->
void&nbsp;</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">&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="a4649b9471bde3b978c20fcafcbef0fc7"></a><!-- doxytag: member="stk::BeeThree::tick" ref="a4649b9471bde3b978c20fcafcbef0fc7" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</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">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BeeThree.html#a30520efff3fac0674d3c7ab95ac35999">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a30520efff3fac0674d3c7ab95ac35999"></a><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 -\|
+-&gt; 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 &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>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Constructor &amp; 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&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</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/><h2>Member Function Documentation</h2>
<a class="anchor" id="a30520efff3fac0674d3c7ab95ac35999"></a><!-- doxytag: member="stk::BeeThree::tick" ref="a30520efff3fac0674d3c7ab95ac35999" args="(StkFrames &amp;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> &amp; stk::BeeThree::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in 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>
<p>Implements <a class="el" href="classstk_1_1FM.html#a870c602be292d2dcc1b0fd97f515f2ff">stk::FM</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00101"></a>00101 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt; frames.channels() - nChannels ) {
<a name="l00103"></a>00103 oStream_ &lt;&lt; <span class="stringliteral">&quot;BeeThree::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;
<a name="l00104"></a>00104 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>
<a name="l00108"></a>00108 StkFloat *samples = &amp;frames[channel];
<a name="l00109"></a>00109 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00110"></a>00110 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00111"></a>00111 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop )
<a name="l00112"></a>00112 *samples++ = <a class="code" href="classstk_1_1BeeThree.html#a4649b9471bde3b978c20fcafcbef0fc7" title="Compute and return one output sample.">tick</a>();
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 <span class="keywordflow">else</span> {
<a name="l00115"></a>00115 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.frames(); i++, samples += hop ) {
<a name="l00116"></a>00116 *samples++ = <a class="code" href="classstk_1_1BeeThree.html#a4649b9471bde3b978c20fcafcbef0fc7" title="Compute and return one output sample.">tick</a>();
<a name="l00117"></a>00117 <span class="keywordflow">for</span> ( j=1; j&lt;nChannels; j++ )
<a name="l00118"></a>00118 *samples++ = lastFrame_[j];
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordflow">return</span> frames;
<a name="l00123"></a>00123 }
</pre></div></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>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink