LV2EffectsModule Class Reference

#include <LoadLV2.h>

Inheritance diagram for LV2EffectsModule:

Collaboration diagram for LV2EffectsModule:

Classes
struct	Factory

Public Member Functions
	LV2EffectsModule ()
virtual	~LV2EffectsModule ()
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...
std::unique_ptr< Validator >	MakeValidator () const override
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

Static Private Member Functions
static const LilvPlugin *	GetPlugin (const PluginPath &path)

Private Attributes
wxString	mStartupPathVar

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 30 of file LoadLV2.h.

Constructor & Destructor Documentation

LV2EffectsModule()

LV2EffectsModule::LV2EffectsModule

(

)

Definition at line 70 of file LoadLV2.cpp.

{
}

~LV2EffectsModule()

LV2EffectsModule::~LV2EffectsModule ( )

virtual

Definition at line 74 of file LoadLV2.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void LV2EffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 153 of file LoadLV2.cpp.

{
   //Plugins aren't registered in PluginManager here, but
   //instead we update `LV2_PATH` and run `lilv_world_load_all`
   //to register bundles within LV2 module.
 
   wxString newVar;
 
#if defined(__WXMAC__)
#define LV2PATH wxT("/Library/Audio/Plug-Ins/LV2")
 
   wxFileName libdir;
//   libdir.AssignDir(wxT(LIBDIR));
   libdir.AppendDir(wxT("lv2"));
 
   newVar += wxT(":$HOME/.lv2");
 
   // Look in ~/Library/Audio/Plug-Ins/lv2 and /Library/Audio/Plug-Ins/lv2
   newVar += wxT(":$HOME") LV2PATH;
   newVar += wxT(":") LV2PATH;
   
   newVar += wxT(":/usr/local/lib/lv2");
   newVar += wxT(":/usr/lib/lv2");
   newVar += wxT(":") + libdir.GetPath();
 
#elif defined(__WXMSW__)
 
   newVar += wxT(";%APPDATA%\\LV2");
   newVar += wxT(";%COMMONPROGRAMFILES%\\LV2");
   newVar += wxT(";%COMMONPROGRAMFILES(x86)%\\LV2");
 
#else
 
   wxFileName libdir;
   libdir.AssignDir(wxT(LIBDIR));
   libdir.AppendDir(wxT("lv2"));
 
   newVar += wxT(":$HOME/.lv2");
#if defined(__LP64__)
   newVar += wxT(":/usr/local/lib64/lv2");
   newVar += wxT(":/usr/lib64/lv2");
#endif
   newVar += wxT(":/usr/local/lib/lv2");
   newVar += wxT(":/usr/lib/lv2");
   newVar += wxT(":") + libdir.GetPath();
 
   // Tell SUIL where to find his GUI support modules
   wxSetEnv(wxT("SUIL_MODULE_DIR"), wxT(PKGLIBDIR));
#endif
 
   {
      auto customPaths = pluginManager.ReadCustomPaths(*this);
      if(!customPaths.empty())
      {
         wxArrayString wxarr;
         std::copy(customPaths.begin(), customPaths.end(), std::back_inserter(wxarr));
         newVar += wxString::Format(";%s", wxJoin(wxarr, ';'));
      }
   }
   // Start with the LV2_PATH environment variable (if any)
   wxString pathVar = mStartupPathVar;
   if (mStartupPathVar.empty())
      pathVar = newVar.Mid(1);
   else
      pathVar += newVar;
 
   wxSetEnv(wxT("LV2_PATH"), pathVar);
   lilv_world_load_all(LV2Symbols::gWorld);
}

References staffpad::vo::copy(), LV2Symbols::gWorld, LV2PATH, mStartupPathVar, PluginManagerInterface::ReadCustomPaths(), and wxT().

Here is the call graph for this function:

CheckPluginExist()

bool LV2EffectsModule::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 290 of file LoadLV2.cpp.

{
   return GetPlugin(path) != nullptr;
}

References GetPlugin().

Here is the call graph for this function:

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 260 of file LoadLV2.cpp.

{
   errMsg = {};
   if (const auto plug = GetPlugin(path)) {
      LV2EffectBase effect(*plug);
      if (effect.InitializePlugin()) {
         if (callback)
            callback( this, &effect );
         return 1;
      }
   }
 
   errMsg = XO("Could not load the library");
   return 0;
}

References GetPlugin(), LV2EffectBase::InitializePlugin(), and XO().

Here is the call graph for this function:

FindModulePaths()

PluginPaths LV2EffectsModule::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 223 of file LoadLV2.cpp.

{
   // Retrieve data about all LV2 plugins
   const LilvPlugins *plugs = lilv_world_get_all_plugins(LV2Symbols::gWorld);
 
   // Iterate over all plugins retrieve their URI
   PluginPaths plugins;
   LILV_FOREACH(plugins, i, plugs)
   {
      const LilvPlugin *plug = lilv_plugins_get(plugs, i);
      const LilvNode *cls = lilv_plugin_class_get_uri(lilv_plugin_get_class(plug));
      LilvNodePtr name{ lilv_plugin_get_name(plug) };
 
      // Bypass unsupported plugin types
      using namespace LV2Symbols;
      if (lilv_node_equals(cls, node_InstrumentPlugin) ||
          lilv_node_equals(cls, node_MIDIPlugin) ||
          lilv_node_equals(cls, node_MathConstants) ||
          lilv_node_equals(cls, node_MathFunctions))
      {
         wxLogInfo(wxT("LV2 plugin '%s' has unsupported type '%s'"), lilv_node_as_string(lilv_plugin_get_uri(plug)), lilv_node_as_string(cls));
         continue;
      }
 
      // If it doesn't have a name or has no ports, then it's not valid
      if (!name || !lilv_plugin_get_port_by_index(plug, 0))
      {
         wxLogInfo(wxT("LV2 plugin '%s' is invalid"), lilv_node_as_string(lilv_plugin_get_uri(plug)));
         continue;
      }
 
      plugins.push_back(LilvString(lilv_plugin_get_uri(plug)));
   }
 
   return plugins;
}

References LV2Symbols::gWorld, LilvString(), name, and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString LV2EffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 103 of file LoadLV2.cpp.

{
   return XO("Provides LV2 Effects support to Audacity");
}

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & LV2EffectsModule::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 147 of file LoadLV2.cpp.

{
   static FileExtensions empty;
   return empty;
}

GetOptionalFamilySymbol()

EffectFamilySymbol LV2EffectsModule::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 138 of file LoadLV2.cpp.

{
#if USE_LV2
   return LV2EFFECTS_FAMILY;
#else
   return {};
#endif
}

References LV2EFFECTS_FAMILY.

GetPath()

PluginPath LV2EffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 82 of file LoadLV2.cpp.

{
   return {};
}

GetPlugin()

const LilvPlugin * LV2EffectsModule::GetPlugin ( const PluginPath &  path )

staticprivate

Definition at line 337 of file LoadLV2.cpp.

{
   using namespace LV2Symbols;
   if (LilvNodePtr uri{ lilv_new_uri(gWorld, path.ToUTF8()) })
      // lilv.h says returns from the following two functions don't need freeing
      return lilv_plugins_get_by_uri(
         lilv_world_get_all_plugins(gWorld), uri.get());
   return nullptr;
}

References LV2Symbols::gWorld.

Referenced by CheckPluginExist(), DiscoverPluginsAtPath(), and LoadPlugin().

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol LV2EffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 87 of file LoadLV2.cpp.

{
   return XO("LV2 Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol LV2EffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 92 of file LoadLV2.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString LV2EffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 97 of file LoadLV2.cpp.

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

References LV2EFFECTS_VERSION.

Initialize()

bool LV2EffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 112 of file LoadLV2.cpp.

{
   if(!LV2Symbols::InitializeGWorld())
      return false;
 
   wxGetEnv(wxT("LV2_PATH"), &mStartupPathVar);
 
   if(PluginHost::IsHostProcess())
   {
      //Plugin validation process does not call `AutoRegisterPlugins`
      //Register plugins from `LV2_PATH` here
      lilv_world_load_all(LV2Symbols::gWorld);
   }
   return true;
}

References LV2Symbols::gWorld, LV2Symbols::InitializeGWorld(), PluginHost::IsHostProcess(), mStartupPathVar, and wxT().

Here is the call graph for this function:

InstallPath()

FilePath LV2EffectsModule::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 56 of file LoadLV2.h.

{ return {}; }

LoadPlugin()

std::unique_ptr< ComponentInterface > LV2EffectsModule::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 279 of file LoadLV2.cpp.

{
   // Acquires a resource for the application.
   if (const auto plug = GetPlugin(path)) {
      auto result = Factory::Call(*plug);
      result->InitializePlugin();
      return result;
   }
   return nullptr;
}

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

Here is the call graph for this function:

MakeValidator()

std::unique_ptr< PluginProvider::Validator > LV2EffectsModule::MakeValidator ( ) const

overridevirtual

Implementation can provide plugin specific checks to the plugin instances. By default returns null.

Reimplemented from PluginProvider.

Definition at line 328 of file LoadLV2.cpp.

{
   return std::make_unique<LV2PluginValidator>();
}

SupportsCustomModulePaths()

bool LV2EffectsModule::SupportsCustomModulePaths ( ) const

overridevirtual

Reimplemented from PluginProvider.

Definition at line 133 of file LoadLV2.cpp.

{
   return true;
}

Terminate()

void LV2EffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 128 of file LoadLV2.cpp.

{
   LV2Symbols::FinalizeGWorld();
}

References LV2Symbols::FinalizeGWorld().

Here is the call graph for this function:

Member Data Documentation

mStartupPathVar

wxString LV2EffectsModule::mStartupPathVar

private

Definition at line 81 of file LoadLV2.h.

Referenced by AutoRegisterPlugins(), and Initialize().

---

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

• LoadLV2.h
• LoadLV2.cpp