VampEffect.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  VampEffect.h
 
  Chris Cannam
 
  Vamp is an audio analysis and feature extraction plugin API.
  http://www.vamp-plugins.org/
 
**********************************************************************/
 
 
 
#if defined(USE_VAMP)
 
#include <vamp-hostsdk/PluginLoader.h>
 
#include <wx/weakref.h>
#include "StatefulEffect.h"
#include "../StatefulEffectUIServices.h"
#include "MemoryX.h"
 
class wxStaticText;
class wxSlider;
class wxChoice;
class wxCheckBox;
class wxTextCtrl;
class LabelTrack;
 
using Floats = ArrayOf<float>;
 
#define VAMPEFFECTS_VERSION wxT("1.0.0.0")
/* i18n-hint: Vamp is the proper name of a software protocol for sound analysis.
   It is not an abbreviation for anything.  See http://vamp-plugins.org */
#define VAMPEFFECTS_FAMILY XO("Vamp")
 
class VampEffect final : public StatefulEffect, public StatefulEffectUIServices
{
public:
   VampEffect(std::unique_ptr<Vamp::Plugin> &&plugin,
              const PluginPath & path,
              int output,
              bool hasParameters);
   virtual ~VampEffect();
 
   // ComponentInterface implementation
 
   PluginPath GetPath() const override;
   ComponentInterfaceSymbol GetSymbol() const override;
   VendorSymbol GetVendor() const override;
   wxString GetVersion() const override;
   TranslatableString GetDescription() const override;
 
   // EffectDefinitionInterface implementation
 
   EffectType GetType() const override;
   EffectFamilySymbol GetFamily() const override;
   bool IsInteractive() const override;
   bool IsDefault() const override;
 
   bool SaveSettings(
      const EffectSettings &settings, CommandParameters & parms) const override;
   bool LoadSettings(
      const CommandParameters & parms, EffectSettings &settings) const override;
 
   unsigned GetAudioInCount() const override;
 
   // Effect implementation
 
   bool Init() override;
   bool Process(EffectInstance &instance, EffectSettings &settings) override;
   std::unique_ptr<EffectEditor> PopulateOrExchange(
      ShuttleGui & S, EffectInstance &instance,
      EffectSettingsAccess &access, const EffectOutputs *pOutputs) override;
   bool TransferDataToWindow(const EffectSettings &settings) override;
   bool TransferDataFromWindow(EffectSettings &settings) override;
 
private:
   // VampEffect implementation
 
   void AddFeatures(LabelTrack *track, Vamp::Plugin::FeatureSet & features);
 
   void UpdateFromPlugin();
 
   void OnCheckBox(wxCommandEvent & evt);
   void OnChoice(wxCommandEvent & evt);
   void OnSlider(wxCommandEvent & evt);
   void OnTextCtrl(wxCommandEvent & evt);
 
private:
   wxWeakRef<wxWindow> mUIParent{};
 
   std::unique_ptr<Vamp::Plugin> mPlugin;
   PluginPath mPath;
   int mOutput;
   bool mHasParameters;
 
   Vamp::HostExt::PluginLoader::PluginKey mKey;
   wxString mName;
   double mRate;
 
   bool mInSlider;
   bool mInText;
 
   Vamp::Plugin::ParameterList mParameters;
 
   Floats mValues;
 
   ArrayOf<wxSlider *> mSliders;
   ArrayOf<wxTextCtrl *> mFields;
   ArrayOf<wxStaticText *> mLabels;
   ArrayOf<wxCheckBox *> mToggles;
   ArrayOf<wxChoice *> mChoices;
   wxChoice *mProgram;
 
   DECLARE_EVENT_TABLE()
};
 
#endif