EffectManager.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  EffectManager.h
 
  Audacity(R) is copyright (c) 1999-2008 Audacity Team.
  License: GPL v2 or later.  See License.txt.
 
**********************************************************************/
 
#ifndef __AUDACITY_EFFECTMANAGER__
#define __AUDACITY_EFFECTMANAGER__
 
#include "EffectInterface.h"
#include "Identifier.h"
 
#include <functional>
#include <memory>
#include <unordered_map>
#include <variant>
#include <vector>
 
class AudacityProject;
class CommandContext;
class ComponentInterfaceSymbol;
class wxString;
typedef wxString PluginID;
class Effect;
class EffectPlugin;
class EffectSettings;
class EffectInstance;
 
struct EffectAndDefaultSettings{
   EffectPlugin *effect{};
   EffectSettings settings{};
};
 
using EffectMap = std::unordered_map<wxString, EffectAndDefaultSettings>;
using EffectOwnerMap = std::unordered_map< wxString, std::shared_ptr<EffectPlugin> >;
 
EFFECTS_API
RegistryPaths GetUserPresets(EffectPlugin& host);
 
EFFECTS_API
bool HasCurrentSettings(EffectPlugin& host);
 
EFFECTS_API
bool HasFactoryDefaults(EffectPlugin& host);
 
class EFFECTS_API EffectManager
{
public:
 
   enum : unsigned {
      // No flags specified
      kNone = 0x00,
      // Flag used to disable prompting for configuration parameteres.
      kConfigured = 0x01,
      // Flag used to disable saving the state after processing.
      kSkipState = 0x02,
      // Flag used to disable "Repeat Last Effect"
      kDontRepeatLast = 0x04,
      // Flag used to disable "Select All during Repeat Generator Effect"
      kRepeatGen = 0x08,
      // Flag used for repeating Nyquist Prompt
      kRepeatNyquistPrompt = 0x10,
   };
 
   static const EffectInstanceFactory*
   GetInstanceFactory(const PluginID& ID);
 
   static EffectManager& Get();
 
   //
   // public methods
   //
   // Used by the outside program to register the list of effects and retrieve
   // them by index number, usually when the user selects one from a menu.
   //
public:
   using EffectPresetDialog = std::function<std::optional<wxString>(
      EffectPlugin&, const wxString& preset)>;
 
 
   const PluginID & RegisterEffect(std::unique_ptr<EffectPlugin> uEffect);
   void UnregisterEffect(const PluginID & ID);
 
   TranslatableString GetEffectFamilyName(const PluginID & ID);
   TranslatableString GetVendorName(const PluginID & ID);
 
   bool IsHidden(const PluginID & ID);
 
   bool HasPresets(const PluginID & ID);
   wxString
   GetPreset(const PluginID& ID, const wxString& params, EffectPresetDialog);
   wxString GetDefaultPreset(const PluginID & ID);
 
   void SetSkipStateFlag(bool flag);
   bool GetSkipStateFlag();
 
   EffectPlugin* GetEffect(const PluginID& ID);
 
   EffectSettings* GetDefaultSettings(const PluginID& ID);
 
   std::pair<EffectPlugin*, EffectSettings*>
   GetEffectAndDefaultSettings(const PluginID& ID);
 
private:
   EffectAndDefaultSettings& DoGetEffect(const PluginID& ID);
 
   EffectMap mEffects;
   EffectOwnerMap mHostEffects;
 
   int mNumEffects;
 
   // Set true if we want to skip pushing state
   // after processing at effect run time.
   bool mSkipStateFlag;
};
 
#endif