AudioUnitEffectsModule Class Reference

#include <AudioUnitEffectsModule.h>

Inheritance diagram for AudioUnitEffectsModule:

Collaboration diagram for AudioUnitEffectsModule:

Classes
struct	Factory

Public Member Functions
	AudioUnitEffectsModule ()
virtual	~AudioUnitEffectsModule ()
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...
void	LoadAudioUnitsOfType (OSType inAUType, PluginPaths &effects)
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 30 of file AudioUnitEffectsModule.h.

Constructor & Destructor Documentation

AudioUnitEffectsModule()

AudioUnitEffectsModule::AudioUnitEffectsModule

(

)

Definition at line 117 of file AudioUnitEffectsModule.cpp.

{
}

~AudioUnitEffectsModule()

AudioUnitEffectsModule::~AudioUnitEffectsModule ( )

virtual

Definition at line 121 of file AudioUnitEffectsModule.cpp.

{
}

Member Function Documentation

AutoRegisterPlugins()

void AudioUnitEffectsModule::AutoRegisterPlugins ( PluginManagerInterface &  pluginManager )

overridevirtual

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

Implements PluginProvider.

Definition at line 187 of file AudioUnitEffectsModule.cpp.

{
}

CheckPluginExist()

bool AudioUnitEffectsModule::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 246 of file AudioUnitEffectsModule.cpp.

{
   wxString unused;
   return FindAudioUnit(path, unused) != nullptr;
}

References anonymous_namespace{AudioUnitEffectsModule.cpp}::FindAudioUnit().

Here is the call graph for this function:

DiscoverPluginsAtPath()

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

overridevirtual

Implements PluginProvider.

Definition at line 204 of file AudioUnitEffectsModule.cpp.

{
   errMsg = {};
   wxString name;
   AudioComponent component = FindAudioUnit(path, name);
   if (component == NULL)
   {
      errMsg = XO("Could not find component");
      return 0;
   }
 
   AudioUnitEffectBase effect(path, name, component);
   if (!effect.InitializePlugin())
   {
      // TODO:  Is it worth it to discriminate all the ways SetHost might
      // return false?
      errMsg = XO("Could not initialize component");
      return 0;
   }
 
   if (callback)
   {
      callback(this, &effect);
   }
 
   return 1;
}

References anonymous_namespace{AudioUnitEffectsModule.cpp}::FindAudioUnit(), AudioUnitEffectBase::InitializePlugin(), name, and XO().

Here is the call graph for this function:

FindModulePaths()

PluginPaths AudioUnitEffectsModule::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 191 of file AudioUnitEffectsModule.cpp.

{
   PluginPaths effects;
 
   LoadAudioUnitsOfType(kAudioUnitType_Effect, effects);
   LoadAudioUnitsOfType(kAudioUnitType_Generator, effects);
   LoadAudioUnitsOfType(kAudioUnitType_Mixer, effects);
   LoadAudioUnitsOfType(kAudioUnitType_MusicEffect, effects);
   LoadAudioUnitsOfType(kAudioUnitType_Panner, effects);
 
   return effects;
}

References LoadAudioUnitsOfType().

Here is the call graph for this function:

GetDescription()

TranslatableString AudioUnitEffectsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 151 of file AudioUnitEffectsModule.cpp.

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

References XO().

Here is the call graph for this function:

GetFileExtensions()

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

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

GetOptionalFamilySymbol()

EffectFamilySymbol AudioUnitEffectsModule::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 178 of file AudioUnitEffectsModule.cpp.

{
#if USE_AUDIO_UNITS
   return AUDIOUNITEFFECTS_FAMILY;
#else
   return {};
#endif
}

References AUDIOUNITEFFECTS_FAMILY.

GetPath()

PluginPath AudioUnitEffectsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 129 of file AudioUnitEffectsModule.cpp.

{
   return {};
}

GetSymbol()

ComponentInterfaceSymbol AudioUnitEffectsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 134 of file AudioUnitEffectsModule.cpp.

{
   /* i18n-hint: Audio Unit is the name of an Apple audio software protocol */
   return XO("Audio Unit Effects");
}

References XO().

Here is the call graph for this function:

GetVendor()

VendorSymbol AudioUnitEffectsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 140 of file AudioUnitEffectsModule.cpp.

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

References XO().

Here is the call graph for this function:

GetVersion()

wxString AudioUnitEffectsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 145 of file AudioUnitEffectsModule.cpp.

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

References AUDIOUNITEFFECTS_VERSION.

Initialize()

bool AudioUnitEffectsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns

"true" if initialization was successful

Implements PluginProvider.

Definition at line 166 of file AudioUnitEffectsModule.cpp.

{
   // Nothing to do here
   return true;
}

InstallPath()

FilePath AudioUnitEffectsModule::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 AudioUnitEffectsModule.h.

{ return {}; }

LoadAudioUnitsOfType()

void AudioUnitEffectsModule::LoadAudioUnitsOfType	(	OSType	inAUType,
		PluginPaths &	effects
	)

Definition at line 256 of file AudioUnitEffectsModule.cpp.

{
   AudioComponentDescription desc;
   AudioComponent component;
 
   desc.componentType = inAUType;
   desc.componentSubType = 0;
   desc.componentManufacturer = 0;
   desc.componentFlags = 0;
   desc.componentFlagsMask = 0;
 
   component = AudioComponentFindNext(NULL, &desc);
   while (component != NULL)
   {
      OSStatus result;
      AudioComponentDescription found;
 
      result = AudioComponentGetDescription(component, &found);
      if (result == noErr)
      {
         CFStringRef cfName{};
         result = AudioComponentCopyName(component, &cfName);
         CF_ptr<CFStringRef> uName{ cfName };
         if (result == noErr) {
            wxString path;
 
            path.Printf(wxT("%-4.4s/%-4.4s/%-4.4s/%s"),
                        FromOSType(found.componentManufacturer),
                        FromOSType(found.componentType),
                        FromOSType(found.componentSubType),
                        wxCFStringRef::AsString(cfName));
 
            for (int i = 0; i < WXSIZEOF(BlackList); ++i) {
               if (BlackList[i].componentType == found.componentType &&
                   BlackList[i].componentSubType == found.componentSubType &&
                   BlackList[i].componentManufacturer ==
                      found.componentManufacturer) {
                  wxLogDebug(wxT("Blacklisted AU skipped: %s"), path);
                  result = !noErr;
                  break;
               }
            }
            if (result == noErr)
               effects.push_back(path);
         }
      }
      component = AudioComponentFindNext(component, &desc);
   }
}

References BlackList, componentType, anonymous_namespace{ExportPCM.cpp}::desc, anonymous_namespace{AudioUnitEffectsModule.cpp}::FromOSType(), and wxT().

Referenced by FindModulePaths().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadPlugin()

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

{
   // Acquires a resource for the application.
   if (wxString name; auto component = FindAudioUnit(path, name)) {
      auto result = Factory::Call(path, name, component);
      result->InitializePlugin();
      return result;
   }
   return nullptr;
}

References GlobalHook< Factory, std::remove_pointer_t< decltype(DefaultFunction)>, DefaultFunction, Options... >::Call(), anonymous_namespace{AudioUnitEffectsModule.cpp}::FindAudioUnit(), and name.

Here is the call graph for this function:

Terminate()

void AudioUnitEffectsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 172 of file AudioUnitEffectsModule.cpp.

{
   // Nothing to do here
   return;
}

---

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

• AudioUnitEffectsModule.h
• AudioUnitEffectsModule.cpp