NyquistEffectsModule Class Reference

#include <LoadNyquist.h>

Inheritance diagram for NyquistEffectsModule:

Collaboration diagram for NyquistEffectsModule:

Public Member Functions
	NyquistEffectsModule ()
virtual	~NyquistEffectsModule ()
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 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 21 of file LoadNyquist.h.

Constructor & Destructor Documentation

NyquistEffectsModule()

NyquistEffectsModule::NyquistEffectsModule

(

)

Definition at line 86 of file LoadNyquist.cpp.

{
}

~NyquistEffectsModule()

NyquistEffectsModule::~NyquistEffectsModule ( )

virtual

Definition at line 90 of file LoadNyquist.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void NyquistEffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 177 of file LoadNyquist.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 = NyquistBase::GetNyquistSearchPath();
   FilePaths files;
   TranslatableString ignoredErrMsg;
 
   auto name = NYQUIST_PROMPT_NAME;
   if (!pm.IsPluginRegistered(NYQUIST_PROMPT_ID, &name))
   {
      // No checking of error ?
      DiscoverPluginsAtPath(NYQUIST_PROMPT_ID, ignoredErrMsg,
         PluginManagerInterface::DefaultRegistrationCallback);
   }
 
   for (size_t i = 0; i < WXSIZEOF(kShippedEffects); i++)
   {
      files.clear();
      pm.FindFilesInPathList(kShippedEffects[i], pathList, files);
      for (size_t j = 0, cnt = files.size(); j < cnt; j++)
      {
         /*
           TODO: Currently the names of Nyquist plug-ins cannot have
          context specific translations or internal names different from
          the visible English names.
 
          This makes it unnecessary to pass a second argument to
          IsPluginRegistered for correction of the registry (as is needed
          in the case of built-in effects).
 
          If it does become necessary in the future, we will need to open the
          .ny files to access their $name lines so that this argument could
          be supplied.
          */
         if (!pm.IsPluginRegistered(files[j]))
         {
            // No checking of error ?
            DiscoverPluginsAtPath(files[j], ignoredErrMsg,
               PluginManagerInterface::DefaultRegistrationCallback);
         }
      }
   }
}

References PluginManagerInterface::DefaultRegistrationCallback(), DiscoverPluginsAtPath(), PluginManagerInterface::FindFilesInPathList(), NyquistBase::GetNyquistSearchPath(), PluginManagerInterface::IsPluginRegistered(), kShippedEffects, name, NYQUIST_PROMPT_ID, and NYQUIST_PROMPT_NAME.

Here is the call graph for this function:

CheckPluginExist()

bool NyquistEffectsModule::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 265 of file LoadNyquist.cpp.

{
   if(path == NYQUIST_PROMPT_ID)
      return true;
 
   return wxFileName::FileExists(path);
}

References NYQUIST_PROMPT_ID.

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 238 of file LoadNyquist.cpp.

{
   errMsg = {};
   NyquistBase effect(path);
   if (effect.IsOk())
   {
      if (callback)
         callback(this, &effect);
      return 1;
   }
 
   errMsg = effect.InitializationError();
   return 0;
}

References NyquistBase::InitializationError(), and NyquistBase::IsOk().

Referenced by AutoRegisterPlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

FindModulePaths()

PluginPaths NyquistEffectsModule::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 222 of file LoadNyquist.cpp.

{
   auto pathList = NyquistBase::GetNyquistSearchPath();
   FilePaths files;
 
   // Add the Nyquist prompt
   files.push_back(NYQUIST_PROMPT_ID);
 
   // Load .ny plug-ins
   pm.FindFilesInPathList(wxT("*.ny"), pathList, files);
   // LLL:  Works for all platform with NEW plugin support (dups are removed)
   pm.FindFilesInPathList(wxT("*.NY"), pathList, files); // Ed's fix for bug 179
 
   return { files.begin(), files.end() };
}

References PluginManagerInterface::FindFilesInPathList(), NyquistBase::GetNyquistSearchPath(), NYQUIST_PROMPT_ID, and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString NyquistEffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 119 of file LoadNyquist.cpp.

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

References XO().

Here is the call graph for this function:

GetFileExtensions()

const FileExtensions & NyquistEffectsModule::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 166 of file LoadNyquist.cpp.

{
   static FileExtensions result{{ _T("ny") }};
   return result;
}

GetOptionalFamilySymbol()

EffectFamilySymbol NyquistEffectsModule::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 157 of file LoadNyquist.cpp.

{
#if USE_NYQUIST
   return NYQUISTEFFECTS_FAMILY;
#else
   return {};
#endif
}

References NYQUISTEFFECTS_FAMILY.

GetPath()

PluginPath NyquistEffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 98 of file LoadNyquist.cpp.

{
   return {};
}

GetSymbol()

ComponentInterfaceSymbol NyquistEffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 103 of file LoadNyquist.cpp.

{
   return XO("Nyquist Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol NyquistEffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 108 of file LoadNyquist.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString NyquistEffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 113 of file LoadNyquist.cpp.

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

References NYQUISTEFFECTS_VERSION.

Initialize()

bool NyquistEffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 128 of file LoadNyquist.cpp.

{
   const auto &audacityPathList = FileNames::AudacityPathList();
 
   for (size_t i = 0, cnt = audacityPathList.size(); i < cnt; i++)
   {
      wxFileName name(audacityPathList[i], wxT(""));
      name.AppendDir(wxT("nyquist"));
      name.SetFullName(wxT("nyquist.lsp"));
      if (name.FileExists())
      {
         // set_xlisp_path doesn't handle fn_Str() in Unicode build. May or may not actually work.
         nyx_set_xlisp_path(name.GetPath().ToUTF8());
         return true;
      }
   }
 
   wxLogWarning(wxT("Critical Nyquist files could not be found. Nyquist effects will not work."));
 
   return false;
}

References FileNames::AudacityPathList(), name, and wxT().

Here is the call graph for this function:

InstallPath()

FilePath NyquistEffectsModule::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 172 of file LoadNyquist.cpp.

{
   return FileNames::PlugInDir();
}

References FileNames::PlugInDir().

Here is the call graph for this function:

LoadPlugin()

std::unique_ptr< ComponentInterface > NyquistEffectsModule::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 256 of file LoadNyquist.cpp.

{
   // Acquires a resource for the application.
   auto effect = NyquistBase::GetEffectHook::Call(path);
   if (effect && effect->IsOk())
      return effect;
   return nullptr;
}

References GlobalHook< GetEffectHook, std::unique_ptr< NyquistBase >(const wxString &pluginId)>::Call().

Here is the call graph for this function:

Terminate()

void NyquistEffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 150 of file LoadNyquist.cpp.

{
   nyx_set_xlisp_path(NULL);
 
   return;
}

---

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

• LoadNyquist.h
• LoadNyquist.cpp