BuiltinEffectsModule Class Reference

Internal module to auto register all built in effects.
More...

#include <LoadEffects.h>

Inheritance diagram for BuiltinEffectsModule:

Collaboration diagram for BuiltinEffectsModule:

Classes
struct	Entry
struct	Registration

Public Types
using	Factory = std::function< std::unique_ptr< Effect >() >
Public Types inherited from PluginProvider
using	RegistrationCallback = std::function< const PluginID &(PluginProvider *, ComponentInterface *) >
	Further expand a path reported by FindModulePaths. More...

Public Member Functions
	BuiltinEffectsModule ()
virtual	~BuiltinEffectsModule ()
PluginPath	GetPath () const override
ComponentInterfaceSymbol	GetSymbol () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
TranslatableString	GetDescription () const override
bool	Initialize () override
	Called immediately after creation. Let provider initialize. More...
void	Terminate () override
	Called just prior to deletion to allow releasing any resources. More...
EffectFamilySymbol	GetOptionalFamilySymbol () override
	A symbol identifying the family of plug-ins provided by this. More...
const FileExtensions &	GetFileExtensions () override
	File types associated with this protocol. More...
FilePath	InstallPath () override
	Where plug-in files should be copied to install them. More...
void	AutoRegisterPlugins (PluginManagerInterface &pm) override
	Called so that a provider of a static set of plug-ins can register them. More...
PluginPaths	FindModulePaths (PluginManagerInterface &pm) override
unsigned	DiscoverPluginsAtPath (const PluginPath &path, TranslatableString &errMsg, const RegistrationCallback &callback) override
bool	CheckPluginExist (const PluginPath &path) const override
	Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check. More...
std::unique_ptr< ComponentInterface >	LoadPlugin (const PluginPath &path) override
	Load the plug-in at a path reported by DiscoverPluginsAtPath. More...
Public Member Functions inherited from PluginProvider
virtual	~PluginProvider ()
virtual bool	Initialize ()=0
	Called immediately after creation. Let provider initialize. More...
virtual void	Terminate ()=0
	Called just prior to deletion to allow releasing any resources. More...
virtual EffectFamilySymbol	GetOptionalFamilySymbol ()=0
	A symbol identifying the family of plug-ins provided by this. More...
virtual const FileExtensions &	GetFileExtensions ()=0
	File types associated with this protocol. More...
virtual FilePath	InstallPath ()=0
	Where plug-in files should be copied to install them. More...
virtual void	AutoRegisterPlugins (PluginManagerInterface &pluginManager)=0
	Called so that a provider of a static set of plug-ins can register them. More...
virtual bool	SupportsCustomModulePaths () const
virtual PluginPaths	FindModulePaths (PluginManagerInterface &pluginManager)=0
virtual unsigned	DiscoverPluginsAtPath (const PluginPath &path, TranslatableString &errMsg, const RegistrationCallback &callback)=0
virtual bool	CheckPluginExist (const PluginPath &path) const =0
	Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check. More...
virtual std::unique_ptr< Validator >	MakeValidator () const
virtual std::unique_ptr< ComponentInterface >	LoadPlugin (const PluginPath &path)=0
	Load the plug-in at a path reported by DiscoverPluginsAtPath. More...
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const

Private Types
using	EffectHash = std::unordered_map< wxString, const Entry * >

Private Member Functions
std::unique_ptr< Effect >	Instantiate (const PluginPath &path)

Static Private Member Functions
static void	DoRegistration (const ComponentInterfaceSymbol &name, const Factory &factory, bool excluded)

Private Attributes
EffectHash	mEffects

Detailed Description

Internal module to auto register all built in effects.

Definition at line 29 of file LoadEffects.h.

Member Typedef Documentation

EffectHash

using BuiltinEffectsModule::EffectHash = std::unordered_map< wxString, const Entry* >

private

Definition at line 86 of file LoadEffects.h.

Factory

using BuiltinEffectsModule::Factory = std::function< std::unique_ptr<Effect> () >

Definition at line 35 of file LoadEffects.h.

Constructor & Destructor Documentation

BuiltinEffectsModule()

BuiltinEffectsModule::BuiltinEffectsModule

(

)

Definition at line 72 of file LoadEffects.cpp.

{
}

~BuiltinEffectsModule()

BuiltinEffectsModule::~BuiltinEffectsModule ( )

virtual

Definition at line 76 of file LoadEffects.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void BuiltinEffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

Called so that a provider of a static set of plug-ins can register them.

Implements PluginProvider.

Definition at line 143 of file LoadEffects.cpp.

{
   // Assume initial PluginManager::Save is not yet done
 
   // The set of built-in functions that are realtime capable may differ with
   // the plugin registry version
   bool rediscoverAll = !Regver_eq(pm.GetRegistryVersion(), REGVERCUR);
 
   TranslatableString ignoredErrMsg;
   for (const auto &pair : mEffects) {
      const auto &path = pair.first;
      if (rediscoverAll ||
         !pm.IsPluginRegistered(path, &pair.second->name.Msgid())
      ){
         DiscoverPluginsAtPath(path, ignoredErrMsg, [&](PluginProvider *provider, ComponentInterface *ident) -> const PluginID&
         {
            const auto& pluginId = PluginManagerInterface::DefaultRegistrationCallback(provider, ident);
            if(pair.second->excluded)
               PluginManager::Get().EnablePlugin(pluginId, false);
            return pluginId;
         });
         
      }
   }
}

References PluginManagerInterface::DefaultRegistrationCallback(), DiscoverPluginsAtPath(), PluginManager::EnablePlugin(), PluginManager::Get(), PluginManagerInterface::GetRegistryVersion(), ident(), PluginManagerInterface::IsPluginRegistered(), mEffects, Regver_eq(), and REGVERCUR.

Here is the call graph for this function:

CheckPluginExist()

bool BuiltinEffectsModule::CheckPluginExist ( const PluginPath &  path ) const

overridevirtual

Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check.

Parameters

path	Internal plugin path/ID discovered via DiscoverPluginsAtPath or module path returned by FindModulePaths

Implements PluginProvider.

Definition at line 203 of file LoadEffects.cpp.

{
   return mEffects.find( path ) != mEffects.end();
}

References mEffects.

DiscoverPluginsAtPath()

unsigned BuiltinEffectsModule::DiscoverPluginsAtPath ( const PluginPath &  path, TranslatableString &  errMsg, const RegistrationCallback &  callback  )

overridevirtual

Implements PluginProvider.

Definition at line 178 of file LoadEffects.cpp.

{
   // At most one
   errMsg = {};
   auto effect = Instantiate(path);
   if (effect)
   {
      if (callback)
         callback(this, effect.get());
      return 1;
   }
 
   errMsg = XO("Unknown built-in effect name");
   return 0;
}

References Instantiate(), and XO().

Referenced by AutoRegisterPlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

DoRegistration()

void BuiltinEffectsModule::DoRegistration ( const ComponentInterfaceSymbol &  name, const Factory &  factory, bool  excluded  )

staticprivate

Definition at line 38 of file LoadEffects.cpp.

{
   wxASSERT( !sInitialized );
   Entry::Registry().emplace_back( Entry{ name, factory, excluded } );
}

References factory, name, BuiltinEffectsModule::Entry::Registry(), and sInitialized.

Here is the call graph for this function:

FindModulePaths()

PluginPaths BuiltinEffectsModule::FindModulePaths ( PluginManagerInterface &  pluginManager )

overridevirtual

Find available "paths", which may each be presented to the user, and then reexamined (possibly loading libraries) to find one or more plug-ins

Paths are not necessarily file system paths. Only the provider reinterprets the paths.

Modules may be associated with plug-ins, one-to-many.

See also

GetFileExtensions DiscoverPluginsAtPath

Implements PluginProvider.

Definition at line 169 of file LoadEffects.cpp.

{
   // Not really libraries
   PluginPaths names;
   for ( const auto &pair : mEffects )
      names.push_back( pair.first );
   return names;
}

References mEffects, and names.

GetDescription()

TranslatableString BuiltinEffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 105 of file LoadEffects.cpp.

{
   return XO("Provides builtin effects to Audacity");
}

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & BuiltinEffectsModule::GetFileExtensions ( )

overridevirtual

File types associated with this protocol.

"Paths" returned by FindModulePaths() and passed back to DiscoverPluginsAtPath() have provider-specific meaning. They are not necessarily file system paths to existent files that could be placed in any folder and queried for plug-in information.

This function returns nonempty only when that is the case, and lists the possible extensions of such files (an empty string in a nonempty array means any file is a candidate).

Implements PluginProvider.

Definition at line 137 of file LoadEffects.cpp.

{
   static FileExtensions empty;
   return empty;
}

GetOptionalFamilySymbol()

EffectFamilySymbol BuiltinEffectsModule::GetOptionalFamilySymbol ( )

overridevirtual

A symbol identifying the family of plug-ins provided by this.

If it is not empty, then the family as a whole can be enabled or disabled by the user in Preferences

Implements PluginProvider.

Definition at line 130 of file LoadEffects.cpp.

{
   // Returns empty, because there should not be an option in Preferences to
   // disable the built-in effects.
   return {};
}

GetPath()

PluginPath BuiltinEffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 84 of file LoadEffects.cpp.

{
   return {};
}

GetSymbol()

ComponentInterfaceSymbol BuiltinEffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 89 of file LoadEffects.cpp.

{
   return XO("Builtin Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol BuiltinEffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 94 of file LoadEffects.cpp.

{
   return XO("The Audacity Team");
}

References XO().

Here is the call graph for this function:

GetVersion()

wxString BuiltinEffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 99 of file LoadEffects.cpp.

{
   // This "may" be different if this were to be maintained as a separate DLL
   return AUDACITY_VERSION_STRING;
}

Initialize()

bool BuiltinEffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 114 of file LoadEffects.cpp.

{
   for ( const auto &entry : Entry::Registry() ) {
      auto path = wxString(BUILTIN_EFFECT_PREFIX) + entry.name.Internal();
      mEffects[ path ] = &entry;
   }
   sInitialized = true;
   return true;
}

References BUILTIN_EFFECT_PREFIX, entry, mEffects, BuiltinEffectsModule::Entry::Registry(), and sInitialized.

Here is the call graph for this function:

InstallPath()

FilePath BuiltinEffectsModule::InstallPath ( )

inlineoverridevirtual

Where plug-in files should be copied to install them.

Returns

may be empty. Drag-and-drop is supported only if GetFileExtensions() returns nonempty and this function returns nonempty.

Implements PluginProvider.

Definition at line 61 of file LoadEffects.h.

{ return {}; }

Instantiate()

std::unique_ptr< Effect > BuiltinEffectsModule::Instantiate ( const PluginPath &  path )

private

Definition at line 212 of file LoadEffects.cpp.

{
   wxASSERT(path.StartsWith(BUILTIN_EFFECT_PREFIX));
   auto iter = mEffects.find( path );
   if ( iter != mEffects.end() )
      return iter->second->factory();
 
   wxASSERT( false );
   return nullptr;
}

References BUILTIN_EFFECT_PREFIX, and mEffects.

Referenced by DiscoverPluginsAtPath(), and LoadPlugin().

Here is the caller graph for this function:

LoadPlugin()

std::unique_ptr< ComponentInterface > BuiltinEffectsModule::LoadPlugin ( const PluginPath &  path )

overridevirtual

Load the plug-in at a path reported by DiscoverPluginsAtPath.

Returns

smart pointer managing the later unloading

Implements PluginProvider.

Definition at line 197 of file LoadEffects.cpp.

{
   // Acquires a resource for the application.
   return Instantiate(path);
}

References Instantiate().

Here is the call graph for this function:

Terminate()

void BuiltinEffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 124 of file LoadEffects.cpp.

{
   // Nothing to do here
   return;
}

Member Data Documentation

mEffects

EffectHash BuiltinEffectsModule::mEffects

private

Definition at line 87 of file LoadEffects.h.

Referenced by AutoRegisterPlugins(), CheckPluginExist(), FindModulePaths(), Initialize(), and Instantiate().

---

The documentation for this class was generated from the following files:

• LoadEffects.h
• LoadEffects.cpp