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 AudioUnitWrapper
using	Parameters = PackedArray::Ptr< const AudioUnitParameterID >

using	ParameterVisitor = std::function< bool(const ParameterInfo &pi, AudioUnitParameterID ID) >
	Return value: if true, continue visiting. 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...

bool	SupportsRealtime () const override
	Whether the effect supports realtime previewing (while audio is playing). 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...

unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...

unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...

int	GetMidiInCount () const override
	Function that has not yet found a use. More...

int	GetMidiOutCount () const override
	Function that has not yet found a use. More...

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

sampleCount	GetLatency () override

bool	ProcessInitialize (EffectSettings &settings, sampleCount totalLen, ChannelNames chanMap) override

bool	ProcessFinalize () override

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

bool	RealtimeInitialize (EffectSettings &settings) override

bool	RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize (EffectSettings &settings) noexcept override

bool	RealtimeSuspend () override

bool	RealtimeResume () noexcept override

bool	RealtimeProcessStart (EffectSettings &settings) override

size_t	RealtimeProcess (int group, EffectSettings &settings, const float const inbuf, float const outbuf, size_t numSamples) override

bool	RealtimeProcessEnd (EffectSettings &settings) noexcept override

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

bool	InitializeInstance ()

bool	InitializePlugin ()

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

std::shared_ptr< EffectInstance >	DoMakeInstance ()

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	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

AudioUnitEffectSettings &	GetSettings (EffectSettings &) const
	This function will be rewritten when the effect is really stateless. More...

const AudioUnitEffectSettings &	GetSettings (const EffectSettings &) const
	This function will be rewritten when the effect is really stateless. More...

Public Member Functions inherited from StatefulPerTrackEffect
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

virtual sampleCount	GetLatency ()

virtual bool	ProcessInitialize (EffectSettings &settings, sampleCount totalLen, ChannelNames chanMap=nullptr)

virtual bool	ProcessFinalize ()

virtual size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen)
	Called for destructive effect computation. More...

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

virtual void	SetSampleRate (double rate)

virtual bool	RealtimeInitialize (EffectSettings &settings)

virtual bool	RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate)

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume () noexcept

virtual bool	RealtimeProcessStart (EffectSettings &settings)

virtual size_t	RealtimeProcess (int group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

virtual void	SetSampleRate (double rate)

virtual bool	RealtimeInitialize (EffectSettings &settings)

virtual bool	RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate)

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume () noexcept

virtual bool	RealtimeProcessStart (EffectSettings &settings)

virtual size_t	RealtimeProcess (int group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

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...

bool	SupportsRealtime () const override
	Whether the effect supports realtime previewing (while audio is playing). 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...

unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...

unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...

virtual const EffectParameterMethods &	Parameters () const

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

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, EffectInstance &instance, 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, 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

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, EffectInstance &instance, EffectSettingsAccess &access, bool forceModal=false)=0
	Usually applies factory to self and given access. 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...

virtual unsigned	GetAudioInCount () const =0
	How many input buffers to allocate at once. More...

virtual unsigned	GetAudioOutCount () const =0
	How many output buffers to allocate at once. More...

virtual int	GetMidiInCount () const
	Function that has not yet found a use. More...

virtual int	GetMidiOutCount () const
	Function that has not yet found a use. 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

virtual EffectSettings	MakeSettings () const

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

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 bool	SupportsRealtime () const =0
	Whether the effect supports realtime previewing (while audio is playing). More...

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

Public 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

bool	StoreSettings (const AudioUnitEffectSettings &settings) const

bool	CreateAudioUnit ()

AudioUnit	GetAudioUnit () const

AudioComponent	GetComponent () const

const Parameters &	GetParameters () const

Public Attributes
AudioUnitEffectArray	mSlaves

Private Member Functions
bool	SetRateAndChannels ()

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

OSStatus	Render (AudioUnitRenderActionFlags inActionFlags, const AudioTimeStamp inTimeStamp, UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList *ioData)

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

bool	BypassEffect (bool bypass)

Static Private Member Functions
static OSStatus	RenderCallback (void inRefCon, AudioUnitRenderActionFlags inActionFlags, const AudioTimeStamp inTimeStamp, UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList ioData)

Private Attributes
AudioUnitEffectSettings	mSettings

const PluginPath	mPath

const wxString	mName

const wxString	mVendor

AudioUnitCleanup< AudioUnit, AudioUnitUninitialize >	mInitialization

unsigned	mAudioIns { 2 }

unsigned	mAudioOuts { 2 }

bool	mInteractive { false }

bool	mLatencyDone { false }

UInt32	mBlockSize { 0 }

Float64	mSampleRate { 44100.0 }

bool	mUseLatency { true }

AudioTimeStamp	mTimeStamp {}

PackedArray::Ptr< AudioBufferList >	mInputList

PackedArray::Ptr< AudioBufferList >	mOutputList

wxWindow *	mParent {}

wxString	mUIType

bool	mIsGraphical { false }

AudioUnitEffect *const	mMaster

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

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Protected Attributes inherited from StatefulEffectBase
double	mSampleRate {}

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 }

Protected Attributes inherited from EffectUIClientInterface
friend	EffectUIValidator

friend	DefaultEffectUIValidator

Protected Attributes inherited from AudioUnitWrapper
const AudioComponent	mComponent

AudioUnitCleanup< AudioUnit, AudioComponentInstanceDispose >	mUnit

Parameters	mOwnParameters

Parameters &	mParameters

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

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

Definition at line 42 of file AudioUnitEffect.h.

Member Typedef Documentation

◆ Parameters

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

Definition at line 47 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) }
   , mMaster{ master }
{
}

◆ ~AudioUnitEffect()

AudioUnitEffect::~AudioUnitEffect ( )

virtual

Definition at line 106 of file AudioUnitEffect.cpp.

107{

108}

Member Function Documentation

◆ BypassEffect()

bool AudioUnitEffect::BypassEffect ( bool bypass )

private

Definition at line 1332 of file AudioUnitEffect.cpp.

{
   UInt32 value = (bypass ? 1 : 0);
   return !SetProperty(kAudioUnitProperty_BypassEffect, value);
}

References AudioUnitWrapper::SetProperty().

Referenced by ProcessInitialize(), RealtimeResume(), and RealtimeSuspend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CanExportPresets()

bool AudioUnitEffect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 877 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ CloseUI()

bool AudioUnitEffect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 866 of file AudioUnitEffect.cpp.

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

References mParent.

◆ DoMakeInstance()

std::shared_ptr< EffectInstance > AudioUnitEffect::DoMakeInstance ( )

Definition at line 256 of file AudioUnitEffect.cpp.

{
   if (mMaster)
      // This is a slave
      InitializeInstance();
   return std::make_shared<AudioUnitInstance>(*this, mComponent, mParameters);
}

References InitializeInstance(), AudioUnitWrapper::mComponent, mMaster, and AudioUnitWrapper::mParameters.

Referenced by MakeInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Export()

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

private

Definition at line 1115 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(), 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 882 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, GetSettings(), mName, mParent, mVendor, PRESET_USER_PATH, SelectFile(), settings(), and XO.

Here is the call graph for this function:

◆ GetAudioInCount()

unsigned AudioUnitEffect::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

If the effect ALWAYS processes channels independently, this can return 1

Implements EffectInstanceFactory.

Definition at line 410 of file AudioUnitEffect.cpp.

{
   return mAudioIns;
}

References mAudioIns.

◆ GetAudioOutCount()

unsigned AudioUnitEffect::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

Implements EffectInstanceFactory.

Definition at line 415 of file AudioUnitEffect.cpp.

{
   return mAudioOuts;
}

References mAudioOuts.

◆ GetBlockSize()

size_t AudioUnitEffect::GetBlockSize ( ) const

overridevirtual

Default implementation returns mEffectBlockSize

Reimplemented from StatefulEffectBase.

Definition at line 440 of file AudioUnitEffect.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ GetChannelCounts()

void AudioUnitEffect::GetChannelCounts ( )

private

Definition at line 1233 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(), mAudioIns, and mAudioOuts.

Referenced by InitializeInstance().

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 141 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 770 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 171 of file AudioUnitEffect.cpp.

{
   return AUDIOUNITEFFECTS_FAMILY;
}

References AUDIOUNITEFFECTS_FAMILY.

◆ GetLatency()

sampleCount AudioUnitEffect::GetLatency ( )

overridevirtual

Called for destructive, non-realtime effect computation Default implementation returns zero

Reimplemented from StatefulPerTrackEffect.

Definition at line 445 of file AudioUnitEffect.cpp.

{
   // Retrieve the latency (can be updated via an event)
   if (mUseLatency && !mLatencyDone) {
      Float64 latency = 0.0;
      if (!GetFixedSizeProperty(kAudioUnitProperty_Latency, latency)) {
         mLatencyDone = true;
         return sampleCount{ latency * mSampleRate };
      }
   }
   return 0;
}

References AudioUnitWrapper::GetFixedSizeProperty(), mLatencyDone, mSampleRate, and mUseLatency.

Here is the call graph for this function:

◆ GetMidiInCount()

int AudioUnitEffect::GetMidiInCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 420 of file AudioUnitEffect.cpp.

{
   return 0;
}

◆ GetMidiOutCount()

int AudioUnitEffect::GetMidiOutCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 425 of file AudioUnitEffect.cpp.

{
   return 0;
}

◆ GetPath()

PluginPath AudioUnitEffect::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 114 of file AudioUnitEffect.cpp.

{
   return mPath;
}

References mPath.

◆ GetSettings() [1/2]

const AudioUnitEffectSettings & AudioUnitEffect::GetSettings ( const EffectSettings & ) const

inline

This function will be rewritten when the effect is really stateless.

Definition at line 191 of file AudioUnitEffect.h.

192 { return mSettings; }

AudioUnitEffect::mSettings

AudioUnitEffectSettings mSettings

Definition: AudioUnitEffect.h:184

References mSettings.

◆ GetSettings() [2/2]

AudioUnitEffectSettings & AudioUnitEffect::GetSettings ( EffectSettings & ) const

inline

This function will be rewritten when the effect is really stateless.

Definition at line 188 of file AudioUnitEffect.h.

189 { return const_cast<AudioUnitEffect*>(this)->mSettings; }

AudioUnitEffect

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

Definition: AudioUnitEffect.h:45

References mSettings.

Referenced by ExportPresets(), ImportPresets(), LoadFactoryPreset(), LoadPreset(), LoadSettings(), MigrateOldConfigFile(), RealtimeAddProcessor(), SaveSettings(), and SaveUserPreset().

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol AudioUnitEffect::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 119 of file AudioUnitEffect.cpp.

{
   return mName;
}

References mName.

Referenced by SetRateAndChannels().

Here is the caller graph for this function:

◆ GetType()

EffectType AudioUnitEffect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 151 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, mAudioIns, and mAudioOuts.

Referenced by ShowClientInterface().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol AudioUnitEffect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 124 of file AudioUnitEffect.cpp.

{
   return { mVendor };
}

References mVendor.

◆ GetVersion()

wxString AudioUnitEffect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 129 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.

◆ HasOptions()

bool AudioUnitEffect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 961 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ Import()

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

private

Definition at line 1139 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);
 
   const auto error = InterpretBlob(settings, path, buf);
   if (!error.empty())
      return error;
 
   return {};
}

References AudioUnitWrapper::InterpretBlob(), settings(), 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 925 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, GetSettings(), Import(), mName, mParent, mVendor, PRESET_USER_PATH, SelectFile(), settings(), and XO.

Here is the call graph for this function:

◆ InitializeInstance()

bool AudioUnitEffect::InitializeInstance ( )

Definition at line 234 of file AudioUnitEffect.cpp.

{
   if (!CreateAudioUnit())
      return false;
 
   mSampleRate = 44100;
   GetChannelCounts();
   SetRateAndChannels();
 
   // Retrieve the desired number of frames per slice
   if (GetFixedSizeProperty(
      kAudioUnitProperty_MaximumFramesPerSlice, mBlockSize))
      // Call failed?  Then supply a default:
      mBlockSize = 512;
   return true;
}

References AudioUnitWrapper::CreateAudioUnit(), GetChannelCounts(), AudioUnitWrapper::GetFixedSizeProperty(), mBlockSize, mSampleRate, and SetRateAndChannels().

Referenced by DoMakeInstance(), and InitializePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializePlugin()

bool AudioUnitEffect::InitializePlugin ( )

Definition at line 268 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.
 
   // When AudioUnitEffect implements its own proper Instance class, this
   // should call CreateAudioUnit() directly and not do the rest of
   // InitializeInstance.
   if (!InitializeInstance())
      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);
      }
   }
 
   // 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 PackedArray::Count(), FullValue, PluginSettings::GetConfig(), AudioUnitWrapper::GetFixedSizeProperty(), InitializeInstance(), mInteractive, AudioUnitWrapper::mParameters, mUIType, mUseLatency, OptionsKey, PluginSettings::Shared, UITypeKey, and UseLatencyKey.

Referenced by AudioUnitEffectsModule::DiscoverPluginsAtPath().

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 181 of file AudioUnitEffect.cpp.

{
   return false;
}

◆ IsGraphicalUI()

bool AudioUnitEffect::IsGraphicalUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 853 of file AudioUnitEffect.cpp.

{
   return mUIType != wxT("Plain");
}

References mUIType.

◆ IsInteractive()

bool AudioUnitEffect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 176 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 751 of file AudioUnitEffect.cpp.

{
   // 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 AudioUnitWrapper::FetchSettings(), AudioUnitWrapper::GetFixedSizeProperty(), GetSettings(), 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 1001 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(), GetSettings(), AudioUnitWrapper::InterpretBlob(), MigrateOldConfigFile(), PRESET_KEY, PluginSettings::Private, and settings().

Referenced by 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

Restore settings from keys and values.

Returns: true on success

Implements EffectSettingsManager.

Definition at line 669 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;
   const auto end = map.end();
 
   // Load settings from CommandParameters
   ForEachParameter([this, &parms, &map, end](
      const ParameterInfo &pi, AudioUnitParameterID ID
   ){
      if (pi.mName) {
         double d = 0.0;
         if (auto iter = map.find(ID);
             iter != end && parms.Read(*pi.mName, &d))
            iter->second = d;
      }
      return true;
   });
   return true;
}

References PackedArray::end(), AudioUnitWrapper::ForEachParameter(), GetSettings(), AudioUnitWrapper::ParameterInfo::mName, 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 738 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

Implements EffectInstanceFactory.

Definition at line 251 of file AudioUnitEffect.cpp.

{
   return const_cast<AudioUnitEffect*>(this)->DoMakeInstance();
}

References DoMakeInstance().

Here is the call graph for this function:

◆ MigrateOldConfigFile()

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

private

Definition at line 981 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(), 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 846 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:

◆ ProcessBlock()

size_t AudioUnitEffect::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Reimplemented from StatefulPerTrackEffect.

Definition at line 510 of file AudioUnitEffect.cpp.

{
   // mAudioIns and mAudioOuts don't change after plugin initialization,
   // so ProcessInitialize() made sufficient allocations
   assert(PackedArray::Count(mInputList) >= mAudioIns);
   for (size_t i = 0; i < mAudioIns; ++i)
      mInputList[i] = { 1, static_cast<UInt32>(sizeof(float) * blockLen),
         const_cast<float*>(inBlock[i]) };
 
   // See previous comment
   assert(PackedArray::Count(mOutputList) >= mAudioOuts);
   for (size_t i = 0; i < mAudioOuts; ++i)
      mOutputList[i] = { 1, static_cast<UInt32>(sizeof(float) * blockLen),
         outBlock[i] };
 
   AudioUnitRenderActionFlags flags = 0;
   OSStatus result;
 
   result = AudioUnitRender(mUnit.get(),
                            &flags,
                            &mTimeStamp,
                            0,
                            blockLen,
                            mOutputList.get());
   if (result != noErr) {
      wxLogError("Render failed: %d %4.4s\n",
         static_cast<int>(result), reinterpret_cast<char *>(&result));
      return 0;
   }
 
   mTimeStamp.mSampleTime += blockLen;
   return blockLen;
}

References PackedArray::Count(), mAudioIns, mAudioOuts, mInputList, mOutputList, mTimeStamp, and AudioUnitWrapper::mUnit.

Here is the call graph for this function:

◆ ProcessFinalize()

bool AudioUnitEffect::ProcessFinalize ( )

overridevirtual

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Reimplemented from StatefulPerTrackEffect.

Definition at line 503 of file AudioUnitEffect.cpp.

{
   mOutputList.reset();
   mInputList.reset();
   return true;
}

References mInputList, and mOutputList.

◆ ProcessInitialize()

bool AudioUnitEffect::ProcessInitialize	(	EffectSettings &	settings,
		sampleCount	totalLen,
		ChannelNames	chanMap
	)

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Reimplemented from StatefulPerTrackEffect.

Definition at line 470 of file AudioUnitEffect.cpp.

{
   mInputList =
      PackedArray::AllocateCount<AudioBufferList>(mAudioIns)(mAudioIns);
   mOutputList =
      PackedArray::AllocateCount<AudioBufferList>(mAudioOuts)(mAudioOuts);
 
   memset(&mTimeStamp, 0, sizeof(AudioTimeStamp));
   mTimeStamp.mSampleTime = 0; // This is a double-precision number that should
                               // accumulate the number of frames processed so far
   mTimeStamp.mFlags = kAudioTimeStampSampleTimeValid;
 
   if (!SetRateAndChannels())
      return false;
 
   if (SetProperty(kAudioUnitProperty_SetRenderCallback,
      AudioUnitUtils::RenderCallback{ RenderCallback, this },
      kAudioUnitScope_Input)) {
      wxLogError("Setting input render callback failed.\n");
      return false;
   }
 
   if (AudioUnitReset(mUnit.get(), kAudioUnitScope_Global, 0))
      return false;
 
   if (!BypassEffect(false))
      return false;
 
   mLatencyDone = false;
   return true;
}

References BypassEffect(), mAudioIns, mAudioOuts, mInputList, mLatencyDone, mOutputList, mTimeStamp, AudioUnitWrapper::mUnit, RenderCallback(), AudioUnitWrapper::SetProperty(), and SetRateAndChannels().

Referenced by RealtimeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

bool AudioUnitEffect::RealtimeAddProcessor	(	EffectSettings &	settings,
		unsigned	numChannels,
		float	sampleRate
	)

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 550 of file AudioUnitEffect.cpp.

{
   auto slave = std::make_unique<AudioUnitEffect>(
      mPath, mName, mComponent, &mParameters, this);
   if (!slave->InitializeInstance())
      return false;
 
   slave->SetBlockSize(mBlockSize);
   slave->SetSampleRate(sampleRate);
 
   if (!slave->StoreSettings(GetSettings(settings)))
      return false;
 
   auto pSlave = slave.get();
   mSlaves.push_back(std::move(slave));
 
   return pSlave->ProcessInitialize(settings, 0, nullptr);
}

References GetSettings(), mBlockSize, AudioUnitWrapper::mComponent, mName, AudioUnitWrapper::mParameters, mPath, mSlaves, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool AudioUnitEffect::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 570 of file AudioUnitEffect.cpp.

{
return GuardedCall<bool>([&]{
   for (size_t i = 0, cnt = mSlaves.size(); i < cnt; i++)
   {
      mSlaves[i]->ProcessFinalize();
   }
   mSlaves.clear();
   return ProcessFinalize();
});
}

◆ RealtimeInitialize()

bool AudioUnitEffect::RealtimeInitialize ( EffectSettings & settings )

overridevirtual

Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 545 of file AudioUnitEffect.cpp.

{
   return ProcessInitialize(settings, 0, nullptr);
}

References ProcessInitialize(), and settings().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t AudioUnitEffect::RealtimeProcess	(	int	group,
		EffectSettings &	settings,
		const float const	inBuf,
		float const	outBuf,
		size_t	numSamples
	)

overridevirtual

Default implementation does nothing, returns 0

Reimplemented from StatefulEffectBase.

Definition at line 625 of file AudioUnitEffect.cpp.

{
   wxASSERT(numSamples <= mBlockSize);
   return mSlaves[group]->ProcessBlock(settings, inbuf, outbuf, numSamples);
}

References mBlockSize, mSlaves, and settings().

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool AudioUnitEffect::RealtimeProcessEnd ( EffectSettings & settings )

overridevirtualnoexcept

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 632 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ RealtimeProcessStart()

bool AudioUnitEffect::RealtimeProcessStart ( EffectSettings & settings )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 620 of file AudioUnitEffect.cpp.

{
   return true;
}

◆ RealtimeResume()

bool AudioUnitEffect::RealtimeResume ( )

overridevirtualnoexcept

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 600 of file AudioUnitEffect.cpp.

{
return GuardedCall<bool>([&]{
   if (!BypassEffect(false))
   {
      return false;
   }
 
   for (size_t i = 0, cnt = mSlaves.size(); i < cnt; i++)
   {
      if (!mSlaves[i]->BypassEffect(false))
      {
         return false;
      }
   }
 
   return true;
});
}

References BypassEffect(), and mSlaves.

Here is the call graph for this function:

◆ RealtimeSuspend()

bool AudioUnitEffect::RealtimeSuspend ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 582 of file AudioUnitEffect.cpp.

{
   if (!BypassEffect(true))
   {
      return false;
   }
 
   for (size_t i = 0, cnt = mSlaves.size(); i < cnt; i++)
   {
      if (!mSlaves[i]->BypassEffect(true))
      {
         return false;
      }
   }
 
   return true;
}

References BypassEffect(), and mSlaves.

Here is the call graph for this function:

◆ Render()

OSStatus AudioUnitEffect::Render	(	AudioUnitRenderActionFlags *	inActionFlags,
		const AudioTimeStamp *	inTimeStamp,
		UInt32	inBusNumber,
		UInt32	inNumFrames,
		AudioBufferList *	ioData
	)

private

Definition at line 1170 of file AudioUnitEffect.cpp.

{
   size_t i = 0;
   auto size =
      std::min<size_t>(ioData->mNumberBuffers, PackedArray::Count(mInputList));
   for (; i < size; ++i)
      ioData->mBuffers[i].mData = mInputList[i].mData;
   // Some defensive code here just in case SDK requests from us an unexpectedly
   // large number of buffers:
   for (; i < ioData->mNumberBuffers; ++i)
      ioData->mBuffers[i].mData = nullptr;
   return 0;
}

References PackedArray::Count(), for(), mInputList, and size.

Referenced by RenderCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RenderCallback()

OSStatus AudioUnitEffect::RenderCallback	(	void *	inRefCon,
		AudioUnitRenderActionFlags *	inActionFlags,
		const AudioTimeStamp *	inTimeStamp,
		UInt32	inBusNumber,
		UInt32	inNumFrames,
		AudioBufferList *	ioData
	)

staticprivate

Definition at line 1189 of file AudioUnitEffect.cpp.

{
   return static_cast<AudioUnitEffect *>(inRefCon)->Render(inActionFlags,
      inTimeStamp, inBusNumber, inNumFrames, ioData);
}

References Render().

Referenced by ProcessInitialize().

Here is the call graph for this function:

Here is the caller 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 1028 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.

Returns: true on success

Implements EffectSettingsManager.

Definition at line 648 of file AudioUnitEffect.cpp.

{
   auto &map = GetSettings(settings).values;
   const auto end = map.end();
 
   // Save settings into CommandParameters
   // Assume settings is an up-to-date cache of AudioUnit state
   ForEachParameter([this, &parms, &map, end](
      const ParameterInfo &pi, AudioUnitParameterID ID
   ){
      if (pi.mName) {
         // Write names, not numbers, as keys in the config file
         if (auto iter = map.find(ID); iter != end)
            parms.Write(*pi.mName, iter->second);
      }
      return true;
   });
   return true;
}

References PackedArray::end(), AudioUnitWrapper::ForEachParameter(), GetSettings(), AudioUnitWrapper::ParameterInfo::mName, settings(), and AudioUnitEffectSettings::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 745 of file AudioUnitEffect.cpp.

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

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

Here is the call graph for this function:

◆ SetBlockSize()

size_t AudioUnitEffect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Default implementation assigns mEffectBlockSize, returns it

Reimplemented from StatefulEffectBase.

Definition at line 435 of file AudioUnitEffect.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ SetRateAndChannels()

bool AudioUnitEffect::SetRateAndChannels ( )

private

Definition at line 1046 of file AudioUnitEffect.cpp.

{
   mInitialization.reset();
   AudioUnitUtils::StreamBasicDescription streamFormat{
      // Float64 mSampleRate;
      mSampleRate,
 
      // UInt32  mFormatID;
      kAudioFormatLinearPCM,
 
      // UInt32  mFormatFlags;
      (kAudioFormatFlagsNativeFloatPacked |
          kAudioFormatFlagIsNonInterleaved),
 
      // UInt32  mBytesPerPacket;
      sizeof(float),
 
      // UInt32  mFramesPerPacket;
      1,
 
      // UInt32  mBytesPerFrame;
      sizeof(float),
 
      // UInt32  mChannelsPerFrame;
      0,
 
      // UInt32  mBitsPerChannel;
      sizeof(float) * 8,
   };
 
   const struct Info{
      unsigned nChannels;
      AudioUnitScope scope;
      const char *const msg; // used only in log messages
   } infos[]{
      { 1, kAudioUnitScope_Global, "global" },
      { mAudioIns, kAudioUnitScope_Input, "input" },
      { mAudioOuts, kAudioUnitScope_Output, "output" },
   };
   for (const auto &[nChannels, scope, msg] : infos) {
      if (nChannels) {
         if (SetProperty(kAudioUnitProperty_SampleRate, mSampleRate, scope)) {
            wxLogError("%ls Didn't accept sample rate on %s\n",
               // Exposing internal name only in logging
               GetSymbol().Internal().wx_str(), msg);
            return false;
         }
         if (scope != kAudioUnitScope_Global) {
            streamFormat.mChannelsPerFrame = nChannels;
            if (SetProperty(kAudioUnitProperty_StreamFormat,
               streamFormat, scope)) {
               wxLogError("%ls didn't accept stream format on %s\n",
                  // Exposing internal name only in logging
                  GetSymbol().Internal().wx_str(), msg);
               return false;
            }
         }
      }
   }
 
   if (AudioUnitInitialize(mUnit.get())) {
      wxLogError("Couldn't initialize audio unit\n");
      return false;
   }
 
   mInitialization.reset(mUnit.get());
   return true;
}

References GetSymbol(), Internal, mAudioIns, mAudioOuts, mInitialization, mSampleRate, AudioUnitWrapper::mUnit, scope, and AudioUnitWrapper::SetProperty().

Referenced by InitializeInstance(), and ProcessInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSampleRate()

void AudioUnitEffect::SetSampleRate ( double rate )

overridevirtual

Default implementation assigns mSampleRate

Reimplemented from StatefulEffectBase.

Definition at line 430 of file AudioUnitEffect.cpp.

{
   mSampleRate = rate;
}

References mSampleRate.

◆ ShowClientInterface()

int AudioUnitEffect::ShowClientInterface	(	wxWindow &	parent,
		wxDialog &	dialog,
		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 637 of file AudioUnitEffect.cpp.

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

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

Here is the call graph for this function:

◆ ShowOptions()

void AudioUnitEffect::ShowOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 966 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 194 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:

◆ SupportsRealtime()

bool AudioUnitEffect::SupportsRealtime ( ) const

overridevirtual

Whether the effect supports realtime previewing (while audio is playing).

Implements EffectDefinitionInterface.

Definition at line 186 of file AudioUnitEffect.cpp.

{
   // TODO reenable after achieving statelessness
   return false;
 
//   return GetType() == EffectTypeProcess;
}

Referenced by ShowClientInterface().

Here is the caller graph for this function:

Member Data Documentation

◆ mAudioIns

unsigned AudioUnitEffect::mAudioIns { 2 }

private

Definition at line 202 of file AudioUnitEffect.h.

Referenced by GetAudioInCount(), GetChannelCounts(), GetType(), ProcessBlock(), ProcessInitialize(), and SetRateAndChannels().

◆ mAudioOuts

unsigned AudioUnitEffect::mAudioOuts { 2 }

private

Definition at line 203 of file AudioUnitEffect.h.

Referenced by GetAudioOutCount(), GetChannelCounts(), GetType(), ProcessBlock(), ProcessInitialize(), and SetRateAndChannels().

◆ mBlockSize

UInt32 AudioUnitEffect::mBlockSize { 0 }

private

Definition at line 207 of file AudioUnitEffect.h.

Referenced by GetBlockSize(), InitializeInstance(), RealtimeAddProcessor(), RealtimeProcess(), and SetBlockSize().

◆ mInitialization

AudioUnitCleanup<AudioUnit, AudioUnitUninitialize> AudioUnitEffect::mInitialization

private

Definition at line 199 of file AudioUnitEffect.h.

Referenced by SetRateAndChannels().

◆ mInputList

PackedArray::Ptr<AudioBufferList> AudioUnitEffect::mInputList

private

Definition at line 214 of file AudioUnitEffect.h.

Referenced by ProcessBlock(), ProcessFinalize(), ProcessInitialize(), and Render().

◆ mInteractive

bool AudioUnitEffect::mInteractive { false }

private

Definition at line 205 of file AudioUnitEffect.h.

Referenced by InitializePlugin(), and IsInteractive().

◆ mIsGraphical

bool AudioUnitEffect::mIsGraphical { false }

private

Definition at line 219 of file AudioUnitEffect.h.

◆ mLatencyDone

bool AudioUnitEffect::mLatencyDone { false }

private

Definition at line 206 of file AudioUnitEffect.h.

Referenced by GetLatency(), and ProcessInitialize().

◆ mMaster

AudioUnitEffect* const AudioUnitEffect::mMaster

private

Definition at line 221 of file AudioUnitEffect.h.

Referenced by DoMakeInstance().

◆ mName

const wxString AudioUnitEffect::mName

private

Definition at line 196 of file AudioUnitEffect.h.

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

◆ mOutputList

PackedArray::Ptr<AudioBufferList> AudioUnitEffect::mOutputList

private

Definition at line 215 of file AudioUnitEffect.h.

Referenced by ProcessBlock(), ProcessFinalize(), and ProcessInitialize().

◆ mParent

wxWindow* AudioUnitEffect::mParent {}

private

Definition at line 217 of file AudioUnitEffect.h.

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

◆ mPath

const PluginPath AudioUnitEffect::mPath

private

Definition at line 195 of file AudioUnitEffect.h.

Referenced by GetPath(), and RealtimeAddProcessor().

◆ mSampleRate

Float64 AudioUnitEffect::mSampleRate { 44100.0 }

private

Definition at line 208 of file AudioUnitEffect.h.

Referenced by GetLatency(), InitializeInstance(), SetRateAndChannels(), and SetSampleRate().

◆ mSettings

AudioUnitEffectSettings AudioUnitEffect::mSettings

private

Definition at line 184 of file AudioUnitEffect.h.

Referenced by GetSettings().

◆ mSlaves

AudioUnitEffectArray AudioUnitEffect::mSlaves

Definition at line 223 of file AudioUnitEffect.h.

Referenced by RealtimeAddProcessor(), RealtimeProcess(), RealtimeResume(), and RealtimeSuspend().

◆ mTimeStamp

AudioTimeStamp AudioUnitEffect::mTimeStamp {}

private

Definition at line 212 of file AudioUnitEffect.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mUIType

wxString AudioUnitEffect::mUIType

private

Definition at line 218 of file AudioUnitEffect.h.

Referenced by InitializePlugin(), IsGraphicalUI(), PopulateUI(), and ShowOptions().

◆ mUseLatency

bool AudioUnitEffect::mUseLatency { true }

private

Definition at line 210 of file AudioUnitEffect.h.

Referenced by GetLatency(), InitializePlugin(), and ShowOptions().

◆ mVendor

const wxString AudioUnitEffect::mVendor

private

Definition at line 197 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

Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Parameters

Constructor & Destructor Documentation

◆ AudioUnitEffect()

◆ ~AudioUnitEffect()

Member Function Documentation

◆ BypassEffect()

◆ CanExportPresets()

◆ CloseUI()

◆ DoMakeInstance()

◆ Export()

◆ ExportPresets()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetChannelCounts()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetLatency()

◆ GetMidiInCount()

◆ GetMidiOutCount()

◆ GetPath()

◆ GetSettings() [1/2]

◆ GetSettings() [2/2]

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ Import()

◆ ImportPresets()

◆ InitializeInstance()

◆ InitializePlugin()

◆ IsDefault()

◆ IsGraphicalUI()

◆ IsInteractive()

◆ LoadFactoryPreset()

◆ LoadPreset()

◆ LoadSettings()

◆ LoadUserPreset()

◆ MakeInstance()

◆ MigrateOldConfigFile()

◆ PopulateUI()

◆ ProcessBlock()

◆ ProcessFinalize()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

◆ Render()

◆ RenderCallback()

◆ SaveBlobToConfig()

◆ SavePreset()

◆ SaveSettings()

◆ SaveUserPreset()

◆ SetBlockSize()

◆ SetRateAndChannels()

◆ SetSampleRate()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

◆ SupportsRealtime()

Member Data Documentation

◆ mAudioIns

◆ mAudioOuts

◆ mBlockSize