Version 4.0

include/Plucked.h

@@ -1,39 +1,66 @@
-/******************************************/  
-/*  Karplus-Strong plucked string model   */
-/*  by Perry Cook, 1995-96                */
-/*                                        */
-/*  There exist at least two patents,     */
-/*  assigned to Stanford, bearing the     */
-/*  names of Karplus and/or Strong.       */
-/******************************************/
+/***************************************************/
+/*! \class Plucked
+    \brief STK plucked string model class.
 
-#if !defined(__Plucked_h)
-#define __Plucked_h
+    This class implements a simple plucked string
+    physical model based on the Karplus-Strong
+    algorithm.
 
-#include "Instrmnt.h" 
-#include "DLineA.h" 
-#include "OneZero.h" 
-#include "OnePole.h" 
-#include "Noise.h" 
+    This is a digital waveguide model, making its
+    use possibly subject to patents held by
+    Stanford University, Yamaha, and others.
+    There exist at least two patents, assigned to
+    Stanford, bearing the names of Karplus and/or
+    Strong.
+
+    by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
+*/
+/***************************************************/
+
+#if !defined(__PLUCKED_H)
+#define __PLUCKED_H
+
+#include "Instrmnt.h"
+#include "DelayA.h"
+#include "OneZero.h"
+#include "OnePole.h"
+#include "Noise.h"
 
 class Plucked : public Instrmnt
 {
-  protected:  
-    DLineA *delayLine;
-    OneZero *loopFilt;
-    OnePole *pickFilt;
-    Noise *noise;
-    long length;
-    MY_FLOAT loopGain;
-  public:
-    Plucked(MY_FLOAT lowestFreq);
-    ~Plucked();
-    void clear();
-    virtual void setFreq(MY_FLOAT frequency);
-    void pluck(MY_FLOAT amplitude);
-    virtual void noteOn(MY_FLOAT freq, MY_FLOAT amp);
-    virtual void noteOff(MY_FLOAT amp);
-    virtual MY_FLOAT tick();
+ public:
+  //! Class constructor, taking the lowest desired playing frequency.
+  Plucked(MY_FLOAT lowestFrequency);
+
+  //! Class destructor.
+  ~Plucked();
+
+  //! Reset and clear all internal state.
+  void clear();
+
+  //! Set instrument parameters for a particular frequency.
+  virtual void setFrequency(MY_FLOAT frequency);
+
+  //! Pluck the string with the given amplitude using the current frequency.
+  void pluck(MY_FLOAT amplitude);
+
+  //! Start a note with the given frequency and amplitude.
+  virtual void noteOn(MY_FLOAT frequency, MY_FLOAT amplitude);
+
+  //! Stop a note with the given amplitude (speed of decay).
+  virtual void noteOff(MY_FLOAT amplitude);
+
+  //! Compute one output sample.
+  virtual MY_FLOAT tick();
+
+ protected:  
+  DelayA *delayLine;
+  OneZero *loopFilter;
+  OnePole *pickFilter;
+  Noise *noise;
+  long length;
+  MY_FLOAT loopGain;
+
 };
 
 #endif