#include <VSTEffect.h>

Inheritance diagram for VSTEffect:

Collaboration diagram for VSTEffect:

Public Member Functions
	VSTEffect (const PluginPath &path)

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

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

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

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

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

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

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

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

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

bool	DoLoadFactoryPreset (int id)

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

bool	InitializePlugin ()

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

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

EffectSettings	MakeSettings () const override

void	Automate (int index, float value) override

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

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

Public Member Functions inherited from VSTEffectWrapper
	VSTEffectWrapper (const PluginPath &path)

	~VSTEffectWrapper ()

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

	wxCRIT_SECT_DECLARE_MEMBER (mDispatcherLock)

float	callGetParameter (int index) const

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

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

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

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

void	ForEachParameter (ParameterVisitor visitor) const

bool	FetchSettings (VSTEffectSettings &vst3Settings) const

bool	StoreSettings (const VSTEffectSettings &vst3settings) const

VstPatchChunkInfo	GetChunkInfo () const

bool	IsCompatible (const VstPatchChunkInfo &) const

bool	LoadXML (const wxFileName &fn)

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

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

ComponentInterfaceSymbol	GetSymbol () const

void	callSetParameter (int index, float value) const

void	SaveXML (const wxFileName &fn) const

bool	LoadFXB (const wxFileName &fn)

bool	LoadFXP (const wxFileName &fn)

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

void	callSetProgram (int index)

void	SaveFXB (const wxFileName &fn) const

void	SaveFXP (const wxFileName &fn) const

void	SaveFXProgram (wxMemoryBuffer &buf, int index) const

bool	Load ()

virtual void	Unload ()=0

void	ResetModuleAndHandle ()

VstTimeInfo *	GetTimeInfo ()

float	GetSampleRate ()

int	GetProcessLevel ()

virtual void	NeedIdle ()

virtual void	UpdateDisplay ()

virtual void	SizeWindow (int w, int h)

virtual void	Automate (int index, float value)

void	SetBufferDelay (int samples)

Public Member Functions inherited from VSTEffectLink
virtual	~VSTEffectLink ()

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

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 PerTrackEffect
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

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

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

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const EffectParameterMethods &	Parameters () const

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

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

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

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

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

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

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

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

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

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

unsigned	TestUIFlags (unsigned mask)

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

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

bool	EnableApply (bool enable=true)

wxWindow *	GetUIParent ()

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

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

virtual bool	IsGraphicalUI ()=0

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

virtual bool	CanExportPresets ()=0

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

virtual void	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

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

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () const =0

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

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

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

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

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

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

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

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

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

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

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

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

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

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

virtual bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst, SettingsCopyDirection copyDirection) 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 RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsRealtime () const

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

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

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

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

virtual bool	IsHiddenFromMenus () const
	Default is false. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Public Attributes
VSTEffectSettings	mSettings

std::mutex	mSettingsMutex

Public Attributes inherited from VSTEffectWrapper
AEffect *	mAEffect = nullptr

int	mVstVersion

wxString	mName

bool	mInSet

bool	mInChunk

wxString	mChunk

long	mXMLVersion

VstPatchChunkInfo	mXMLInfo

intptr_t	mCurrentEffectID {}

PluginPath	mPath

ModuleHandle	mModule {}

wxString	mVendor

wxString	mDescription

int	mVersion

bool	mInteractive { false }

unsigned	mAudioIns { 0 }

unsigned	mAudioOuts { 0 }

int	mMidiIns { 0 }

int	mMidiOuts { 0 }

bool	mAutomatable

BundleHandle	mBundleRef

ResourceHandle	mResource

VstTimeInfo	mTimeInfo

int	mBufferDelay { 0 }

int	mProcessLevel { 1 }

bool	mUseLatency { true }

Protected Member Functions
void	NeedIdle () override
	This is what GetSettings will be when the effect becomes really stateless. More...

void	UpdateDisplay () override

void	SizeWindow (int w, int h) override

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

Private Member Functions
void	Unload () override

std::vector< int >	GetEffectIDs ()

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

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

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 (EffectInstance &instance)

wxSizer *	BuildProgramBar ()

void	RefreshParameters (int skip=-1) const

void	NeedEditIdle (bool state)

Private Attributes
VSTEffectValidator *	mValidator {}

PluginID	mID

bool	mWantsEditIdle {false}

bool	mWantsIdle { false }

int	mTimerGuard {0}

std::unique_ptr< VSTEffectTimer >	mTimer

wxWeakRef< wxDialog >	mDialog

wxWindow *	mParent

wxSizerItem *	mContainer {}

bool	mGui {false}

VSTControl *	mControl

NumericTextCtrl *	mDuration

ArrayOf< wxStaticText * >	mNames

ArrayOf< wxSlider * >	mSliders

ArrayOf< wxStaticText * >	mDisplays

ArrayOf< wxStaticText * >	mLabels

bool	mInitialFetchDone { false }

Friends
class	VSTEffectsModule

Additional Inherited Members
Public Types inherited from VSTEffectWrapper
using	ParameterVisitor = std::function< bool(const ParameterInfo &pi) >

using	ModuleHandle = std::unique_ptr< wxDynamicLibrary >

using	BundleHandle = CF_ptr< CFBundleRef >

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

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

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

Static Public Member Functions inherited from VSTEffectWrapper
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...

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 Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

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

wxWindow *	mUIParent {}

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

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

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

Definition at line 309 of file VSTEffect.h.

Constructor & Destructor Documentation

◆ VSTEffect()

VSTEffect::VSTEffect ( const PluginPath & path )

Definition at line 789 of file VSTEffect.cpp.

:  VSTEffectWrapper(path)
{
   mTimer = std::make_unique<VSTEffectTimer>(this);
 
   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;
}

References VstTimeInfo::flags, kVstNanosValid, kVstTempoValid, VSTEffectWrapper::mTimeInfo, mTimer, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

◆ ~VSTEffect()

VSTEffect::~VSTEffect ( )

virtual

Definition at line 804 of file VSTEffect.cpp.

{
   Unload();
}

References Unload().

Here is the call graph for this function:

Member Function Documentation

◆ Automate()

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

overridevirtual

Reimplemented from VSTEffectWrapper.

Definition at line 3592 of file VSTEffect.cpp.

{
   callSetParameter(index, value);
 
   // Because we come here when a control on the effect's GUI is moved,
   // we must update the temporary Effect-owned settings - users might
   // want to hear what happens when they move a knob.
   //
   {
      // we need a mutex because FetchSettings writes mSettings in the main
      // thread, but the storing of the settings passed to ::RealtimeProcess
      // happens in the worker thread
      auto guard = std::lock_guard{ mSettingsMutex };
      FetchSettings(mSettings);
   }
}

References VSTEffectWrapper::callSetParameter(), VSTEffectWrapper::FetchSettings(), mSettings, and mSettingsMutex.

Here is the call graph for this function:

◆ BuildFancy()

void VSTEffect::BuildFancy ( EffectInstance & instance )

private

Definition at line 2225 of file VSTEffect.cpp.

{
   auto& vstEffInstance = dynamic_cast<VSTEffectInstance&>(instance);
 
   // Turn the power on...some effects need this when the editor is open
   vstEffInstance.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(), VSTEffectInstance::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 2265 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(),
                  mProjectRate,
                  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(), VSTEffectWrapper::GetString(), GetType(), ID_Duration, ID_Sliders, VSTEffectWrapper::mAEffect, mDisplays, mDuration, mLabels, mNames, mParent, EffectBase::mProjectRate, mSliders, AEffect::numParams, RefreshParameters(), ArrayOf< X >::reinit(), safenew, NumericTextCtrl::SetName(), NumericConverter::TIME, wxT(), 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

◆ CanExportPresets()

bool VSTEffect::CanExportPresets ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1361 of file VSTEffect.cpp.

{
   return true;
}

◆ CloseUI()

bool VSTEffect::CloseUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1334 of file VSTEffect.cpp.

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

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

Referenced by Unload().

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

{
   callSetProgram(id);
 
   return true;
}

References VSTEffectWrapper::callSetProgram().

Referenced by LoadFactoryPreset().

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

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

References PluginSettings::GetConfig(), VSTEffectWrapper::mPath, VSTEffectWrapper::mUseLatency, PluginSettings::Shared, and wxT().

Referenced by MakeInstance().

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 1367 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;
   }
 
   if ( ! StoreSettings(GetSettings(settings)) )
      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, GetSettings(), mParent, VSTEffectWrapper::SaveFXB(), VSTEffectWrapper::SaveFXP(), VSTEffectWrapper::SaveXML(), SelectFile(), settings(), VSTEffectWrapper::StoreSettings(), wxT(), and XO.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString VSTEffect::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 847 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 VSTEffectWrapper::mAudioIns, VSTEffectWrapper::mAudioOuts, and XO.

◆ GetEffectIDs()

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

private

Definition at line 1823 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 VSTEffectWrapper::callDispatcher(), effGetPlugCategory, effShellGetNextPlugin, kPlugCategShell, VSTEffectWrapper::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 1243 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, VSTEffectWrapper::GetString(), VSTEffectWrapper::mAEffect, VSTEffectWrapper::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 880 of file VSTEffect.cpp.

{
   return VSTPLUGINTYPE;
}

References VSTPLUGINTYPE.

◆ GetPath()

PluginPath VSTEffect::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 813 of file VSTEffect.cpp.

{
   return mPath;
}

References VSTEffectWrapper::mPath.

◆ GetSettings() [1/2]

const VSTEffectSettings & VSTEffect::GetSettings ( const EffectSettings & ) const

inline

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

Definition at line 395 of file VSTEffect.h.

   {
      return mSettings;
   }

References mSettings.

◆ GetSettings() [2/2]

VSTEffectSettings & VSTEffect::GetSettings ( EffectSettings & ) const

inline

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

Definition at line 389 of file VSTEffect.h.

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

References mSettings.

Referenced by ExportPresets(), VSTEffectInstance::GetSettings(), ImportPresets(), LoadFactoryPreset(), LoadParameters(), LoadSettings(), MakeSettings(), SaveParameters(), SaveSettings(), TransferDataToWindow(), and ValidateUI().

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol VSTEffect::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 818 of file VSTEffect.cpp.

{
   return VSTEffectWrapper::GetSymbol();
}

References VSTEffectWrapper::GetSymbol().

Here is the call graph for this function:

◆ GetType()

EffectType VSTEffect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 859 of file VSTEffect.cpp.

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

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, VSTEffectWrapper::mAudioIns, and VSTEffectWrapper::mAudioOuts.

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

{
   return { mVendor };
}

References VSTEffectWrapper::mVendor.

◆ GetVersion()

wxString VSTEffect::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 828 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 VSTEffectWrapper::mVersion, and wxT().

Here is the call graph for this function:

◆ HasOptions()

bool VSTEffect::HasOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1497 of file VSTEffect.cpp.

{
   return true;
}

◆ ImportPresets()

void VSTEffect::ImportPresets ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 1430 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;
   }
 
   FetchSettings(GetSettings(settings));
 
   return;
}

References AudacityMessageBox(), VSTEffectWrapper::FetchSettings(), fn, GetSettings(), VSTEffectWrapper::LoadFXB(), VSTEffectWrapper::LoadFXP(), VSTEffectWrapper::LoadXML(), mParent, SelectFile(), settings(), wxT(), and XO.

Here is the call graph for this function:

◆ InitializePlugin()

bool VSTEffect::InitializePlugin ( )

Definition at line 909 of file VSTEffect.cpp.

{
   if (!mAEffect)
   {
      Load();
   }
 
   if (!mAEffect)
   {
      return false;
   }
 
   return true;
}

References VSTEffectWrapper::Load(), and VSTEffectWrapper::mAEffect.

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

{
   return false;
}

◆ IsGraphicalUI()

bool VSTEffect::IsGraphicalUI ( )

overridevirtual

Returns: false

Reimplemented from Effect.

Definition at line 1319 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 885 of file VSTEffect.cpp.

{
   return mInteractive;
}

References VSTEffectWrapper::mInteractive.

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

{
   // To do: externalize state so const_cast isn't needed
   bool loadOK = const_cast<VSTEffect*>(this)->DoLoadFactoryPreset(id);
 
   if (loadOK)
      FetchSettings(GetSettings(settings));
 
   return loadOK;
}

References DoLoadFactoryPreset(), VSTEffectWrapper::FetchSettings(), GetSettings(), and settings().

Here is the call graph for this function:

◆ LoadParameters()

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

private

Definition at line 1858 of file VSTEffect.cpp.

{
   wxString value;
 
   auto info = GetChunkInfo();
 
   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 ( ! IsCompatible(info) )
   {
      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);
         FetchSettings(GetSettings(settings));
      }
 
      return true;
   }
 
   wxString parms;
   if (!GetConfig(*this,
      PluginSettings::Private, group, wxT("Parameters"), parms, wxEmptyString))
   {
      return false;
   }
 
   CommandParameters eap;
   if (!eap.SetParameters(parms))
   {
      return false;
   }
 
   const bool loadOK = LoadSettings(eap, settings);
 
   if (loadOK)
     FetchSettings(GetSettings(settings));
 
   return loadOK;
}

References VSTEffectWrapper::callSetChunk(), Base64::Decode(), VSTEffectWrapper::FetchSettings(), VSTEffectWrapper::GetChunkInfo(), PluginSettings::GetConfig(), GetSettings(), VSTEffectWrapper::IsCompatible(), LoadSettings(), PluginSettings::Private, CommandParameters::SetParameters(), settings(), and wxT().

Referenced by LoadUserPreset().

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

{
   VSTEffectSettings& vstSettings = GetSettings(settings);
   vstSettings.mParamsMap.clear();
 
   long index{};
   wxString key;
   float value = 0.0f;
   if (parms.GetFirstEntry(key, index))
   {
      do
      {
         if (parms.Read(key, value))
            vstSettings.mParamsMap[key] = value;
         else
            return false;
 
      } while (parms.GetNextEntry(key, index));
   }
 
   vstSettings.mChunk     = std::nullopt;
   vstSettings.mVersion   = VSTEffectWrapper::mVstVersion;
   vstSettings.mUniqueID  = VSTEffectWrapper::mAEffect->uniqueID;
   vstSettings.mNumParams = VSTEffectWrapper::mAEffect->numParams;
 
   return true;
}

References GetSettings(), key, VSTEffectWrapper::mAEffect, VSTEffectSettings::mChunk, VSTEffectSettings::mNumParams, VSTEffectSettings::mParamsMap, VSTEffectSettings::mUniqueID, VSTEffectSettings::mVersion, VSTEffectWrapper::mVstVersion, AEffect::numParams, settings(), and AEffect::uniqueID.

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

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

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

Here is the call 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

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

Implements EffectInstanceFactory.

Definition at line 924 of file VSTEffect.cpp.

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

References DoMakeInstance().

Here is the call graph for this function:

◆ MakeSettings()

EffectSettings VSTEffect::MakeSettings ( ) const

overridevirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 3543 of file VSTEffect.cpp.

{
   auto result = PerTrackEffect::MakeSettings();
   // Cause initial population of the map stored in the stateful effect
   if (!mInitialFetchDone) {
      FetchSettings(GetSettings(result));
      mInitialFetchDone = true;
   }
   return result;
}

References VSTEffectWrapper::FetchSettings(), GetSettings(), EffectSettingsManager::MakeSettings(), and mInitialFetchDone.

Here is the call graph for this function:

◆ NeedEditIdle()

void VSTEffect::NeedEditIdle ( bool state )

private

Definition at line 1987 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 ( )

overrideprotectedvirtual

This is what GetSettings will be when the effect becomes really stateless.

Reimplemented from VSTEffectWrapper.

Definition at line 1981 of file VSTEffect.cpp.

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

References mTimer, and mWantsIdle.

◆ 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 2445 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 2467 of file VSTEffect.cpp.

{
   wxSlider *s = (wxSlider *) evt.GetEventObject();
   int i = s->GetId() - ID_Sliders;
 
   // The plain GUI works (destructive or realtime) even without this call
   // 
   //if (mValidator)
   //   mValidator->GetInstance().callSetParameter(i, s->GetValue() / 1000.0);
 
   // This, along with the call to FetchSettings below, is needed in order
   // to have the plain GUI work properly when realtime processing
   callSetParameter(i, s->GetValue() / 1000.0);
 
   {
      // Same comments found in VSTInstanceBase::Automate apply here
      auto guard = std::lock_guard{ mSettingsMutex };
      FetchSettings(mSettings);
   }   
 
   RefreshParameters(i);
}

References VSTEffectWrapper::callSetParameter(), VSTEffectWrapper::FetchSettings(), ID_Sliders, mSettings, mSettingsMutex, and RefreshParameters().

Here is the call graph for this function:

◆ OnTimer()

void VSTEffect::OnTimer ( )

Definition at line 1956 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 VSTEffectWrapper::callDispatcher(), effEditIdle, effIdle, mTimerGuard, VSTEffectWrapper::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 1283 of file VSTEffect.cpp.

{
   auto parent = S.GetParent();
   mDialog = static_cast<wxDialog *>(wxGetTopLevelParent(parent));
   mParent = parent;
 
   // 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(instance);
   }
   else
   {
      BuildPlain(access);
   }
 
   auto pParent = S.GetParent();
   pParent->PushEventHandler(this);
 
   return std::make_unique<VSTEffectValidator>(dynamic_cast<VSTEffectInstance&>(instance), *this, access, pParent);
}

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

Here is the call graph for this function:

◆ RealtimeSupport()

auto VSTEffect::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 895 of file VSTEffect.cpp.

{
   // TODO reenable after achieving statelessness
   return RealtimeSince::Never;
   /* return GetType() == EffectTypeProcess
      ? RealtimeSince::Always
      : RealtimeSince::Never; */
}

References EffectDefinitionInterface::Never.

◆ RefreshParameters()

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

private

Definition at line 2394 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 VSTEffectWrapper::callGetParameter(), effGetParamDisplay, effGetParamLabel, effGetParamName, VSTEffectWrapper::GetString(), VSTEffectWrapper::mAEffect, mDisplays, mLabels, mNames, mSliders, name, AEffect::numParams, and wxT().

Referenced by BuildPlain(), OnSlider(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveHandler()

void VSTEffect::RemoveHandler ( )

private

Definition at line 2203 of file VSTEffect.cpp.

2204{

2205}

Referenced by CloseUI().

Here is the caller graph for this function:

◆ SaveParameters()

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

private

Definition at line 1914 of file VSTEffect.cpp.

{
   const auto& vstSettings = GetSettings(settings);
 
   if ( ! StoreSettings(vstSettings) )
      return false;
 
   SetConfig(*this, PluginSettings::Private, group, wxT("UniqueID"), vstSettings.mUniqueID );
   SetConfig(*this, PluginSettings::Private, group, wxT("Version"),  vstSettings.mVersion  );
   SetConfig(*this, PluginSettings::Private, group, wxT("Elements"), vstSettings.mNumParams);
 
   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 VSTEffectWrapper::constCallDispatcher(), effFlagsProgramChunks, effGetChunk, Base64::Encode(), AEffect::flags, CommandParameters::GetParameters(), GetSettings(), VSTEffectWrapper::mAEffect, PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), settings(), VSTEffectWrapper::StoreSettings(), and wxT().

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.

The override may assume parms is initially empty

Returns: true on success

Reimplemented from Effect.

Definition at line 1177 of file VSTEffect.cpp.

{
   const VSTEffectSettings& vstSettings = GetSettings(settings);
 
   for (const auto& item : vstSettings.mParamsMap)
   {
      const auto& name  = item.first;
      const auto& value = item.second;
 
      if (!parms.Write(name, value))
      {
         return false;
      }
   }
 
   return true;
}

References GetSettings(), VSTEffectSettings::mParamsMap, name, and settings().

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

{
   return SaveParameters(name, settings);
}

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

Here is the call graph for this function:

◆ ShowClientInterface()

int VSTEffect::ShowClientInterface	(	wxWindow &	parent,
		wxDialog &	dialog,
		EffectUIValidator *	validator,
		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 1146 of file VSTEffect.cpp.

{
   //   mProcessLevel = 1;      // in GUI thread
 
   VSTEffectValidator* vstValidator = static_cast<VSTEffectValidator*>(validator);
   mValidator = vstValidator;
 
   if (! vstValidator->GetInstance().IsReady() )
   {
      // Set some defaults since some VSTs need them...these will be reset when
      // normal or realtime processing begins
      vstValidator->GetInstance().mBlockSize = 8192;
      vstValidator->GetInstance().DoProcessInitialize(mProjectRate);
   }
 
   // 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 VSTEffectInstance::DoProcessInitialize(), VSTEffectValidator::GetInstance(), VSTEffectInstance::IsReady(), VSTEffectInstance::mBlockSize, mDialog, EffectBase::mProjectRate, mValidator, and EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

◆ ShowOptions()

void VSTEffect::ShowOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1502 of file VSTEffect.cpp.

{
   VSTEffectOptionsDialog dlg(mParent, *this);
   if (dlg.ShowModal())
   {
      // Reinitialize configuration settings
      
      GetConfig(*this, PluginSettings::Shared, wxT("Options"),
         wxT("UseLatency"), mUseLatency, true);
   }
}

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

Here is the call graph for this function:

◆ SizeWindow()

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

overrideprotectedvirtual

Reimplemented from VSTEffectWrapper.

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

◆ SupportsAutomation()

bool VSTEffect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 904 of file VSTEffect.cpp.

{
   return mAutomatable;
}

References VSTEffectWrapper::mAutomatable.

◆ TransferDataToWindow()

bool VSTEffect::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings.

Reimplemented from Effect.

Definition at line 3528 of file VSTEffect.cpp.

{
   if (!StoreSettings(GetSettings(settings)))
      return false;
 
   RefreshParameters();
 
   return true;
}

References GetSettings(), RefreshParameters(), settings(), and VSTEffectWrapper::StoreSettings().

Here is the call graph for this function:

◆ Unload()

void VSTEffect::Unload ( )

overrideprivatevirtual

Implements VSTEffectWrapper.

Definition at line 1774 of file VSTEffect.cpp.

{
   if (mDialog)
   {
      CloseUI();
   }
 
   if (mAEffect)
   {
      // Finally, close the plugin
      callDispatcher(effClose, 0, 0, NULL, 0.0);
      mAEffect = NULL;
   }
 
   //ResetModuleAndHandle();
}

References VSTEffectWrapper::callDispatcher(), CloseUI(), effClose, VSTEffectWrapper::mAEffect, and mDialog.

Referenced by ~VSTEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateDisplay()

void VSTEffect::UpdateDisplay ( )

overrideprotectedvirtual

Reimplemented from VSTEffectWrapper.

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

◆ ValidateUI()

bool VSTEffect::ValidateUI ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 1324 of file VSTEffect.cpp.

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

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ VSTEffectsModule

friend class VSTEffectsModule

friend

Definition at line 481 of file VSTEffect.h.

Member Data Documentation

◆ mContainer

wxSizerItem* VSTEffect::mContainer {}

private

Definition at line 467 of file VSTEffect.h.

◆ mControl

VSTControl* VSTEffect::mControl

private

Definition at line 470 of file VSTEffect.h.

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

◆ mDialog

wxWeakRef<wxDialog> VSTEffect::mDialog

private

Definition at line 465 of file VSTEffect.h.

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

◆ mDisplays

ArrayOf<wxStaticText *> VSTEffect::mDisplays

private

Definition at line 475 of file VSTEffect.h.

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

◆ mDuration

NumericTextCtrl* VSTEffect::mDuration

private

Definition at line 472 of file VSTEffect.h.

Referenced by BuildPlain(), and ValidateUI().

◆ mGui

bool VSTEffect::mGui {false}

private

Definition at line 468 of file VSTEffect.h.

Referenced by IsGraphicalUI(), and PopulateUI().

◆ mID

PluginID VSTEffect::mID

private

Definition at line 455 of file VSTEffect.h.

◆ mInitialFetchDone

bool VSTEffect::mInitialFetchDone { false }

mutableprivate

Definition at line 483 of file VSTEffect.h.

Referenced by MakeSettings().

◆ mLabels

ArrayOf<wxStaticText *> VSTEffect::mLabels

private

Definition at line 476 of file VSTEffect.h.

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

◆ mNames

ArrayOf<wxStaticText *> VSTEffect::mNames

private

Definition at line 473 of file VSTEffect.h.

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

◆ mParent

wxWindow* VSTEffect::mParent

private

Definition at line 466 of file VSTEffect.h.

Referenced by BuildFancy(), BuildPlain(), CloseUI(), ExportPresets(), ImportPresets(), PopulateUI(), ShowOptions(), SizeWindow(), and UpdateDisplay().

◆ mSettings

VSTEffectSettings VSTEffect::mSettings

Definition at line 384 of file VSTEffect.h.

Referenced by Automate(), GetSettings(), and OnSlider().

◆ mSettingsMutex

std::mutex VSTEffect::mSettingsMutex

Definition at line 385 of file VSTEffect.h.

Referenced by Automate(), OnSlider(), and VSTEffectInstance::RealtimeProcessStart().

◆ mSliders

ArrayOf<wxSlider *> VSTEffect::mSliders

private

Definition at line 474 of file VSTEffect.h.

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

◆ mTimer

std::unique_ptr<VSTEffectTimer> VSTEffect::mTimer

private

Definition at line 461 of file VSTEffect.h.

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

◆ mTimerGuard

int VSTEffect::mTimerGuard {0}

private

Definition at line 460 of file VSTEffect.h.

Referenced by OnTimer().

◆ mValidator

VSTEffectValidator* VSTEffect::mValidator {}

private

Definition at line 417 of file VSTEffect.h.

Referenced by CloseUI(), and ShowClientInterface().

◆ mWantsEditIdle

bool VSTEffect::mWantsEditIdle {false}

private

Definition at line 457 of file VSTEffect.h.

Referenced by NeedEditIdle(), and OnTimer().

◆ mWantsIdle

bool VSTEffect::mWantsIdle { false }

private

Definition at line 458 of file VSTEffect.h.

Referenced by NeedIdle(), and OnTimer().

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VSTEffect()

◆ ~VSTEffect()

Member Function Documentation

◆ Automate()

◆ BuildFancy()

◆ BuildPlain()

◆ BuildProgramBar()

◆ CanExportPresets()

◆ CloseUI()

◆ DoLoadFactoryPreset()

◆ DoMakeInstance()

◆ ExportPresets()

◆ GetDescription()

◆ GetEffectIDs()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetPath()

◆ GetSettings() [1/2]

◆ GetSettings() [2/2]

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ ImportPresets()

◆ InitializePlugin()

◆ IsDefault()

◆ IsGraphicalUI()

◆ IsInteractive()

◆ LoadFactoryPreset()

◆ LoadParameters()

◆ LoadSettings()

◆ LoadUserPreset()

◆ MakeInstance()

◆ MakeSettings()

◆ NeedEditIdle()

◆ NeedIdle()

◆ OnLoad()

◆ OnProgram()

◆ OnProgramText()

◆ OnSave()

◆ OnSettings()

◆ OnSizeWindow()

◆ OnSlider()

◆ OnTimer()

◆ OnUpdateDisplay()

◆ PopulateUI()

◆ RealtimeSupport()

◆ RefreshParameters()

◆ RemoveHandler()

◆ SaveParameters()

◆ SaveSettings()

◆ SaveUserPreset()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SizeWindow()

◆ SupportsAutomation()

◆ TransferDataToWindow()

◆ Unload()

◆ UpdateDisplay()

◆ ValidateUI()

Friends And Related Function Documentation

◆ VSTEffectsModule

Member Data Documentation

◆ mContainer

◆ mControl

◆ mDialog

◆ mDisplays

◆ mDuration

◆ mGui

◆ mID