LadspaEffectsModule Class Reference

#include <LadspaEffectsModule.h>

Inheritance diagram for LadspaEffectsModule:

Collaboration diagram for LadspaEffectsModule:

Classes
struct	Factory

Public Member Functions
	LadspaEffectsModule ()
virtual	~LadspaEffectsModule ()
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...
bool	SupportsCustomModulePaths () const override
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...
FilePaths	GetSearchPaths (PluginManagerInterface &pluginManager)
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

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

Detailed Description

Definition at line 20 of file LadspaEffectsModule.h.

Constructor & Destructor Documentation

LadspaEffectsModule()

LadspaEffectsModule::LadspaEffectsModule

(

)

Definition at line 69 of file LadspaEffectsModule.cpp.

{
}

~LadspaEffectsModule()

LadspaEffectsModule::~LadspaEffectsModule ( )

virtual

Definition at line 73 of file LadspaEffectsModule.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void LadspaEffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 161 of file LadspaEffectsModule.cpp.

{
   // Autoregister effects that we "think" are ones that have been shipped with
   // Audacity.  A little simplistic, but it should suffice for now.
   auto pathList = GetSearchPaths(pm);
   FilePaths files;
   TranslatableString ignoredErrMsg;
 
   for (int i = 0; i < (int)WXSIZEOF(kShippedEffects); i++)
   {
      files.clear();
      pm.FindFilesInPathList(kShippedEffects[i], pathList, files);
      for (size_t j = 0, cnt = files.size(); j < cnt; j++)
      {
         if (!pm.IsPluginRegistered(files[j]))
         {
            // No checking for error ?
            DiscoverPluginsAtPath(files[j], ignoredErrMsg,
               PluginManagerInterface::DefaultRegistrationCallback);
         }
      }
   }
}

References PluginManagerInterface::DefaultRegistrationCallback(), DiscoverPluginsAtPath(), PluginManagerInterface::FindFilesInPathList(), GetSearchPaths(), PluginManagerInterface::IsPluginRegistered(), and kShippedEffects.

Here is the call graph for this function:

CheckPluginExist()

bool LadspaEffectsModule::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 308 of file LadspaEffectsModule.cpp.

{
   const auto realPath = path.BeforeFirst(wxT(';'));
   return wxFileName::FileExists(realPath);
}

References wxT().

Here is the call graph for this function:

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 210 of file LadspaEffectsModule.cpp.

{
   errMsg = {};
   // Since we now have builtin VST support, ignore the VST bridge as it
   // causes duplicate menu entries to appear.
   wxFileName ff(path);
   if (ff.GetName().CmpNoCase(wxT("vst-bridge")) == 0) {
      errMsg = XO("Audacity no longer uses vst-bridge");
      return 0;
   }
 
   // As a courtesy to some plug-ins that might be bridges to
   // open other plug-ins, we set the current working
   // directory to be the plug-in's directory.
   wxString envpath;
   bool hadpath = wxGetEnv(wxT("PATH"), &envpath);
   wxSetEnv(wxT("PATH"), ff.GetPath() + wxFILE_SEP_PATH + envpath);
   wxString saveOldCWD = ff.GetCwd();
   ff.SetCwd();
 
   int index = 0;
   int nLoaded = 0;
   LADSPA_Descriptor_Function mainFn = NULL;
 
#if defined(__WXMSW__)
   wxDynamicLibrary lib;
   if (lib.Load(path, wxDL_NOW))
#else
   void *lib = dlopen((const char *)path.ToUTF8(), RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
   if (lib)
#endif
   {
 
#if defined(__WXMSW__)
      wxLogNull logNo;
 
      mainFn = (LADSPA_Descriptor_Function) lib.GetSymbol(wxT("ladspa_descriptor"));
#else
      mainFn = (LADSPA_Descriptor_Function) dlsym(lib, "ladspa_descriptor");
#endif
 
      if (mainFn) {
         const LADSPA_Descriptor *data;
 
         for (data = mainFn(index); data; data = mainFn(++index)) {
            LadspaEffectBase effect(path, index);
            if (effect.InitializePlugin()) {
               ++nLoaded;
               if (callback)
                  callback( this, &effect );
            }
            else
               errMsg = XO("Could not load the library");
         }
      }
   }
   else
      errMsg = XO("Could not load the library");
 
#if defined(__WXMSW__)
   if (lib.IsLoaded()) {
      // PRL:  I suspect Bug1257 -- Crash when enabling Amplio2 -- is the fault of a timing-
      // dependent multi-threading bug in the Amplio2 library itself, in case the unload of the .dll
      // comes too soon after the load.  I saw the bug in Release builds but not Debug.
      // A sleep of even 1 ms was enough to fix the problem for me, but let's be even more generous.
      using namespace std::chrono;
      std::this_thread::sleep_for(10ms);
      lib.Unload();
   }
#else
   if (lib) {
      dlclose(lib);
   }
#endif
 
   wxSetWorkingDirectory(saveOldCWD);
   hadpath ? wxSetEnv(wxT("PATH"), envpath) : wxUnsetEnv(wxT("PATH"));
 
   return nLoaded;
}

References LadspaEffectBase::InitializePlugin(), wxT(), and XO().

Referenced by AutoRegisterPlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

FindModulePaths()

PluginPaths LadspaEffectsModule::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 185 of file LadspaEffectsModule.cpp.

{
   auto pathList = GetSearchPaths(pm);
   FilePaths files;
 
#if defined(__WXMAC__)
 
   // Recursively scan for all shared objects
   pm.FindFilesInPathList(wxT("*.so"), pathList, files, true);
 
#elif defined(__WXMSW__)
 
   // Recursively scan for all DLLs
   pm.FindFilesInPathList(wxT("*.dll"), pathList, files, true);
 
#else
 
   // Recursively scan for all shared objects
   pm.FindFilesInPathList(wxT("*.so"), pathList, files, true);
 
#endif
 
   return { files.begin(), files.end() };
}

References PluginManagerInterface::FindFilesInPathList(), GetSearchPaths(), and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString LadspaEffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 101 of file LadspaEffectsModule.cpp.

{
   return XO("Provides LADSPA Effects");
}

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & LadspaEffectsModule::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 132 of file LadspaEffectsModule.cpp.

{
   static FileExtensions result{{
 
#ifdef __WXMSW__
 
      _T("dll")
 
#else
 
      _T("so")
 
   #ifdef __WXMAC__
   // Is it correct that these are candidate plug-in files too for macOs?
      , _T("dylib")
   #endif
 
#endif
 
   }};
   return result;
}

GetOptionalFamilySymbol()

EffectFamilySymbol LadspaEffectsModule::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 123 of file LadspaEffectsModule.cpp.

{
#if USE_LADSPA
   return LADSPAEFFECTS_FAMILY;
#else
   return {};
#endif
}

References LADSPAEFFECTS_FAMILY.

GetPath()

PluginPath LadspaEffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 77 of file LadspaEffectsModule.cpp.

{
   return {};
}

GetSearchPaths()

FilePaths LadspaEffectsModule::GetSearchPaths

(

PluginManagerInterface &

pluginManager

)

Definition at line 314 of file LadspaEffectsModule.cpp.

{
   FilePaths pathList;
   wxString pathVar;
 
   // Check for the LADSPA_PATH environment variable
   pathVar = wxString::FromUTF8(getenv("LADSPA_PATH"));
   if (!pathVar.empty())
   {
      wxStringTokenizer tok(pathVar, wxPATH_SEP);
      while (tok.HasMoreTokens())
      {
         pathList.push_back(tok.GetNextToken());
      }
   }
 
#if defined(__WXMAC__)
#define LADSPAPATH wxT("/Library/Audio/Plug-Ins/LADSPA")
 
   // Look in ~/Library/Audio/Plug-Ins/LADSPA and /Library/Audio/Plug-Ins/LADSPA
   pathList.push_back(wxGetHomeDir() + wxFILE_SEP_PATH + LADSPAPATH);
   pathList.push_back(LADSPAPATH);
 
#elif defined(__WXMSW__)
 
   // No special paths...probably should look in %CommonProgramFiles%\LADSPA
 
#else
 
   pathList.push_back(wxGetHomeDir() + wxFILE_SEP_PATH + wxT(".ladspa"));
#if defined(__LP64__)
   pathList.push_back(wxT("/usr/local/lib64/ladspa"));
   pathList.push_back(wxT("/usr/lib64/ladspa"));
#endif
   pathList.push_back(wxT("/usr/local/lib/ladspa"));
   pathList.push_back(wxT("/usr/lib/ladspa"));
   pathList.push_back(wxT(LIBDIR) wxT("/ladspa"));
 
#endif
 
   {
      auto customPaths = pluginManager.ReadCustomPaths(*this);
      std::copy(customPaths.begin(), customPaths.end(), std::back_inserter(pathList));
   }
 
   return pathList;
}

References staffpad::vo::copy(), LADSPAPATH, PluginManagerInterface::ReadCustomPaths(), and wxT().

Referenced by AutoRegisterPlugins(), and FindModulePaths().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol LadspaEffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 82 of file LadspaEffectsModule.cpp.

{
   /* i18n-hint: abbreviates "Linux Audio Developer's Simple Plugin API"
      (Application programming interface)
    */
   return XO("LADSPA Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol LadspaEffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 90 of file LadspaEffectsModule.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString LadspaEffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 95 of file LadspaEffectsModule.cpp.

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

References LADSPAEFFECTS_VERSION.

Initialize()

bool LadspaEffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 106 of file LadspaEffectsModule.cpp.

{
   // Nothing to do here
   return true;
}

InstallPath()

FilePath LadspaEffectsModule::InstallPath ( )

overridevirtual

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 155 of file LadspaEffectsModule.cpp.

{
   // To do: better choice
   return FileNames::PlugInDir();
}

References FileNames::PlugInDir().

Here is the call graph for this function:

LoadPlugin()

std::unique_ptr< ComponentInterface > LadspaEffectsModule::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 294 of file LadspaEffectsModule.cpp.

{
   // Acquires a resource for the application.
   // For us, the path is two words.
   // 1)  The library's path
   // 2)  The LADSPA descriptor index
   long index;
   wxString realPath = path.BeforeFirst(wxT(';'));
   path.AfterFirst(wxT(';')).ToLong(&index);
   auto result = Factory::Call(realPath, (int)index);
   result->InitializePlugin();
   return result;
}

References GlobalHook< Factory, std::remove_pointer_t< decltype(DefaultFunction)>, DefaultFunction, Options... >::Call(), and wxT().

Here is the call graph for this function:

SupportsCustomModulePaths()

bool LadspaEffectsModule::SupportsCustomModulePaths ( ) const

overridevirtual

Reimplemented from PluginProvider.

Definition at line 118 of file LadspaEffectsModule.cpp.

{
   return true;
}

Terminate()

void LadspaEffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 112 of file LadspaEffectsModule.cpp.

{
   // Nothing to do here
   return;
}

---

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

• LadspaEffectsModule.h
• LadspaEffectsModule.cpp