PluginManager maintains a list of all plug ins. That covers modules, effects, generators, analysis-effects, commands. It also has functions for shared and private configs - which need to move out. More...

#include <PluginManager.h>

Inheritance diagram for PluginManager:

[legend]

Collaboration diagram for PluginManager:

[legend]

Classes
class	Iterator

struct	Range

Public Types
using	FileConfigFactory = std::function< std::unique_ptr< FileConfig >(const FilePath &localFilename) >

Public Types inherited from PluginManagerInterface
using	ConfigurationType = PluginSettings::ConfigurationType

using	ConfigReference = PluginSettings::ConfigReference

using	ConfigConstReference = PluginSettings::ConfigConstReference

Public Member Functions
RegistryPath	GetPluginEnabledSetting (const PluginID &ID) const

RegistryPath	GetPluginEnabledSetting (const PluginDescriptor &desc) const

bool	IsPluginRegistered (const PluginPath &path, const TranslatableString *pSymbol) override
	Was the plugin registry already populated for a path (maybe from loading the config file)? More...

bool	IsPluginLoaded (const wxString &ID) const

void	RegisterPlugin (PluginDescriptor &&desc)

const PluginID &	RegisterPlugin (PluginProvider *provider) override

const PluginID &	RegisterPlugin (PluginProvider provider, ComponentInterface command)

const PluginID &	RegisterPlugin (PluginProvider provider, EffectDefinitionInterface effect, int type) override

void	FindFilesInPathList (const wxString &pattern, const FilePaths &pathList, FilePaths &files, bool directories=false) override

bool	HasConfigGroup (ConfigurationType type, const PluginID &ID, const RegistryPath &group)

bool	GetConfigSubgroups (ConfigurationType type, const PluginID &ID, const RegistryPath &group, RegistryPaths &subgroups) override

bool	HasConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key) override

bool	GetConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key, ConfigReference var, ConfigConstReference defval) override

bool	SetConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key, ConfigConstReference value) override

bool	RemoveConfigSubgroup (ConfigurationType type, const PluginID &ID, const RegistryPath &group) override

bool	RemoveConfig (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key) override

void	Initialize (FileConfigFactory factory)

void	Terminate ()

bool	DropFile (const wxString &fileName)

int	GetPluginCount (PluginType type)

const PluginDescriptor *	GetPlugin (const PluginID &ID) const

bool	IsPluginEnabled (const PluginID &ID)

void	EnablePlugin (const PluginID &ID, bool enable)

const ComponentInterfaceSymbol &	GetSymbol (const PluginID &ID)

ComponentInterface *	Load (const PluginID &ID)

void	ClearEffectPlugins ()

std::map< wxString, std::vector< wxString > >	CheckPluginUpdates ()
	Ensures that all currently registered plugins still exist and scans for new ones. More...

const PluginID &	RegisterPlugin (std::unique_ptr< EffectDefinitionInterface > effect, PluginType type)
	Used only by Nyquist Workbench module. More...

void	UnregisterPlugin (const PluginID &ID)

void	Load ()
	Load from preferences. More...

void	Save ()
	Save to preferences. More...

const PluginRegistryVersion &	GetRegistryVersion () const override

iteration over plugins of certain types, supporting range-for syntax
Range	AllPlugins ()

Range	PluginsOfType (int type)

Range	EffectsOfType (EffectType type)

Public Member Functions inherited from PluginManagerInterface
virtual	~PluginManagerInterface ()

virtual bool	IsPluginRegistered (const PluginPath &path, const TranslatableString *pName=nullptr)=0
	Was the plugin registry already populated for a path (maybe from loading the config file)? More...

virtual const PluginID &	RegisterPlugin (PluginProvider *provider)=0

virtual const PluginID &	RegisterPlugin (PluginProvider provider, EffectDefinitionInterface effect, int type)=0

virtual void	FindFilesInPathList (const wxString &pattern, const FilePaths &pathList, FilePaths &files, bool directories=false)=0

virtual bool	GetConfigSubgroups (ConfigurationType type, const PluginID &ID, const RegistryPath &group, RegistryPaths &subgroups)=0

virtual bool	HasConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key)=0

virtual bool	GetConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key, ConfigReference var, ConfigConstReference defval)=0

virtual bool	SetConfigValue (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key, ConfigConstReference value)=0

virtual bool	RemoveConfigSubgroup (ConfigurationType type, const PluginID &ID, const RegistryPath &group)=0

virtual bool	RemoveConfig (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key)=0

virtual const PluginRegistryVersion &	GetRegistryVersion () const =0
	What is the plugin registry version number now in the file? More...

Static Public Member Functions
static PluginManager &	Get ()

static PluginID	GetID (PluginProvider *provider)

static PluginID	GetID (ComponentInterface *command)

static PluginID	OldGetID (const EffectDefinitionInterface *effect)

static PluginID	GetID (const EffectDefinitionInterface *effect)

static Identifier	GetEffectNameFromID (const PluginID &ID)

static wxString	GetPluginTypeString (PluginType type)

Static Public Member Functions inherited from PluginManagerInterface
static const PluginID &	DefaultRegistrationCallback (PluginProvider provider, ComponentInterface ident)

static const PluginID &	AudacityCommandRegistrationCallback (PluginProvider provider, ComponentInterface ident)

Private Member Functions
	PluginManager ()

	~PluginManager ()

void	InitializePlugins ()

void	LoadGroup (FileConfig *pRegistry, PluginType type)

void	SaveGroup (FileConfig *pRegistry, PluginType type)

PluginDescriptor &	CreatePlugin (const PluginID &id, ComponentInterface *ident, PluginType type)

FileConfig *	GetSettings ()

bool	HasGroup (const RegistryPath &group)

bool	GetSubgroups (const RegistryPath &group, RegistryPaths &subgroups)

bool	HasConfigValue (const RegistryPath &key)

bool	GetConfigValue (const RegistryPath &key, ConfigReference var, ConfigConstReference defval)

bool	SetConfigValue (const RegistryPath &key, ConfigConstReference value)

RegistryPath	SettingsPath (ConfigurationType type, const PluginID &ID)

RegistryPath	Group (ConfigurationType type, const PluginID &ID, const RegistryPath &group)

RegistryPath	Key (ConfigurationType type, const PluginID &ID, const RegistryPath &group, const RegistryPath &key)

wxString	ConvertID (const PluginID &ID)

bool	IsDirty ()

void	SetDirty (bool dirty=true)

Private Attributes
std::unique_ptr< FileConfig >	mSettings

bool	mDirty

int	mCurrentIndex

PluginMap	mRegisteredPlugins

std::map< PluginID, std::unique_ptr< ComponentInterface > >	mLoadedInterfaces

std::vector< PluginDescriptor >	mEffectPluginsCleared

PluginRegistryVersion	mRegver

Static Private Attributes
static std::unique_ptr< PluginManager >	mInstance {}

Detailed Description

PluginManager maintains a list of all plug ins. That covers modules, effects, generators, analysis-effects, commands. It also has functions for shared and private configs - which need to move out.

Definition at line 41 of file PluginManager.h.

Member Typedef Documentation

◆ FileConfigFactory

using PluginManager::FileConfigFactory = std::function< std::unique_ptr<FileConfig>(const FilePath &localFilename ) >

Definition at line 91 of file PluginManager.h.

Constructor & Destructor Documentation

◆ PluginManager()

PluginManager::PluginManager ( )

private

Definition at line 329 of file PluginManager.cpp.

{
   mSettings = NULL;
}

References mSettings.

◆ ~PluginManager()

PluginManager::~PluginManager ( )

private

Definition at line 334 of file PluginManager.cpp.

{
   // Ensure termination (harmless if already done)
   Terminate();
}

References Terminate().

Here is the call graph for this function:

Member Function Documentation

◆ AllPlugins()

Range PluginManager::AllPlugins ( )

inline

Definition at line 146 of file PluginManager.h.

146{ return { Iterator{ *this } }; }

Referenced by PluginRegistrationDialog::PopulateItemsList().

Here is the caller graph for this function:

◆ CheckPluginUpdates()

std::map< wxString, std::vector< wxString > > PluginManager::CheckPluginUpdates ( )

Ensures that all currently registered plugins still exist and scans for new ones.

Returns: Map, where each module path(key) is associated with at least one provider id

Definition at line 1188 of file PluginManager.cpp.

{
   wxArrayString pathIndex;
   for (auto &pair : mRegisteredPlugins) {
      auto &plug = pair.second;
 
      // Bypass 2.1.0 placeholders...remove this after a few releases past 2.1.0
      if (plug.GetPluginType() != PluginTypeNone)
         pathIndex.push_back(plug.GetPath().BeforeFirst(wxT(';')));
   }
 
   // Scan for NEW ones.
   //
   // Because we use the plugins "path" as returned by the providers, we can actually
   // have multiple providers report the same path since, at this point, they only
   // know that the path might possibly be one supported by the provider.
   //
   // When the user enables the plugin, each provider that reported it will be asked
   // to register the plugin.
 
   auto& moduleManager = ModuleManager::Get();
   std::map<wxString, std::vector<wxString>> newPaths;
   for(auto& [id, provider] : moduleManager.Providers())
   {
      const auto paths = provider->FindModulePaths(*this);
      for(const auto& path : paths)
      {
         const auto modulePath = path.BeforeFirst(';');
         if (!make_iterator_range(pathIndex).contains(modulePath) ||
            make_iterator_range(mEffectPluginsCleared).any_of([&modulePath](const PluginDescriptor& plug) {
               return plug.GetPath().BeforeFirst(wxT(';')) == modulePath;
            })
         )
         {
            newPaths[modulePath].push_back(id);
         }
      }
   }
 
   return newPaths;
}

References ModuleManager::Get(), PluginDescriptor::GetPath(), make_iterator_range(), mEffectPluginsCleared, mRegisteredPlugins, PluginTypeNone, and wxT().

Referenced by AudacityApp::InitPart2(), and PluginRegistrationDialog::OnRescan().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearEffectPlugins()

void PluginManager::ClearEffectPlugins ( )

Definition at line 1153 of file PluginManager.cpp.

{
   mEffectPluginsCleared.clear();
 
   for ( auto it = mRegisteredPlugins.cbegin(); it != mRegisteredPlugins.cend(); )
   {
      const auto& desc = it->second;
      const auto type = desc.GetPluginType();
 
      if (type == PluginTypeEffect || type == PluginTypeStub)
      {
         mEffectPluginsCleared.push_back(desc);
         it = mRegisteredPlugins.erase(it);
      }
      else
      {
         ++it;
      }
   }
 
   // Repeat what usually happens at startup
   // This prevents built-in plugins to appear in the plugin validation list
   for (auto& [_, provider] : ModuleManager::Get().Providers())
      provider->AutoRegisterPlugins(*this);
 
   // Remove auto registered plugins from "cleared" list
   for ( auto it = mEffectPluginsCleared.begin(); it != mEffectPluginsCleared.end(); )
   {
      if ( mRegisteredPlugins.find(it->GetID()) != mRegisteredPlugins.end() )
         it = mEffectPluginsCleared.erase(it);
      else
         ++it;
   }
}

References _, desc, ModuleManager::Get(), mEffectPluginsCleared, mRegisteredPlugins, PluginTypeEffect, and PluginTypeStub.

Here is the call graph for this function:

◆ ConvertID()

wxString PluginManager::ConvertID ( const PluginID & ID )

private

Definition at line 1493 of file PluginManager.cpp.

{
   if (ID.StartsWith(wxT("base64:")))
   {
      wxString id = ID.Mid(7);
      ArrayOf<char> buf{ id.length() / 4 * 3 };
      id =  wxString::FromUTF8(buf.get(), Base64::Decode(id, buf.get()));
      return id;
   }
 
   const wxCharBuffer & buf = ID.ToUTF8();
   return wxT("base64:") + Base64::Encode(buf, strlen(buf));
}

References Base64::Decode(), Base64::Encode(), id, and wxT().

Referenced by LoadGroup(), SaveGroup(), and SettingsPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreatePlugin()

PluginDescriptor & PluginManager::CreatePlugin	(	const PluginID &	id,
		ComponentInterface *	ident,
		PluginType	type
	)

private

Definition at line 1309 of file PluginManager.cpp.

{
   // This will either create a NEW entry or replace an existing entry
   PluginDescriptor & plug = mRegisteredPlugins[id];
 
   plug.SetPluginType(type);
 
   plug.SetID(id);
   plug.SetPath(ident->GetPath());
   plug.SetSymbol(ident->GetSymbol());
   plug.SetVendor(ident->GetVendor().Internal());
   plug.SetVersion(ident->GetVersion());
 
   return plug;
}

References id, ident(), mRegisteredPlugins, PluginDescriptor::SetID(), PluginDescriptor::SetPath(), PluginDescriptor::SetPluginType(), PluginDescriptor::SetSymbol(), PluginDescriptor::SetVendor(), and PluginDescriptor::SetVersion().

Referenced by RegisterPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DropFile()

bool PluginManager::DropFile ( const wxString & fileName )

Definition at line 424 of file PluginManager.cpp.

{
   using namespace BasicUI;
   auto &mm = ModuleManager::Get();
   const wxFileName src{ fileName };
 
   for (auto &plug : PluginsOfType(PluginTypeModule)) {
      auto module = static_cast<PluginProvider *>
         (mm.CreateProviderInstance(plug.GetID(), plug.GetPath()));
      if (! module)
         continue;
 
      const auto &ff = module->InstallPath();
      const auto &extensions = module->GetFileExtensions();
      if ( !ff.empty() &&
          extensions.Index(src.GetExt(), false) != wxNOT_FOUND ) {
         TranslatableString errMsg;
         // Do dry-run test of the file format
         unsigned nPlugIns =
            module->DiscoverPluginsAtPath(fileName, errMsg, {});
         if (nPlugIns) {
            // File contents are good for this module, so check no others.
            // All branches of this block return true, even in case of
            // failure for other reasons, to signal that other drag-and-drop
            // actions should not be tried.
 
            // Find path to copy it
            wxFileName dst;
            dst.AssignDir( ff );
            dst.SetFullName( src.GetFullName() );
            if ( dst.Exists() ) {
               // Query whether to overwrite
               bool overwrite = (MessageBoxResult::Yes == ShowMessageBox(
                  XO("Overwrite the plug-in file %s?")
                     .Format( dst.GetFullPath() ),
                  MessageBoxOptions{}
                     .Caption(XO("Plug-in already exists"))
                     .ButtonStyle(Button::YesNo)));
               if ( !overwrite )
                  return true;
            }
 
            // Move the file or subtree
            bool copied = false;
            auto dstPath = dst.GetFullPath();
            if ( src.FileExists() )
               // A simple one-file plug-in
               copied = FileNames::DoCopyFile(
                  src.GetFullPath(), dstPath, true );
            else {
               // A sub-folder
               // such as for some VST packages
               // Recursive copy needed -- to do
               return true;
            }
 
            if (!copied) {
               ShowMessageBox(
                  XO("Plug-in file is in use. Failed to overwrite") );
               return true;
            }
 
            // Register for real
            std::vector<PluginID> ids;
            std::vector<wxString> names;
            nPlugIns = module->DiscoverPluginsAtPath(dstPath, errMsg,
               [&](PluginProvider *provider, ComponentInterface *ident)
                                                     -> const PluginID& {
                  // Register as by default, but also collecting the PluginIDs
                  // and names
                  auto &id = PluginManagerInterface::DefaultRegistrationCallback(
                        provider, ident);
                  ids.push_back(id);
                  names.push_back( ident->GetSymbol().Translation() );
                  return id;
               });
            if ( ! nPlugIns ) {
               // Unlikely after the dry run succeeded
               ShowMessageBox(
                  XO("Failed to register:\n%s").Format( errMsg ) );
               return true;
            }
 
            // Ask whether to enable the plug-ins
            if (auto nIds = ids.size()) {
               auto message = XPC(
               /* i18n-hint A plug-in is an optional added program for a sound
                effect, or generator, or analyzer */
                  "Enable this plug-in?\n",
                  "Enable these plug-ins?\n",
                  0,
                  "plug-ins"
               )( nIds );
               for (const auto &name : names)
                  message.Join( Verbatim( name ), wxT("\n") );
               bool enable = (MessageBoxResult::Yes == ShowMessageBox(
                  message,
                  MessageBoxOptions{}
                     .Caption(XO("Enable new plug-ins"))
                     .ButtonStyle(Button::YesNo)));
               for (const auto &id : ids)
                  mRegisteredPlugins[id].SetEnabled(enable);
               // Make changes to enabled status persist:
               this->Save();
            }
 
            return true;
         }
      }
   }
   
   return false;
}

References BasicUI::MessageBoxOptions::Caption(), PluginManagerInterface::DefaultRegistrationCallback(), FileNames::DoCopyFile(), ModuleManager::Get(), id, ident(), PluginProvider::InstallPath(), mRegisteredPlugins, name, names, PluginsOfType(), PluginTypeModule, Save(), BasicUI::ShowMessageBox(), Verbatim(), wxT(), XO, and XPC.

Here is the call graph for this function:

◆ EffectsOfType()

Range PluginManager::EffectsOfType ( EffectType type )

inline

Definition at line 148 of file PluginManager.h.

148{ return { Iterator{ *this, type } }; }

Referenced by anonymous_namespace{PluginMenus.cpp}::PopulateEffectsMenu().

Here is the caller graph for this function:

◆ EnablePlugin()

void PluginManager::EnablePlugin	(	const PluginID &	ID,
		bool	enable
	)

Definition at line 1112 of file PluginManager.cpp.

{
   if (auto iter = mRegisteredPlugins.find(ID); iter == mRegisteredPlugins.end())
      return;
   else
      iter->second.SetEnabled(enable);
}

References mRegisteredPlugins.

◆ FindFilesInPathList()

void PluginManager::FindFilesInPathList	(	const wxString &	pattern,
		const FilePaths &	pathList,
		FilePaths &	files,
		bool	directories = `false`
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 203 of file PluginManager.cpp.

{
   
   wxLogNull nolog;
 
   // Why bother...
   if (pattern.empty())
   {
      return;
   }
 
   // TODO:  We REALLY need to figure out the "Audacity" plug-in path(s)
 
   FilePaths paths;
 
   // Add the "per-user" plug-ins directory
   {
      const wxFileName &ff = FileNames::PlugInDir();
      paths.push_back(ff.GetFullPath());
   }
 
   // Add the "Audacity" plug-ins directory
   wxFileName ff = PlatformCompatibility::GetExecutablePath();
#if defined(__WXMAC__)
   // Path ends for example in "Audacity.app/Contents/MacOSX"
   //ff.RemoveLastDir();
   //ff.RemoveLastDir();
   // just remove the MacOSX part.
   ff.RemoveLastDir();
#endif
   ff.AppendDir(wxT("plug-ins"));
   paths.push_back(ff.GetPath());
 
   // Weed out duplicates
   for (const auto &filePath : pathList)
   {
      ff = filePath;
      const wxString path{ ff.GetFullPath() };
      if (paths.Index(path, wxFileName::IsCaseSensitive()) == wxNOT_FOUND)
      {
         paths.push_back(path);
      }
   }
 
   // Find all matching files in each path
   for (size_t i = 0, cnt = paths.size(); i < cnt; i++)
   {
      ff = paths[i] + wxFILE_SEP_PATH + pattern;
      wxDir::GetAllFiles(ff.GetPath(), &files, ff.GetFullName(), directories ? wxDIR_DEFAULT : wxDIR_FILES);
   }
 
   return;
}

References PlatformCompatibility::GetExecutablePath(), FileNames::PlugInDir(), and wxT().

Here is the call graph for this function:

◆ Get()

PluginManager & PluginManager::Get ( )

static

Definition at line 378 of file PluginManager.cpp.

{
   if (!mInstance)
   {
      mInstance.reset(safenew PluginManager);
   }
 
   return *mInstance;
}

References mInstance, and safenew.

Here is the caller graph for this function:

◆ GetConfigSubgroups()

bool PluginManager::GetConfigSubgroups	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		RegistryPaths &	subgroups
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 266 of file PluginManager.cpp.

{
   return GetSubgroups(Group(type, ID, group), subgroups);
}

References GetSubgroups(), and Group().

Here is the call graph for this function:

◆ GetConfigValue() [1/2]

bool PluginManager::GetConfigValue	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		const RegistryPath &	key,
		ConfigReference	var,
		ConfigConstReference	defval
	)

overridevirtual

Precondition: var and defval wrap references to the same type (ignoring const)

Implements PluginManagerInterface.

Definition at line 278 of file PluginManager.cpp.

{
   return GetConfigValue(Key(type, ID, group, key), var, defval);
}

References GetConfigValue(), Key(), and key.

Referenced by GetConfigValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetConfigValue() [2/2]

bool PluginManager::GetConfigValue	(	const RegistryPath &	key,
		ConfigReference	var,
		ConfigConstReference	defval
	)

private

Definition at line 1404 of file PluginManager.cpp.

{
   if (key.empty())
      return false;
   const auto visitor = [&](const auto var){
      const auto pVar = &var.get();
      // precondition is that defval wraps same type as var
      using Type = typename decltype(var)::type;
      const auto pDefval =
         std::get_if<std::reference_wrapper<const Type>>(&defval);
      return GetSettings()->Read(key, pVar, *pDefval);
   };
   return Visit(visitor, var);
}

References GetSettings(), key, and Visit().

Here is the call graph for this function:

◆ GetEffectNameFromID()

Identifier PluginManager::GetEffectNameFromID ( const PluginID & ID )

static

Parse English effect name from the result of GetID(const EffectDefinitionInterface*)

Definition at line 1266 of file PluginManager.cpp.

{
   auto strings = wxSplit(ID, '_');
   if (strings.size() == 5)
      return strings[3];
   return {};
}

Referenced by anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::GetEffectName().

Here is the caller graph for this function:

◆ GetID() [1/3]

PluginID PluginManager::GetID ( ComponentInterface * command )

static

Definition at line 1235 of file PluginManager.cpp.

{
   return wxString::Format(wxT("%s_%s_%s_%s_%s"),
                           GetPluginTypeString(PluginTypeAudacityCommand),
                           wxEmptyString,
                           command->GetVendor().Internal(),
                           command->GetSymbol().Internal(),
                           command->GetPath());
}

References ComponentInterface::GetPath(), GetPluginTypeString(), ComponentInterface::GetSymbol(), ComponentInterface::GetVendor(), ComponentInterfaceSymbol::Internal(), PluginTypeAudacityCommand, and wxT().

Here is the call graph for this function:

◆ GetID() [2/3]

PluginID PluginManager::GetID ( const EffectDefinitionInterface * effect )

static

Definition at line 1255 of file PluginManager.cpp.

{
   return wxJoin(wxArrayStringEx{
      GetPluginTypeString(PluginTypeEffect),
      effect->GetFamily().Internal(),
      effect->GetVendor().Internal(),
      effect->GetSymbol().Internal(),
      effect->GetPath()
   }, '_');
}

References EffectDefinitionInterface::GetFamily(), ComponentInterface::GetPath(), GetPluginTypeString(), ComponentInterface::GetSymbol(), ComponentInterface::GetVendor(), ComponentInterfaceSymbol::Internal(), and PluginTypeEffect.

Here is the call graph for this function:

◆ GetID() [3/3]

PluginID PluginManager::GetID ( PluginProvider * provider )

static

Definition at line 1230 of file PluginManager.cpp.

{
   return ModuleManager::GetID(provider);
}

References ModuleManager::GetID().

Referenced by GetID(), RegisterPlugin(), and RealtimeEffectState::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlugin()

const PluginDescriptor * PluginManager::GetPlugin ( const PluginID & ID ) const

Definition at line 1036 of file PluginManager.cpp.

{
   if (auto iter = mRegisteredPlugins.find(ID); iter != mRegisteredPlugins.end())
      return &iter->second;
 
   auto iter2 = make_iterator_range(mEffectPluginsCleared)
      .find_if([&ID](const PluginDescriptor& plug) {
         return plug.GetID() == ID;
      });
   if (iter2 != mEffectPluginsCleared.end())
      return &(*iter2);
 
   return nullptr;
}

References PluginDescriptor::GetID(), make_iterator_range(), mEffectPluginsCleared, and mRegisteredPlugins.

Referenced by anonymous_namespace{PluginMenus.cpp}::AddEffectMenuItemGroup(), MacroCommands::ApplyEffectCommand(), MacroCommands::DoAudacityCommand(), EffectUI::DoEffect(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::GetPlugin(), GetPluginEnabledSetting(), EffectManager::SupportsAutomation(), and anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPluginCount()

int PluginManager::GetPluginCount ( PluginType type )

Definition at line 1030 of file PluginManager.cpp.

{
   return count_if(mRegisteredPlugins.begin(), mRegisteredPlugins.end(), [type](auto &pair){
      return pair.second.GetPluginType() == type; });
}

References mRegisteredPlugins.

◆ GetPluginEnabledSetting() [1/2]

RegistryPath PluginManager::GetPluginEnabledSetting ( const PluginDescriptor & desc ) const

Definition at line 111 of file PluginManager.cpp.

{
   switch ( desc.GetPluginType() ) {
      case PluginTypeModule: {
         // Retrieve optional family symbol that was recorded in
         // RegisterPlugin() for the module
         auto family = desc.GetEffectFamily();
         if ( family.empty() ) // as for built-in effect and command modules
            return {};
         else
            return wxT('/') + family + wxT("/Enable");
      }
      case PluginTypeEffect:
         // do NOT use GetEffectFamily() for this descriptor, but instead,
         // delegate to the plugin descriptor of the provider, which may
         // be different (may be empty)
         return GetPluginEnabledSetting( desc.GetProviderID() );
      default:
         return {};
   }
}

References desc, GetPluginEnabledSetting(), PluginTypeEffect, PluginTypeModule, and wxT().

Here is the call graph for this function:

◆ GetPluginEnabledSetting() [2/2]

RegistryPath PluginManager::GetPluginEnabledSetting ( const PluginID & ID ) const

Definition at line 103 of file PluginManager.cpp.

{
   auto pPlugin = GetPlugin( ID );
   if ( pPlugin )
      return GetPluginEnabledSetting( *pPlugin );
   return {};
}

References GetPlugin(), and GetPluginEnabledSetting().

Referenced by PluginManager::Iterator::Advance(), and GetPluginEnabledSetting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPluginTypeString()

wxString PluginManager::GetPluginTypeString ( PluginType type )

static

Definition at line 1276 of file PluginManager.cpp.

{
   wxString str;
 
   switch (type)
   {
   default:
   case PluginTypeNone:
      str = wxT("Placeholder");
      break;
   case PluginTypeStub:
      str = wxT("Stub");
      break;
   case PluginTypeEffect:
      str = wxT("Effect");
      break;
   case PluginTypeAudacityCommand:
      str = wxT("Generic");
      break;
   case PluginTypeExporter:
      str = wxT("Exporter");
      break;
   case PluginTypeImporter:
      str = wxT("Importer");
      break;
   case PluginTypeModule:
      str = ModuleManager::GetPluginTypeString();
      break;
   }
 
   return str;
}

References ModuleManager::GetPluginTypeString(), PluginTypeAudacityCommand, PluginTypeEffect, PluginTypeExporter, PluginTypeImporter, PluginTypeModule, PluginTypeNone, PluginTypeStub, str, and wxT().

Referenced by GetID(), Load(), LoadGroup(), OldGetID(), SaveGroup(), and SettingsPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRegistryVersion()

const PluginRegistryVersion & PluginManager::GetRegistryVersion ( ) const

overridevirtual

What is the plugin registry version number now in the file? (Save() updates it)

Implements PluginManagerInterface.

Definition at line 912 of file PluginManager.cpp.

{
   return mRegver;
}

References mRegver.

◆ GetSettings()

FileConfig * PluginManager::GetSettings ( )

private

Definition at line 1327 of file PluginManager.cpp.

{
   if (!mSettings)
   {
      mSettings = sFactory(FileNames::PluginSettings());
 
      // Check for a settings version that we can understand
      if (mSettings->HasEntry(SETVERKEY))
      {
         wxString setver = mSettings->Read(SETVERKEY, SETVERKEY);
         if (setver < SETVERCUR )
         {
            // This is where we'd put in conversion code when the
            // settings version changes.
            //
            // Should also check for a settings file that is newer than
            // what we can understand.
         }
      }
      else
      {
         // Make sure is has a version string
         mSettings->Write(SETVERKEY, SETVERCUR);
         mSettings->Flush();
      }
   }
 
   return mSettings.get();
}

References mSettings, FileNames::PluginSettings(), SETVERCUR, SETVERKEY, and sFactory.

Referenced by GetConfigValue(), GetSubgroups(), HasConfigValue(), HasGroup(), Initialize(), RemoveConfig(), RemoveConfigSubgroup(), and SetConfigValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSubgroups()

bool PluginManager::GetSubgroups	(	const RegistryPath &	group,
		RegistryPaths &	subgroups
	)

private

Definition at line 1374 of file PluginManager.cpp.

{
   if (group.empty() || !HasGroup(group))
   {
      return false;
   }
 
   wxString path = GetSettings()->GetPath();
   GetSettings()->SetPath(group);
 
   wxString name;
   long index = 0;
   if (GetSettings()->GetFirstGroup(name, index))
   {
      do
      {
         subgroups.push_back(name);
      } while (GetSettings()->GetNextGroup(name, index));
   }
 
   GetSettings()->SetPath(path);
 
   return true;
}

References FileConfig::GetPath(), GetSettings(), HasGroup(), name, and FileConfig::SetPath().

Referenced by GetConfigSubgroups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

const ComponentInterfaceSymbol & PluginManager::GetSymbol ( const PluginID & ID )

Definition at line 1120 of file PluginManager.cpp.

{
   if (auto iter = mRegisteredPlugins.find(ID); iter == mRegisteredPlugins.end()) {
      static ComponentInterfaceSymbol empty;
      return empty;
   }
   else
      return iter->second.GetSymbol();
}

References mRegisteredPlugins.

Referenced by EffectManager::GetCommandIdentifier(), EffectManager::GetCommandSymbol(), and ComponentInterface::GetName().

Here is the caller graph for this function:

◆ Group()

RegistryPath PluginManager::Group	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group
	)

private

Definition at line 1464 of file PluginManager.cpp.

{
   auto path = SettingsPath(type, ID);
 
   wxFileName ff(group);
   if (!ff.GetName().empty())
   {
      path += ff.GetFullPath(wxPATH_UNIX) + wxCONFIG_PATH_SEPARATOR;
   }
 
   return path;
}

References SettingsPath().

Referenced by GetConfigSubgroups(), HasConfigGroup(), Key(), and RemoveConfigSubgroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasConfigGroup()

bool PluginManager::HasConfigGroup	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group
	)

Definition at line 260 of file PluginManager.cpp.

{
   return HasGroup(Group(type, ID, group));
}

References Group(), and HasGroup().

Here is the call graph for this function:

◆ HasConfigValue() [1/2]

bool PluginManager::HasConfigValue	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		const RegistryPath &	key
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 272 of file PluginManager.cpp.

{
   return HasConfigValue(Key(type, ID, group, key));
}

References HasConfigValue(), Key(), and key.

Referenced by HasConfigValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasConfigValue() [2/2]

bool PluginManager::HasConfigValue ( const RegistryPath & key )

private

Definition at line 1399 of file PluginManager.cpp.

{
   return GetSettings()->Exists(key);
}

References GetSettings(), and key.

Here is the call graph for this function:

◆ HasGroup()

bool PluginManager::HasGroup ( const RegistryPath & group )

private

Definition at line 1357 of file PluginManager.cpp.

{
   auto settings = GetSettings();
 
   bool res = settings->HasGroup(group);
   if (res)
   {
      // The group exists, but empty groups aren't considered valid
      wxString oldPath = settings->GetPath();
      settings->SetPath(group);
      res = settings->GetNumberOfEntries() || settings->GetNumberOfGroups();
      settings->SetPath(oldPath);
   }
 
   return res;
}

References GetSettings(), and settings().

Referenced by GetSubgroups(), and HasConfigGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize()

void PluginManager::Initialize ( FileConfigFactory factory )

Precondition: factory != nullptr

Definition at line 388 of file PluginManager.cpp.

{
   sFactory = move(factory);
 
   // Always load the registry first
   Load();
 
   // And force load of setting to verify it's accessible
   GetSettings();
 
   auto &mm = ModuleManager::Get();
   mm.DiscoverProviders();
   for (auto& [id, module] : mm.Providers()) {
      RegisterPlugin(module.get());
      // Allow the module to auto-register children
      module->AutoRegisterPlugins(*this);
   }
 
   InitializePlugins();
}

References cloud::factory, ModuleManager::Get(), GetSettings(), InitializePlugins(), Load(), RegisterPlugin(), and sFactory.

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializePlugins()

void PluginManager::InitializePlugins ( )

private

Definition at line 340 of file PluginManager.cpp.

{
   ModuleManager & moduleManager = ModuleManager::Get();
   //ModuleManager::DiscoverProviders was called earlier, so we
   //can be sure that providers are already loaded
 
   //Check all known plugins to ensure they are still valid.
   for (auto it = mRegisteredPlugins.begin(); it != mRegisteredPlugins.end();) {
      auto &pluginDesc = it->second;
      const auto pluginType = pluginDesc.GetPluginType();
      if(pluginType == PluginTypeNone || pluginType == PluginTypeModule)
      {
         ++it;
         continue;
      }
 
      if(!moduleManager.CheckPluginExist(pluginDesc.GetProviderID(), pluginDesc.GetPath()))
         it = mRegisteredPlugins.erase(it);
      else
         ++it;
   }
 
   Save();
}

References ModuleManager::CheckPluginExist(), ModuleManager::Get(), mRegisteredPlugins, PluginTypeModule, PluginTypeNone, and Save().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDirty()

bool PluginManager::IsDirty ( )

private

◆ IsPluginEnabled()

bool PluginManager::IsPluginEnabled ( const PluginID & ID )

Definition at line 1104 of file PluginManager.cpp.

{
   if (auto iter = mRegisteredPlugins.find(ID); iter == mRegisteredPlugins.end())
      return false;
   else
      return iter->second.IsEnabled();
}

References mRegisteredPlugins.

◆ IsPluginLoaded()

bool PluginManager::IsPluginLoaded ( const wxString & ID ) const

Definition at line 148 of file PluginManager.cpp.

{
   return mLoadedInterfaces.find(ID) != mLoadedInterfaces.end();
}

References mLoadedInterfaces.

◆ IsPluginRegistered()

bool PluginManager::IsPluginRegistered	(	const PluginPath &	path,
		const TranslatableString *	pName
	)

overridevirtual

Was the plugin registry already populated for a path (maybe from loading the config file)?

Parameters

path	an identifier for the plug-in with meaning defined by provider; not always a file path
pName	if supplied, a correction for the user visible name associated with the plug-in, if it is registered already. (Needed because the configuration file only stores an internal name.)

Implements PluginManagerInterface.

Definition at line 134 of file PluginManager.cpp.

{
   for (auto &pair : mRegisteredPlugins) {
      if (auto &descriptor = pair.second; descriptor.GetPath() == path) {
         if (pName)
            descriptor.SetSymbol(
               { descriptor.GetSymbol().Internal(), *pName });
         return true;
      }
   }
   return false;
}

References Internal, and mRegisteredPlugins.

◆ Key()

RegistryPath PluginManager::Key	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		const RegistryPath &	key
	)

private

Definition at line 1479 of file PluginManager.cpp.

{
   auto path = Group(type, ID, group);
   if (path.empty())
   {
      return path;
   }
 
   return path + key;
}

References Group(), and key.

Referenced by GetConfigValue(), HasConfigValue(), RemoveConfig(), and SetConfigValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Load() [1/2]

void PluginManager::Load ( )

Load from preferences.

Definition at line 538 of file PluginManager.cpp.

{
   // Create/Open the registry
   auto pRegistry = sFactory(FileNames::PluginRegistry());
   auto &registry = *pRegistry;
 
   // If this group doesn't exist then we have something that's not a registry.
   // We should probably warn the user, but it's pretty unlikely that this will happen.
   if (!registry.HasGroup(REGROOT))
   {
      // Must start over
      // This DeleteAll affects pluginregistry.cfg only, not audacity.cfg
      // That is, the memory of on/off states of effect (and generator,
      // analyzer, and tool) plug-ins
      registry.DeleteAll();
      registry.Flush();
      return;
   }
 
   // Check for a registry version that we can understand
   // TODO: Should also check for a registry file that is newer than
   // what we can understand.
   mRegver = registry.Read(REGVERKEY);
   if (Regver_lt(mRegver, "1.1")) {
      // Conversion code here, for when registry version changes.
 
      // We iterate through the effects, possibly updating their info.
      wxString groupName;
      long groupIndex;
      wxString group = GetPluginTypeString(PluginTypeEffect);
      wxString cfgPath = REGROOT + group + wxCONFIG_PATH_SEPARATOR;
      wxArrayString groupsToDelete;
 
      registry.SetPath(cfgPath);
      for (bool cont = registry.GetFirstGroup(groupName, groupIndex);
         cont;
         registry.SetPath(cfgPath),
         cont = registry.GetNextGroup(groupName, groupIndex))
      {
         registry.SetPath(groupName);
         wxString effectSymbol = registry.Read(KEY_SYMBOL, "");
         wxString effectVersion = registry.Read(KEY_VERSION, "");
 
 
         // For 2.3.0 the plugins we distribute have moved around.
         // So we upped the registry version number to 1.1.
         // These particular config edits were originally written to fix Bug 1914.
         if (Regver_le(mRegver, "1.0")) {
            // Nyquist prompt is a built-in that has moved to the tools menu.
            if (effectSymbol == NYQUIST_PROMPT_ID) {
               registry.Write(KEY_EFFECTTYPE, "Tool");
            // Old version of SDE was in Analyze menu.  Now it is in Tools.
            // We don't want both the old and the new.
            } else if ((effectSymbol == "Sample Data Export") && (effectVersion == "n/a")) {
               groupsToDelete.push_back(cfgPath + groupName);
            // Old version of SDI was in Generate menu.  Now it is in Tools.
            } else if ((effectSymbol == "Sample Data Import") && (effectVersion == "n/a")) {
               groupsToDelete.push_back(cfgPath + groupName);
            }
         }
 
      }
      // Doing the deletion within the search loop risked skipping some items,
      // hence the delayed delete.
      for (unsigned int i = 0; i < groupsToDelete.size(); i++) {
         registry.DeleteGroup(groupsToDelete[i]);
      }
      registry.SetPath("");
      // Updates done.  Make sure we read the updated data later.
      registry.Flush();
   }
 
   // Load all provider plugins first
   LoadGroup(&registry, PluginTypeModule);
 
   // Now the rest
   LoadGroup(&registry, PluginTypeEffect);
   LoadGroup(&registry, PluginTypeAudacityCommand );
   LoadGroup(&registry, PluginTypeExporter);
   LoadGroup(&registry, PluginTypeImporter);
 
   LoadGroup(&registry, PluginTypeStub);
   return;
}

References GetPluginTypeString(), KEY_EFFECTTYPE, KEY_SYMBOL, KEY_VERSION, LoadGroup(), mRegver, NYQUIST_PROMPT_ID, FileNames::PluginRegistry(), PluginTypeAudacityCommand, PluginTypeEffect, PluginTypeExporter, PluginTypeImporter, PluginTypeModule, PluginTypeStub, REGROOT, Regver_le(), Regver_lt(), REGVERKEY, and sFactory.

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Load() [2/2]

ComponentInterface * PluginManager::Load ( const PluginID & ID )

Definition at line 1130 of file PluginManager.cpp.

{
   if(auto it = mLoadedInterfaces.find(ID); it != mLoadedInterfaces.end())
      return it->second.get();
 
   if(auto it = mRegisteredPlugins.find(ID); it != mRegisteredPlugins.end())
   {
      auto& desc = it->second;
      if(desc.GetPluginType() == PluginTypeModule)
         //it's very likely that this code path is not used
         return ModuleManager::Get().CreateProviderInstance(desc.GetID(), desc.GetPath());
      
      if(auto provider = ModuleManager::Get().CreateProviderInstance(desc.GetProviderID(), wxEmptyString))
      {
         auto pluginInterface = provider->LoadPlugin(desc.GetPath());
         auto result = pluginInterface.get();
         mLoadedInterfaces[desc.GetID()] = std::move(pluginInterface);
         return result;
      }
   }
   return nullptr;
}

References ModuleManager::CreateProviderInstance(), desc, ModuleManager::Get(), PluginProvider::LoadPlugin(), mLoadedInterfaces, mRegisteredPlugins, and PluginTypeModule.

Referenced by EffectManager::GetAudacityCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadGroup()

void PluginManager::LoadGroup	(	FileConfig *	pRegistry,
		PluginType	type
	)

private

Definition at line 623 of file PluginManager.cpp.

{
#ifdef __WXMAC__
   // Bug 1590: On Mac, we should purge the registry of Nyquist plug-ins
   // bundled with other versions of Audacity, assuming both versions
   // were properly installed in /Applications (or whatever it is called in
   // your locale)
 
   const auto fullExePath = PlatformCompatibility::GetExecutablePath();
 
   // Strip rightmost path components up to *.app
   wxFileName exeFn{ fullExePath };
   exeFn.SetEmptyExt();
   exeFn.SetName(wxString{});
   while(exeFn.GetDirCount() && !exeFn.GetDirs().back().EndsWith(".app"))
      exeFn.RemoveLastDir();
 
   const auto goodPath = exeFn.GetPath();
 
   if(exeFn.GetDirCount())
      exeFn.RemoveLastDir();
   const auto possiblyBadPath = exeFn.GetPath();
 
   auto AcceptPath = [&](const wxString &path) {
      if (!path.StartsWith(possiblyBadPath))
         // Assume it's not under /Applications
         return true;
      if (path.StartsWith(goodPath))
         // It's bundled with this executable
         return true;
      return false;
   };
#else
   auto AcceptPath = [](const wxString&){ return true; };
#endif
 
   wxString strVal;
   bool boolVal;
   wxString groupName;
   long groupIndex;
   wxString group = GetPluginTypeString(type);
   wxString cfgPath = REGROOT + group + wxCONFIG_PATH_SEPARATOR;
 
   pRegistry->SetPath(cfgPath);
   for (bool cont = pRegistry->GetFirstGroup(groupName, groupIndex);
        cont;
        pRegistry->SetPath(cfgPath),
        cont = pRegistry->GetNextGroup(groupName, groupIndex))
   {
      PluginDescriptor plug;
 
      pRegistry->SetPath(groupName);
 
      groupName = ConvertID(groupName);
 
      // Bypass group if the ID is already in use
      if (mRegisteredPlugins.count(groupName))
         continue;
 
      // Set the ID and type
      plug.SetID(groupName);
      plug.SetPluginType(type);
 
      // Get the provider ID and bypass group if not found
      if (!pRegistry->Read(KEY_PROVIDERID, &strVal, wxEmptyString))
      {
         // Bypass group if the provider isn't valid
         if (!strVal.empty() && !mRegisteredPlugins.count(strVal))
            continue;
      }
      plug.SetProviderID(PluginID(strVal));
 
      // Get the path (optional)
      pRegistry->Read(KEY_PATH, &strVal, wxEmptyString);
      if (!AcceptPath(strVal))
         // Ignore the obsolete path in the config file, during session,
         // but don't remove it from the file.  Maybe you really want to
         // switch back to the other version of Audacity and lose nothing.
         continue;
      plug.SetPath(strVal);
 
      /*
       // PRL: Ignore names  written in configs before 2.3.0!
       // use Internal string only!  Let the present version of Audacity map
       // that to a user-visible string.
      // Get the name and bypass group if not found
      if (!pRegistry->Read(KEY_NAME, &strVal))
      {
         continue;
      }
      plug.SetName(strVal);
       */
 
      // Get the symbol...Audacity 2.3.0 or later requires it
      // bypass group if not found
      // Note, KEY_SYMBOL started getting written to config files in 2.1.0.
      // KEY_NAME (now ignored) was written before that, but only for VST
      // effects.
      if (!pRegistry->Read(KEY_SYMBOL, &strVal))
         continue;
 
      // Related to Bug2778: config file only remembered an internal name,
      // so this symbol may not contain the correct TranslatableString.
      // See calls to IsPluginRegistered which can correct that.
      plug.SetSymbol(strVal);
 
      // Get the version and bypass group if not found
      if (!pRegistry->Read(KEY_VERSION, &strVal))
      {
         continue;
      }
      plug.SetVersion(strVal);
 
      // Get the vendor and bypass group if not found
      if (!pRegistry->Read(KEY_VENDOR, &strVal))
      {
         continue;
      }
      plug.SetVendor( strVal );
 
#if 0
      // This was done before version 2.2.2, but the value was not really used
      // But absence of a value will cause early versions to skip the group
      // Therefore we still write a blank to keep pluginregistry.cfg
      // backwards-compatible
 
      // Get the description and bypass group if not found
      if (!pRegistry->Read(KEY_DESCRIPTION, &strVal))
      {
         continue;
      }
#endif
 
      // Is it enabled...default to no if not found
      pRegistry->Read(KEY_ENABLED, &boolVal, false);
      plug.SetEnabled(boolVal);
 
      // Is it valid...default to no if not found
      pRegistry->Read(KEY_VALID, &boolVal, false);
      plug.SetValid(boolVal);
 
      switch (type)
      {
         case PluginTypeModule:
         {
            // Nothing to do here yet
         }
         break;
 
         case PluginTypeEffect:
         {
            // Get the effect type and bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTTYPE, &strVal))
               continue;
 
            if (strVal == KEY_EFFECTTYPE_NONE)
               plug.SetEffectType(EffectTypeNone);
            else if (strVal == KEY_EFFECTTYPE_ANALYZE)
               plug.SetEffectType(EffectTypeAnalyze);
            else if (strVal == KEY_EFFECTTYPE_GENERATE)
               plug.SetEffectType(EffectTypeGenerate);
            else if (strVal == KEY_EFFECTTYPE_PROCESS)
               plug.SetEffectType(EffectTypeProcess);
            else if (strVal == KEY_EFFECTTYPE_TOOL)
               plug.SetEffectType(EffectTypeTool);
            else if (strVal == KEY_EFFECTTYPE_HIDDEN)
               plug.SetEffectType(EffectTypeHidden);
            else
               continue;
 
            // Get the effect family and bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTFAMILY, &strVal))
            {
               continue;
            }
            plug.SetEffectFamily(strVal);
 
            // Is it a default (above the line) effect and bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTDEFAULT, &boolVal))
            {
               continue;
            }
            plug.SetEffectDefault(boolVal);
 
            // Is it an interactive effect and bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTINTERACTIVE, &boolVal))
            {
               continue;
            }
            plug.SetEffectInteractive(boolVal);
 
            // Is it a realtime capable effect and bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTREALTIME, &strVal))
            {
               continue;
            }
            plug.DeserializeRealtimeSupport(strVal);
 
            // Does the effect support automation...bypass group if not found
            if (!pRegistry->Read(KEY_EFFECTAUTOMATABLE, &boolVal))
            {
               continue;
            }
            plug.SetEffectAutomatable(boolVal);
         }
         break;
 
         case PluginTypeImporter:
         {
            // Get the importer identifier and bypass group if not found
            if (!pRegistry->Read(KEY_IMPORTERIDENT, &strVal))
            {
               continue;
            }
            plug.SetImporterIdentifier(strVal);
 
            // Get the importer extensions and bypass group if not found
            if (!pRegistry->Read(KEY_IMPORTEREXTENSIONS, &strVal))
            {
               continue;
            }
            FileExtensions extensions;
            wxStringTokenizer tkr(strVal, wxT(":"));
            while (tkr.HasMoreTokens())
            {
               extensions.push_back(tkr.GetNextToken());
            }
            plug.SetImporterExtensions(extensions);
         }
         break;
 
         case PluginTypeStub:
         {
            // Nothing additional for stubs
         }
         break;
 
         // Not used by 2.1.1 or greater and should be removed after a few releases past 2.1.0.
         case PluginTypeNone:
         {
            // Used for stub groups
         }
         break;
 
         default:
         {
            continue;
         }
      }
 
      // Everything checked out...accept the plugin
      mRegisteredPlugins[groupName] = std::move(plug);
   }
 
   return;
}

Referenced by Load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OldGetID()

PluginID PluginManager::OldGetID ( const EffectDefinitionInterface * effect )

static

Definition at line 1245 of file PluginManager.cpp.

{
   return wxString::Format(wxT("%s_%s_%s_%s_%s"),
                           GetPluginTypeString(PluginTypeEffect),
                           effect->GetFamily().Internal(),
                           effect->GetVendor().Internal(),
                           effect->GetSymbol().Internal(),
                           effect->GetPath());
}

References EffectDefinitionInterface::GetFamily(), ComponentInterface::GetPath(), GetPluginTypeString(), ComponentInterface::GetSymbol(), ComponentInterface::GetVendor(), ComponentInterfaceSymbol::Internal(), PluginTypeEffect, and wxT().

Here is the call graph for this function:

◆ PluginsOfType()

Range PluginManager::PluginsOfType ( int type )

inline

Definition at line 147 of file PluginManager.h.

147{ return { Iterator{ *this, type } }; }

Referenced by DropFile(), EffectManager::GetEffectByIdentifier(), MacroCommandsCatalog::MacroCommandsCatalog(), and GetInfoCommand::SendCommands().

Here is the caller graph for this function:

◆ RegisterPlugin() [1/5]

void PluginManager::RegisterPlugin ( PluginDescriptor && desc )

Definition at line 153 of file PluginManager.cpp.

{
   mRegisteredPlugins[desc.GetID()] = std::move(desc);
}

References desc, and mRegisteredPlugins.

Referenced by PluginManagerInterface::AudacityCommandRegistrationCallback(), PluginManagerInterface::DefaultRegistrationCallback(), Initialize(), PluginStartupRegistration::OnPluginFound(), PluginStartupRegistration::OnValidationFinished(), and EffectManager::RegisterEffect().

Here is the caller graph for this function:

◆ RegisterPlugin() [2/5]

const PluginID & PluginManager::RegisterPlugin ( PluginProvider * provider )

overridevirtual

Implements PluginManagerInterface.

Definition at line 158 of file PluginManager.cpp.

{
   PluginDescriptor & plug =
      CreatePlugin(GetID(provider), provider, PluginTypeModule);
   plug.SetEffectFamily(provider->GetOptionalFamilySymbol().Internal());
 
   plug.SetEnabled(true);
   plug.SetValid(true);
 
   return plug.GetID();
}

References CreatePlugin(), PluginDescriptor::GetID(), GetID(), PluginProvider::GetOptionalFamilySymbol(), ComponentInterfaceSymbol::Internal(), PluginTypeModule, PluginDescriptor::SetEffectFamily(), PluginDescriptor::SetEnabled(), and PluginDescriptor::SetValid().

Here is the call graph for this function:

◆ RegisterPlugin() [3/5]

const PluginID & PluginManager::RegisterPlugin	(	PluginProvider *	provider,
		ComponentInterface *	command
	)

Definition at line 170 of file PluginManager.cpp.

{
   PluginDescriptor & plug = CreatePlugin(GetID(command), command, (PluginType)PluginTypeAudacityCommand);
 
   plug.SetProviderID(PluginManager::GetID(provider));
 
   plug.SetEnabled(true);
   plug.SetValid(true);
 
   return plug.GetID();
}

References CreatePlugin(), PluginDescriptor::GetID(), GetID(), PluginTypeAudacityCommand, PluginDescriptor::SetEnabled(), PluginDescriptor::SetProviderID(), and PluginDescriptor::SetValid().

Here is the call graph for this function:

◆ RegisterPlugin() [4/5]

const PluginID & PluginManager::RegisterPlugin	(	PluginProvider *	provider,
		EffectDefinitionInterface *	effect,
		int	type
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 183 of file PluginManager.cpp.

{
   PluginDescriptor & plug = CreatePlugin(GetID(effect), effect, (PluginType)type);
 
   plug.SetProviderID(PluginManager::GetID(provider));
 
   plug.SetEffectType(effect->GetClassification());
   plug.SetEffectFamily(effect->GetFamily().Internal());
   plug.SetEffectInteractive(effect->IsInteractive());
   plug.SetEffectDefault(effect->IsDefault());
   plug.SetRealtimeSupport(effect->RealtimeSupport());
   plug.SetEffectAutomatable(effect->SupportsAutomation());
 
   plug.SetEnabled(true);
   plug.SetValid(true);
 
   return plug.GetID();
}

References CreatePlugin(), EffectDefinitionInterface::GetClassification(), EffectDefinitionInterface::GetFamily(), PluginDescriptor::GetID(), GetID(), ComponentInterfaceSymbol::Internal(), EffectDefinitionInterface::IsDefault(), EffectDefinitionInterface::IsInteractive(), EffectDefinitionInterface::RealtimeSupport(), PluginDescriptor::SetEffectAutomatable(), PluginDescriptor::SetEffectDefault(), PluginDescriptor::SetEffectFamily(), PluginDescriptor::SetEffectInteractive(), PluginDescriptor::SetEffectType(), PluginDescriptor::SetEnabled(), PluginDescriptor::SetProviderID(), PluginDescriptor::SetRealtimeSupport(), PluginDescriptor::SetValid(), and EffectDefinitionInterface::SupportsAutomation().

Here is the call graph for this function:

◆ RegisterPlugin() [5/5]

const PluginID & PluginManager::RegisterPlugin	(	std::unique_ptr< EffectDefinitionInterface >	effect,
		PluginType	type
	)

Used only by Nyquist Workbench module.

Definition at line 1002 of file PluginManager.cpp.

{
   PluginDescriptor & plug =
      CreatePlugin(GetID(effect.get()), effect.get(), type);
 
   plug.SetEffectType(effect->GetType());
   plug.SetEffectFamily(effect->GetFamily().Internal());
   plug.SetEffectInteractive(effect->IsInteractive());
   plug.SetEffectDefault(effect->IsDefault());
   plug.SetRealtimeSupport(effect->RealtimeSupport());
   plug.SetEffectAutomatable(effect->SupportsAutomation());
   
   plug.SetEffectLegacy(true);
   plug.SetEnabled(true);
   plug.SetValid(true);
 
   mLoadedInterfaces[plug.GetID()] = std::move(effect);
 
   return plug.GetID();
}

References CreatePlugin(), PluginDescriptor::GetID(), GetID(), mLoadedInterfaces, PluginDescriptor::SetEffectAutomatable(), PluginDescriptor::SetEffectDefault(), PluginDescriptor::SetEffectFamily(), PluginDescriptor::SetEffectInteractive(), PluginDescriptor::SetEffectLegacy(), PluginDescriptor::SetEffectType(), PluginDescriptor::SetEnabled(), PluginDescriptor::SetRealtimeSupport(), and PluginDescriptor::SetValid().

Here is the call graph for this function:

◆ RemoveConfig()

bool PluginManager::RemoveConfig	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		const RegistryPath &	key
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 304 of file PluginManager.cpp.

{
   bool result = GetSettings()->DeleteEntry(Key(type, ID, group, key));
   if (result)
   {
      GetSettings()->Flush();
   }
 
   return result;
}

References FileConfig::DeleteEntry(), FileConfig::Flush(), GetSettings(), Key(), and key.

Here is the call graph for this function:

◆ RemoveConfigSubgroup()

bool PluginManager::RemoveConfigSubgroup	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 292 of file PluginManager.cpp.

{
   bool result = GetSettings()->DeleteGroup(Group(type, ID, group));
   if (result)
   {
      GetSettings()->Flush();
   }
 
   return result;
}

References FileConfig::DeleteGroup(), FileConfig::Flush(), GetSettings(), and Group().

Here is the call graph for this function:

◆ Save()

void PluginManager::Save ( )

Save to preferences.

Definition at line 880 of file PluginManager.cpp.

{
   // Create/Open the registry
   auto pRegistry = sFactory(FileNames::PluginRegistry());
   auto &registry = *pRegistry;
 
   // Clear pluginregistry.cfg (not audacity.cfg)
   registry.DeleteAll();
 
   // Save the individual groups
   SaveGroup(&registry, PluginTypeEffect);
   SaveGroup(&registry, PluginTypeExporter);
   SaveGroup(&registry, PluginTypeAudacityCommand);
   SaveGroup(&registry, PluginTypeImporter);
   SaveGroup(&registry, PluginTypeStub);
 
   // Not used by 2.1.1 or greater, but must save to allow users to switch between 2.1.0
   // and 2.1.1+.  This should be removed after a few releases past 2.1.0.
   //SaveGroup(&registry, PluginTypeNone);
 
   // And now the providers
   SaveGroup(&registry, PluginTypeModule);
 
   // Write the version string
   registry.Write(REGVERKEY, REGVERCUR);
 
   // Just to be safe
   registry.Flush();
 
   mRegver = REGVERCUR;
}

References mRegver, FileNames::PluginRegistry(), PluginTypeAudacityCommand, PluginTypeEffect, PluginTypeExporter, PluginTypeImporter, PluginTypeModule, PluginTypeStub, REGVERCUR, REGVERKEY, SaveGroup(), and sFactory.

Referenced by DropFile(), InitializePlugins(), PluginRegistrationDialog::OnOK(), and PluginStartupRegistration::Stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveGroup()

void PluginManager::SaveGroup	(	FileConfig *	pRegistry,
		PluginType	type
	)

private

Definition at line 917 of file PluginManager.cpp.

{
   wxString group = GetPluginTypeString(type);
   for (auto &pair : mRegisteredPlugins) {
      auto & plug = pair.second;
 
      if (plug.GetPluginType() != type)
      {
         continue;
      }
 
      pRegistry->SetPath(REGROOT + group + wxCONFIG_PATH_SEPARATOR + ConvertID(plug.GetID()));
 
      pRegistry->Write(KEY_PATH, plug.GetPath());
 
      // See comments with the corresponding load-time call to SetSymbol().
      pRegistry->Write(KEY_SYMBOL, plug.GetSymbol().Internal());
 
      // PRL:  Writing KEY_NAME which is no longer read, but older Audacity
      // versions expect to find it.
      pRegistry->Write(KEY_NAME, plug.GetSymbol().Msgid().MSGID());
 
      pRegistry->Write(KEY_VERSION, plug.GetUntranslatedVersion());
      pRegistry->Write(KEY_VENDOR, plug.GetVendor());
      // Write a blank -- see comments in LoadGroup:
      pRegistry->Write(KEY_DESCRIPTION, wxString{});
      pRegistry->Write(KEY_PROVIDERID, plug.GetProviderID());
      pRegistry->Write(KEY_ENABLED, plug.IsEnabled());
      pRegistry->Write(KEY_VALID, plug.IsValid());
 
      switch (type)
      {
         case PluginTypeModule:
         break;
 
         case PluginTypeEffect:
         {
            EffectType etype = plug.GetEffectType();
            wxString stype;
            if (etype == EffectTypeNone)
               stype = KEY_EFFECTTYPE_NONE;
            else if (etype == EffectTypeAnalyze)
               stype = KEY_EFFECTTYPE_ANALYZE;
            else if (etype == EffectTypeGenerate)
               stype = KEY_EFFECTTYPE_GENERATE;
            else if (etype == EffectTypeProcess)
               stype = KEY_EFFECTTYPE_PROCESS;
            else if (etype == EffectTypeTool)
               stype = KEY_EFFECTTYPE_TOOL;
            else if (etype == EffectTypeHidden)
               stype = KEY_EFFECTTYPE_HIDDEN;
 
            pRegistry->Write(KEY_EFFECTTYPE, stype);
            pRegistry->Write(KEY_EFFECTFAMILY, plug.GetEffectFamily());
            pRegistry->Write(KEY_EFFECTDEFAULT, plug.IsEffectDefault());
            pRegistry->Write(KEY_EFFECTINTERACTIVE, plug.IsEffectInteractive());
            pRegistry->Write(KEY_EFFECTREALTIME, plug.SerializeRealtimeSupport());
            pRegistry->Write(KEY_EFFECTAUTOMATABLE, plug.IsEffectAutomatable());
         }
         break;
 
         case PluginTypeImporter:
         {
            pRegistry->Write(KEY_IMPORTERIDENT, plug.GetImporterIdentifier());
            const auto & extensions = plug.GetImporterExtensions();
            wxString strExt;
            for (size_t i = 0, cnt = extensions.size(); i < cnt; i++)
            {
               strExt += extensions[i] + wxT(":");
            }
            strExt.RemoveLast(1);
            pRegistry->Write(KEY_IMPORTEREXTENSIONS, strExt);
         }
         break;
 
         default:
         break;
      }
   }
 
   return;
}

References ConvertID(), EffectTypeAnalyze, EffectTypeGenerate, EffectTypeHidden, EffectTypeNone, EffectTypeProcess, EffectTypeTool, GetPluginTypeString(), KEY_DESCRIPTION, KEY_EFFECTAUTOMATABLE, KEY_EFFECTDEFAULT, KEY_EFFECTFAMILY, KEY_EFFECTINTERACTIVE, KEY_EFFECTREALTIME, KEY_EFFECTTYPE, KEY_EFFECTTYPE_ANALYZE, KEY_EFFECTTYPE_GENERATE, KEY_EFFECTTYPE_HIDDEN, KEY_EFFECTTYPE_NONE, KEY_EFFECTTYPE_PROCESS, KEY_EFFECTTYPE_TOOL, KEY_ENABLED, KEY_IMPORTEREXTENSIONS, KEY_IMPORTERIDENT, KEY_NAME, KEY_PATH, KEY_PROVIDERID, KEY_SYMBOL, KEY_VALID, KEY_VENDOR, KEY_VERSION, mRegisteredPlugins, PluginTypeEffect, PluginTypeImporter, PluginTypeModule, REGROOT, FileConfig::SetPath(), and wxT().

Referenced by Save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetConfigValue() [1/2]

bool PluginManager::SetConfigValue	(	ConfigurationType	type,
		const PluginID &	ID,
		const RegistryPath &	group,
		const RegistryPath &	key,
		ConfigConstReference	value
	)

overridevirtual

Implements PluginManagerInterface.

Definition at line 285 of file PluginManager.cpp.

{
   return SetConfigValue(Key(type, ID, group, key), value);
}

References Key(), key, and SetConfigValue().

Referenced by SetConfigValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetConfigValue() [2/2]

bool PluginManager::SetConfigValue	(	const RegistryPath &	key,
		ConfigConstReference	value
	)

private

Definition at line 1420 of file PluginManager.cpp.

{
   if (key.empty())
      return false;
   const auto visitor = [&](const auto value){
      return GetSettings()->Write(key, value.get()) && GetSettings()->Flush();
   };
   return Visit(visitor, value);
}

References FileConfig::Flush(), GetSettings(), key, and Visit().

Here is the call graph for this function:

◆ SetDirty()

void PluginManager::SetDirty ( bool dirty = true )

private

◆ SettingsPath()

RegistryPath PluginManager::SettingsPath	(	ConfigurationType	type,
		const PluginID &	ID
	)

private

Definition at line 1432 of file PluginManager.cpp.

{
   bool shared = (type == ConfigurationType::Shared);
 
   // All the strings reported by PluginDescriptor and used in this function
   // persist in the plugin settings configuration file, so they should not
   // be changed across Audacity versions, or else compatibility of the
   // configuration files will break.
 
   if (auto iter = mRegisteredPlugins.find(ID); iter == mRegisteredPlugins.end())
      return {};
   else {
      const PluginDescriptor & plug = iter->second;
      
      wxString id = GetPluginTypeString(plug.GetPluginType()) +
                    wxT("_") +
                    plug.GetEffectFamily() + // is empty for non-Effects
                    wxT("_") +
                    plug.GetVendor() +
                    wxT("_") +
                    (shared ? wxString{} : plug.GetSymbol().Internal());
 
      return SETROOT +
             ConvertID(id) +
             wxCONFIG_PATH_SEPARATOR +
             (shared ? wxT("shared") : wxT("private")) +
             wxCONFIG_PATH_SEPARATOR;
   }
}

References ConvertID(), PluginDescriptor::GetEffectFamily(), PluginDescriptor::GetPluginType(), GetPluginTypeString(), PluginDescriptor::GetSymbol(), PluginDescriptor::GetVendor(), ComponentInterfaceSymbol::Internal(), mRegisteredPlugins, SETROOT, PluginSettings::Shared, and wxT().

Referenced by Group().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Terminate()

void PluginManager::Terminate ( )

Definition at line 409 of file PluginManager.cpp.

{
   // Get rid of all non-module(effects?) plugins first
   for(auto& p : mRegisteredPlugins)
   {
      auto& desc = p.second;
      if(desc.GetPluginType() == PluginTypeEffect)
         mLoadedInterfaces.erase(desc.GetID());
   }
 
   // Now get rid of others
   mRegisteredPlugins.clear();
   mLoadedInterfaces.clear();
}

References desc, mLoadedInterfaces, mRegisteredPlugins, and PluginTypeEffect.

Referenced by AudacityApp::OnExit(), and ~PluginManager().

Here is the caller graph for this function:

◆ UnregisterPlugin()

void PluginManager::UnregisterPlugin ( const PluginID & ID )

Definition at line 1024 of file PluginManager.cpp.

{
   mRegisteredPlugins.erase(ID);
   mLoadedInterfaces.erase(ID);
}

References mLoadedInterfaces, and mRegisteredPlugins.

Referenced by PluginRegistrationDialog::OnOK(), and EffectManager::UnregisterEffect().

Here is the caller graph for this function:

Member Data Documentation

◆ mCurrentIndex

int PluginManager::mCurrentIndex

private

Definition at line 222 of file PluginManager.h.

◆ mDirty

bool PluginManager::mDirty

private

Definition at line 221 of file PluginManager.h.

◆ mEffectPluginsCleared

std::vector<PluginDescriptor> PluginManager::mEffectPluginsCleared

private

Definition at line 226 of file PluginManager.h.

Referenced by CheckPluginUpdates(), ClearEffectPlugins(), and GetPlugin().

◆ mInstance

std::unique_ptr< PluginManager > PluginManager::mInstance {}

staticprivate

Definition at line 215 of file PluginManager.h.

Referenced by Get().

◆ mLoadedInterfaces

std::map<PluginID, std::unique_ptr<ComponentInterface> > PluginManager::mLoadedInterfaces

private

Definition at line 225 of file PluginManager.h.

Referenced by IsPluginLoaded(), Load(), RegisterPlugin(), Terminate(), and UnregisterPlugin().

◆ mRegisteredPlugins

PluginMap PluginManager::mRegisteredPlugins

private

Definition at line 224 of file PluginManager.h.

Referenced by PluginManager::Iterator::Advance(), CheckPluginUpdates(), ClearEffectPlugins(), CreatePlugin(), DropFile(), EnablePlugin(), GetPlugin(), GetPluginCount(), GetSymbol(), InitializePlugins(), IsPluginEnabled(), IsPluginRegistered(), Load(), LoadGroup(), RegisterPlugin(), SaveGroup(), SettingsPath(), Terminate(), and UnregisterPlugin().

◆ mRegver

PluginRegistryVersion PluginManager::mRegver

private

Definition at line 228 of file PluginManager.h.

Referenced by GetRegistryVersion(), Load(), and Save().

◆ mSettings

std::unique_ptr<FileConfig> PluginManager::mSettings

private

Definition at line 219 of file PluginManager.h.

Referenced by GetSettings(), and PluginManager().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ FileConfigFactory

Constructor & Destructor Documentation

◆ PluginManager()

◆ ~PluginManager()

Member Function Documentation

◆ AllPlugins()

◆ CheckPluginUpdates()

◆ ClearEffectPlugins()

◆ ConvertID()

◆ CreatePlugin()

◆ DropFile()

◆ EffectsOfType()

◆ EnablePlugin()

◆ FindFilesInPathList()

◆ Get()

◆ GetConfigSubgroups()

◆ GetConfigValue() [1/2]

◆ GetConfigValue() [2/2]

◆ GetEffectNameFromID()

◆ GetID() [1/3]

◆ GetID() [2/3]

◆ GetID() [3/3]

◆ GetPlugin()

◆ GetPluginCount()

◆ GetPluginEnabledSetting() [1/2]

◆ GetPluginEnabledSetting() [2/2]

◆ GetPluginTypeString()

◆ GetRegistryVersion()

◆ GetSettings()

◆ GetSubgroups()

◆ GetSymbol()

◆ Group()

◆ HasConfigGroup()

◆ HasConfigValue() [1/2]

◆ HasConfigValue() [2/2]

◆ HasGroup()

◆ Initialize()

◆ InitializePlugins()

◆ IsDirty()

◆ IsPluginEnabled()

◆ IsPluginLoaded()

◆ IsPluginRegistered()

◆ Key()

◆ Load() [1/2]

◆ Load() [2/2]

◆ LoadGroup()

◆ OldGetID()

◆ PluginsOfType()

◆ RegisterPlugin() [1/5]

◆ RegisterPlugin() [2/5]

◆ RegisterPlugin() [3/5]

◆ RegisterPlugin() [4/5]

◆ RegisterPlugin() [5/5]

◆ RemoveConfig()

◆ RemoveConfigSubgroup()

◆ Save()

◆ SaveGroup()

◆ SetConfigValue() [1/2]

◆ SetConfigValue() [2/2]

◆ SetDirty()

◆ SettingsPath()

◆ Terminate()

◆ UnregisterPlugin()

Member Data Documentation

◆ mCurrentIndex

◆ mDirty

◆ mEffectPluginsCleared

◆ mInstance

◆ mLoadedInterfaces

◆ mRegisteredPlugins

◆ mRegver