An Effect class that handles a wide range of effects. ??Mac only?? More...

#include <AudioUnitEffect.h>

Inheritance diagram for AudioUnitEffect:

Collaboration diagram for AudioUnitEffect:

Public Types
using	Parameters = PackedArray::Ptr< const AudioUnitParameterID >

Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >

Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , Since_3_2 , Always }
	In which versions of Audacity was an effect realtime capable? More...

Public Member Functions
	AudioUnitEffect (const PluginPath &path, const wxString &name, AudioComponent component, Parameters pParameters=nullptr, AudioUnitEffect master=nullptr)

virtual	~AudioUnitEffect ()

PluginPath	GetPath () const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

EffectType	GetType () const override
	Type determines how it behaves. More...

EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...

RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...

EffectSettings	MakeSettings () const override

bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst, SettingsCopyDirection) const override
	Update one settings object from another. More...

bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...

bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	May allocate memory, so should be called only in the main thread. More...

bool	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
	Change settings to a user-named preset. More...

bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...

RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...

bool	LoadFactoryPreset (int id, EffectSettings &settings) const override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override

bool	InitializePlugin ()

bool	FullyInitializePlugin ()

std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Adds controls to a panel that is given as the parent window of `S` More...

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

Public Member Functions inherited from PerTrackEffect
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override

bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

EffectType	GetType () const override
	Type determines how it behaves. More...

EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...

RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...

bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...

bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...

bool	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
	Change settings to a user-named preset. More...

bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...

RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...

bool	LoadFactoryPreset (int id, EffectSettings &settings) const override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

bool	LoadFactoryDefaults (EffectSettings &settings) const override
	Change settings back to "factory default". More...

virtual const EffectParameterMethods &	Parameters () const

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override

EffectUIClientInterface *	GetEffectUIClientInterface () override
	Returns the EffectUIClientInterface instance for this effect. More...

std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
	Usually applies factory to self and given access. More...

bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override

bool	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

unsigned	TestUIFlags (unsigned mask)

bool	Delegate (Effect &delegate, EffectSettings &settings)
	Re-invoke DoEffect on another Effect object that implements the work. More...

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const

bool	EnableApply (bool enable=true)

wxWindow *	GetUIParent ()

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0

virtual bool	IsGraphicalUI ()=0

virtual std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual bool	CanExportPresets ()=0

virtual void	ExportPresets (const EffectSettings &settings) const =0

virtual void	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
	Usually applies factory to self and given access. More...

virtual EffectUIClientInterface *	GetEffectUIClientInterface ()=0
	Returns the EffectUIClientInterface instance for this effect. More...

virtual void	Preview (EffectSettingsAccess &access, bool dryOnly)=0

virtual bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0

virtual bool	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

virtual bool	DoEffect (EffectSettings &settings, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
	Unfortunately complicated dual-use function. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)=0
	Update controls for the settings. More...

virtual bool	TransferDataFromWindow (EffectSettings &settings)=0
	Update the given settings from controls. More...

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

virtual std::shared_ptr< EffectInstance >	MakeInstance () const =0
	Make an object maintaining short-term state of an Effect. More...

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

virtual bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)

virtual bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetType () const =0
	Type determines how it behaves. More...

virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...

virtual EffectFamilySymbol	GetFamily () const =0
	Report identifier and user-visible name of the effect protocol. More...

virtual bool	IsInteractive () const =0
	Whether the effect needs a dialog for entry of settings. More...

virtual bool	IsDefault () const =0
	Whether the effect sorts "above the line" in the menus. More...

virtual RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsRealtime () const

virtual bool	SupportsAutomation () const =0
	Whether the effect has any automatable controls. More...

virtual bool	EnablesDebug () const
	Whether the effect dialog should have a Debug button; default, always false. More...

virtual ManualPageID	ManualPage () const
	Name of a page in the Audacity alpha manual, default is empty. More...

virtual FilePath	HelpPage () const
	Fully qualified local help file name, default is empty. More...

virtual bool	IsHiddenFromMenus () const
	Default is false. 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
TranslatableString	Export (const AudioUnitEffectSettings &settings, const wxString &path) const

TranslatableString	Import (AudioUnitEffectSettings &settings, const wxString &path) const

TranslatableString	SaveBlobToConfig (const RegistryPath &group, const wxString &path, const void *blob, size_t len, bool allowEmpty=true) const

void	GetChannelCounts ()

bool	MigrateOldConfigFile (const RegistryPath &group, EffectSettings &settings) const

bool	LoadPreset (const RegistryPath &group, EffectSettings &settings) const

bool	SavePreset (const RegistryPath &group, const AudioUnitEffectSettings &settings) const

Private Member Functions inherited from AudioUnitWrapper
	AudioUnitWrapper (AudioComponent component, Parameters *pParameters)

template<typename T >
OSStatus	GetFixedSizeProperty (AudioUnitPropertyID inID, T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

template<typename T >
OSStatus	GetVariableSizeProperty (AudioUnitPropertyID inID, PackedArray::Ptr< T > &pObject, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

template<typename T >
OSStatus	SetProperty (AudioUnitPropertyID inID, const T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

void	ForEachParameter (ParameterVisitor visitor) const

std::pair< CF_ptr< CFDataRef >, TranslatableString >	MakeBlob (const AudioUnitEffectSettings &settings, const wxCFStringRef &cfname, bool binary) const
	Obtain dump of the setting state of an AudioUnit instance. More...

TranslatableString	InterpretBlob (AudioUnitEffectSettings &settings, const wxString &group, const wxMemoryBuffer &buf) const
	Interpret the dump made before by MakeBlob. More...

bool	FetchSettings (AudioUnitEffectSettings &settings) const
	May allocate memory, so should be called only in the main thread. More...

bool	StoreSettings (const AudioUnitEffectSettings &settings) const

bool	CreateAudioUnit ()

AudioUnit	GetAudioUnit () const

AudioComponent	GetComponent () const

const Parameters &	GetParameters () const

bool	SetRateAndChannels (double sampleRate, const wxString &identifier)

Private Attributes
const PluginPath	mPath

const wxString	mName

const wxString	mVendor

bool	mInteractive { false }

bool	mUseLatency { true }

wxWindow *	mParent {}

wxString	mUIType

Private Attributes inherited from AudioUnitWrapper
const AudioComponent	mComponent

AudioUnitCleanup< AudioUnit, AudioComponentInstanceDispose >	mUnit

Parameters	mOwnParameters

Parameters &	mParameters

unsigned	mAudioIns { 2 }

unsigned	mAudioOuts { 2 }

Additional Inherited Members
Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

static void	IncEffectCounter ()

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Static Public Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")

static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")

static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")

static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

bool	Process (EffectInstance &instance, EffectSettings &settings) const

Protected Member Functions inherited from Effect
bool	EnablePreview (bool enable=true)

bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns `previewLength` More...

virtual std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
	Add controls to effect panel; always succeeds. More...

bool	TotalProgress (double frac, const TranslatableString &={}) const

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

Protected Member Functions inherited from EffectBase
void	Preview (EffectSettingsAccess &access, bool dryOnly) override

bool	DoEffect (EffectSettings &settings, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
	Unfortunately complicated dual-use function. More...

virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

Protected Attributes inherited from Effect
wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWindow *	mUIParent {}

Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Private Types inherited from AudioUnitWrapper
using	Parameters = PackedArray::Ptr< const AudioUnitParameterID >

using	ParameterVisitor = std::function< bool(const ParameterInfo &pi, AudioUnitParameterID ID) >
	Return value: if true, continue visiting. More...

Static Private Member Functions inherited from AudioUnitWrapper
static AudioUnitEffectSettings &	GetSettings (EffectSettings &settings)

static const AudioUnitEffectSettings &	GetSettings (const EffectSettings &settings)

Detailed Description

An Effect class that handles a wide range of effects. ??Mac only??

Definition at line 40 of file AudioUnitEffect.h.

Member Typedef Documentation

◆ Parameters

using AudioUnitEffect::Parameters = PackedArray::Ptr<const AudioUnitParameterID>

Definition at line 45 of file AudioUnitEffect.h.

Constructor & Destructor Documentation

◆ AudioUnitEffect()

AudioUnitEffect::AudioUnitEffect	(	const PluginPath &	path,
		const wxString &	name,
		AudioComponent	component,
		Parameters *	pParameters = `nullptr`,
		AudioUnitEffect *	master = `nullptr`
	)

Definition at line 95 of file AudioUnitEffect.cpp.

   : AudioUnitWrapper{ component, pParameters }
   , mPath{ path }
   , mName{ name.AfterFirst(wxT(':')).Trim(true).Trim(false) }
   , mVendor{ name.BeforeFirst(wxT(':')).Trim(true).Trim(false) }
{
}

◆ ~AudioUnitEffect()

AudioUnitEffect::~AudioUnitEffect ( )

virtual

Definition at line 105 of file AudioUnitEffect.cpp.

106{

107}

Member Function Documentation

◆ CanExportPresets()

bool AudioUnitEffect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 450 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ CloseUI()

bool AudioUnitEffect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 439 of file AudioUnitEffect.cpp.

{
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(false);
#endif
#endif
   mParent = nullptr;
   return true;
}

References mParent.

◆ CopySettingsContents()

bool AudioUnitEffect::CopySettingsContents	(	const EffectSettings &	src,
		EffectSettings &	dst,
		SettingsCopyDirection	copyDirection
	)		const

overridevirtual

Update one settings object from another.

This may run in a worker thread, and should avoid memory allocations. Therefore do not copy the underlying std::any, but copy the contents of the contained objects.

Assume that src and dst were created and previously modified only by this

Default implementation does nothing and returns true

Parameters

src	settings to copy from
dst	settings to copy into
copyDirection	direction in which copy is performed

Returns: success

Reimplemented from EffectSettingsManager.

Definition at line 306 of file AudioUnitEffect.cpp.

{
   auto &dstSettings = GetSettings(dst);
   auto &srcSettings = GetSettings(src);
   dstSettings.pSource = srcSettings.pSource;
 
   // Do an in-place rewrite of dst, avoiding allocations
   auto &dstMap = dstSettings.values;
   auto dstIter = dstMap.begin(), dstEnd = dstMap.end();
   const auto &srcMap = srcSettings.values;
   // Iterate the two maps in parallel, assuming correspondence of
   // keys, because the settings objects ultimately came from MakeSettings()
   // and copies.  Nothing else ever inserts or removes keys.
   assert(srcMap.size() == dstMap.size());
   for (auto &[key, oValue] : srcMap) {
      assert(dstIter != dstEnd);
      auto &[dstKey, dstOValue] = *dstIter;
      assert(dstKey == key);
      if (oValue)
         dstOValue.emplace(*oValue);
      else
         dstOValue.reset();
      ++dstIter;
   }
   assert(dstIter == dstEnd);
   return true;
}

References AudioUnitWrapper::GetSettings(), and key.

Here is the call graph for this function:

◆ Export()

TranslatableString AudioUnitEffect::Export	(	const AudioUnitEffectSettings &	settings,
		const wxString &	path
	)		const

private

Definition at line 619 of file AudioUnitEffect.cpp.

{
   // Create the file
   wxFFile f(path, wxT("wb"));
   if (!f.IsOpened())
      return XO("Couldn't open \"%s\"").Format(path);
 
   // First set the name of the preset
   wxCFStringRef cfname(wxFileName(path).GetName());
 
   const auto &[data, message] = MakeBlob(settings, cfname, false);
   if (!data || !message.empty())
      return message;
 
   // Write XML data
   auto length = CFDataGetLength(data.get());
   if (f.Write(CFDataGetBytePtr(data.get()), length) != length || f.Error())
      return XO("Failed to write XML preset to \"%s\"").Format(path);
 
   f.Close();
   return {};
}

References ComponentInterface::GetName(), AudioUnitWrapper::MakeBlob(), settings(), wxT(), and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExportPresets()

void AudioUnitEffect::ExportPresets ( const EffectSettings & settings ) const

overridevirtual

Implements EffectUIClientInterface.

Definition at line 455 of file AudioUnitEffect.cpp.

{
   // Generate the user domain path
   wxFileName fn;
   fn.SetPath(PRESET_USER_PATH);
   fn.AppendDir(mVendor);
   fn.AppendDir(mName);
   fn.Normalize();
   FilePath path = fn.GetFullPath();
 
   if (!fn.Mkdir(fn.GetFullPath(), 0755, wxPATH_MKDIR_FULL)) {
      wxLogError(wxT("Couldn't create the \"%s\" directory"), fn.GetPath());
      return;
   }
 
   // Ask the user for the name to use
   //
   // Passing a valid parent will cause some effects dialogs to malfunction
   // upon returning from the SelectFile().
   path = SelectFile(FileNames::Operation::_None,
      XO("Export Audio Unit Preset As %s:").Format(fn.GetFullPath()),
      fn.GetFullPath(),
      wxEmptyString,
      wxT("aupreset"),
      {
        { XO("Standard Audio Unit preset file"), { wxT("aupreset") }, true },
      },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
      NULL);
 
   // User canceled...
   if (path.empty())
      return;
 
   auto msg = Export(GetSettings(settings), path);
   if (!msg.empty())
      AudacityMessageBox(
         XO("Could not export \"%s\" preset\n\n%s").Format(path, msg),
         XO("Export Audio Unit Presets"),
         wxOK | wxCENTRE,
         mParent);
}

References AudacityMessageBox(), Export(), fn, AudioUnitWrapper::GetSettings(), mName, mParent, mVendor, PRESET_USER_PATH, SelectFile(), settings(), wxT(), and XO.

Here is the call graph for this function:

◆ FullyInitializePlugin()

bool AudioUnitEffect::FullyInitializePlugin ( )

Definition at line 256 of file AudioUnitEffect.cpp.

{
   if (!InitializePlugin())
      return false;
 
   // Reading these values from the config file can't be done in the PluginHost
   // process but isn't needed only for plugin discovery.
 
   // Consult preferences
   // Decide mUseLatency, which affects GetLatency(), which is actually used
   // so far only in destructive effect processing
   GetConfig(*this, PluginSettings::Shared, OptionsKey, UseLatencyKey,
      mUseLatency, true);
   // Decide whether to build plain or fancy user interfaces
   GetConfig(*this, PluginSettings::Shared, OptionsKey, UITypeKey,
      mUIType, FullValue.MSGID().GET() /* Config stores un-localized string */);
 
   return true;
}

References FullValue, PluginSettings::GetConfig(), InitializePlugin(), mUIType, mUseLatency, OptionsKey, PluginSettings::Shared, UITypeKey, and UseLatencyKey.

Here is the call graph for this function:

◆ GetChannelCounts()

void AudioUnitEffect::GetChannelCounts ( )

private

Definition at line 665 of file AudioUnitEffect.cpp.

{
   // Does AU have channel info
   PackedArray::Ptr<AUChannelInfo> info;
   if (GetVariableSizeProperty(kAudioUnitProperty_SupportedNumChannels, info)) {
      // None supplied.  Apparently all FX type units can do any number of INs
      // and OUTs as long as they are the same number.  In this case, we'll
      // just say stereo.
      //
      // We should probably check to make sure we're dealing with an FX type.
      mAudioIns = 2;
      mAudioOuts = 2;
      return;
   }
 
   // This is where it gets weird...not sure what is the best
   // way to do this really.  If we knew how many ins/outs we
   // really needed, we could make a better choice.
 
   bool haven2m = false;   // nothing -> mono
   bool haven2s = false;   // nothing -> stereo
   bool havem2n = false;   // mono -> nothing
   bool haves2n = false;   // stereo -> nothing
   bool havem2m = false;   // mono -> mono
   bool haves2s = false;   // stereo -> stereo
   bool havem2s = false;   // mono -> stereo
   bool haves2m = false;   // stereo -> mono
 
   mAudioIns = 2;
   mAudioOuts = 2;
 
   // Look only for exact channel constraints
   for (auto &ci : info) {
      int ic = ci.inChannels;
      int oc = ci.outChannels;
 
      if (ic < 0 && oc >= 0)
         ic = 2;
      else if (ic >= 0 && oc < 0)
         oc = 2;
      else if (ic < 0 && oc < 0) {
         ic = 2;
         oc = 2;
      }
 
      if (ic == 2 && oc == 2)
         haves2s = true;
      else if (ic == 1 && oc == 1)
         havem2m = true;
      else if (ic == 1 && oc == 2)
         havem2s = true;
      else if (ic == 2 && oc == 1)
         haves2m = true;
      else if (ic == 0 && oc == 2)
         haven2s = true;
      else if (ic == 0 && oc == 1)
         haven2m = true;
      else if (ic == 1 && oc == 0)
         havem2n = true;
      else if (ic == 2 && oc == 0)
         haves2n = true;
   }
 
   if (haves2s) {
      mAudioIns = 2;
      mAudioOuts = 2;
   }
   else if (havem2m) {
      mAudioIns = 1;
      mAudioOuts = 1;
   }
   else if (havem2s) {
      mAudioIns = 1;
      mAudioOuts = 2;
   }
   else if (haves2m) {
      mAudioIns = 2;
      mAudioOuts = 1;
   }
   else if (haven2m) {
      mAudioIns = 0;
      mAudioOuts = 1;
   }
   else if (haven2s) {
      mAudioIns = 0;
      mAudioOuts = 2;
   }
   else if (haves2n) {
      mAudioIns = 2;
      mAudioOuts = 0;
   }
   else if (havem2n) {
      mAudioIns = 1;
      mAudioOuts = 0;
   }
 
   return;
}

References AudioUnitWrapper::GetVariableSizeProperty(), AudioUnitWrapper::mAudioIns, and AudioUnitWrapper::mAudioOuts.

Referenced by InitializePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString AudioUnitEffect::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 140 of file AudioUnitEffect.cpp.

{
   /* i18n-hint: Can mean "not available," "not applicable," "no answer" */
   return XO("n/a");
}

References XO.

◆ GetFactoryPresets()

RegistryPaths AudioUnitEffect::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Implements EffectSettingsManager.

Definition at line 406 of file AudioUnitEffect.cpp.

{
   RegistryPaths presets;
 
   // Retrieve the list of factory presets
   CF_ptr<CFArrayRef> array;
   if (!GetFixedSizeProperty(kAudioUnitProperty_FactoryPresets, array))
      for (CFIndex i = 0, cnt = CFArrayGetCount(array.get()); i < cnt; ++i)
         presets.push_back(wxCFStringRef::AsString(
            static_cast<const AUPreset*>(CFArrayGetValueAtIndex(array.get(), i))
               ->presetName));
   return presets;
}

References AudioUnitWrapper::GetFixedSizeProperty().

Here is the call graph for this function:

◆ GetFamily()

EffectFamilySymbol AudioUnitEffect::GetFamily ( ) const

overridevirtual

Report identifier and user-visible name of the effect protocol.

Implements EffectDefinitionInterface.

Definition at line 170 of file AudioUnitEffect.cpp.

{
   return AUDIOUNITEFFECTS_FAMILY;
}

References AUDIOUNITEFFECTS_FAMILY.

◆ GetPath()

PluginPath AudioUnitEffect::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 113 of file AudioUnitEffect.cpp.

{
   return mPath;
}

References mPath.

◆ GetSymbol()

ComponentInterfaceSymbol AudioUnitEffect::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 118 of file AudioUnitEffect.cpp.

{
   return mName;
}

References mName.

Referenced by InitializePlugin(), and MakeInstance().

Here is the caller graph for this function:

◆ GetType()

EffectType AudioUnitEffect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 150 of file AudioUnitEffect.cpp.

{
   if (mAudioIns == 0 && mAudioOuts == 0)
   {
      return EffectTypeNone;
   }
 
   if (mAudioIns == 0)
   {
      return EffectTypeGenerate;
   }
 
   if (mAudioOuts == 0)
   {
      return EffectTypeAnalyze;
   }
 
   return EffectTypeProcess;
}

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeNone, EffectTypeProcess, AudioUnitWrapper::mAudioIns, and AudioUnitWrapper::mAudioOuts.

Referenced by RealtimeSupport(), and ShowClientInterface().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol AudioUnitEffect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 123 of file AudioUnitEffect.cpp.

{
   return { mVendor };
}

References mVendor.

◆ GetVersion()

wxString AudioUnitEffect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 128 of file AudioUnitEffect.cpp.

{
   UInt32 version;
 
   OSStatus result = AudioComponentGetVersion(mComponent, &version);
 
   return wxString::Format(wxT("%d.%d.%d"),
                           (version >> 16) & 0xffff,
                           (version >> 8) & 0xff,
                           version & 0xff);
}

References AudioUnitWrapper::mComponent, and wxT().

Here is the call graph for this function:

◆ HasOptions()

bool AudioUnitEffect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 534 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ Import()

TranslatableString AudioUnitEffect::Import	(	AudioUnitEffectSettings &	settings,
		const wxString &	path
	)		const

private

Definition at line 643 of file AudioUnitEffect.cpp.

{
   // Open the preset
   wxFFile f(path, wxT("r"));
   if (!f.IsOpened())
      return XO("Couldn't open \"%s\"").Format(path);
 
   // Load it into the buffer
   size_t len = f.Length();
   wxMemoryBuffer buf(len);
   if (f.Read(buf.GetData(), len) != len || f.Error())
      return XO("Unable to read the preset from \"%s\"").Format(path);
   buf.SetDataLen(len);
 
   const auto error = InterpretBlob(settings, path, buf);
   if (!error.empty())
      return error;
 
   return {};
}

References AudioUnitWrapper::InterpretBlob(), settings(), wxT(), and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ImportPresets()

void AudioUnitEffect::ImportPresets ( EffectSettings & settings )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 498 of file AudioUnitEffect.cpp.

{
   // Generate the user domain path
   wxFileName fn;
   fn.SetPath(PRESET_USER_PATH);
   fn.AppendDir(mVendor);
   fn.AppendDir(mName);
   fn.Normalize();
   FilePath path = fn.GetFullPath();
 
   // Ask the user for the name to use
   //
   // Passing a valid parent will cause some effects dialogs to malfunction
   // upon returning from the SelectFile().
   path = SelectFile(FileNames::Operation::_None,
      XO("Import Audio Unit Preset As %s:").Format(fn.GetFullPath()),
      fn.GetFullPath(), wxEmptyString, wxT("aupreset"),
      {
        { XO("Standard Audio Unit preset file"), { wxT("aupreset") }, true },
      },
      wxFD_OPEN | wxRESIZE_BORDER,
      nullptr);
 
   // User canceled...
   if (path.empty())
      return;
 
   auto msg = Import(GetSettings(settings), path);
   if (!msg.empty())
      AudacityMessageBox(
         XO("Could not import \"%s\" preset\n\n%s").Format(path, msg),
         XO("Import Audio Unit Presets"),
         wxOK | wxCENTRE,
         mParent);
}

References AudacityMessageBox(), fn, AudioUnitWrapper::GetSettings(), Import(), mName, mParent, mVendor, PRESET_USER_PATH, SelectFile(), settings(), wxT(), and XO.

Here is the call graph for this function:

◆ InitializePlugin()

bool AudioUnitEffect::InitializePlugin ( )

Definition at line 215 of file AudioUnitEffect.cpp.

{
   // To implement the services of EffectPlugin -- such as, a query of the
   // set of effect parameters, so that we can implement MakeSettings -- we
   // also need what is called an AudioComponentInstance, also called an
   // AudioUnit.
   // It's not just for implementing EffectInstance.  AudioUnits is unlike other
   // third party effect families that distinguish the notions of plug-in and
   // instance.
 
   GetChannelCounts();
 
   if (!CreateAudioUnit())
      return false;
 
   // Use an arbitrary rate while completing the discovery of channel support
   if (!SetRateAndChannels(44100.0, GetSymbol().Internal()))
      return false;
 
   // Determine interactivity
   mInteractive = (Count(mParameters) > 0);
   if (!mInteractive) {
      // Check for a Cocoa UI
      // This could retrieve a variable-size property, but we only look at
      // the first element.
      AudioUnitCocoaViewInfo cocoaViewInfo;
      mInteractive =
         !GetFixedSizeProperty(kAudioUnitProperty_CocoaUI, cocoaViewInfo);
      if (!mInteractive) {
         // Check for a Carbon UI
         // This could retrieve a variable sized array but we only need the
         // first
         AudioComponentDescription compDesc;
         mInteractive = !GetFixedSizeProperty(
            kAudioUnitProperty_GetUIComponentList, compDesc);
      }
   }
 
   return true;
}

References PackedArray::Count(), AudioUnitWrapper::CreateAudioUnit(), GetChannelCounts(), AudioUnitWrapper::GetFixedSizeProperty(), GetSymbol(), Internal, mInteractive, AudioUnitWrapper::mParameters, and AudioUnitWrapper::SetRateAndChannels().

Referenced by AudioUnitEffectsModule::DiscoverPluginsAtPath(), and FullyInitializePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDefault()

bool AudioUnitEffect::IsDefault ( ) const

overridevirtual

Whether the effect sorts "above the line" in the menus.

Implements EffectDefinitionInterface.

Definition at line 180 of file AudioUnitEffect.cpp.

{
   return false;
}

◆ IsInteractive()

bool AudioUnitEffect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 175 of file AudioUnitEffect.cpp.

{
   return mInteractive;
}

References mInteractive.

◆ LoadFactoryPreset()

bool AudioUnitEffect::LoadFactoryPreset	(	int	id,
		EffectSettings &	settings
	)		const

overridevirtual

Change settings to the preset whose name is GetFactoryPresets()[id]

Implements EffectSettingsManager.

Definition at line 382 of file AudioUnitEffect.cpp.

{
   // Issue 3441: Some factory presets of some effects do not reassign all
   // controls.  So first put controls into a default state, not contaminated
   // by previous importing or other loading of settings into this wrapper.
   LoadPreset(FactoryDefaultsGroup(), settings);
 
   // Retrieve the list of factory presets
   CF_ptr<CFArrayRef> array;
   if (GetFixedSizeProperty(kAudioUnitProperty_FactoryPresets, array) ||
       id < 0 || id >= CFArrayGetCount(array.get()))
      return false;
 
   // Mutate the scratch pad AudioUnit in the effect
   if (!SetProperty(kAudioUnitProperty_PresentPreset,
      *static_cast<const AUPreset*>(CFArrayGetValueAtIndex(array.get(), id)))) {
      // Repopulate the AudioUnitEffectSettings from the change of state in
      // the AudioUnit
      FetchSettings(GetSettings(settings));
      return true;
   }
   return false;
}

References FactoryDefaultsGroup(), AudioUnitWrapper::FetchSettings(), AudioUnitWrapper::GetFixedSizeProperty(), AudioUnitWrapper::GetSettings(), LoadPreset(), AudioUnitWrapper::SetProperty(), and settings().

Here is the call graph for this function:

◆ LoadPreset()

bool AudioUnitEffect::LoadPreset	(	const RegistryPath &	group,
		EffectSettings &	settings
	)		const

private

Definition at line 574 of file AudioUnitEffect.cpp.

{
   if (MigrateOldConfigFile(group, settings))
      return true;
 
   // Retrieve the preset
   wxString parms;
   if (!GetConfig(*this, PluginSettings::Private, group, PRESET_KEY, parms,
      wxEmptyString)) {
      // Commented "CurrentSettings" gets tried a lot and useless messages appear
      // in the log
      //wxLogError(wxT("Preset key \"%s\" not found in group \"%s\""), PRESET_KEY, group);
      return false;
   }
 
   // Decode it, complementary to what SaveBlobToConfig did
   auto error =
      InterpretBlob(GetSettings(settings), group, wxBase64Decode(parms));
   if (!error.empty()) {
      wxLogError(error.Debug());
      return false;
   }
 
   return true;
}

References PluginSettings::GetConfig(), AudioUnitWrapper::GetSettings(), AudioUnitWrapper::InterpretBlob(), MigrateOldConfigFile(), PRESET_KEY, PluginSettings::Private, and settings().

Referenced by LoadFactoryPreset(), and LoadUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadSettings()

bool AudioUnitEffect::LoadSettings	(	const CommandParameters &	parms,
		EffectSettings &	settings
	)		const

overridevirtual

May allocate memory, so should be called only in the main thread.

Implements EffectSettingsManager.

Definition at line 347 of file AudioUnitEffect.cpp.

{
   // First clean all settings, in case any are not defined in parms
   auto &mySettings = GetSettings(settings);
   mySettings.ResetValues();
   auto &map = mySettings.values;
 
   // Load settings from CommandParameters
   // Iterate the config only, not using any AudioUnit handles
   if (auto [index, key, value] = std::tuple(
         0L, wxString{}, AudioUnitParameterValue{})
       ; parms.GetFirstEntry(key, index)
   ) do {
      if (auto pKey = ParameterInfo::ParseKey(key)
         ; pKey && parms.Read(key, &value)
      )
         map[*pKey].emplace(mySettings.Intern(key), value);
   } while(parms.GetNextEntry(key, index));
   return true;
}

References AudioUnitWrapper::GetSettings(), key, AudioUnitWrapper::ParameterInfo::ParseKey(), and settings().

Referenced by MigrateOldConfigFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

bool AudioUnitEffect::LoadUserPreset	(	const RegistryPath &	name,
		EffectSettings &	settings
	)		const

overridevirtual

Change settings to a user-named preset.

Implements EffectSettingsManager.

Definition at line 369 of file AudioUnitEffect.cpp.

{
   // To do: externalize state so const_cast isn't needed
   return const_cast<AudioUnitEffect*>(this)->LoadPreset(name, settings);
}

References LoadPreset(), name, and settings().

Here is the call graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > AudioUnitEffect::MakeInstance ( ) const

overridevirtual

Make an object maintaining short-term state of an Effect.

One effect may have multiple instances extant simultaneously. Instances have state, may be implemented in foreign code, and are temporary, whereas EffectSettings represents persistent effect state that can be saved and reloaded from files.

Parameters

settings may be assumed to have a lifetime enclosing the instance's

Postcondition: true (no promises that the result isn't null)

Implements EffectInstanceFactory.

Definition at line 205 of file AudioUnitEffect.cpp.

{
   return std::make_shared<AudioUnitInstance>(*this, mComponent, mParameters,
      GetSymbol().Internal(), mAudioIns, mAudioOuts, mUseLatency);
}

References GetSymbol(), Internal, AudioUnitWrapper::mAudioIns, AudioUnitWrapper::mAudioOuts, AudioUnitWrapper::mComponent, AudioUnitWrapper::mParameters, and mUseLatency.

Here is the call graph for this function:

◆ MakeSettings()

EffectSettings AudioUnitEffect::MakeSettings ( ) const

overridevirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 299 of file AudioUnitEffect.cpp.

{
   AudioUnitEffectSettings settings;
   FetchSettings(settings);
   return EffectSettings::Make<AudioUnitEffectSettings>(std::move(settings));
}

References AudioUnitWrapper::FetchSettings(), and settings().

Here is the call graph for this function:

◆ MigrateOldConfigFile()

bool AudioUnitEffect::MigrateOldConfigFile	(	const RegistryPath &	group,
		EffectSettings &	settings
	)		const

private

Definition at line 554 of file AudioUnitEffect.cpp.

{
   // Migration of very old format configuration file, should not normally
   // happen and perhaps this code can be abandoned
   // Attempt to load old preset parameters and resave using new method
   constexpr auto oldKey = L"Parameters";
   wxString parms;
   if (GetConfig(*this, PluginSettings::Private,
      group, oldKey, parms, wxEmptyString)) {
      CommandParameters eap;
      if (eap.SetParameters(parms))
         if (LoadSettings(eap, settings))
            if (SavePreset(group, GetSettings(settings)))
               RemoveConfig(*this, PluginSettings::Private, group, oldKey);
      return true;
   }
   return false;
}

References PluginSettings::GetConfig(), AudioUnitWrapper::GetSettings(), LoadSettings(), PluginSettings::Private, PluginSettings::RemoveConfig(), SavePreset(), CommandParameters::SetParameters(), and settings().

Referenced by LoadPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateUI()

std::unique_ptr< EffectUIValidator > AudioUnitEffect::PopulateUI	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access
	)

overridevirtual

Adds controls to a panel that is given as the parent window of S

Parameters

S	interface for adding controls to a panel in a dialog
instance	guaranteed to have a lifetime containing that of the returned object
access	guaranteed to have a lifetime containing that of the returned object

Returns: null for failure; else an object invoked to retrieve values of UI controls; it might also hold some state needed to implement event handlers of the controls; it will exist only while the dialog continues to exist

Implements EffectUIClientInterface.

Definition at line 424 of file AudioUnitEffect.cpp.

{
   mParent = S.GetParent();
   return AudioUnitValidator::Create(*this, S, mUIType, instance, access);
}

References AudioUnitValidator::Create(), mParent, mUIType, and S.

Here is the call graph for this function:

◆ RealtimeSupport()

auto AudioUnitEffect::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Implements EffectDefinitionInterface.

Definition at line 185 of file AudioUnitEffect.cpp.

{
   return GetType() == EffectTypeProcess
      ? RealtimeSince::Since_3_2
      : RealtimeSince::Never;
}

References EffectTypeProcess, GetType(), EffectDefinitionInterface::Never, and EffectDefinitionInterface::Since_3_2.

Here is the call graph for this function:

◆ SaveBlobToConfig()

TranslatableString AudioUnitEffect::SaveBlobToConfig	(	const RegistryPath &	group,
		const wxString &	path,
		const void *	blob,
		size_t	len,
		bool	allowEmpty = `true`
	)		const

private

Parameters

path	only for formatting error messages

Returns: error message

Definition at line 74 of file AudioUnitEffect.cpp.

{
   // Base64 encode the returned binary property list
   auto parms = wxBase64Encode(blob, len);
   if (!allowEmpty && parms.IsEmpty())
      return XO("Failed to encode preset from \"%s\"").Format(path);
 
   // And write it to the config
   if (!SetConfig(*this, PluginSettings::Private, group, PRESET_KEY, parms))
      return XO("Unable to store preset in config file");
   return {};
}

References PRESET_KEY, PluginSettings::Private, PluginSettings::SetConfig(), and XO.

Referenced by SavePreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SavePreset()

bool AudioUnitEffect::SavePreset	(	const RegistryPath &	group,
		const AudioUnitEffectSettings &	settings
	)		const

private

Definition at line 601 of file AudioUnitEffect.cpp.

{
   wxCFStringRef cfname(wxFileNameFromPath(group));
   const auto &[data, _] = MakeBlob(settings, cfname, true);
   if (!data)
      return false;
 
   // Nothing to do if we don't have any data
   if (const auto length = CFDataGetLength(data.get())) {
      auto error =
         SaveBlobToConfig(group, {}, CFDataGetBytePtr(data.get()), length);
      if (!error.empty())
         return false;
   }
   return true;
}

References _, AudioUnitWrapper::MakeBlob(), SaveBlobToConfig(), and settings().

Referenced by MigrateOldConfigFile(), and SaveUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveSettings()

bool AudioUnitEffect::SaveSettings	(	const EffectSettings &	settings,
		CommandParameters &	parms
	)		const

overridevirtual

Store settings as keys and values.

The override may assume parms is initially empty

Returns: true on success

Implements EffectSettingsManager.

Definition at line 335 of file AudioUnitEffect.cpp.

{
   // Save settings into CommandParameters
   // Iterate the map only, not using any AudioUnit handles
   for (auto &[ID, pPair] : GetSettings(settings).values)
      if (pPair)
         // Write names, not numbers, as keys in the config file
         parms.Write(pPair->first, pPair->second);
   return true;
}

References AudioUnitWrapper::GetSettings(), settings(), and values.

Here is the call graph for this function:

◆ SaveUserPreset()

bool AudioUnitEffect::SaveUserPreset	(	const RegistryPath &	name,
		const EffectSettings &	settings
	)		const

overridevirtual

Save settings in the configuration file as a user-named preset.

Implements EffectSettingsManager.

Definition at line 376 of file AudioUnitEffect.cpp.

{
   return SavePreset(name, GetSettings(settings));
}

References AudioUnitWrapper::GetSettings(), name, SavePreset(), and settings().

Here is the call graph for this function:

◆ ShowClientInterface()

int AudioUnitEffect::ShowClientInterface	(	wxWindow &	parent,
		wxDialog &	dialog,
		EffectUIValidator *	pValidator,
		bool	forceModal
	)

overridevirtual

Returns: 0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implements EffectUIClientInterface.

Definition at line 287 of file AudioUnitEffect.cpp.

{
   if ((SupportsRealtime() || GetType() == EffectTypeAnalyze) && !forceModal) {
      dialog.Show();
      return 0;
   }
   return dialog.ShowModal();
}

References EffectTypeAnalyze, GetType(), and EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

◆ ShowOptions()

void AudioUnitEffect::ShowOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 539 of file AudioUnitEffect.cpp.

{
   AudioUnitEffectOptionsDialog dlg(mParent, mUseLatency, mUIType);
   if (dlg.ShowModal()) {
      // Save changed values to the config file
      SetConfig(*this, PluginSettings::Shared, OptionsKey, UseLatencyKey,
         mUseLatency);
      SetConfig(*this, PluginSettings::Shared, OptionsKey, UITypeKey, mUIType);
   }
}

References mParent, mUIType, mUseLatency, OptionsKey, PluginSettings::SetConfig(), PluginSettings::Shared, UITypeKey, and UseLatencyKey.

Here is the call graph for this function:

◆ SupportsAutomation()

bool AudioUnitEffect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 192 of file AudioUnitEffect.cpp.

{
   bool supports = false;
   ForEachParameter(
   [&supports](const ParameterInfo &pi, AudioUnitParameterID) {
      if (pi.mInfo.flags & kAudioUnitParameterFlag_IsWritable)
         supports = true;
      // Search only until we find one, that's all we need to know
      return !supports;
   });
   return supports;
}

References AudioUnitWrapper::ForEachParameter(), and AudioUnitWrapper::ParameterInfo::mInfo.

Here is the call graph for this function:

Member Data Documentation

◆ mInteractive

bool AudioUnitEffect::mInteractive { false }

private

Definition at line 141 of file AudioUnitEffect.h.

Referenced by InitializePlugin(), and IsInteractive().

◆ mName

const wxString AudioUnitEffect::mName

private

Definition at line 138 of file AudioUnitEffect.h.

Referenced by ExportPresets(), GetSymbol(), and ImportPresets().

◆ mParent

wxWindow* AudioUnitEffect::mParent {}

private

Definition at line 144 of file AudioUnitEffect.h.

Referenced by CloseUI(), ExportPresets(), ImportPresets(), PopulateUI(), and ShowOptions().

◆ mPath

const PluginPath AudioUnitEffect::mPath

private

Definition at line 137 of file AudioUnitEffect.h.

Referenced by GetPath().

◆ mUIType

wxString AudioUnitEffect::mUIType

private

Definition at line 145 of file AudioUnitEffect.h.

Referenced by FullyInitializePlugin(), PopulateUI(), and ShowOptions().

◆ mUseLatency

bool AudioUnitEffect::mUseLatency { true }

private

Definition at line 142 of file AudioUnitEffect.h.

Referenced by FullyInitializePlugin(), MakeInstance(), and ShowOptions().

◆ mVendor

const wxString AudioUnitEffect::mVendor

private

Definition at line 139 of file AudioUnitEffect.h.

Referenced by ExportPresets(), GetVendor(), and ImportPresets().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Parameters

Constructor & Destructor Documentation

◆ AudioUnitEffect()

◆ ~AudioUnitEffect()

Member Function Documentation

◆ CanExportPresets()

◆ CloseUI()

◆ CopySettingsContents()

◆ Export()

◆ ExportPresets()

◆ FullyInitializePlugin()

◆ GetChannelCounts()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ Import()

◆ ImportPresets()

◆ InitializePlugin()

◆ IsDefault()

◆ IsInteractive()

◆ LoadFactoryPreset()

◆ LoadPreset()

◆ LoadSettings()

◆ LoadUserPreset()

◆ MakeInstance()

◆ MakeSettings()

◆ MigrateOldConfigFile()

◆ PopulateUI()

◆ RealtimeSupport()

◆ SaveBlobToConfig()

◆ SavePreset()

◆ SaveSettings()

◆ SaveUserPreset()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

Member Data Documentation

◆ mInteractive

◆ mName

◆ mParent

◆ mPath

◆ mUIType

◆ mUseLatency

◆ mVendor