VST3EffectsModule Class Reference

VST3Effect factory. More...

#include <VST3EffectsModule.h>

Inheritance diagram for VST3EffectsModule:

Collaboration diagram for VST3EffectsModule:

Classes
struct	Factory

Public Member Functions
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 &pluginManager) override
	Called so that a provider of a static set of plug-ins can register them. More...
bool	SupportsCustomModulePaths () const override
PluginPaths	FindModulePaths (PluginManagerInterface &pluginManager) 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

Private Member Functions
std::shared_ptr< VST3::Hosting::Module >	GetModule (const wxString &path)

Private Attributes
std::unordered_map< wxString, std::weak_ptr< VST3::Hosting::Module > >	mModules

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

VST3Effect factory.

Definition at line 34 of file VST3EffectsModule.h.

Member Function Documentation

AutoRegisterPlugins()

void VST3EffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 149 of file VST3EffectsModule.cpp.

{
}

CheckPluginExist()

bool VST3EffectsModule::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 319 of file VST3EffectsModule.cpp.

{
   wxString modulePath;
   if(VST3Utils::ParsePluginPath(path, &modulePath, nullptr))
      return wxFileName::FileExists(modulePath) || wxFileName::DirExists(modulePath);
 
   return wxFileName::FileExists(path) || wxFileName::DirExists(path);
}

References VST3Utils::ParsePluginPath().

Here is the call graph for this function:

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 211 of file VST3EffectsModule.cpp.

{
   try
   {
      auto module = GetModule(path);
 
      const auto moduleFactory = module->getFactory();
      auto nEffects { 0u };
      for(auto& classInfo : moduleFactory.classInfos())
      {
         if(classInfo.category() == kVstAudioEffectClass)
         {
            std::unique_ptr<VST3EffectBase> effect;
            try
            {
               effect = Factory::Call(module, classInfo);
               ++nEffects;
            }
            catch(std::exception& e)
            {
               wxLogError(
                  "Effect %s@%s cannot be loaded: %s", 
                  classInfo.name().c_str(),
                  path.c_str(),
                  e.what()
               );
            }
            catch(...)
            {
               wxLogError(
                  "Effect %s@%s cannot be loaded: unknown error",
                  classInfo.name().c_str(),
                  path.c_str()
               );
            }
            if(effect && callback)
               callback(this, effect.get());
         }
      }
      if(nEffects == 0u)
         throw std::runtime_error("no effects found");
      
      return nEffects;
   }
   catch(std::exception& e)
   {
      errMsg = XO("VST3 module error: %s").Format(e.what());
   }
 
   return 0u;
}

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

Here is the call graph for this function:

FindModulePaths()

PluginPaths VST3EffectsModule::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 159 of file VST3EffectsModule.cpp.

{
   //Note: The host recursively scans these folders at startup in this order (User/Global/Application).
   //https://developer.steinberg.help/display/VST/Plug-in+Locations
 
   FilePaths pathList;
#ifdef __WXMSW__
   // Windows specific VST3 search paths
   {
      wxString programFilesPath;
      if(wxGetEnv("programfiles", &programFilesPath))
         pathList.push_back(programFilesPath + "\\Common Files\\VST3");
   }
#elif __WXMAC__
   pathList.push_back("~/Library/Audio/Plug-ins/VST3/");
   pathList.push_back("/Library/Audio/Plug-ins/VST3/");
   pathList.push_back("/Network/Library/Audio/Plug-ins/VST3/");
#elif __WXGTK__
   pathList.push_back(wxGetHomeDir() + "/.vst3/");
   pathList.push_back("/usr/lib/vst3/");
   pathList.push_back("/usr/local/lib/vst3/");
#endif
 
   // bundled/app specific
   {
      auto path = wxFileName(PlatformCompatibility::GetExecutablePath());
#ifdef __WXGTK__
      path.AppendDir("vst3");
#else
      path.AppendDir("VST3");
#endif
      pathList.push_back(path.GetPath());
   }
   {
      auto customPaths = pluginManager.ReadCustomPaths(*this);
      std::copy(customPaths.begin(), customPaths.end(), std::back_inserter(pathList));
   }
 
   PluginPaths result;
   VST3PluginTraverser vst3PluginTraverser([&](const wxString& pluginPath){
      result.push_back(pluginPath);
   });
 
   for(const auto& path : pathList)
   {
      wxDir dir(path);
      if(dir.IsOpened())
         dir.Traverse(vst3PluginTraverser, wxEmptyString, wxDIR_DEFAULT);
   }
   return result;
}

References staffpad::vo::copy(), PlatformCompatibility::GetExecutablePath(), and PluginManagerInterface::ReadCustomPaths().

Here is the call graph for this function:

GetDescription()

TranslatableString VST3EffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 113 of file VST3EffectsModule.cpp.

{
   return XO("Adds the ability to use VST3 effects in Audacity.");
}

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & VST3EffectsModule::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 VST3EffectsModule.cpp.

{
   static const FileExtensions ext {
      { _T("vst3") }
   };
   return ext;
}

GetModule()

std::shared_ptr< VST3::Hosting::Module > VST3EffectsModule::GetModule ( const wxString &  path )

private

Definition at line 71 of file VST3EffectsModule.cpp.

{
   const auto it = mModules.find(path);
   if(it != mModules.end())
   {
      if(auto lock = it->second.lock())
         return lock;
   }
 
   std::string moduleCreateError;
   //VST sdk provides platform-specific module loading routines as well,
   //implementation is conditionally included (see CMakeLists.txt)
   auto module = VST3::Hosting::Module::create(path.ToStdString(), moduleCreateError);
   if(!module)
      throw std::runtime_error(moduleCreateError.c_str());
 
   module->getFactory().setHostContext(&AudacityVst3HostApplication::Get());
 
   mModules[path] = module;
   return module;
}

References AudacityVst3HostApplication::Get(), and mModules.

Referenced by DiscoverPluginsAtPath(), and LoadPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

GetOptionalFamilySymbol()

EffectFamilySymbol VST3EffectsModule::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 127 of file VST3EffectsModule.cpp.

{
   return VST3EffectBase::GetFamilySymbol();
}

References VST3EffectBase::GetFamilySymbol().

Here is the call graph for this function:

GetPath()

PluginPath VST3EffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 93 of file VST3EffectsModule.cpp.

{
   return {};
}

GetSymbol()

ComponentInterfaceSymbol VST3EffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 98 of file VST3EffectsModule.cpp.

{
   return XO("VST3 Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol VST3EffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 103 of file VST3EffectsModule.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString VST3EffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 108 of file VST3EffectsModule.cpp.

{
   return AUDACITY_VERSION_STRING;
}

Initialize()

bool VST3EffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 118 of file VST3EffectsModule.cpp.

{
   return true;
}

InstallPath()

FilePath VST3EffectsModule::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 140 of file VST3EffectsModule.cpp.

{
#ifdef VST3_DEFAULT_INSTALL_PATH
   return FilePath { VST3_DEFAULT_INSTALL_PATH };
#else
   return {};
#endif
}

LoadPlugin()

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

{
   try
   {
      wxString modulePath;
      std::string effectUIDString;
 
      if(!VST3Utils::ParsePluginPath(pluginPath, &modulePath, &effectUIDString))
         throw std::runtime_error("failed to parse plugin string");
 
      auto module = GetModule(modulePath);
      const auto pluginFactory = module->getFactory();
      for(const auto& classInfo : pluginFactory.classInfos())
      {
         if(effectUIDString == classInfo.ID().toString()) {
            auto result = Factory::Call(module, classInfo);
            return result;
         }
      }
      throw std::runtime_error("effect UID not found");
   }
   catch(std::exception& e)
   {
      wxLogError("VST3 Module was not loaded: %s", e.what());
   }
   return nullptr;
}

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

Here is the call graph for this function:

MakeValidator()

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

overridevirtual

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

Reimplemented from PluginProvider.

Definition at line 313 of file VST3EffectsModule.cpp.

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

SupportsCustomModulePaths()

bool VST3EffectsModule::SupportsCustomModulePaths ( ) const

overridevirtual

Reimplemented from PluginProvider.

Definition at line 153 of file VST3EffectsModule.cpp.

{
   return true;
}

Terminate()

void VST3EffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 123 of file VST3EffectsModule.cpp.

{
}

Member Data Documentation

mModules

std::unordered_map<wxString, std::weak_ptr<VST3::Hosting::Module> > VST3EffectsModule::mModules

private

Definition at line 38 of file VST3EffectsModule.h.

Referenced by GetModule().

---

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

• VST3EffectsModule.h
• VST3EffectsModule.cpp