EffectPlugin.h

Go to the documentation of this file.

/*!********************************************************************
 
   Audacity: A Digital Audio Editor
 
   @file EffectPlugin.h
 
   Paul Licameli
   split from EffectInterface.h
 
**********************************************************************/
 
#ifndef __AUDACITY_EFFECTPLUGIN_H__
#define __AUDACITY_EFFECTPLUGIN_H__
 
#include "EffectInterface.h"
 
#include <functional>
#include <memory>
 
class EffectSettingsManager;
 
class wxDialog;
class wxWindow;
class EffectUIClientInterface;
class EffectInstance;
class EffectSettings;
class EffectSettingsAccess;
class EffectPlugin;
class EffectUIValidator;
 
struct DialogFactoryResults {
   wxDialog *pDialog{};
   std::shared_ptr<EffectInstance> pInstance{};
   EffectUIValidator *pValidator{};
};
 
 
using EffectDialogFactory = std::function< DialogFactoryResults(
   wxWindow &parent, EffectPlugin &, EffectUIClientInterface &,
   EffectSettingsAccess &) >;
 
class TrackList;
class WaveTrackFactory;
class NotifyingSelectedRegion;
class EffectInstance;
 
/***************************************************************************/
class AUDACITY_DLL_API EffectPlugin
   : public EffectInstanceFactory
{
public:
   using EffectSettingsAccessPtr = std::shared_ptr<EffectSettingsAccess>;
 
   const static wxString kUserPresetIdent;
   const static wxString kFactoryPresetIdent;
   const static wxString kCurrentSettingsIdent;
   const static wxString kFactoryDefaultsIdent;
 
   EffectPlugin &operator=(EffectPlugin&) = delete;
   virtual ~EffectPlugin();
 
   virtual const EffectSettingsManager& GetDefinition() const = 0;
 
 
   virtual int ShowHostInterface(
      wxWindow &parent, const EffectDialogFactory &factory,
      std::shared_ptr<EffectInstance> &pInstance, EffectSettingsAccess &access,
      bool forceModal = false) = 0;
 
 
   virtual EffectUIClientInterface* GetEffectUIClientInterface() = 0;
 
   virtual void Preview(EffectSettingsAccess &access, bool dryOnly) = 0;
   virtual bool SaveSettingsAsString(
      const EffectSettings &settings, wxString & parms) const = 0;
   // @return nullptr for failure
   [[nodiscard]] virtual OptionalMessage LoadSettingsFromString(
      const wxString & parms, EffectSettings &settings) const = 0;
   virtual bool IsBatchProcessing() const = 0;
   virtual void SetBatchProcessing() = 0;
   virtual void UnsetBatchProcessing() = 0;
 
 
   virtual bool DoEffect(
      EffectSettings &settings, 
      double projectRate, TrackList *list,
      WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion,
      unsigned flags,
      // Prompt the user for input only if the next arguments are not all null.
      wxWindow *pParent = nullptr,
      const EffectDialogFactory &dialogFactory = {},
      const EffectSettingsAccessPtr &pAccess = nullptr
   ) = 0;
 
   virtual bool TransferDataToWindow(const EffectSettings &settings) = 0;
 
   virtual bool TransferDataFromWindow(EffectSettings &settings) = 0;
};
 
/***************************************************************************/
class AUDACITY_DLL_API EffectInstanceEx : public virtual EffectInstance {
public:
 
   virtual bool Init();
 
 
   virtual bool Process(EffectSettings &settings) = 0;
 
   ~EffectInstanceEx() override;
};
 
/*************************************************************************************/
class AUDACITY_DLL_API EffectUIClientInterface /* not final */
{
public:
   virtual ~EffectUIClientInterface();
 
   virtual int ShowClientInterface(wxWindow &parent, wxDialog &dialog,
      EffectUIValidator *pValidator, bool forceModal = false) = 0;
 
   virtual bool IsGraphicalUI() = 0;
 
 
   virtual std::unique_ptr<EffectUIValidator> PopulateUI(ShuttleGui &S,
      EffectInstance &instance, EffectSettingsAccess &access,
      const EffectOutputs *pOutputs) = 0;
 
   virtual bool CanExportPresets() = 0;
   virtual void ExportPresets(const EffectSettings &settings) const = 0;
   [[nodiscard]] virtual OptionalMessage
      ImportPresets(EffectSettings &settings) = 0;
 
   virtual bool HasOptions() = 0;
   virtual void ShowOptions() = 0;
 
   virtual bool ValidateUI(EffectSettings &settings) = 0;
   virtual bool CloseUI() = 0;
};
 
/*************************************************************************************/ 
struct EffectSettingChanged final
{
   size_t index { size_t(-1) };
   float newValue {};
};
 
/*************************************************************************************/
class AUDACITY_DLL_API EffectUIValidator /* not final */
    : public Observer::Publisher<EffectSettingChanged>
{
public:
   EffectUIValidator(
      EffectUIClientInterface &effect, EffectSettingsAccess &access);
 
   virtual ~EffectUIValidator();
 
 
   virtual bool ValidateUI() = 0;
 
 
   virtual bool UpdateUI();
 
   virtual bool IsGraphicalUI();
 
 
   virtual void Disconnect();
 
   virtual void OnClose();
 
   static bool EnableApply(wxWindow *parent, bool enable = true);
 
   // id that should be used by preview play button of effect dialog
   static constexpr int kPlayID = 20102;
 
   static bool EnablePreview(wxWindow *parent, bool enable = true);
 
 protected:
   // Convenience function template for binding event handler functions
   template<typename EventTag, typename Class, typename Event>
   void BindTo(
      wxEvtHandler &src, const EventTag& eventType, void (Class::*pmf)(Event &))
   {
      src.Bind(eventType, pmf, static_cast<Class *>(this));
   }
 
   EffectUIClientInterface &mEffect;
   EffectSettingsAccess &mAccess;
 
   bool mUIClosed { false };
};
#endif