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;
 
struct EffectSettings;
class EffectSettingsAccess;
class EffectPlugin;
 
class TrackList;
class WaveTrackFactory;
class NotifyingSelectedRegion;
class EffectInstanceEx;
 
/***************************************************************************/
class EFFECTS_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 bool HasOptions() const = 0;
 
   virtual bool CanExportPresets() const = 0;
 
   virtual const EffectSettingsManager& GetDefinition() const = 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;
 
   using InstancePointer = std::shared_ptr<EffectInstanceEx>;
   using InstanceFinder = std::function<
      std::optional<InstancePointer>(EffectSettings &settings)
   >;
 
   virtual bool DoEffect(
      EffectSettings &settings, 
      const InstanceFinder &finder,
      double projectRate, TrackList *list,
      WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion,
      unsigned flags,
      const EffectSettingsAccessPtr &pAccess = nullptr
   ) = 0;
};
 
/***************************************************************************/
class EFFECTS_API EffectInstanceEx : public virtual EffectInstance {
public:
 
   virtual bool Init();
 
 
   virtual bool Process(EffectSettings &settings) = 0;
 
   ~EffectInstanceEx() override;
};
#endif