VampEffectsModule Class Reference

#include <LoadVamp.h>

Inheritance diagram for VampEffectsModule:

Collaboration diagram for VampEffectsModule:

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

Private Member Functions
std::unique_ptr< Vamp::Plugin >	FindPlugin (const PluginPath &wpath, int &output, bool &hasParameters)

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 29 of file LoadVamp.h.

Constructor & Destructor Documentation

VampEffectsModule()

VampEffectsModule::VampEffectsModule

(

)

Definition at line 56 of file LoadVamp.cpp.

{
}

~VampEffectsModule()

VampEffectsModule::~VampEffectsModule ( )

virtual

Definition at line 60 of file LoadVamp.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void VampEffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 125 of file LoadVamp.cpp.

{
}

CheckPluginExist()

bool VampEffectsModule::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 240 of file LoadVamp.cpp.

{
   PluginLoader::PluginKey key = path.BeforeFirst(wxT('/')).ToUTF8().data();
   const auto libraryPathUTF8 = PluginLoader::getInstance()->getLibraryPathForPlugin(key);
   if(!libraryPathUTF8.empty())
      return wxFileName::FileExists(wxString::FromUTF8(libraryPathUTF8));
   return wxFileName::FileExists(path);
}

References key, and wxT().

Here is the call graph for this function:

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 206 of file LoadVamp.cpp.

{
   errMsg = {};
   int output;
   bool hasParameters;
 
   auto vp = FindPlugin(path, output, hasParameters);
   if (vp)
   {
      VampEffect effect(std::move(vp), path, output, hasParameters);
      if (callback)
         callback( this, &effect );
 
      return 1;
   }
 
   errMsg = XO("Could not load the library");
   return 0;
}

References FindPlugin(), and XO().

Here is the call graph for this function:

FindModulePaths()

PluginPaths VampEffectsModule::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 129 of file LoadVamp.cpp.

{
   PluginPaths names;
 
   PluginLoader *loader = PluginLoader::getInstance();
 
   PluginLoader::PluginKeyList keys = loader->listPlugins();
 
   for (PluginLoader::PluginKeyList::iterator i = keys.begin(); i != keys.end(); ++i)
   {
      std::unique_ptr<Plugin> vp{ PluginLoader::getInstance()->loadPlugin(*i, 48000) }; // rate doesn't matter here
      if (!vp)
      {
         continue;
      }
 
      // We limit the listed plugin outputs to those whose results can
      // readily be displayed in an Audacity label track.
      //
      // - Any output whose features have no values (time instants only),
      //   with or without duration, is fine
      //
      // - Any output whose features have more than one value, or an
      //   unknown or variable number of values, is right out
      //
      // - Any output whose features have exactly one value, with
      //   variable sample rate or with duration, should be OK --
      //   this implies a sparse feature, of which the time and/or
      //   duration are significant aspects worth displaying
      //
      // - An output whose features have exactly one value, with
      //   fixed sample rate and no duration, cannot be usefully
      //   displayed -- the value is the only significant piece of
      //   data there and we have no good value plot
 
      Plugin::OutputList outputs = vp->getOutputDescriptors();
 
      int output = 0;
 
      for (Plugin::OutputList::iterator j = outputs.begin(); j != outputs.end(); ++j)
      {
         if (j->sampleType == Plugin::OutputDescriptor::FixedSampleRate ||
               j->sampleType == Plugin::OutputDescriptor::OneSamplePerStep ||
               !j->hasFixedBinCount ||
               j->binCount > 1)
         {
            // All of these qualities disqualify (see notes above)
 
            ++output;
            continue;
         }
 
         wxString name = wxString::FromUTF8(vp->getName().c_str());
 
         if (outputs.size() > 1)
         {
            // This is not the plugin's only output.
            // Use "plugin name: output name" as the effect name,
            // unless the output name is the same as the plugin name
            wxString outputName = wxString::FromUTF8(j->name.c_str());
            if (outputName != name)
            {
               name = wxString::Format(wxT("%s: %s"),
                                       name, outputName);
            }
         }
 
         wxString path = wxString::FromUTF8(i->c_str()) + wxT("/") + name;
         names.push_back(path);
 
         ++output;
      }
   }
 
   return names;
}

References name, names, and wxT().

Here is the call graph for this function:

FindPlugin()

std::unique_ptr< Vamp::Plugin > VampEffectsModule::FindPlugin ( const PluginPath &  wpath, int &  output, bool &  hasParameters  )

private

Definition at line 251 of file LoadVamp.cpp.

{
   PluginLoader::PluginKey key = path.BeforeFirst(wxT('/')).ToUTF8().data();
 
   std::unique_ptr<Plugin> vp{ PluginLoader::getInstance()->loadPlugin(key, 48000) }; // rate doesn't matter here
   if (!vp)
   {
      return nullptr;
   }
 
   // We limit the listed plugin outputs to those whose results can
   // readily be displayed in an Audacity label track.
   //
   // - Any output whose features have no values (time instants only),
   //   with or without duration, is fine
   //
   // - Any output whose features have more than one value, or an
   //   unknown or variable number of values, is right out
   //
   // - Any output whose features have exactly one value, with
   //   variable sample rate or with duration, should be OK --
   //   this implies a sparse feature, of which the time and/or
   //   duration are significant aspects worth displaying
   //
   // - An output whose features have exactly one value, with
   //   fixed sample rate and no duration, cannot be usefully
   //   displayed -- the value is the only significant piece of
   //   data there and we have no good value plot
 
   Plugin::OutputList outputs = vp->getOutputDescriptors();
 
   output = 0;
 
   hasParameters = !vp->getParameterDescriptors().empty();
 
   for (Plugin::OutputList::iterator j = outputs.begin(); j != outputs.end(); ++j)
   {
      if (j->sampleType == Plugin::OutputDescriptor::FixedSampleRate ||
            j->sampleType == Plugin::OutputDescriptor::OneSamplePerStep ||
            !j->hasFixedBinCount ||
            j->binCount > 1)
      {
         // All of these qualities disqualify (see notes above)
 
         ++output;
         continue;
      }
 
      wxString name = wxString::FromUTF8(vp->getName().c_str());
 
      if (outputs.size() > 1)
      {
         // This is not the plugin's only output.
         // Use "plugin name: output name" as the effect name,
         // unless the output name is the same as the plugin name
         wxString outputName = wxString::FromUTF8(j->name.c_str());
         if (outputName != name)
         {
            name = wxString::Format(wxT("%s: %s"),
                                    name, outputName);
         }
      }
 
      if (wxString::FromUTF8(key.c_str()) + wxT("/") + name == path)
      {
         return vp;
      }
 
      ++output;
   }
 
   return {};
}

References key, name, and wxT().

Referenced by DiscoverPluginsAtPath(), and LoadPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString VampEffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 89 of file LoadVamp.cpp.

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

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & VampEffectsModule::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 119 of file LoadVamp.cpp.

{
   static FileExtensions empty;
   return empty;
}

GetOptionalFamilySymbol()

EffectFamilySymbol VampEffectsModule::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 110 of file LoadVamp.cpp.

{
#if USE_VAMP
   return VAMPEFFECTS_FAMILY;
#else
   return {};
#endif
}

References VAMPEFFECTS_FAMILY.

GetPath()

PluginPath VampEffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 68 of file LoadVamp.cpp.

{
   return {};
}

GetSymbol()

ComponentInterfaceSymbol VampEffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 73 of file LoadVamp.cpp.

{
   return XO("Vamp Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol VampEffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 78 of file LoadVamp.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString VampEffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 83 of file LoadVamp.cpp.

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

References VAMPEFFECTS_VERSION.

Initialize()

bool VampEffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 98 of file LoadVamp.cpp.

{
   // Nothing to do here
   return true;
}

InstallPath()

FilePath VampEffectsModule::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 50 of file LoadVamp.h.

{ return {}; }

LoadPlugin()

std::unique_ptr< ComponentInterface > VampEffectsModule::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 229 of file LoadVamp.cpp.

{
   // Acquires a resource for the application.
   int output;
   bool hasParameters;
 
   if (auto vp = FindPlugin(path, output, hasParameters))
      return std::make_unique<VampEffect>(std::move(vp), path, output, hasParameters);
   return nullptr;
}

References FindPlugin().

Here is the call graph for this function:

Terminate()

void VampEffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 104 of file LoadVamp.cpp.

{
   // Nothing to do here
   return;
}

---

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

• LoadVamp.h
• LoadVamp.cpp