LoadEffects.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  LoadEffects.h
 
  Dominic Mazzoni
 
**********************************************************************/
 
#ifndef __AUDACITY_LOAD_EFFECTS__
#define __AUDACITY_LOAD_EFFECTS__
 
#include "PluginProvider.h"
 
#include <functional>
#include <memory>
#include <unordered_map>
#include <memory>
 
class Effect;
 
//
// BuiltinEffectsModule
//
 
class EFFECTS_API BuiltinEffectsModule final : public PluginProvider
{
public:
   BuiltinEffectsModule();
   virtual ~BuiltinEffectsModule();
 
   using Factory = std::function< std::unique_ptr<Effect> () >;
 
   // Typically you make a static object of this type in the .cpp file that
   // also implements the Effect subclass.
   template< typename Subclass >
   struct Registration final { Registration( bool excluded = false ) {
      DoRegistration(
         Subclass::Symbol, []{ return std::make_unique< Subclass >(); },
         excluded );
   } };
 
   // ComponentInterface implementation
 
   PluginPath GetPath() const override;
   ComponentInterfaceSymbol GetSymbol() const override;
   VendorSymbol GetVendor() const override;
   wxString GetVersion() const override;
   TranslatableString GetDescription() const override;
 
   // PluginProvider implementation
 
   bool Initialize() override;
   void Terminate() override;
   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
   const FileExtensions &GetFileExtensions() override;
   FilePath InstallPath() override { return {}; }
 
   void AutoRegisterPlugins(PluginManagerInterface & pm) override;
   PluginPaths FindModulePaths(PluginManagerInterface & pm) override;
   unsigned DiscoverPluginsAtPath(
      const PluginPath & path, TranslatableString &errMsg,
      const RegistrationCallback &callback)
         override;
   
   bool CheckPluginExist(const PluginPath& path) const override;
 
   std::unique_ptr<ComponentInterface>
      LoadPlugin(const PluginPath & path) override;
 
private:
   // BuiltinEffectModule implementation
 
   std::unique_ptr<Effect> Instantiate(const PluginPath & path);
 
private:
   static void DoRegistration(
      const ComponentInterfaceSymbol &name, const Factory &factory,
      bool excluded );
 
   struct Entry;
   using EffectHash = std::unordered_map< wxString, const Entry* > ;
   EffectHash mEffects;
};
 
#endif