#include <VSTEffect.h>

Inheritance diagram for VSTEffect:

Collaboration diagram for VSTEffect:

Classes
struct	ResourceHandle

Public Member Functions
	VSTEffect (const PluginPath &path, VSTEffect *master=NULL)

virtual	~VSTEffect ()

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	DoLoadUserPreset (const RegistryPath &name, EffectSettings &settings)

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	DoLoadFactoryPreset (int id)

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

sampleCount	GetLatency () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	IsReady ()

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

bool	DoProcessInitialize (sampleCount totalLen, ChannelNames chanMap)

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

void	OnTimer ()

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 XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from VSTEffectLink
virtual	~VSTEffectLink ()

virtual intptr_t	callDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt)=0

Static Public Member Functions
static intptr_t	AudioMaster (AEffect effect, int32_t opcode, int32_t index, intptr_t value, void ptr, float opt)

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

Private Types
using	ModuleHandle = std::unique_ptr< wxDynamicLibrary >

using	BundleHandle = CF_ptr< CFBundleRef >

Private Member Functions
bool	Load ()

void	Unload ()

std::vector< int >	GetEffectIDs ()

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

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

unsigned	GetChannelCount ()

void	SetChannelCount (unsigned numChannels)

void	OnSlider (wxCommandEvent &evt)

void	OnSizeWindow (wxCommandEvent &evt)

void	OnUpdateDisplay (wxCommandEvent &evt)

void	RemoveHandler ()

void	OnProgram (wxCommandEvent &evt)

void	OnProgramText (wxCommandEvent &evt)

void	OnLoad (wxCommandEvent &evt)

void	OnSave (wxCommandEvent &evt)

void	OnSettings (wxCommandEvent &evt)

void	BuildPlain (EffectSettingsAccess &access)

void	BuildFancy ()

wxSizer *	BuildProgramBar ()

void	RefreshParameters (int skip=-1)

bool	LoadFXB (const wxFileName &fn)

bool	LoadFXP (const wxFileName &fn)

bool	LoadXML (const wxFileName &fn)

bool	LoadFXProgram (unsigned char **bptr, ssize_t &len, int index, bool dryrun)

void	SaveFXB (const wxFileName &fn) const

void	SaveFXP (const wxFileName &fn) const

void	SaveXML (const wxFileName &fn) const

void	SaveFXProgram (wxMemoryBuffer &buf, int index) const

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

void	HandleXMLEndTag (const std::string_view &tag) override

void	HandleXMLContent (const std::string_view &content) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

VstTimeInfo *	GetTimeInfo ()

float	GetSampleRate ()

int	GetProcessLevel ()

void	SetBufferDelay (int samples)

void	NeedIdle ()

void	NeedEditIdle (bool state)

void	SizeWindow (int w, int h)

void	UpdateDisplay ()

void	Automate (int index, float value)

void	PowerOn ()

void	PowerOff ()

int	GetString (wxString &outstr, int opcode, int index=0) const

wxString	GetString (int opcode, int index=0) const

void	SetString (int opcode, const wxString &str, int index=0)

intptr_t	callDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt) override

intptr_t	constCallDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt) const

void	callProcessReplacing (const float const inputs, float const outputs, int sampleframes)

void	callSetParameter (int index, float value)

float	callGetParameter (int index) const

void	callSetProgram (int index)

void	callSetChunk (bool isPgm, int len, void *buf)

void	callSetChunk (bool isPgm, int len, void buf, VstPatchChunkInfo info)

	wxCRIT_SECT_DECLARE_MEMBER (mDispatcherLock)

Private Attributes
PluginID	mID

PluginPath	mPath

unsigned	mAudioIns

unsigned	mAudioOuts

int	mMidiIns

int	mMidiOuts

bool	mAutomatable

float	mSampleRate

size_t	mUserBlockSize

wxString	mName

wxString	mVendor

wxString	mDescription

int	mVersion

bool	mInteractive

int	mVstVersion

bool	mReady

ModuleHandle	mModule

BundleHandle	mBundleRef

ResourceHandle	mResource

AEffect *	mAEffect

VstTimeInfo	mTimeInfo

bool	mUseLatency

int	mBufferDelay

unsigned	mBlockSize

int	mProcessLevel

bool	mHasPower

bool	mWantsIdle

bool	mWantsEditIdle

std::unique_ptr< VSTEffectTimer >	mTimer

int	mTimerGuard

VSTEffect *	mMaster

VSTEffectArray	mSlaves

unsigned	mNumChannels

wxWeakRef< wxDialog >	mDialog

wxWindow *	mParent

wxSizerItem *	mContainer

bool	mGui

VSTControl *	mControl

NumericTextCtrl *	mDuration

ArrayOf< wxStaticText * >	mNames

ArrayOf< wxSlider * >	mSliders

ArrayOf< wxStaticText * >	mDisplays

ArrayOf< wxStaticText * >	mLabels

bool	mInSet

bool	mInChunk

wxString	mChunk

long	mXMLVersion

VstPatchChunkInfo	mXMLInfo

Static Private Attributes
static intptr_t	mCurrentEffectID

Friends
class	VSTEffectsModule

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

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

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

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

VSTEffect is an Audacity effect that forwards actual audio processing via a VSTEffectLink

Definition at line 93 of file VSTEffect.h.

Member Typedef Documentation

◆ BundleHandle

using VSTEffect::BundleHandle = CF_ptr<CFBundleRef>

private

Definition at line 318 of file VSTEffect.h.

◆ ModuleHandle

using VSTEffect::ModuleHandle = std::unique_ptr<wxDynamicLibrary>

private

Definition at line 285 of file VSTEffect.h.

Constructor & Destructor Documentation

◆ VSTEffect()

VSTEffect::VSTEffect	(	const PluginPath &	path,
		VSTEffect *	master = `NULL`
	)

Definition at line 792 of file VSTEffect.cpp.

:  mPath(path),
   mMaster(master)
{
   mModule = NULL;
   mAEffect = NULL;
 
   mTimer = std::make_unique<VSTEffectTimer>(this);
   mTimerGuard = 0;
 
   mInteractive = false;
   mAudioIns = 0;
   mAudioOuts = 0;
   mMidiIns = 0;
   mMidiOuts = 0;
   mSampleRate = 44100;
   mBlockSize = mUserBlockSize = 8192;
   mBufferDelay = 0;
   mProcessLevel = 1;         // in GUI thread
   mHasPower = false;
   mWantsIdle = false;
   mWantsEditIdle = false;
   mUseLatency = true;
   mReady = false;
 
   memset(&mTimeInfo, 0, sizeof(mTimeInfo));
   mTimeInfo.samplePos = 0.0;
   mTimeInfo.sampleRate = 44100.0;  // this is a bogus value, but it's only for the display
   mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
   mTimeInfo.tempo = 120.0;
   mTimeInfo.timeSigNumerator = 4;
   mTimeInfo.timeSigDenominator = 4;
   mTimeInfo.flags = kVstTempoValid | kVstNanosValid;
 
   // UI
   
   mGui = false;
   mContainer = NULL;
 
   // If we're a slave then go ahead a load immediately
   if (mMaster)
   {
      Load();
   }
}

References VstTimeInfo::flags, kVstNanosValid, kVstTempoValid, Load(), mAEffect, mAudioIns, mAudioOuts, mBlockSize, mBufferDelay, mContainer, mGui, mHasPower, mInteractive, mMaster, mMidiIns, mMidiOuts, mModule, mProcessLevel, mReady, mSampleRate, mTimeInfo, mTimer, mTimerGuard, mUseLatency, mUserBlockSize, mWantsEditIdle, mWantsIdle, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Here is the call graph for this function:

◆ ~VSTEffect()

VSTEffect::~VSTEffect ( )

virtual

Definition at line 838 of file VSTEffect.cpp.

{
   Unload();
}

References Unload().

Here is the call graph for this function:

Member Function Documentation

◆ AudioMaster()

intptr_t VSTEffect::AudioMaster	(	AEffect *	effect,
		int32_t	opcode,
		int32_t	index,
		intptr_t	value,
		void *	ptr,
		float	opt
	)

static

Definition at line 610 of file VSTEffect.cpp.

{
   VSTEffect *vst = (effect ? (VSTEffect *) effect->ptr2 : NULL);
 
   // Handles operations during initialization...before VSTEffect has had a
   // chance to set its instance pointer.
   switch (opcode)
   {
      case audioMasterVersion:
         return (intptr_t) 2400;
 
      case audioMasterCurrentId:
         return mCurrentEffectID;
 
      case audioMasterGetVendorString:
         strcpy((char *) ptr, "Audacity Team");    // Do not translate, max 64 + 1 for null terminator
         return 1;
 
      case audioMasterGetProductString:
         strcpy((char *) ptr, "Audacity");         // Do not translate, max 64 + 1 for null terminator
         return 1;
 
      case audioMasterGetVendorVersion:
         return (intptr_t) (AUDACITY_VERSION << 24 |
                            AUDACITY_RELEASE << 16 |
                            AUDACITY_REVISION << 8 |
                            AUDACITY_MODLEVEL);
 
      // Some (older) effects depend on an effIdle call when requested.  An
      // example is the Antress Modern plugins which uses the call to update
      // the editors display when the program (preset) changes.
      case audioMasterNeedIdle:
         if (vst)
         {
            vst->NeedIdle();
            return 1;
         }
         return 0;
 
      // We would normally get this if the effect editor is dipslayed and something "major"
      // has changed (like a program change) instead of multiple automation calls.
      // Since we don't do anything with the parameters while the editor is displayed,
      // there's no need for us to do anything.
      case audioMasterUpdateDisplay:
         if (vst)
         {
            vst->UpdateDisplay();
            return 1;
         }
         return 0;
 
      // Return the current time info.
      case audioMasterGetTime:
         if (vst)
         {
            return (intptr_t) vst->GetTimeInfo();
         }
         return 0;
 
      // Inputs, outputs, or initial delay has changed...all we care about is initial delay.
      case audioMasterIOChanged:
         if (vst)
         {
            vst->SetBufferDelay(effect->initialDelay);
            return 1;
         }
         return 0;
 
      case audioMasterGetSampleRate:
         if (vst)
         {
            return (intptr_t) vst->GetSampleRate();
         }
         return 0;
 
      case audioMasterIdle:
         wxYieldIfNeeded();
         return 1;
 
      case audioMasterGetCurrentProcessLevel:
         if (vst)
         {
            return vst->GetProcessLevel();
         }
         return 0;
 
      case audioMasterGetLanguage:
         return kVstLangEnglish;
 
      // We always replace, never accumulate
      case audioMasterWillReplaceOrAccumulate:
         return 1;
 
      // Resize the window to accommodate the effect size
      case audioMasterSizeWindow:
         if (vst)
         {
            vst->SizeWindow(index, value);
         }
         return 1;
 
      case audioMasterCanDo:
      {
         char *s = (char *) ptr;
         if (strcmp(s, "acceptIOChanges") == 0 ||
            strcmp(s, "sendVstTimeInfo") == 0 ||
            strcmp(s, "startStopProcess") == 0 ||
            strcmp(s, "shellCategory") == 0 ||
            strcmp(s, "sizeWindow") == 0)
         {
            return 1;
         }
 
#if defined(VST_DEBUG)
#if defined(__WXMSW__)
         wxLogDebug(wxT("VST canDo: %s"), wxString::FromAscii((char *)ptr));
#else
         wxPrintf(wxT("VST canDo: %s\n"), wxString::FromAscii((char *)ptr));
#endif
#endif
 
         return 0;
      }
 
      case audioMasterBeginEdit:
      case audioMasterEndEdit:
         return 0;
 
      case audioMasterAutomate:
         if (vst)
         {
            vst->Automate(index, opt);
         }
         return 0;
 
      // We're always connected (sort of)
      case audioMasterPinConnected:
 
      // We don't do MIDI yet
      case audioMasterWantMidi:
      case audioMasterProcessEvents:
 
         // Don't need to see any messages about these
         return 0;
   }
 
#if defined(VST_DEBUG)
#if defined(__WXMSW__)
   wxLogDebug(wxT("vst: %p opcode: %d index: %d value: %p ptr: %p opt: %f user: %p"),
              effect, (int) opcode, (int) index, (void *) value, ptr, opt, vst);
#else
   wxPrintf(wxT("vst: %p opcode: %d index: %d value: %p ptr: %p opt: %f user: %p\n"),
            effect, (int) opcode, (int) index, (void *) value, ptr, opt, vst);
#endif
#endif
 
   return 0;
}

References audioMasterAutomate, audioMasterBeginEdit, audioMasterCanDo, audioMasterCurrentId, audioMasterEndEdit, audioMasterGetCurrentProcessLevel, audioMasterGetLanguage, audioMasterGetProductString, audioMasterGetSampleRate, audioMasterGetTime, audioMasterGetVendorString, audioMasterGetVendorVersion, audioMasterIdle, audioMasterIOChanged, audioMasterNeedIdle, audioMasterPinConnected, audioMasterProcessEvents, audioMasterSizeWindow, audioMasterUpdateDisplay, audioMasterVersion, audioMasterWantMidi, audioMasterWillReplaceOrAccumulate, Automate(), GetProcessLevel(), GetSampleRate(), GetTimeInfo(), kVstLangEnglish, NeedIdle(), SetBufferDelay(), SizeWindow(), and UpdateDisplay().

Referenced by Load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Automate()

void VSTEffect::Automate	(	int	index,
		float	value
	)

private

Definition at line 2110 of file VSTEffect.cpp.

{
   // Just ignore it if we're a slave
   if (mMaster)
   {
      return;
   }
 
   for (const auto &slave : mSlaves)
      slave->callSetParameter(index, value);
 
   return;
}

References mMaster, and mSlaves.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ BuildFancy()

void VSTEffect::BuildFancy ( )

private

Definition at line 2279 of file VSTEffect.cpp.

{
   // Turn the power on...some effects need this when the editor is open
   PowerOn();
 
   auto control = Destroy_ptr<VSTControl>{ safenew VSTControl };
   if (!control)
   {
      return;
   }
 
   if (!control->Create(mParent, this))
   {
      return;
   }
 
   {
      auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
      mainSizer->Add((mControl = control.release()), 0, wxALIGN_CENTER);
 
      mParent->SetMinSize(wxDefaultSize);
      mParent->SetSizer(mainSizer.release());
   }
 
   NeedEditIdle(true);
 
   mDialog->Bind(wxEVT_SIZE, OnSize);
 
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(true);
#endif
#endif
 
   return;
}

References mControl, mDialog, mParent, NeedEditIdle(), OnSize(), PowerOn(), and safenew.

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildPlain()

void VSTEffect::BuildPlain ( EffectSettingsAccess & access )

private

Definition at line 2317 of file VSTEffect.cpp.

{
   wxASSERT(mParent); // To justify safenew
   wxScrolledWindow *const scroller = safenew wxScrolledWindow(mParent,
      wxID_ANY,
      wxDefaultPosition,
      wxDefaultSize,
      wxVSCROLL | wxTAB_TRAVERSAL);
 
   {
      auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
      // Try to give the window a sensible default/minimum size
      scroller->SetMinSize(wxSize(wxMax(600, mParent->GetSize().GetWidth() * 2 / 3),
         mParent->GetSize().GetHeight() / 2));
      scroller->SetScrollRate(0, 20);
 
      // This fools NVDA into not saying "Panel" when the dialog gets focus
      scroller->SetName(wxT("\a"));
      scroller->SetLabel(wxT("\a"));
 
      mainSizer->Add(scroller, 1, wxEXPAND | wxALL, 5);
      mParent->SetSizer(mainSizer.release());
   }
 
   mNames.reinit(static_cast<size_t>(mAEffect->numParams));
   mSliders.reinit(static_cast<size_t>(mAEffect->numParams));
   mDisplays.reinit(static_cast<size_t>(mAEffect->numParams));
   mLabels.reinit(static_cast<size_t>(mAEffect->numParams));
 
   {
      auto paramSizer = std::make_unique<wxStaticBoxSizer>(wxVERTICAL, scroller, _("Effect Settings"));
 
      {
         auto gridSizer = std::make_unique<wxFlexGridSizer>(4, 0, 0);
         gridSizer->AddGrowableCol(1);
 
         // Add the duration control for generators
         if (GetType() == EffectTypeGenerate)
         {
            wxControl *item = safenew wxStaticText(scroller, 0, _("Duration:"));
            gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
            auto &extra = access.Get().extra;
            mDuration = safenew
               NumericTextCtrl(scroller, ID_Duration,
                  NumericConverter::TIME,
                  extra.GetDurationFormat(),
                  extra.GetDuration(),
                  mSampleRate,
                  NumericTextCtrl::Options{}
                     .AutoPos(true));
            mDuration->SetName( XO("Duration") );
            gridSizer->Add(mDuration, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5);
            gridSizer->Add(1, 1, 0);
            gridSizer->Add(1, 1, 0);
         }
 
         // Find the longest parameter name.
         int namew = 0;
         int w;
         int h;
         for (int i = 0; i < mAEffect->numParams; i++)
         {
            wxString text = GetString(effGetParamName, i);
 
            if (text.Right(1) != wxT(':'))
            {
               text += wxT(':');
            }
 
            scroller->GetTextExtent(text, &w, &h);
            if (w > namew)
            {
               namew = w;
            }
         }
 
         scroller->GetTextExtent(wxT("HHHHHHHH"), &w, &h);
 
         for (int i = 0; i < mAEffect->numParams; i++)
         {
            mNames[i] = safenew wxStaticText(scroller,
               wxID_ANY,
               wxEmptyString,
               wxDefaultPosition,
               wxSize(namew, -1),
               wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
            gridSizer->Add(mNames[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
 
            mSliders[i] = safenew wxSliderWrapper(scroller,
               ID_Sliders + i,
               0,
               0,
               1000,
               wxDefaultPosition,
               wxSize(200, -1));
            gridSizer->Add(mSliders[i], 0, wxALIGN_CENTER_VERTICAL | wxEXPAND | wxALL, 5);
#if wxUSE_ACCESSIBILITY
            // so that name can be set on a standard control
            mSliders[i]->SetAccessible(safenew WindowAccessible(mSliders[i]));
#endif
 
            mDisplays[i] = safenew wxStaticText(scroller,
               wxID_ANY,
               wxEmptyString,
               wxDefaultPosition,
               wxSize(w, -1),
               wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
            gridSizer->Add(mDisplays[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
 
            mLabels[i] = safenew wxStaticText(scroller,
               wxID_ANY,
               wxEmptyString,
               wxDefaultPosition,
               wxSize(w, -1),
               wxALIGN_LEFT | wxST_NO_AUTORESIZE);
            gridSizer->Add(mLabels[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxALL, 5);
         }
 
         paramSizer->Add(gridSizer.release(), 1, wxEXPAND | wxALL, 5);
      }
      scroller->SetSizer(paramSizer.release());
   }
 
   RefreshParameters();
 
   mSliders[0]->SetFocus();
}

References _, NumericTextCtrl::Options::AutoPos(), EffectTypeGenerate, effGetParamName, EffectSettings::extra, EffectSettingsAccess::Get(), GetString(), GetType(), ID_Duration, ID_Sliders, mAEffect, mDisplays, mDuration, mLabels, mNames, mParent, mSampleRate, mSliders, AEffect::numParams, RefreshParameters(), ArrayOf< X >::reinit(), safenew, NumericTextCtrl::SetName(), NumericConverter::TIME, and XO.

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildProgramBar()

wxSizer * VSTEffect::BuildProgramBar ( )

private

◆ callDispatcher()

intptr_t VSTEffect::callDispatcher	(	int	opcode,
		int	index,
		intptr_t	value,
		void *	ptr,
		float	opt
	)

overrideprivatevirtual

Implements VSTEffectLink.

Definition at line 2166 of file VSTEffect.cpp.

{
   // Needed since we might be in the dispatcher when the timer pops
   wxCRIT_SECT_LOCKER(locker, mDispatcherLock);
   return mAEffect->dispatcher(mAEffect, opcode, index, value, ptr, opt);
}

References AEffect::dispatcher, and mAEffect.

Referenced by callSetChunk(), callSetParameter(), callSetProgram(), constCallDispatcher(), DoProcessInitialize(), GetEffectIDs(), HandleXMLEndTag(), HandleXMLTag(), Load(), LoadFXB(), LoadFXProgram(), LoadXML(), OnTimer(), PowerOff(), PowerOn(), RealtimeAddProcessor(), SetString(), and Unload().

Here is the caller graph for this function:

◆ callGetParameter()

float VSTEffect::callGetParameter ( int index ) const

private

Definition at line 2190 of file VSTEffect.cpp.

{
   return mAEffect->getParameter(mAEffect, index);
}

References AEffect::getParameter, and mAEffect.

Referenced by RealtimeAddProcessor(), RefreshParameters(), SaveFXProgram(), and SaveSettings().

Here is the caller graph for this function:

◆ callProcessReplacing()

void VSTEffect::callProcessReplacing	(	const float const	inputs,
		float const	outputs,
		int	sampleframes
	)

private

Definition at line 2182 of file VSTEffect.cpp.

{
   mAEffect->processReplacing(mAEffect,
      const_cast<float**>(inputs),
      const_cast<float**>(outputs), sampleframes);
}

References mAEffect, and AEffect::processReplacing.

Referenced by ProcessBlock().

Here is the caller graph for this function:

◆ callSetChunk() [1/2]

void VSTEffect::callSetChunk	(	bool	isPgm,
		int	len,
		void *	buf
	)

private

Definition at line 2217 of file VSTEffect.cpp.

{
   VstPatchChunkInfo info;
 
   memset(&info, 0, sizeof(info));
   info.version = 1;
   info.pluginUniqueID = mAEffect->uniqueID;
   info.pluginVersion = mAEffect->version;
   info.numElements = isPgm ? mAEffect->numParams : mAEffect->numPrograms;
 
   callSetChunk(isPgm, len, buf, &info);
}

References callSetChunk(), mAEffect, VstPatchChunkInfo::numElements, AEffect::numParams, AEffect::numPrograms, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, AEffect::uniqueID, AEffect::version, and VstPatchChunkInfo::version.

Referenced by callSetChunk(), HandleXMLEndTag(), LoadFXB(), LoadFXProgram(), LoadParameters(), and RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callSetChunk() [2/2]

void VSTEffect::callSetChunk	(	bool	isPgm,
		int	len,
		void *	buf,
		VstPatchChunkInfo *	info
	)

private

Definition at line 2230 of file VSTEffect.cpp.

{
   if (isPgm)
   {
      // Ask the effect if this is an acceptable program
      if (callDispatcher(effBeginLoadProgram, 0, 0, info, 0.0) == -1)
      {
         return;
      }
   }
   else
   {
      // Ask the effect if this is an acceptable bank
      if (callDispatcher(effBeginLoadBank, 0, 0, info, 0.0) == -1)
      {
         return;
      }
   }
 
   callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
   callDispatcher(effSetChunk, isPgm ? 1 : 0, len, buf, 0.0);
   callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
 
   for (const auto &slave : mSlaves)
      slave->callSetChunk(isPgm, len, buf, info);
}

References callDispatcher(), effBeginLoadBank, effBeginLoadProgram, effBeginSetProgram, effEndSetProgram, effSetChunk, and mSlaves.

Here is the call graph for this function:

◆ callSetParameter()

void VSTEffect::callSetParameter	(	int	index,
		float	value
	)

private

Definition at line 2195 of file VSTEffect.cpp.

{
   if (mVstVersion == 0 || callDispatcher(effCanBeAutomated, 0, index, NULL, 0.0))
   {
      mAEffect->setParameter(mAEffect, index, value);
 
      for (const auto &slave : mSlaves)
         slave->callSetParameter(index, value);
   }
}

References callDispatcher(), effCanBeAutomated, mAEffect, mSlaves, mVstVersion, and AEffect::setParameter.

Referenced by HandleXMLTag(), LoadFXProgram(), LoadSettings(), OnSlider(), and RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callSetProgram()

void VSTEffect::callSetProgram ( int index )

private

Definition at line 2206 of file VSTEffect.cpp.

{
   callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
 
   callDispatcher(effSetProgram, 0, index, NULL, 0.0);
   for (const auto &slave : mSlaves)
      slave->callSetProgram(index);
 
   callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
}

References callDispatcher(), effBeginSetProgram, effEndSetProgram, effSetProgram, and mSlaves.

Referenced by DoLoadFactoryPreset(), Load(), and LoadFXB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CanExportPresets()

bool VSTEffect::CanExportPresets ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1439 of file VSTEffect.cpp.

{
   return true;
}

◆ CloseUI()

bool VSTEffect::CloseUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1411 of file VSTEffect.cpp.

{
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(false);
#endif
   mControl->Close();
#endif
 
   mParent->RemoveEventHandler(this);
 
   PowerOff();
 
   NeedEditIdle(false);
 
   RemoveHandler();
 
   mNames.reset();
   mSliders.reset();
   mDisplays.reset();
   mLabels.reset();
 
   mParent = NULL;
   mDialog = NULL;
 
   return true;
}

References VSTControl::Close(), mControl, mDialog, mDisplays, mLabels, mNames, mParent, mSliders, NeedEditIdle(), PowerOff(), and RemoveHandler().

Referenced by Unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constCallDispatcher()

intptr_t VSTEffect::constCallDispatcher	(	int	opcode,
		int	index,
		intptr_t	value,
		void *	ptr,
		float	opt
	)		const

private

Definition at line 2174 of file VSTEffect.cpp.

{
   // Assume we are passed a read-only dispatcher function code
   return const_cast<VSTEffect*>(this)
      ->callDispatcher(opcode, index, value, ptr, opt);
}

References callDispatcher().

Referenced by GetString(), LoadSettings(), SaveFXB(), SaveFXP(), SaveFXProgram(), and SaveParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoLoadFactoryPreset()

bool VSTEffect::DoLoadFactoryPreset ( int id )

Definition at line 1350 of file VSTEffect.cpp.

{
   callSetProgram(id);
 
   RefreshParameters();
 
   return true;
}

References callSetProgram(), and RefreshParameters().

Referenced by LoadFactoryPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoLoadUserPreset()

bool VSTEffect::DoLoadUserPreset	(	const RegistryPath &	name,
		EffectSettings &	settings
	)

Definition at line 1307 of file VSTEffect.cpp.

{
   if (!LoadParameters(name, settings))
   {
      return false;
   }
 
   RefreshParameters();
 
   return true;
}

References LoadParameters(), name, RefreshParameters(), and settings().

Referenced by LoadUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoMakeInstance()

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

Definition at line 968 of file VSTEffect.cpp.

{
   int userBlockSize;
   GetConfig(*this, PluginSettings::Shared, wxT("Options"),
      wxT("BufferSize"), userBlockSize, 8192);
   mUserBlockSize = std::max( 1, userBlockSize );
   GetConfig(*this, PluginSettings::Shared, wxT("Options"),
      wxT("UseLatency"), mUseLatency, true);
   mBlockSize = mUserBlockSize;
   return std::make_shared<Instance>(*this);
}

References PluginSettings::GetConfig(), mBlockSize, mUseLatency, mUserBlockSize, and PluginSettings::Shared.

Referenced by MakeInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoProcessInitialize()

bool VSTEffect::DoProcessInitialize	(	sampleCount	totalLen,
		ChannelNames	chanMap
	)

Definition at line 1040 of file VSTEffect.cpp.

{
   // Initialize time info
   memset(&mTimeInfo, 0, sizeof(mTimeInfo));
   mTimeInfo.sampleRate = mSampleRate;
   mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
   mTimeInfo.tempo = 120.0;
   mTimeInfo.timeSigNumerator = 4;
   mTimeInfo.timeSigDenominator = 4;
   mTimeInfo.flags = kVstTempoValid | kVstNanosValid | kVstTransportPlaying;
 
   // Set processing parameters...power must be off for this
   callDispatcher(effSetSampleRate, 0, 0, NULL, mSampleRate);
   callDispatcher(effSetBlockSize, 0, mBlockSize, NULL, 0.0);
 
   // Turn on the power
   PowerOn();
 
   // Set the initial buffer delay
   SetBufferDelay(mAEffect->initialDelay);
 
   mReady = true;
 
   return true;
}

References callDispatcher(), effSetBlockSize, effSetSampleRate, VstTimeInfo::flags, AEffect::initialDelay, kVstNanosValid, kVstTempoValid, kVstTransportPlaying, mAEffect, mBlockSize, mReady, mSampleRate, mTimeInfo, VstTimeInfo::nanoSeconds, PowerOn(), VstTimeInfo::sampleRate, SetBufferDelay(), VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Referenced by ProcessInitialize(), and ShowClientInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExportPresets()

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

overridevirtual

Reimplemented from Effect.

Definition at line 1445 of file VSTEffect.cpp.

{
   wxString path;
 
   // Ask the user for the real name
   //
   // Passing a valid parent will cause some effects dialogs to malfunction
   // upon returning from the SelectFile().
   path = SelectFile(FileNames::Operation::Presets,
      XO("Save VST Preset As:"),
      wxEmptyString,
      wxT("preset"),
      wxT("xml"),
      {
        { XO("Standard VST bank file"), { wxT("fxb") }, true },
        { XO("Standard VST program file"), { wxT("fxp") }, true },
        { XO("Audacity VST preset file"), { wxT("xml") }, true },
      },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
      NULL);
 
   // User canceled...
   if (path.empty())
   {
      return;
   }
 
   wxFileName fn(path);
   wxString ext = fn.GetExt();
   if (ext.CmpNoCase(wxT("fxb")) == 0)
   {
      SaveFXB(fn);
   }
   else if (ext.CmpNoCase(wxT("fxp")) == 0)
   {
      SaveFXP(fn);
   }
   else if (ext.CmpNoCase(wxT("xml")) == 0)
   {
      // may throw
      SaveXML(fn);
   }
   else
   {
      // This shouldn't happen, but complain anyway
      AudacityMessageBox(
         XO("Unrecognized file extension."),
         XO("Error Saving VST Presets"),
         wxOK | wxCENTRE,
         mParent);
 
      return;
   }
}

References AudacityMessageBox(), fn, mParent, SaveFXB(), SaveFXP(), SaveXML(), SelectFile(), and XO.

Here is the call graph for this function:

◆ GetAudioInCount()

unsigned VSTEffect::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

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

Reimplemented from Effect.

Definition at line 980 of file VSTEffect.cpp.

{
   return mAudioIns;
}

References mAudioIns.

◆ GetAudioOutCount()

unsigned VSTEffect::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

Reimplemented from Effect.

Definition at line 985 of file VSTEffect.cpp.

{
   return mAudioOuts;
}

References mAudioOuts.

◆ GetBlockSize()

size_t VSTEffect::GetBlockSize ( ) const

overridevirtual

Default implementation returns mEffectBlockSize

Reimplemented from StatefulPerTrackEffect.

Definition at line 1006 of file VSTEffect.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ GetChannelCount()

unsigned VSTEffect::GetChannelCount ( )

private

Definition at line 1091 of file VSTEffect.cpp.

{
   return mNumChannels;
}

References mNumChannels.

◆ GetDescription()

TranslatableString VSTEffect::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 881 of file VSTEffect.cpp.

{
   // VST does have a product string opcode and some effects return a short
   // description, but most do not or they just return the name again.  So,
   // try to provide some sort of useful information.
   return XO("Audio In: %d, Audio Out: %d").Format( mAudioIns, mAudioOuts );
}

References mAudioIns, mAudioOuts, and XO.

◆ GetEffectIDs()

std::vector< int > VSTEffect::GetEffectIDs ( )

private

Definition at line 1883 of file VSTEffect.cpp.

{
   std::vector<int> effectIDs;
 
   // Are we a shell?
   if (mVstVersion >= 2 && (VstPlugCategory) callDispatcher(effGetPlugCategory, 0, 0, NULL, 0) == kPlugCategShell)
   {
      char name[64];
      int effectID;
 
      effectID = (int) callDispatcher(effShellGetNextPlugin, 0, 0, &name, 0);
      while (effectID)
      {
         effectIDs.push_back(effectID);
         effectID = (int) callDispatcher(effShellGetNextPlugin, 0, 0, &name, 0);
      }
   }
 
   return effectIDs;
}

References callDispatcher(), effGetPlugCategory, effShellGetNextPlugin, kPlugCategShell, mVstVersion, and name.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFactoryPresets()

RegistryPaths VSTEffect::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 1326 of file VSTEffect.cpp.

{
   RegistryPaths progs;
 
   // Some plugins, like Guitar Rig 5, only report 128 programs while they have hundreds.  While
   // I was able to come up with a hack in the Guitar Rig case to gather all of the program names
   // it would not let me set a program outside of the first 128.
   if (mVstVersion >= 2)
   {
      for (int i = 0; i < mAEffect->numPrograms; i++)
      {
         progs.push_back(GetString(effGetProgramNameIndexed, i));
      }
   }
 
   return progs;
}

References effGetProgramNameIndexed, GetString(), mAEffect, mVstVersion, and AEffect::numPrograms.

Here is the call graph for this function:

◆ GetFamily()

EffectFamilySymbol VSTEffect::GetFamily ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 914 of file VSTEffect.cpp.

{
   return VSTPLUGINTYPE;
}

References VSTPLUGINTYPE.

◆ GetLatency()

sampleCount VSTEffect::GetLatency ( )

overridevirtual

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

Reimplemented from StatefulPerTrackEffect.

Definition at line 1016 of file VSTEffect.cpp.

{
   if (mUseLatency)
   {
      // ??? Threading issue ???
      auto delay = mBufferDelay;
      mBufferDelay = 0;
      return delay;
   }
 
   return 0;
}

References mBufferDelay, and mUseLatency.

◆ GetMidiInCount()

int VSTEffect::GetMidiInCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 990 of file VSTEffect.cpp.

{
   return mMidiIns;
}

References mMidiIns.

◆ GetMidiOutCount()

int VSTEffect::GetMidiOutCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 995 of file VSTEffect.cpp.

{
   return mMidiOuts;
}

References mMidiOuts.

◆ GetPath()

PluginPath VSTEffect::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 847 of file VSTEffect.cpp.

{
   return mPath;
}

References mPath.

◆ GetProcessLevel()

int VSTEffect::GetProcessLevel ( )

private

Definition at line 2042 of file VSTEffect.cpp.

{
   return mProcessLevel;
}

References mProcessLevel.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetSampleRate()

float VSTEffect::GetSampleRate ( )

private

Definition at line 2037 of file VSTEffect.cpp.

{
   return mTimeInfo.sampleRate;
}

References mTimeInfo, and VstTimeInfo::sampleRate.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetString() [1/2]

wxString VSTEffect::GetString	(	int	opcode,
		int	index = `0`
	)		const

private

Definition at line 2149 of file VSTEffect.cpp.

{
   wxString str;
 
   GetString(str, opcode, index);
 
   return str;
}

References GetString(), and str.

Here is the call graph for this function:

◆ GetString() [2/2]

int VSTEffect::GetString	(	wxString &	outstr,
		int	opcode,
		int	index = `0`
	)		const

private

Definition at line 2135 of file VSTEffect.cpp.

{
   char buf[256];
 
   memset(buf, 0, sizeof(buf));
 
   // Assume we are passed a read-only dispatcher function code
   constCallDispatcher(opcode, index, 0, buf, 0.0);
 
   outstr = wxString::FromUTF8(buf);
 
   return 0;
}

References constCallDispatcher().

Referenced by BuildPlain(), GetFactoryPresets(), GetString(), Load(), LoadSettings(), RefreshParameters(), and SaveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol VSTEffect::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 852 of file VSTEffect.cpp.

{
   return mName;
}

References mName.

Referenced by HandleXMLTag().

Here is the caller graph for this function:

◆ GetTimeInfo()

VstTimeInfo * VSTEffect::GetTimeInfo ( )

private

Definition at line 2031 of file VSTEffect.cpp.

{
   mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
   return &mTimeInfo;
}

References mTimeInfo, and VstTimeInfo::nanoSeconds.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetType()

EffectType VSTEffect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 893 of file VSTEffect.cpp.

{
   if (mAudioIns == 0 && mAudioOuts == 0 && mMidiIns == 0 && mMidiOuts == 0)
   {
      return EffectTypeTool;
   }
 
   if (mAudioIns == 0 && mMidiIns == 0)
   {
      return EffectTypeGenerate;
   }
 
   if (mAudioOuts == 0 && mMidiOuts == 0)
   {
      return EffectTypeAnalyze;
   }
 
   return EffectTypeProcess;
}

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, mAudioIns, mAudioOuts, mMidiIns, and mMidiOuts.

Referenced by BuildPlain(), and ValidateUI().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VSTEffect::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 857 of file VSTEffect.cpp.

{
   return { mVendor };
}

References mVendor.

◆ GetVersion()

wxString VSTEffect::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 862 of file VSTEffect.cpp.

{
   wxString version;
 
   bool skipping = true;
   for (int i = 0, s = 0; i < 4; i++, s += 8)
   {
      int dig = (mVersion >> s) & 0xff;
      if (dig != 0 || !skipping)
      {
         version += !skipping ? wxT(".") : wxT("");
         version += wxString::Format(wxT("%d"), dig);
         skipping = false;
      }
   }
 
   return version;
}

References mVersion.

◆ HandleXMLChild()

XMLTagHandler * VSTEffect::HandleXMLChild ( const std::string_view & tag )

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 3430 of file VSTEffect.cpp.

{
   if (tag == "vstprogrampersistence")
   {
      return this;
   }
 
   if (tag == "effect")
   {
      return this;
   }
 
   if (tag == "program")
   {
      return this;
   }
 
   if (tag == "param")
   {
      return this;
   }
 
   if (tag == "chunk")
   {
      return this;
   }
 
   return NULL;
}

◆ HandleXMLContent()

void VSTEffect::HandleXMLContent ( const std::string_view & content )

overrideprivate

Definition at line 3422 of file VSTEffect.cpp.

{
   if (mInChunk)
   {
      mChunk += wxString(std::string(content)).Trim(true).Trim(false);
   }
}

References mChunk, and mInChunk.

◆ HandleXMLEndTag()

void VSTEffect::HandleXMLEndTag ( const std::string_view & tag )

overrideprivate

Definition at line 3392 of file VSTEffect.cpp.

{
   if (tag == "chunk")
   {
      if (mChunk.length())
      {
         ArrayOf<char> buf{ mChunk.length() / 4 * 3 };
 
         int len = Base64::Decode(mChunk, buf.get());
         if (len)
         {
            callSetChunk(true, len, buf.get(), &mXMLInfo);
         }
 
         mChunk.clear();
      }
      mInChunk = false;
   }
 
   if (tag == "program")
   {
      if (mInSet)
      {
         callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
 
         mInSet = false;
      }
   }
}

References callDispatcher(), callSetChunk(), Base64::Decode(), effEndSetProgram, mChunk, mInChunk, mInSet, and mXMLInfo.

Here is the call graph for this function:

◆ HandleXMLTag()

bool VSTEffect::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 3184 of file VSTEffect.cpp.

{
   if (tag == "vstprogrampersistence")
   {
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "version")
         {
            if (!value.TryGet(mXMLVersion))
            {
               return false;
            }
 
            if (mXMLVersion < 1 || mXMLVersion > 2)
            {
               return false;
            }
         }
         else
         {
            return false;
         }
      }
 
      return true;
   }
 
   if (tag == "effect")
   {
      memset(&mXMLInfo, 0, sizeof(mXMLInfo));
      mXMLInfo.version = 1;
      mXMLInfo.pluginUniqueID = mAEffect->uniqueID;
      mXMLInfo.pluginVersion = mAEffect->version;
      mXMLInfo.numElements = mAEffect->numParams;
 
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "name")
         {
            wxString strValue = value.ToWString();
 
            if (strValue != GetSymbol().Internal())
            {
               auto msg = XO("This parameter file was saved from %s. Continue?")
                  .Format( strValue );
               int result = AudacityMessageBox(
                  msg,
                  XO("Confirm"),
                  wxYES_NO,
                  mParent );
               if (result == wxNO)
               {
                  return false;
               }
            }
         }
         else if (attr == "version")
         {
            long version;
            if (!value.TryGet(version))
            {
               return false;
            }
 
            mXMLInfo.pluginVersion = (int) version;
         }
         else if (mXMLVersion > 1 && attr == "uniqueID")
         {
            long uniqueID;
            if (!value.TryGet(uniqueID))
            {
               return false;
            }
 
            mXMLInfo.pluginUniqueID = (int) uniqueID;
         }
         else if (mXMLVersion > 1 && attr == "numParams")
         {
            long numParams;
            if (!value.TryGet(numParams))
            {
               return false;
            }
 
            mXMLInfo.numElements = (int) numParams;
         }
         else
         {
            return false;
         }
      }
 
      return true;
   }
 
   if (tag == "program")
   {
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "name")
         {
            const wxString strValue = value.ToWString();
 
            if (strValue.length() > 24)
            {
               return false;
            }
 
            int ndx = 0; //mProgram->GetCurrentSelection();
            if (ndx == wxNOT_FOUND)
            {
               ndx = 0;
            }
 
            SetString(effSetProgramName, strValue, ndx);
         }
         else
         {
            return false;
         }
      }
 
      mInChunk = false;
 
      if (callDispatcher(effBeginLoadProgram, 0, 0, &mXMLInfo, 0.0) == -1)
      {
         return false;
      }
 
      callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
 
      mInSet = true;
 
      return true;
   }
 
   if (tag == "param")
   {
      long ndx = -1;
      double val = -1.0;
 
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "index")
         {
            if (!value.TryGet(ndx))
            {
               return false;
            }
 
            if (ndx < 0 || ndx >= mAEffect->numParams)
            {
               // Could be a different version of the effect...probably should
               // tell the user
               return false;
            }
         }
         // "name" attribute is ignored for params
         /* else if (attr == "name")
         {
 
            // Nothing to do with it for now
         }*/
         else if (attr == "value")
         {
            if (!value.TryGet(val))
            {
               return false;
            }
 
            if (val < 0.0 || val > 1.0)
            {
               return false;
            }
         }
      }
 
      if (ndx == -1 || val == -1.0)
      {
         return false;
      }
 
      callSetParameter(ndx, val);
 
      return true;
   }
 
   if (tag == "chunk")
   {
      mInChunk = true;
      return true;
   }
 
   return false;
}

References AudacityMessageBox(), callDispatcher(), callSetParameter(), effBeginLoadProgram, effBeginSetProgram, effSetProgramName, GetSymbol(), Internal, mAEffect, mInChunk, mInSet, mParent, mXMLInfo, mXMLVersion, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, SetString(), AEffect::uniqueID, AEffect::version, VstPatchChunkInfo::version, and XO.

Here is the call graph for this function:

◆ HasOptions()

bool VSTEffect::HasOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1572 of file VSTEffect.cpp.

{
   return true;
}

◆ ImportPresets()

void VSTEffect::ImportPresets ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 1505 of file VSTEffect.cpp.

{
   wxString path;
 
   // Ask the user for the real name
   path = SelectFile(FileNames::Operation::Presets,
      XO("Load VST Preset:"),
      wxEmptyString,
      wxT("preset"),
      wxT("xml"),
      { {
         XO("VST preset files"),
         { wxT("fxb"), wxT("fxp"), wxT("xml") },
         true
      } },
      wxFD_OPEN | wxRESIZE_BORDER,
      mParent);
 
   // User canceled...
   if (path.empty())
   {
      return;
   }
 
   wxFileName fn(path);
   wxString ext = fn.GetExt();
   bool success = false;
   if (ext.CmpNoCase(wxT("fxb")) == 0)
   {
      success = LoadFXB(fn);
   }
   else if (ext.CmpNoCase(wxT("fxp")) == 0)
   {
      success = LoadFXP(fn);
   }
   else if (ext.CmpNoCase(wxT("xml")) == 0)
   {
      success = LoadXML(fn);
   }
   else
   {
      // This shouldn't happen, but complain anyway
      AudacityMessageBox(
         XO("Unrecognized file extension."),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         mParent);
 
         return;
   }
 
   if (!success)
   {
      AudacityMessageBox(
         XO("Unable to load presets file."),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         mParent);
 
      return;
   }
 
   RefreshParameters();
 
   return;
}

References AudacityMessageBox(), fn, LoadFXB(), LoadFXP(), LoadXML(), mParent, RefreshParameters(), SelectFile(), and XO.

Here is the call graph for this function:

◆ InitializePlugin()

bool VSTEffect::InitializePlugin ( )

Definition at line 941 of file VSTEffect.cpp.

{
   if (!mAEffect)
   {
      Load();
   }
 
   if (!mAEffect)
   {
      return false;
   }
 
   // If we have a master then there's no need to load settings since the master will feed
   // us everything we need.
   if (mMaster)
   {
      return true;
   }
 
   return true;
}

References Load(), mAEffect, and mMaster.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDefault()

bool VSTEffect::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 924 of file VSTEffect.cpp.

{
   return false;
}

◆ IsGraphicalUI()

bool VSTEffect::IsGraphicalUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1398 of file VSTEffect.cpp.

{
   return mGui;
}

References mGui.

◆ IsInteractive()

bool VSTEffect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 919 of file VSTEffect.cpp.

{
   return mInteractive;
}

References mInteractive.

◆ IsReady()

bool VSTEffect::IsReady ( )

Definition at line 1029 of file VSTEffect.cpp.

{
   return mReady;
}

References mReady.

Referenced by ShowClientInterface().

Here is the caller graph for this function:

◆ Load()

bool VSTEffect::Load ( )

private

Definition at line 1596 of file VSTEffect.cpp.

{
   vstPluginMain pluginMain;
   bool success = false;
 
   long effectID = 0;
   wxString realPath = mPath.BeforeFirst(wxT(';'));
   mPath.AfterFirst(wxT(';')).ToLong(&effectID);
   mCurrentEffectID = (intptr_t) effectID;
 
   mModule = NULL;
   mAEffect = NULL;
 
#if defined(__WXMAC__)
   // Start clean
   mBundleRef.reset();
 
   mResource = ResourceHandle{};
 
   // Convert the path to a CFSTring
   wxCFStringRef path(realPath);
 
   // Create the bundle using the URL
   BundleHandle bundleRef{ CFBundleCreate(kCFAllocatorDefault,
      // Convert the path to a URL
      CF_ptr<CFURLRef>{
         CFURLCreateWithFileSystemPath(kCFAllocatorDefault,
            path, kCFURLPOSIXPathStyle, true)
      }.get()
   )};
 
   // Bail if the bundle wasn't created
   if (!bundleRef)
      return false;
 
 
   // Convert back to path
   UInt8 exePath[PLATFORM_MAX_PATH];
   Boolean good = CFURLGetFileSystemRepresentation(
      // Retrieve a reference to the executable
      CF_ptr<CFURLRef>{ CFBundleCopyExecutableURL(bundleRef.get()) }.get(),
      true, exePath, sizeof(exePath)
   );
 
   // Bail if we couldn't resolve the executable path
   if (good == FALSE)
      return false;
 
   // Attempt to open it
   mModule.reset((char*)dlopen((char *) exePath, RTLD_NOW | RTLD_LOCAL));
   if (!mModule)
      return false;
 
   // Try to locate the NEW plugin entry point
   pluginMain = (vstPluginMain) dlsym(mModule.get(), "VSTPluginMain");
 
   // If not found, try finding the old entry point
   if (pluginMain == NULL)
   {
      pluginMain = (vstPluginMain) dlsym(mModule.get(), "main_macho");
   }
 
   // Must not be a VST plugin
   if (pluginMain == NULL)
   {
      mModule.reset();
      return false;
   }
 
   // Need to keep the bundle reference around so we can map the
   // resources.
   mBundleRef = std::move(bundleRef);
 
   // Open the resource map ... some plugins (like GRM Tools) need this.
   mResource = ResourceHandle{
      mBundleRef.get(), CFBundleOpenBundleResourceMap(mBundleRef.get())
   };
 
#elif defined(__WXMSW__)
 
   {
      wxLogNull nolog;
 
      // Try to load the library
      auto lib = std::make_unique<wxDynamicLibrary>(realPath);
      if (!lib) 
         return false;
 
      // Bail if it wasn't successful
      if (!lib->IsLoaded())
         return false;
 
      // Try to find the entry point, while suppressing error messages
      pluginMain = (vstPluginMain) lib->GetSymbol(wxT("VSTPluginMain"));
      if (pluginMain == NULL)
      {
         pluginMain = (vstPluginMain) lib->GetSymbol(wxT("main"));
         if (pluginMain == NULL)
            return false;
      }
 
      // Save the library reference
      mModule = std::move(lib);
   }
 
#else
 
   // Attempt to load it
   //
   // Spent a few days trying to figure out why some VSTs where running okay and
   // others were hit or miss.  The cause was that we export all of Audacity's
   // symbols and some of the loaded libraries were picking up Audacity's and 
   // not their own.
   //
   // So far, I've only seen this issue on Linux, but we might just be getting
   // lucky on the Mac and Windows.  The sooner we stop exporting everything
   // the better.
   //
   // To get around the problem, I just added the RTLD_DEEPBIND flag to the load
   // and that "basically" puts Audacity last when the loader needs to resolve
   // symbols.
   //
   // Once we define a proper external API, the flags can be removed.
#ifndef RTLD_DEEPBIND
#define RTLD_DEEPBIND 0
#endif
   ModuleHandle lib {
      (char*) dlopen((const char *)wxString(realPath).ToUTF8(),
                     RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND)
   };
   if (!lib) 
   {
      return false;
   }
 
   // Try to find the entry point, while suppressing error messages
   pluginMain = (vstPluginMain) dlsym(lib.get(), "VSTPluginMain");
   if (pluginMain == NULL)
   {
      pluginMain = (vstPluginMain) dlsym(lib.get(), "main");
      if (pluginMain == NULL)
         return false;
   }
 
   // Save the library reference
   mModule = std::move(lib);
 
#endif
 
   // Initialize the plugin
   try
   {
      mAEffect = pluginMain(VSTEffect::AudioMaster);
   }
   catch (...)
   {
      wxLogMessage(wxT("VST plugin initialization failed\n"));
      mAEffect = NULL;
   }
 
   // Was it successful?
   if (mAEffect)
   {
      // Save a reference to ourselves
      //
      // Note:  Some hosts use "user" and some use "ptr2/resvd2".  It might
      //        be worthwhile to check if user is NULL before using it and
      //        then falling back to "ptr2/resvd2".
      mAEffect->ptr2 = this;
 
      // Give the plugin an initial sample rate and blocksize
      callDispatcher(effSetSampleRate, 0, 0, NULL, 48000.0);
      callDispatcher(effSetBlockSize, 0, 512, NULL, 0);
 
      // Ask the plugin to identify itself...might be needed for older plugins
      callDispatcher(effIdentify, 0, 0, NULL, 0);
 
      // Open the plugin
      callDispatcher(effOpen, 0, 0, NULL, 0.0);
 
      // Get the VST version the plugin understands
      mVstVersion = callDispatcher(effGetVstVersion, 0, 0, NULL, 0);
 
      // Set it again in case plugin ignored it before the effOpen
      callDispatcher(effSetSampleRate, 0, 0, NULL, 48000.0);
      callDispatcher(effSetBlockSize, 0, 512, NULL, 0);
 
      // Ensure that it looks like a plugin and can deal with ProcessReplacing
      // calls.  Also exclude synths for now.
      if (mAEffect->magic == kEffectMagic &&
         !(mAEffect->flags & effFlagsIsSynth) &&
         mAEffect->flags & effFlagsCanReplacing)
      {
         if (mVstVersion >= 2)
         {
            mName = GetString(effGetEffectName);
            if (mName.length() == 0)
            {
               mName = GetString(effGetProductString);
            }
         }
         if (mName.length() == 0)
         {
            mName = wxFileName{realPath}.GetName();
         }
 
         if (mVstVersion >= 2)
         {
            mVendor = GetString(effGetVendorString);
            mVersion = wxINT32_SWAP_ON_LE(callDispatcher(effGetVendorVersion, 0, 0, NULL, 0));
         }
         if (mVersion == 0)
         {
            mVersion = wxINT32_SWAP_ON_LE(mAEffect->version);
         }
 
         if (mAEffect->flags & effFlagsHasEditor || mAEffect->numParams != 0)
         {
            mInteractive = true;
         }
 
         mAudioIns = mAEffect->numInputs;
         mAudioOuts = mAEffect->numOutputs;
 
         mMidiIns = 0;
         mMidiOuts = 0;
 
         // Check to see if parameters can be automated.  This isn't a guarantee
         // since it could be that the effect simply doesn't support the opcode.
         mAutomatable = false;
         for (int i = 0; i < mAEffect->numParams; i++)
         {
            if (callDispatcher(effCanBeAutomated, 0, i, NULL, 0.0))
            {
               mAutomatable = true;
               break;
            }
         }
 
         // Make sure we start out with a valid program selection
         // I've found one plugin (SoundHack +morphfilter) that will
         // crash Audacity when saving the initial default parameters
         // with this.
         callSetProgram(0);
 
         // Pretty confident that we're good to go
         success = true;
      }
   }
 
   if (!success)
   {
      Unload();
   }
 
   return success;
}

References AudioMaster(), callDispatcher(), callSetProgram(), effCanBeAutomated, effFlagsCanReplacing, effFlagsHasEditor, effFlagsIsSynth, effGetEffectName, effGetProductString, effGetVendorString, effGetVendorVersion, effGetVstVersion, effIdentify, effOpen, effSetBlockSize, effSetSampleRate, AEffect::flags, GetString(), kEffectMagic, mAEffect, AEffect::magic, mAudioIns, mAudioOuts, mAutomatable, mBundleRef, mCurrentEffectID, mInteractive, mMidiIns, mMidiOuts, mModule, mName, mPath, mResource, mVendor, mVersion, mVstVersion, AEffect::numInputs, AEffect::numOutputs, AEffect::numParams, PLATFORM_MAX_PATH, AEffect::ptr2, Unload(), and AEffect::version.

Referenced by InitializePlugin(), and VSTEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFactoryPreset()

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

overridevirtual

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

Reimplemented from Effect.

Definition at line 1344 of file VSTEffect.cpp.

{
   // To do: externalize state so const_cast isn't needed
   return const_cast<VSTEffect*>(this)->DoLoadFactoryPreset(id);
}

References DoLoadFactoryPreset().

Here is the call graph for this function:

◆ LoadFXB()

bool VSTEffect::LoadFXB ( const wxFileName & fn )

private

Definition at line 2529 of file VSTEffect.cpp.

{
   bool ret = false;
 
   // Try to open the file...will be closed automatically when method returns
   wxFFile f(fn.GetFullPath(), wxT("rb"));
   if (!f.IsOpened())
   {
      return false;
   }
 
   // Allocate memory for the contents
   ArrayOf<unsigned char> data{ size_t(f.Length()) };
   if (!data)
   {
      AudacityMessageBox(
         XO("Unable to allocate memory when loading presets file."),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         mParent);
      return false;
   }
   unsigned char *bptr = data.get();
 
   do
   {
      // Read in the whole file
      ssize_t len = f.Read((void *) bptr, f.Length());
      if (f.Error())
      {
         AudacityMessageBox(
            XO("Unable to read presets file."),
            XO("Error Loading VST Presets"),
            wxOK | wxCENTRE,
            mParent);
         break;
      }
 
      // Most references to the data are via an "int" array
      int32_t *iptr = (int32_t *) bptr;
 
      // Verify that we have at least enough for the header
      if (len < 156)
      {
         break;
      }
 
      // Verify that we probably have an FX file
      if (wxINT32_SWAP_ON_LE(iptr[0]) != CCONST('C', 'c', 'n', 'K'))
      {
         break;
      }
 
      // Ignore the size...sometimes it's there, other times it's zero
 
      // Get the version and verify
      int version = wxINT32_SWAP_ON_LE(iptr[3]);
      if (version != 1 && version != 2)
      {
         break;
      }
 
      VstPatchChunkInfo info =
      {
         1,
         wxINT32_SWAP_ON_LE(iptr[4]),
         wxINT32_SWAP_ON_LE(iptr[5]),
         wxINT32_SWAP_ON_LE(iptr[6]),
         ""
      };
 
      // Ensure this program looks to belong to the current plugin
      if ((info.pluginUniqueID != mAEffect->uniqueID) &&
          (info.pluginVersion != mAEffect->version) &&
          (info.numElements != mAEffect->numPrograms))
      {
         break;
      }
 
      // Get the number of programs
      int numProgs = info.numElements;
 
      // Get the current program index
      int curProg = 0;
      if (version >= 2)
      {
         curProg = wxINT32_SWAP_ON_LE(iptr[7]);
         if (curProg < 0 || curProg >= numProgs)
         {
            break;
         }
      }
 
      // Is it a bank of programs?
      if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'x', 'B', 'k'))
      {
         // Drop the header
         bptr += 156;
         len -= 156;
 
         unsigned char *tempPtr = bptr;
         ssize_t tempLen = len;
 
         // Validate all of the programs
         for (int i = 0; i < numProgs; i++)
         {
            if (!LoadFXProgram(&tempPtr, tempLen, i, true))
            {
               break;
            }
         }
 
         // Ask the effect if this is an acceptable bank
         if (callDispatcher(effBeginLoadBank, 0, 0, &info, 0.0) == -1)
         {
            return false;
         }
 
         // Start loading the individual programs
         for (int i = 0; i < numProgs; i++)
         {
            ret = LoadFXProgram(&bptr, len, i, false);
         }
      }
      // Or maybe a bank chunk?
      else if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'B', 'C', 'h'))
      {
         // Can't load programs chunks if the plugin doesn't support it
         if (!(mAEffect->flags & effFlagsProgramChunks))
         {
            break;
         }
 
         // Verify that we have enough to grab the chunk size
         if (len < 160)
         {
            break;
         }
 
         // Get the chunk size
         int size = wxINT32_SWAP_ON_LE(iptr[39]);
 
         // We finally know the full length of the program
         int proglen = 160 + size;
 
         // Verify that we have enough for the entire program
         if (len < proglen)
         {
            break;
         }
 
         // Set the entire bank in one shot
         callSetChunk(false, size, &iptr[40], &info);
 
         // Success
         ret = true;
      }
      // Unrecognizable type
      else
      {
         break;
      }
 
      // Set the active program
      if (ret && version >= 2)
      {
         callSetProgram(curProg);
      }
   } while (false);
 
   return ret;
}

References AudacityMessageBox(), callDispatcher(), callSetChunk(), callSetProgram(), CCONST, effBeginLoadBank, effFlagsProgramChunks, AEffect::flags, fn, LoadFXProgram(), mAEffect, mParent, VstPatchChunkInfo::numElements, AEffect::numPrograms, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, size, AEffect::uniqueID, AEffect::version, and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFXP()

bool VSTEffect::LoadFXP ( const wxFileName & fn )

private

Definition at line 2702 of file VSTEffect.cpp.

{
   bool ret = false;
 
   // Try to open the file...will be closed automatically when method returns
   wxFFile f(fn.GetFullPath(), wxT("rb"));
   if (!f.IsOpened())
   {
      return false;
   }
 
   // Allocate memory for the contents
   ArrayOf<unsigned char> data{ size_t(f.Length()) };
   if (!data)
   {
      AudacityMessageBox(
         XO("Unable to allocate memory when loading presets file."),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         mParent);
      return false;
   }
   unsigned char *bptr = data.get();
 
   do
   {
      // Read in the whole file
      ssize_t len = f.Read((void *) bptr, f.Length());
      if (f.Error())
      {
         AudacityMessageBox(
            XO("Unable to read presets file."),
            XO("Error Loading VST Presets"),
            wxOK | wxCENTRE,
            mParent);
         break;
      }
 
      // Get (or default) currently selected program
      int i = 0; //mProgram->GetCurrentSelection();
      if (i < 0)
      {
         i = 0;   // default to first program
      }
 
      // Go verify and set the program
      ret = LoadFXProgram(&bptr, len, i, false);
   } while (false);
 
   return ret;
}

References AudacityMessageBox(), fn, LoadFXProgram(), mParent, and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFXProgram()

bool VSTEffect::LoadFXProgram	(	unsigned char **	bptr,
		ssize_t &	len,
		int	index,
		bool	dryrun
	)

private

Definition at line 2754 of file VSTEffect.cpp.

{
   // Most references to the data are via an "int" array
   int32_t *iptr = (int32_t *) *bptr;
 
   // Verify that we have at least enough for a program without parameters
   if (len < 28)
   {
      return false;
   }
 
   // Verify that we probably have an FX file
   if (wxINT32_SWAP_ON_LE(iptr[0]) != CCONST('C', 'c', 'n', 'K'))
   {
      return false;
   }
 
   // Ignore the size...sometimes it's there, other times it's zero
 
   // Get the version and verify
#if defined(IS_THIS_AN_FXP_ARTIFICAL_LIMITATION)
   int version = wxINT32_SWAP_ON_LE(iptr[3]);
   if (version != 1)
   {
      return false;
   }
#endif
 
   VstPatchChunkInfo info =
   {
      1,
      wxINT32_SWAP_ON_LE(iptr[4]),
      wxINT32_SWAP_ON_LE(iptr[5]),
      wxINT32_SWAP_ON_LE(iptr[6]),
      ""
   };
 
   // Ensure this program looks to belong to the current plugin
   if ((info.pluginUniqueID != mAEffect->uniqueID) &&
         (info.pluginVersion != mAEffect->version) &&
         (info.numElements != mAEffect->numParams))
   {
      return false;
   }
 
   // Get the number of parameters
   int numParams = info.numElements;
 
   // At this point, we have to have enough to include the program name as well
   if (len < 56)
   {
      return false;
   }
 
   // Get the program name
   wxString progName(wxString::From8BitData((char *)&iptr[7]));
 
   // Might be a regular program
   if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'x', 'C', 'k'))
   {
      // We finally know the full length of the program
      int proglen = 56 + (numParams * sizeof(float));
 
      // Verify that we have enough for all of the parameter values
      if (len < proglen)
      {
         return false;
      }
 
      // Validate all of the parameter values
      for (int i = 0; i < numParams; i++)
      {
         uint32_t ival = wxUINT32_SWAP_ON_LE(iptr[14 + i]);
         float val = reinterpretAsFloat(ival);
         if (val < 0.0 || val > 1.0)
         {
            return false;
         }
      }
         
      // They look okay...time to start changing things
      if (!dryrun)
      {
         // Ask the effect if this is an acceptable program
         if (callDispatcher(effBeginLoadProgram, 0, 0, &info, 0.0) == -1)
         {
            return false;
         }
 
         // Load all of the parameters
         callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
         for (int i = 0; i < numParams; i++)
         {
            wxUint32 val = wxUINT32_SWAP_ON_LE(iptr[14 + i]);
            callSetParameter(i, reinterpretAsFloat(val));
         }
         callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
      }
 
      // Update in case we're loading an "FxBk" format bank file
      *bptr += proglen;
      len -= proglen;
   }
   // Maybe we have a program chunk
   else if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'P', 'C', 'h'))
   {
      // Can't load programs chunks if the plugin doesn't support it
      if (!(mAEffect->flags & effFlagsProgramChunks))
      {
         return false;
      }
 
      // Verify that we have enough to grab the chunk size
      if (len < 60)
      {
         return false;
      }
 
      // Get the chunk size
      int size = wxINT32_SWAP_ON_LE(iptr[14]);
 
      // We finally know the full length of the program
      int proglen = 60 + size;
 
      // Verify that we have enough for the entire program
      if (len < proglen)
      {
         return false;
      }
 
      // Set the entire program in one shot
      if (!dryrun)
      {
         callSetChunk(true, size, &iptr[15], &info);
      }
 
      // Update in case we're loading an "FxBk" format bank file
      *bptr += proglen;
      len -= proglen;
   }
   else
   {
      // Unknown type
      return false;
   }
   
   if (!dryrun)
   {
      SetString(effSetProgramName, wxString(progName), index);
   }
 
   return true;
}

References callDispatcher(), callSetChunk(), callSetParameter(), CCONST, effBeginLoadProgram, effBeginSetProgram, effEndSetProgram, effFlagsProgramChunks, effSetProgramName, AEffect::flags, mAEffect, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, reinterpretAsFloat(), SetString(), size, AEffect::uniqueID, and AEffect::version.

Referenced by LoadFXB(), and LoadFXP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadParameters()

bool VSTEffect::LoadParameters	(	const RegistryPath &	group,
		EffectSettings &	settings
	)

private

Definition at line 1904 of file VSTEffect.cpp.

{
   wxString value;
 
   VstPatchChunkInfo info = {1, mAEffect->uniqueID, mAEffect->version, mAEffect->numParams, ""};
   GetConfig(*this, PluginSettings::Private, group, wxT("UniqueID"),
      info.pluginUniqueID, info.pluginUniqueID);
   GetConfig(*this, PluginSettings::Private, group, wxT("Version"),
      info.pluginVersion, info.pluginVersion);
   GetConfig(*this, PluginSettings::Private, group, wxT("Elements"),
      info.numElements, info.numElements);
 
   if ((info.pluginUniqueID != mAEffect->uniqueID) ||
       (info.pluginVersion != mAEffect->version) ||
       (info.numElements != mAEffect->numParams))
   {
      return false;
   }
 
   if (GetConfig(*this,
      PluginSettings::Private, group, wxT("Chunk"), value, wxEmptyString))
   {
      ArrayOf<char> buf{ value.length() / 4 * 3 };
 
      int len = Base64::Decode(value, buf.get());
      if (len)
      {
         callSetChunk(true, len, buf.get(), &info);
      }
 
      return true;
   }
 
   wxString parms;
   if (!GetConfig(*this,
      PluginSettings::Private, group, wxT("Parameters"), parms, wxEmptyString))
   {
      return false;
   }
 
   CommandParameters eap;
   if (!eap.SetParameters(parms))
   {
      return false;
   }
 
   return LoadSettings(eap, settings);
}

References callSetChunk(), Base64::Decode(), PluginSettings::GetConfig(), LoadSettings(), mAEffect, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, PluginSettings::Private, CommandParameters::SetParameters(), settings(), AEffect::uniqueID, and AEffect::version.

Referenced by DoLoadUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadSettings()

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

overridevirtual

Restore settings from keys and values.

Returns: true on success

Reimplemented from Effect.

Definition at line 1270 of file VSTEffect.cpp.

{
   constCallDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
   for (int i = 0; i < mAEffect->numParams; i++)
   {
      wxString name = GetString(effGetParamName, i);
      if (name.empty())
      {
         name.Printf(wxT("parm_%d"), i);
      }
 
      double d = 0.0;
      if (!parms.Read(name, &d))
      {
         return false;
      }
 
      if (d >= -1.0 && d <= 1.0)
      {
         const_cast<VSTEffect*>(this)->callSetParameter(i, d);
         for (const auto &slave : mSlaves)
            slave->callSetParameter(i, d);
      }
   }
   constCallDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
 
   return true;
}

References callSetParameter(), constCallDispatcher(), effBeginSetProgram, effEndSetProgram, effGetParamName, TranslatableString::empty(), GetString(), mAEffect, mSlaves, name, and AEffect::numParams.

Referenced by LoadParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

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

overridevirtual

Change settings to a user-named preset.

Reimplemented from Effect.

Definition at line 1300 of file VSTEffect.cpp.

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

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

Here is the call graph for this function:

◆ LoadXML()

bool VSTEffect::LoadXML ( const wxFileName & fn )

private

Definition at line 2908 of file VSTEffect.cpp.

{
   mInChunk = false;
   mInSet = false;
 
   // default to read as XML file
   // Load the program
   XMLFileReader reader;
   bool ok = reader.Parse(this, fn.GetFullPath());
 
   // Something went wrong with the file, clean up
   if (mInSet)
   {
      callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
 
      mInSet = false;
   }
 
   if (!ok)
   {
      // Inform user of load failure
      AudacityMessageBox(
         reader.GetErrorStr(),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         mParent);
      return false;
   }
 
   return true;
}

References AudacityMessageBox(), callDispatcher(), effEndSetProgram, fn, XMLFileReader::GetErrorStr(), mInChunk, mInSet, mParent, XMLFileReader::Parse(), and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > VSTEffect::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

Reimplemented from StatefulPerTrackEffect.

Definition at line 963 of file VSTEffect.cpp.

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

References DoMakeInstance().

Here is the call graph for this function:

◆ NeedEditIdle()

void VSTEffect::NeedEditIdle ( bool state )

private

Definition at line 2025 of file VSTEffect.cpp.

{
   mWantsEditIdle = state;
   mTimer->Start(100);
}

References mTimer, and mWantsEditIdle.

Referenced by BuildFancy(), and CloseUI().

Here is the caller graph for this function:

◆ NeedIdle()

void VSTEffect::NeedIdle ( )

private

Definition at line 2019 of file VSTEffect.cpp.

{
   mWantsIdle = true;
   mTimer->Start(100);
}

References mTimer, and mWantsIdle.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ OnLoad()

void VSTEffect::OnLoad ( wxCommandEvent & evt )

private

◆ OnProgram()

void VSTEffect::OnProgram ( wxCommandEvent & evt )

private

◆ OnProgramText()

void VSTEffect::OnProgramText ( wxCommandEvent & evt )

private

◆ OnSave()

void VSTEffect::OnSave ( wxCommandEvent & evt )

private

◆ OnSettings()

void VSTEffect::OnSettings ( wxCommandEvent & evt )

private

◆ OnSizeWindow()

void VSTEffect::OnSizeWindow ( wxCommandEvent & evt )

private

Definition at line 2497 of file VSTEffect.cpp.

{
   if (!mControl)
   {
      return;
   }
 
   mControl->SetMinSize(wxSize(evt.GetInt(), (int) evt.GetExtraLong()));
   mControl->SetSize(wxSize(evt.GetInt(), (int) evt.GetExtraLong()));
 
   // DO NOT CHANGE THE ORDER OF THESE
   //
   // Guitar Rig (and possibly others) Cocoa VSTs can resize too large
   // if the bounds are unlimited.
   mDialog->SetMinSize(wxDefaultSize);
   mDialog->SetMaxSize(wxDefaultSize);
   mDialog->Layout();
   mDialog->SetMinSize(mDialog->GetBestSize());
   mDialog->SetMaxSize(mDialog->GetBestSize());
   mDialog->Fit();
}

References mControl, and mDialog.

◆ OnSlider()

void VSTEffect::OnSlider ( wxCommandEvent & evt )

private

Definition at line 2519 of file VSTEffect.cpp.

{
   wxSlider *s = (wxSlider *) evt.GetEventObject();
   int i = s->GetId() - ID_Sliders;
 
   callSetParameter(i, s->GetValue() / 1000.0);
 
   RefreshParameters(i);
}

References callSetParameter(), ID_Sliders, and RefreshParameters().

Here is the call graph for this function:

◆ OnTimer()

void VSTEffect::OnTimer ( )

Definition at line 1994 of file VSTEffect.cpp.

{
   wxRecursionGuard guard(mTimerGuard);
 
   // Ignore it if we're recursing
   if (guard.IsInside())
   {
      return;
   }
 
   if (mVstVersion >= 2 && mWantsIdle)
   {
      int ret = callDispatcher(effIdle, 0, 0, NULL, 0.0);
      if (!ret)
      {
         mWantsIdle = false;
      }
   }
 
   if (mWantsEditIdle)
   {
      callDispatcher(effEditIdle, 0, 0, NULL, 0.0);
   }
}

References callDispatcher(), effEditIdle, effIdle, mTimerGuard, mVstVersion, mWantsEditIdle, and mWantsIdle.

Referenced by VSTEffectTimer::Notify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnUpdateDisplay()

void VSTEffect::OnUpdateDisplay ( wxCommandEvent & evt )

private

◆ PopulateUI()

std::unique_ptr< EffectUIValidator > VSTEffect::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

Reimplemented from Effect.

Definition at line 1363 of file VSTEffect.cpp.

{
   auto parent = S.GetParent();
   mDialog = static_cast<wxDialog *>(wxGetTopLevelParent(parent));
   mParent = parent;
 
   mParent->PushEventHandler(this);
 
   // Determine if the VST editor is supposed to be used or not
   GetConfig(*this, PluginSettings::Shared, wxT("Options"),
                          wxT("UseGUI"),
                          mGui,
                          true);
   mGui = mAEffect->flags & effFlagsHasEditor ? mGui : false;
 
   // Must use the GUI editor if parameters aren't provided
   if (mAEffect->numParams == 0)
   {
      mGui = true;
   }
 
   // Build the appropriate dialog type
   if (mGui)
   {
      BuildFancy();
   }
   else
   {
      BuildPlain(access);
   }
 
   return std::make_unique<DefaultEffectUIValidator>(*this, access);
}

References BuildFancy(), BuildPlain(), effFlagsHasEditor, AEffect::flags, PluginSettings::GetConfig(), mAEffect, mDialog, mGui, mParent, AEffect::numParams, S, and PluginSettings::Shared.

Here is the call graph for this function:

◆ PowerOff()

void VSTEffect::PowerOff ( )

private

Definition at line 2065 of file VSTEffect.cpp.

{
   if (mHasPower)
   {
      // Tell the effect we're going to stop processing
      if (mVstVersion >= 2)
      {
         callDispatcher(effStopProcess, 0, 0, NULL, 0.0);
      }
 
      // Turn the power off
      callDispatcher(effMainsChanged, 0, 0, NULL, 0.0);
 
      // Set state
      mHasPower = false;
   }
}

References callDispatcher(), effMainsChanged, effStopProcess, mHasPower, and mVstVersion.

Referenced by CloseUI(), ProcessFinalize(), RealtimeSuspend(), and Unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PowerOn()

void VSTEffect::PowerOn ( )

private

Definition at line 2047 of file VSTEffect.cpp.

{
   if (!mHasPower)
   {
      // Turn the power on
      callDispatcher(effMainsChanged, 0, 1, NULL, 0.0);
 
      // Tell the effect we're going to start processing
      if (mVstVersion >= 2)
      {
         callDispatcher(effStartProcess, 0, 0, NULL, 0.0);
      }
 
      // Set state
      mHasPower = true;
   }
}

References callDispatcher(), effMainsChanged, effStartProcess, mHasPower, and mVstVersion.

Referenced by BuildFancy(), DoProcessInitialize(), and RealtimeResume().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

size_t VSTEffect::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 1075 of file VSTEffect.cpp.

{
   // Only call the effect if there's something to do...some do not like zero-length block
   if (blockLen)
   {
      // Go let the plugin moleste the samples
      callProcessReplacing(inBlock, outBlock, blockLen);
 
      // And track the position
      mTimeInfo.samplePos += (double) blockLen;
   }
 
   return blockLen;
}

References callProcessReplacing(), mTimeInfo, and VstTimeInfo::samplePos.

Here is the call graph for this function:

◆ ProcessFinalize()

bool VSTEffect::ProcessFinalize ( void )

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 1066 of file VSTEffect.cpp.

{
   mReady = false;
 
   PowerOff();
 
   return true;
}

References mReady, and PowerOff().

Here is the call graph for this function:

◆ ProcessInitialize()

bool VSTEffect::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 1034 of file VSTEffect.cpp.

{
   return DoProcessInitialize(count, names);
}

References DoProcessInitialize(), and names.

Referenced by RealtimeAddProcessor(), and RealtimeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 1106 of file VSTEffect.cpp.

{
   mSlaves.push_back(std::make_unique<VSTEffect>(mPath, this));
   VSTEffect *const slave = mSlaves.back().get();
 
   slave->SetBlockSize(mBlockSize);
   slave->SetChannelCount(numChannels);
   slave->SetSampleRate(sampleRate);
 
   int clen = 0;
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      void *chunk = NULL;
 
      clen = (int) callDispatcher(effGetChunk, 1, 0, &chunk, 0.0); // get master's chunk, for the program only
      if (clen != 0)
      {
         slave->callSetChunk(true, clen, chunk); // copy state to slave, for the program only
      }
   }
 
   if (clen == 0)
   {
      callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
 
      for (int i = 0; i < mAEffect->numParams; i++)
      {
         slave->callSetParameter(i, callGetParameter(i));
      }
 
      callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
   }
 
   return slave->ProcessInitialize(settings, 0, nullptr);
}

References callDispatcher(), callGetParameter(), callSetChunk(), callSetParameter(), effBeginSetProgram, effEndSetProgram, effFlagsProgramChunks, effGetChunk, AEffect::flags, mAEffect, mBlockSize, mPath, mSlaves, AEffect::numParams, ProcessInitialize(), SetBlockSize(), SetChannelCount(), SetSampleRate(), and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool VSTEffect::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 1143 of file VSTEffect.cpp.

{
return GuardedCall<bool>([&]{
   for (const auto &slave : mSlaves)
      slave->ProcessFinalize();
   mSlaves.clear();
 
   return ProcessFinalize();
});
}

◆ RealtimeInitialize()

bool VSTEffect::RealtimeInitialize ( EffectSettings & settings )

overridevirtual

Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 1101 of file VSTEffect.cpp.

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

References ProcessInitialize(), and settings().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t VSTEffect::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 1181 of file VSTEffect.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 VSTEffect::RealtimeProcessEnd ( EffectSettings & settings )

overridevirtualnoexcept

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 1188 of file VSTEffect.cpp.

{
   return true;
}

◆ RealtimeProcessStart()

bool VSTEffect::RealtimeProcessStart ( EffectSettings & settings )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 1176 of file VSTEffect.cpp.

{
   return true;
}

◆ RealtimeResume()

bool VSTEffect::RealtimeResume ( )

overridevirtualnoexcept

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 1164 of file VSTEffect.cpp.

{
return GuardedCall<bool>([&]{
   PowerOn();
 
   for (const auto &slave : mSlaves)
      slave->PowerOn();
 
   return true;
});
}

References mSlaves, and PowerOn().

Here is the call graph for this function:

◆ RealtimeSuspend()

bool VSTEffect::RealtimeSuspend ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 1154 of file VSTEffect.cpp.

{
   PowerOff();
 
   for (const auto &slave : mSlaves)
      slave->PowerOff();
 
   return true;
}

References mSlaves, and PowerOff().

Here is the call graph for this function:

◆ RefreshParameters()

void VSTEffect::RefreshParameters ( int skip = -1 )

private

Definition at line 2446 of file VSTEffect.cpp.

{
   if (!mNames)
   {
      return;
   }
 
   for (int i = 0; i < mAEffect->numParams; i++)
   {
      wxString text = GetString(effGetParamName, i);
 
      text = text.Trim(true).Trim(false);
 
      wxString name = text;
 
      if (text.Right(1) != wxT(':'))
      {
         text += wxT(':');
      }
      mNames[i]->SetLabel(text);
 
      // For some parameters types like on/off, setting the slider value has
      // a side effect that causes it to only move when the parameter changes
      // from off to on.  However, this prevents changing the value using the
      // keyboard, so we skip the active slider if any.
      if (i != skip)
      {
         mSliders[i]->SetValue(callGetParameter(i) * 1000);
      }
      name = text;
 
      text = GetString(effGetParamDisplay, i);
      if (text.empty())
      {
         text.Printf(wxT("%.5g"),callGetParameter(i));
      }
      mDisplays[i]->SetLabel(wxString::Format(wxT("%8s"), text));
      name += wxT(' ') + text;
 
      text = GetString(effGetParamDisplay, i);
      if (!text.empty())
      {
         text.Printf(wxT("%-8s"), GetString(effGetParamLabel, i));
         mLabels[i]->SetLabel(wxString::Format(wxT("%8s"), text));
         name += wxT(' ') + text;
      }
 
      mSliders[i]->SetName(name);
   }
}

References callGetParameter(), effGetParamDisplay, effGetParamLabel, effGetParamName, GetString(), mAEffect, mDisplays, mLabels, mNames, mSliders, name, and AEffect::numParams.

Referenced by BuildPlain(), DoLoadFactoryPreset(), DoLoadUserPreset(), ImportPresets(), and OnSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveHandler()

void VSTEffect::RemoveHandler ( )

private

Definition at line 2257 of file VSTEffect.cpp.

2258{

2259}

Referenced by CloseUI().

Here is the caller graph for this function:

◆ SaveFXB()

void VSTEffect::SaveFXB ( const wxFileName & fn ) const

private

Definition at line 2940 of file VSTEffect.cpp.

{
   // Create/Open the file
   const wxString fullPath{fn.GetFullPath()};
   wxFFile f(fullPath, wxT("wb"));
   if (!f.IsOpened())
   {
      AudacityMessageBox(
         XO("Could not open file: \"%s\"").Format( fullPath ),
         XO("Error Saving VST Presets"),
         wxOK | wxCENTRE,
         mParent);
      return;
   }
 
   wxMemoryBuffer buf;
   wxInt32 subType;
   void *chunkPtr = nullptr;
   int chunkSize = 0;
   int dataSize = 148;
   wxInt32 tab[8];
   int curProg = 0 ; //mProgram->GetCurrentSelection();
 
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      subType = CCONST('F', 'B', 'C', 'h');
 
      // read-only dispatcher function
      chunkSize = constCallDispatcher(effGetChunk, 0, 0, &chunkPtr, 0.0);
      dataSize += 4 + chunkSize;
   }
   else
   {
      subType = CCONST('F', 'x', 'B', 'k');
 
      for (int i = 0; i < mAEffect->numPrograms; i++)
      {
         SaveFXProgram(buf, i);
      }
 
      dataSize += buf.GetDataLen();
   }
 
   tab[0] = wxINT32_SWAP_ON_LE(CCONST('C', 'c', 'n', 'K'));
   tab[1] = wxINT32_SWAP_ON_LE(dataSize);
   tab[2] = wxINT32_SWAP_ON_LE(subType);
   tab[3] = wxINT32_SWAP_ON_LE(curProg >= 0 ? 2 : 1);
   tab[4] = wxINT32_SWAP_ON_LE(mAEffect->uniqueID);
   tab[5] = wxINT32_SWAP_ON_LE(mAEffect->version);
   tab[6] = wxINT32_SWAP_ON_LE(mAEffect->numPrograms);
   tab[7] = wxINT32_SWAP_ON_LE(curProg >= 0 ? curProg : 0);
 
   f.Write(tab, sizeof(tab));
   if (!f.Error())
   {
      char padding[124];
      memset(padding, 0, sizeof(padding));
      f.Write(padding, sizeof(padding));
 
      if (!f.Error())
      {
         if (mAEffect->flags & effFlagsProgramChunks)
         {
            wxInt32 size = wxINT32_SWAP_ON_LE(chunkSize);
            f.Write(&size, sizeof(size));
            f.Write(chunkPtr, chunkSize);
         }
         else
         {
            f.Write(buf.GetData(), buf.GetDataLen());
         }
      }
   }
 
   if (f.Error())
   {
      AudacityMessageBox(
         XO("Error writing to file: \"%s\"").Format( fullPath ),
         XO("Error Saving VST Presets"),
         wxOK | wxCENTRE,
         mParent);
   }
 
   f.Close();
 
   return;
}

References AudacityMessageBox(), CCONST, constCallDispatcher(), effFlagsProgramChunks, effGetChunk, AEffect::flags, fn, mAEffect, mParent, AEffect::numPrograms, SaveFXProgram(), size, AEffect::uniqueID, AEffect::version, and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveFXP()

void VSTEffect::SaveFXP ( const wxFileName & fn ) const

private

Definition at line 3028 of file VSTEffect.cpp.

{
   // Create/Open the file
   const wxString fullPath{ fn.GetFullPath() };
   wxFFile f(fullPath, wxT("wb"));
   if (!f.IsOpened())
   {
      AudacityMessageBox(
         XO("Could not open file: \"%s\"").Format( fullPath ),
         XO("Error Saving VST Presets"),
         wxOK | wxCENTRE,
         mParent);
      return;
   }
 
   wxMemoryBuffer buf;
 
   // read-only dispatcher function
   int ndx = constCallDispatcher(effGetProgram, 0, 0, NULL, 0.0);
   SaveFXProgram(buf, ndx);
 
   f.Write(buf.GetData(), buf.GetDataLen());
   if (f.Error())
   {
      AudacityMessageBox(
         XO("Error writing to file: \"%s\"").Format( fullPath ),
         XO("Error Saving VST Presets"),
         wxOK | wxCENTRE,
         mParent);
   }
 
   f.Close();
 
   return;
}

References AudacityMessageBox(), constCallDispatcher(), effGetProgram, fn, mParent, SaveFXProgram(), and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveFXProgram()

void VSTEffect::SaveFXProgram	(	wxMemoryBuffer &	buf,
		int	index
	)		const

private

Definition at line 3064 of file VSTEffect.cpp.

{
   wxInt32 subType;
   void *chunkPtr;
   int chunkSize;
   int dataSize = 48;
   char progName[28];
   wxInt32 tab[7];
 
   // read-only dispatcher function
   constCallDispatcher(effGetProgramNameIndexed, index, 0, &progName, 0.0);
   progName[27] = '\0';
   chunkSize = strlen(progName);
   memset(&progName[chunkSize], 0, sizeof(progName) - chunkSize);
 
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      subType = CCONST('F', 'P', 'C', 'h');
 
      // read-only dispatcher function
      chunkSize = constCallDispatcher(effGetChunk, 1, 0, &chunkPtr, 0.0);
      dataSize += 4 + chunkSize;
   }
   else
   {
      subType = CCONST('F', 'x', 'C', 'k');
 
      dataSize += (mAEffect->numParams << 2);
   }
 
   tab[0] = wxINT32_SWAP_ON_LE(CCONST('C', 'c', 'n', 'K'));
   tab[1] = wxINT32_SWAP_ON_LE(dataSize);
   tab[2] = wxINT32_SWAP_ON_LE(subType);
   tab[3] = wxINT32_SWAP_ON_LE(1);
   tab[4] = wxINT32_SWAP_ON_LE(mAEffect->uniqueID);
   tab[5] = wxINT32_SWAP_ON_LE(mAEffect->version);
   tab[6] = wxINT32_SWAP_ON_LE(mAEffect->numParams);
 
   buf.AppendData(tab, sizeof(tab));
   buf.AppendData(progName, sizeof(progName));
 
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      wxInt32 size = wxINT32_SWAP_ON_LE(chunkSize);
      buf.AppendData(&size, sizeof(size));
      buf.AppendData(chunkPtr, chunkSize);
   }
   else
   {
      for (int i = 0; i < mAEffect->numParams; i++)
      {
         float val = callGetParameter(i);
         wxUint32 ival = wxUINT32_SWAP_ON_LE(reinterpretAsUint32(val));
         buf.AppendData(&ival, sizeof(ival));
      }
   }
 
   return;
}

References callGetParameter(), CCONST, constCallDispatcher(), effFlagsProgramChunks, effGetChunk, effGetProgramNameIndexed, AEffect::flags, mAEffect, AEffect::numParams, reinterpretAsUint32(), size, AEffect::uniqueID, and AEffect::version.

Referenced by SaveFXB(), and SaveFXP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveParameters()

bool VSTEffect::SaveParameters	(	const RegistryPath &	group,
		const EffectSettings &	settings
	)		const

private

Definition at line 1954 of file VSTEffect.cpp.

{
   SetConfig(*this, PluginSettings::Private, group, wxT("UniqueID"),
      mAEffect->uniqueID);
   SetConfig(*this, PluginSettings::Private, group, wxT("Version"),
      mAEffect->version);
   SetConfig(*this, PluginSettings::Private, group, wxT("Elements"),
      mAEffect->numParams);
 
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      void *chunk = NULL;
      int clen = (int) constCallDispatcher(effGetChunk, 1, 0, &chunk, 0.0);
      if (clen <= 0)
      {
         return false;
      }
 
      SetConfig(*this, PluginSettings::Private, group, wxT("Chunk"),
         Base64::Encode(chunk, clen));
      return true;
   }
 
   CommandParameters eap;
   if (!SaveSettings(settings, eap))
   {
      return false;
   }
 
   wxString parms;
   if (!eap.GetParameters(parms))
   {
      return false;
   }
 
   return SetConfig(*this, PluginSettings::Private,
      group, wxT("Parameters"), parms);
}

References constCallDispatcher(), effFlagsProgramChunks, effGetChunk, Base64::Encode(), AEffect::flags, CommandParameters::GetParameters(), mAEffect, AEffect::numParams, PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), settings(), AEffect::uniqueID, and AEffect::version.

Referenced by SaveUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveSettings()

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

overridevirtual

Store settings as keys and values.

Returns: true on success

Reimplemented from Effect.

Definition at line 1249 of file VSTEffect.cpp.

{
   for (int i = 0; i < mAEffect->numParams; i++)
   {
      wxString name = GetString(effGetParamName, i);
      if (name.empty())
      {
         name.Printf(wxT("parm_%d"), i);
      }
 
      float value = callGetParameter(i);
      if (!parms.Write(name, value))
      {
         return false;
      }
   }
 
   return true;
}

References callGetParameter(), effGetParamName, TranslatableString::empty(), GetString(), mAEffect, name, and AEffect::numParams.

Referenced by SaveParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveUserPreset()

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

overridevirtual

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

Reimplemented from Effect.

Definition at line 1320 of file VSTEffect.cpp.

{
   return SaveParameters(name, settings);
}

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

Here is the call graph for this function:

◆ SaveXML()

void VSTEffect::SaveXML ( const wxFileName & fn ) const

private

Definition at line 3125 of file VSTEffect.cpp.

{
   XMLFileWriter xmlFile{ fn.GetFullPath(), XO("Error Saving Effect Presets") };
 
   xmlFile.StartTag(wxT("vstprogrampersistence"));
   xmlFile.WriteAttr(wxT("version"), wxT("2"));
 
   xmlFile.StartTag(wxT("effect"));
   // Use internal name only in persistent information
   xmlFile.WriteAttr(wxT("name"), GetSymbol().Internal());
   xmlFile.WriteAttr(wxT("uniqueID"), mAEffect->uniqueID);
   xmlFile.WriteAttr(wxT("version"), mAEffect->version);
   xmlFile.WriteAttr(wxT("numParams"), mAEffect->numParams);
 
   xmlFile.StartTag(wxT("program"));
   xmlFile.WriteAttr(wxT("name"), wxEmptyString); //mProgram->GetValue());
 
   int clen = 0;
   if (mAEffect->flags & effFlagsProgramChunks)
   {
      void *chunk = NULL;
 
      // read-only dispatcher function
      clen = (int) constCallDispatcher(effGetChunk, 1, 0, &chunk, 0.0);
      if (clen != 0)
      {
         xmlFile.StartTag(wxT("chunk"));
         xmlFile.WriteSubTree(Base64::Encode(chunk, clen) + wxT('\n'));
         xmlFile.EndTag(wxT("chunk"));
      }
   }
 
   if (clen == 0)
   {
      for (int i = 0; i < mAEffect->numParams; i++)
      {
         xmlFile.StartTag(wxT("param"));
 
         xmlFile.WriteAttr(wxT("index"), i);
         xmlFile.WriteAttr(wxT("name"),
                           GetString(effGetParamName, i));
         xmlFile.WriteAttr(wxT("value"),
                           wxString::Format(wxT("%f"),
                           callGetParameter(i)));
 
         xmlFile.EndTag(wxT("param"));
      }
   }
 
   xmlFile.EndTag(wxT("program"));
 
   xmlFile.EndTag(wxT("effect"));
 
   xmlFile.EndTag(wxT("vstprogrampersistence"));
 
   xmlFile.Commit();
}

References effFlagsProgramChunks, effGetChunk, effGetParamName, Base64::Encode(), fn, Internal, and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBlockSize()

size_t VSTEffect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Default implementation assigns mEffectBlockSize, returns it

Reimplemented from StatefulPerTrackEffect.

Definition at line 1000 of file VSTEffect.cpp.

{
   mBlockSize = std::min( maxBlockSize, mUserBlockSize );
   return mBlockSize;
}

References mBlockSize, min(), and mUserBlockSize.

Referenced by RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBufferDelay()

void VSTEffect::SetBufferDelay ( int samples )

private

Definition at line 2124 of file VSTEffect.cpp.

{
   // We do not support negative delay
   if (samples >= 0 && mUseLatency)
   {
      mBufferDelay = samples;
   }
 
   return;
}

References mBufferDelay, and mUseLatency.

Referenced by AudioMaster(), and DoProcessInitialize().

Here is the caller graph for this function:

◆ SetChannelCount()

void VSTEffect::SetChannelCount ( unsigned numChannels )

private

Definition at line 1096 of file VSTEffect.cpp.

{
   mNumChannels = numChannels;
}

References mNumChannels.

Referenced by RealtimeAddProcessor().

Here is the caller graph for this function:

◆ SetSampleRate()

void VSTEffect::SetSampleRate ( double rate )

overridevirtual

Default implementation assigns mSampleRate

Reimplemented from StatefulEffectBase.

Definition at line 1011 of file VSTEffect.cpp.

{
   mSampleRate = (float) rate;
}

References mSampleRate.

Referenced by RealtimeAddProcessor().

Here is the caller graph for this function:

◆ SetString()

void VSTEffect::SetString	(	int	opcode,
		const wxString &	str,
		int	index = `0`
	)

private

Definition at line 2158 of file VSTEffect.cpp.

{
   char buf[256];
   strcpy(buf, str.Left(255).ToUTF8());
 
   callDispatcher(opcode, index, 0, buf, 0.0);
}

References callDispatcher(), and str.

Referenced by HandleXMLTag(), and LoadFXProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowClientInterface()

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

overridevirtual

Some history...

Before we ran into the Antress plugin problem with buffer size limitations, (see below) we just had a plain old effect loop...get the input samples, pass them to the effect, save the output samples.

But, the hack I put in to limit the buffer size to only 8k (normally 512k or so) severely impacted performance. So, Michael C. added some intermediate buffering that sped things up quite a bit and this is how things have worked for quite a while. It still didn't get the performance back to the pre-hack stage, but it was a definite benefit.

History over...

I've recently (May 2014) tried newer versions of the Antress effects and they no longer seem to have a problem with buffer size. So, I've made a bit of a compromise...I've made the buffer size user configurable. Should have done this from the beginning. I've left the default 8k, just in case, but now the user can set the buffering based on their specific setup and needs.

And at the same time I added buffer delay compensation, which allows Audacity to account for latency introduced by some effects. This is based on information provided by the effect, so it will not work with all effects since they don't all provide the information (kn0ck0ut is one).

Reimplemented from Effect.

Definition at line 1219 of file VSTEffect.cpp.

{
   //   mProcessLevel = 1;      // in GUI thread
 
   // Set some defaults since some VSTs need them...these will be reset when
   // normal or realtime processing begins
   if (!IsReady())
   {
      mSampleRate = 44100;
      mBlockSize = 8192;
      // No settings here!  Is this call really needed?  It appears to be
      // redundant with later calls that reach process initialization from the
      // dialog, either with the Apply or Play buttons.
      DoProcessInitialize(0, nullptr);
   }
 
   // Remember the dialog with a weak pointer, but don't control its lifetime
   mDialog = &dialog;
   mDialog->CentreOnParent();
 
   if (SupportsRealtime() && !forceModal)
   {
      mDialog->Show();
      return 0;
   }
 
   return mDialog->ShowModal();
}

References DoProcessInitialize(), IsReady(), mBlockSize, mDialog, mSampleRate, and SupportsRealtime().

Here is the call graph for this function:

◆ ShowOptions()

void VSTEffect::ShowOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1577 of file VSTEffect.cpp.

{
   VSTEffectOptionsDialog dlg(mParent, *this);
   if (dlg.ShowModal())
   {
      // Reinitialize configuration settings
      int userBlockSize;
      GetConfig(*this, PluginSettings::Shared, wxT("Options"),
         wxT("BufferSize"), userBlockSize, 8192);
      mUserBlockSize = std::max( 1, userBlockSize );
      GetConfig(*this, PluginSettings::Shared, wxT("Options"),
         wxT("UseLatency"), mUseLatency, true);
   }
}

References PluginSettings::GetConfig(), mParent, mUseLatency, mUserBlockSize, and PluginSettings::Shared.

Here is the call graph for this function:

◆ SizeWindow()

void VSTEffect::SizeWindow	(	int	w,
		int	h
	)

private

Definition at line 2083 of file VSTEffect.cpp.

{
   // Queue the event to make the resizes smoother
   if (mParent)
   {
      wxCommandEvent sw(EVT_SIZEWINDOW);
      sw.SetInt(w);
      sw.SetExtraLong(h);
      mParent->GetEventHandler()->AddPendingEvent(sw);
   }
 
   return;
}

References mParent.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ SupportsAutomation()

bool VSTEffect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 936 of file VSTEffect.cpp.

{
   return mAutomatable;
}

References mAutomatable.

◆ SupportsRealtime()

bool VSTEffect::SupportsRealtime ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 929 of file VSTEffect.cpp.

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

Referenced by ShowClientInterface().

Here is the caller graph for this function:

◆ Unload()

void VSTEffect::Unload ( )

private

Definition at line 1854 of file VSTEffect.cpp.

{
   if (mDialog)
   {
      CloseUI();
   }
 
   if (mAEffect)
   {
      // Turn the power off
      PowerOff();
 
      // Finally, close the plugin
      callDispatcher(effClose, 0, 0, NULL, 0.0);
      mAEffect = NULL;
   }
 
   if (mModule)
   {
#if defined(__WXMAC__)
      mResource.reset();
      mBundleRef.reset();
#endif
 
      mModule.reset();
      mAEffect = NULL;
   }
}

References callDispatcher(), CloseUI(), effClose, mAEffect, mBundleRef, mDialog, mModule, mResource, PowerOff(), and VSTEffect::ResourceHandle::reset().

Referenced by Load(), and ~VSTEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateDisplay()

void VSTEffect::UpdateDisplay ( )

private

Definition at line 2097 of file VSTEffect.cpp.

{
#if 0
   // Tell the dialog to refresh effect information
   if (mParent)
   {
      wxCommandEvent ud(EVT_UPDATEDISPLAY);
      mParent->GetEventHandler()->AddPendingEvent(ud);
   }
#endif
   return;
}

References mParent.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ ValidateUI()

bool VSTEffect::ValidateUI ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 1403 of file VSTEffect.cpp.

{
   if (GetType() == EffectTypeGenerate)
      settings.extra.SetDuration(mDuration->GetValue());
 
   return true;
}

References EffectTypeGenerate, GetType(), NumericConverter::GetValue(), mDuration, and settings().

Here is the call graph for this function:

◆ wxCRIT_SECT_DECLARE_MEMBER()

VSTEffect::wxCRIT_SECT_DECLARE_MEMBER ( mDispatcherLock )

private

Friends And Related Function Documentation

◆ VSTEffectsModule

friend class VSTEffectsModule

friend

Definition at line 392 of file VSTEffect.h.

Member Data Documentation

◆ mAEffect

AEffect* VSTEffect::mAEffect

private

Definition at line 346 of file VSTEffect.h.

Referenced by BuildPlain(), callDispatcher(), callGetParameter(), callProcessReplacing(), callSetChunk(), callSetParameter(), DoProcessInitialize(), GetFactoryPresets(), HandleXMLTag(), InitializePlugin(), Load(), LoadFXB(), LoadFXProgram(), LoadParameters(), LoadSettings(), PopulateUI(), RealtimeAddProcessor(), RefreshParameters(), SaveFXB(), SaveFXProgram(), SaveParameters(), SaveSettings(), Unload(), and VSTEffect().

◆ mAudioIns

unsigned VSTEffect::mAudioIns

private

Definition at line 295 of file VSTEffect.h.

Referenced by GetAudioInCount(), GetDescription(), GetType(), Load(), and VSTEffect().

◆ mAudioOuts

unsigned VSTEffect::mAudioOuts

private

Definition at line 296 of file VSTEffect.h.

Referenced by GetAudioOutCount(), GetDescription(), GetType(), Load(), and VSTEffect().

◆ mAutomatable

bool VSTEffect::mAutomatable

private

Definition at line 299 of file VSTEffect.h.

Referenced by Load(), and SupportsAutomation().

◆ mBlockSize

unsigned VSTEffect::mBlockSize

private

Definition at line 353 of file VSTEffect.h.

Referenced by DoMakeInstance(), DoProcessInitialize(), GetBlockSize(), RealtimeAddProcessor(), RealtimeProcess(), SetBlockSize(), ShowClientInterface(), and VSTEffect().

◆ mBufferDelay

int VSTEffect::mBufferDelay

private

Definition at line 351 of file VSTEffect.h.

Referenced by GetLatency(), SetBufferDelay(), and VSTEffect().

◆ mBundleRef

BundleHandle VSTEffect::mBundleRef

private

Definition at line 320 of file VSTEffect.h.

Referenced by Load(), and Unload().

◆ mChunk

wxString VSTEffect::mChunk

private

Definition at line 386 of file VSTEffect.h.

Referenced by HandleXMLContent(), and HandleXMLEndTag().

◆ mContainer

wxSizerItem* VSTEffect::mContainer

private

Definition at line 373 of file VSTEffect.h.

Referenced by VSTEffect().

◆ mControl

VSTControl* VSTEffect::mControl

private

Definition at line 376 of file VSTEffect.h.

Referenced by BuildFancy(), CloseUI(), and OnSizeWindow().

◆ mCurrentEffectID

intptr_t VSTEffect::mCurrentEffectID

staticprivate

Definition at line 309 of file VSTEffect.h.

Referenced by Load().

◆ mDescription

wxString VSTEffect::mDescription

private

Definition at line 304 of file VSTEffect.h.

◆ mDialog

wxWeakRef<wxDialog> VSTEffect::mDialog

private

Definition at line 371 of file VSTEffect.h.

Referenced by BuildFancy(), CloseUI(), OnSizeWindow(), PopulateUI(), ShowClientInterface(), and Unload().

◆ mDisplays

ArrayOf<wxStaticText *> VSTEffect::mDisplays

private

Definition at line 381 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mDuration

NumericTextCtrl* VSTEffect::mDuration

private

Definition at line 378 of file VSTEffect.h.

Referenced by BuildPlain(), and ValidateUI().

◆ mGui

bool VSTEffect::mGui

private

Definition at line 374 of file VSTEffect.h.

Referenced by IsGraphicalUI(), PopulateUI(), and VSTEffect().

◆ mHasPower

bool VSTEffect::mHasPower

private

Definition at line 356 of file VSTEffect.h.

Referenced by PowerOff(), PowerOn(), and VSTEffect().

◆ mID

PluginID VSTEffect::mID

private

Definition at line 293 of file VSTEffect.h.

◆ mInChunk

bool VSTEffect::mInChunk

private

Definition at line 385 of file VSTEffect.h.

Referenced by HandleXMLContent(), HandleXMLEndTag(), HandleXMLTag(), and LoadXML().

◆ mInSet

bool VSTEffect::mInSet

private

Definition at line 384 of file VSTEffect.h.

Referenced by HandleXMLEndTag(), HandleXMLTag(), and LoadXML().

◆ mInteractive

bool VSTEffect::mInteractive

private

Definition at line 306 of file VSTEffect.h.

Referenced by IsInteractive(), Load(), and VSTEffect().

◆ mLabels

ArrayOf<wxStaticText *> VSTEffect::mLabels

private

Definition at line 382 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mMaster

VSTEffect* VSTEffect::mMaster

private

Definition at line 366 of file VSTEffect.h.

Referenced by Automate(), InitializePlugin(), and VSTEffect().

◆ mMidiIns

int VSTEffect::mMidiIns

private

Definition at line 297 of file VSTEffect.h.

Referenced by GetMidiInCount(), GetType(), Load(), and VSTEffect().

◆ mMidiOuts

int VSTEffect::mMidiOuts

private

Definition at line 298 of file VSTEffect.h.

Referenced by GetMidiOutCount(), GetType(), Load(), and VSTEffect().

◆ mModule

ModuleHandle VSTEffect::mModule

private

Definition at line 313 of file VSTEffect.h.

Referenced by Load(), Unload(), and VSTEffect().

◆ mName

wxString VSTEffect::mName

private

Definition at line 302 of file VSTEffect.h.

Referenced by GetSymbol(), and Load().

◆ mNames

ArrayOf<wxStaticText *> VSTEffect::mNames

private

Definition at line 379 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mNumChannels

unsigned VSTEffect::mNumChannels

private

Definition at line 368 of file VSTEffect.h.

Referenced by GetChannelCount(), and SetChannelCount().

◆ mParent

wxWindow* VSTEffect::mParent

private

Definition at line 372 of file VSTEffect.h.

Referenced by BuildFancy(), BuildPlain(), CloseUI(), ExportPresets(), HandleXMLTag(), ImportPresets(), LoadFXB(), LoadFXP(), LoadXML(), PopulateUI(), SaveFXB(), SaveFXP(), ShowOptions(), SizeWindow(), and UpdateDisplay().

◆ mPath

PluginPath VSTEffect::mPath

private

Definition at line 294 of file VSTEffect.h.

Referenced by GetPath(), Load(), and RealtimeAddProcessor().

◆ mProcessLevel

int VSTEffect::mProcessLevel

private

Definition at line 355 of file VSTEffect.h.

Referenced by GetProcessLevel(), and VSTEffect().

◆ mReady

bool VSTEffect::mReady

private

Definition at line 311 of file VSTEffect.h.

Referenced by DoProcessInitialize(), IsReady(), ProcessFinalize(), and VSTEffect().

◆ mResource

ResourceHandle VSTEffect::mResource

private

Definition at line 343 of file VSTEffect.h.

Referenced by Load(), and Unload().

◆ mSampleRate

float VSTEffect::mSampleRate

private

Definition at line 300 of file VSTEffect.h.

Referenced by BuildPlain(), DoProcessInitialize(), SetSampleRate(), ShowClientInterface(), and VSTEffect().

◆ mSlaves

VSTEffectArray VSTEffect::mSlaves

private

Definition at line 367 of file VSTEffect.h.

Referenced by Automate(), callSetChunk(), callSetParameter(), callSetProgram(), LoadSettings(), RealtimeAddProcessor(), RealtimeProcess(), RealtimeResume(), and RealtimeSuspend().

◆ mSliders

ArrayOf<wxSlider *> VSTEffect::mSliders

private

Definition at line 380 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mTimeInfo

VstTimeInfo VSTEffect::mTimeInfo

private

Definition at line 348 of file VSTEffect.h.

Referenced by DoProcessInitialize(), GetSampleRate(), GetTimeInfo(), ProcessBlock(), and VSTEffect().

◆ mTimer

std::unique_ptr<VSTEffectTimer> VSTEffect::mTimer

private

Definition at line 362 of file VSTEffect.h.

Referenced by NeedEditIdle(), NeedIdle(), and VSTEffect().

◆ mTimerGuard

int VSTEffect::mTimerGuard

private

Definition at line 363 of file VSTEffect.h.

Referenced by OnTimer(), and VSTEffect().

◆ mUseLatency

bool VSTEffect::mUseLatency

private

Definition at line 350 of file VSTEffect.h.

Referenced by DoMakeInstance(), GetLatency(), SetBufferDelay(), ShowOptions(), and VSTEffect().

◆ mUserBlockSize

size_t VSTEffect::mUserBlockSize

private

Definition at line 301 of file VSTEffect.h.

Referenced by DoMakeInstance(), SetBlockSize(), ShowOptions(), and VSTEffect().

◆ mVendor

wxString VSTEffect::mVendor

private

Definition at line 303 of file VSTEffect.h.

Referenced by GetVendor(), and Load().

◆ mVersion

int VSTEffect::mVersion

private

Definition at line 305 of file VSTEffect.h.

Referenced by GetVersion(), and Load().

◆ mVstVersion

int VSTEffect::mVstVersion

private

Definition at line 307 of file VSTEffect.h.

Referenced by callSetParameter(), GetEffectIDs(), GetFactoryPresets(), Load(), OnTimer(), PowerOff(), and PowerOn().

◆ mWantsEditIdle

bool VSTEffect::mWantsEditIdle

private

Definition at line 358 of file VSTEffect.h.

Referenced by NeedEditIdle(), OnTimer(), and VSTEffect().

◆ mWantsIdle

bool VSTEffect::mWantsIdle

private

Definition at line 357 of file VSTEffect.h.

Referenced by NeedIdle(), OnTimer(), and VSTEffect().

◆ mXMLInfo

VstPatchChunkInfo VSTEffect::mXMLInfo

private

Definition at line 388 of file VSTEffect.h.

Referenced by HandleXMLEndTag(), and HandleXMLTag().

◆ mXMLVersion

long VSTEffect::mXMLVersion

private

Definition at line 387 of file VSTEffect.h.

Referenced by HandleXMLTag().

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BundleHandle

◆ ModuleHandle

Constructor & Destructor Documentation

◆ VSTEffect()

◆ ~VSTEffect()

Member Function Documentation

◆ AudioMaster()

◆ Automate()

◆ BuildFancy()

◆ BuildPlain()

◆ BuildProgramBar()

◆ callDispatcher()

◆ callGetParameter()

◆ callProcessReplacing()

◆ callSetChunk() [1/2]

◆ callSetChunk() [2/2]

◆ callSetParameter()

◆ callSetProgram()

◆ CanExportPresets()

◆ CloseUI()

◆ constCallDispatcher()

◆ DoLoadFactoryPreset()

◆ DoLoadUserPreset()

◆ DoMakeInstance()

◆ DoProcessInitialize()

◆ ExportPresets()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetChannelCount()

◆ GetDescription()

◆ GetEffectIDs()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetLatency()

◆ GetMidiInCount()

◆ GetMidiOutCount()

◆ GetPath()

◆ GetProcessLevel()

◆ GetSampleRate()

◆ GetString() [1/2]

◆ GetString() [2/2]

◆ GetSymbol()

◆ GetTimeInfo()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HandleXMLChild()

◆ HandleXMLContent()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ HasOptions()

◆ ImportPresets()

◆ InitializePlugin()

◆ IsDefault()

◆ IsGraphicalUI()

◆ IsInteractive()

◆ IsReady()

◆ Load()

◆ LoadFactoryPreset()

◆ LoadFXB()

◆ LoadFXP()

◆ LoadFXProgram()

◆ LoadParameters()

◆ LoadSettings()

◆ LoadUserPreset()

◆ LoadXML()

◆ MakeInstance()

◆ NeedEditIdle()