comparison vamp-sdk/Plugin.h @ 35:154f86cb8c99

* Add an implementation of Dan Barry's percussion onset detector

  * 5. Plugin is properly initialised with a call to initialise.  This
  * fixes the step size, block size, and number of channels, as well as
  * all of the parameter and program settings.  If the values passed in
  * to initialise do not match the plugin's advertised preferred values
  * from step 4, the plugin may refuse to initialise and return false
- * (although if possible it should accept the new values).
+ * (although if possible it should accept the new values).  Any
+ * computationally expensive setup code should take place here.
  *
  * 6. Host finally checks the number of values per output (which may
  * vary depending on the number of channels, step size and block size
  * as well as the parameter values).
  *

  * does not mean it can change the parameters, which are fixed from
  * initialise until destruction.)
  *
  * A plugin does not need to handle the case where setParameter or
  * selectProgram is called after initialise has been called.  It's the
- * host's responsibility not to do that.
+ * host's responsibility not to do that.  Similarly, the plugin may
+ * safely assume that initialise is called no more than once.
  */
 
 class Plugin : public PluginBase
 {
 public: