Version 4.0

include/BeeThree.h

@@ -1,23 +1,56 @@
-/******************************************/
-/*  HammondOid Organ Subclass             */
-/*  of Algorithm 8 (TX81Z) Subclass of    */ 
-/*  4 Operator FM Synth                   */
-/*  by Perry R. Cook, 1995-96             */ 
-/******************************************/
+/***************************************************/
+/*! \class BeeThree
+    \brief STK Hammond-oid organ FM synthesis instrument.
 
-#if !defined(__BeeThree_h)
-#define __BeeThree_h
+    This class implements a simple 4 operator
+    topology, also referred to as algorithm 8 of
+    the TX81Z.
 
-#include "FM4Alg8.h"
+    \code
+    Algorithm 8 is :
+                     1 --.
+                     2 -\|
+                         +-> Out
+                     3 -/|
+                     4 --
+    \endcode
 
-class BeeThree : public FM4Alg8
+    Control Change Numbers: 
+       - Operator 4 (feedback) Gain = 2
+       - Operator 3 Gain = 4
+       - LFO Speed = 11
+       - LFO Depth = 1
+       - ADSR 2 & 4 Target = 128
+
+    The basic Chowning/Stanford FM 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.
+
+    by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
+*/
+/***************************************************/
+
+#if !defined(__BEETHREE_H)
+#define __BEETHREE_H
+
+#include "FM.h"
+
+class BeeThree : public FM
 {
-  public:
-    BeeThree();
-    ~BeeThree();
-    virtual void setFreq(MY_FLOAT frequency);
-    MY_FLOAT tick();
-    virtual void noteOn(MY_FLOAT freq, MY_FLOAT amp);
+ public:
+  //! Class constructor.
+  BeeThree();
+
+  //! Class destructor.
+  ~BeeThree();
+
+  //! Start a note with the given frequency and amplitude.
+  void noteOn(MY_FLOAT frequency, MY_FLOAT amplitude);
+
+  //! Compute one output sample.
+  MY_FLOAT tick();
 };
 
 #endif