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;
 
 
   /*
    @param[out] pInstance may construct
    (and then must call Init() with success), or leave null for failure
    */
using EffectDialogFactory = std::function< wxDialog* (
   wxWindow &parent, EffectPlugin &, EffectUIClientInterface &,
   std::shared_ptr<EffectInstance> &,
   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 void Preview(EffectSettingsAccess &access, bool dryOnly) = 0;
   virtual bool SaveSettingsAsString(
      const EffectSettings &settings, wxString & parms) const = 0;
   virtual bool 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;
};
 
#endif