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

OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override

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

OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override

bool	DoLoadFactoryPreset (int id)

int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const 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< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Adds controls to a panel that is given as the parent window of `S` More...

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

OptionalMessage	ImportPresetsNC (EffectSettings &settings)

bool	HasOptions () const override

void	ShowOptions (const EffectPlugin &plugin) const override

EffectSettings	MakeSettings () const override

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

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, bool doFetch=true) 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 ()

void	Unload ()

void	ResetModuleAndHandle ()

VstTimeInfo *	GetTimeInfo ()

float	GetSampleRate ()

int	GetProcessLevel ()

virtual void	UpdateDisplay ()

virtual void	SetBufferDelay (int samples)

std::unique_ptr< EffectInstance::Message >	MakeMessageFS (const VSTEffectSettings &settings) const

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 VSTEffectUIWrapper
virtual void	NeedIdle ()

virtual void	SizeWindow (int w, int h)

virtual void	Automate (int index, float value)

virtual void	Flush ()

Public Member Functions inherited from StatelessPerTrackEffect
	~StatelessPerTrackEffect () override

Public Member Functions inherited from PerTrackEffect
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

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

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

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

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

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

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

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

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

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

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

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

OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override

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

OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

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

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

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

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

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

void	SetTracks (TrackList *pTracks)

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

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

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

virtual bool	CanExportPresets () const =0
	Whether the effect supports export of presets to files, and importing too. More...

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
	Calculate temporary tracks of limited length with effect applied and play. More...

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

virtual OptionalMessage	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, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0

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) const
	Update one settings object from another. More...

virtual std::unique_ptr< EffectOutputs >	MakeOutputs () const
	Produce an object to hold values to send to effect output meters. 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

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

virtual std::unique_ptr< EffectEditor >	MakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Called only from PopulateUI, to add controls to effect panel. More...

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

virtual int	ShowHostInterface (EffectPlugin &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

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

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

Protected Member Functions
virtual std::unique_ptr< EffectEditor >	MakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const final
	Will never be called. More...

void	UpdateDisplay () 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	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...

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)

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

Protected Member Functions inherited from EffectBase
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
	Calculate temporary tracks of limited length with effect applied and play. 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
std::vector< int >	GetEffectIDs ()

void	OnUpdateDisplay (wxCommandEvent &evt)

void	OnProgram (wxCommandEvent &evt)

void	OnProgramText (wxCommandEvent &evt)

void	OnLoad (wxCommandEvent &evt)

void	OnSave (wxCommandEvent &evt)

void	OnSettings (wxCommandEvent &evt)

wxSizer *	BuildProgramBar ()

Private Attributes
PluginID	mID

wxSizerItem *	mContainer {}

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 EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

using	InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >

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

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

Static Public Member Functions inherited from VSTEffectWrapper
static VSTEffectSettings &	GetSettings (EffectSettings &settings)

static const VSTEffectSettings &	GetSettings (const EffectSettings &settings)

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 Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Public Attributes inherited from VSTEffectWrapper
AEffect *	mAEffect = nullptr

std::thread::id	mMainThreadId

std::recursive_mutex	mDispatcherLock

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	mGui { false }

Public Attributes inherited from EffectBase
TrackList *	mTracks {}

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 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 335 of file VSTEffect.h.

Constructor & Destructor Documentation

◆ VSTEffect()

VSTEffect::VSTEffect ( const PluginPath & path )

Definition at line 786 of file VSTEffect.cpp.

:  VSTEffectWrapper(path)
{
   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, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

◆ ~VSTEffect()

VSTEffect::~VSTEffect ( )

virtual

Definition at line 799 of file VSTEffect.cpp.

800{

801}

Member Function Documentation

◆ BuildProgramBar()

wxSizer * VSTEffect::BuildProgramBar ( )

private

◆ CanExportPresets()

bool VSTEffect::CanExportPresets ( ) const

overridevirtual

Whether the effect supports export of presets to files, and importing too.

Implements EffectPlugin.

Definition at line 1603 of file VSTEffect.cpp.

{
   return true;
}

◆ DoLoadFactoryPreset()

bool VSTEffect::DoLoadFactoryPreset ( int id )

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

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

References PluginSettings::GetConfig(), VSTEffectWrapper::mPath, 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 EffectPlugin &	plugin,
		const EffectSettings &	settings
	)		const

overridevirtual

Reimplemented from BasicEffectUIServices.

Definition at line 1609 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,
         nullptr);
 
      return;
   }
}

References AudacityMessageBox(), fn, VSTEffectWrapper::GetSettings(), 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

Implements ComponentInterface.

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

Here is the call graph for this function:

◆ GetEffectIDs()

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

private

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

Implements EffectSettingsManager.

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

Implements EffectDefinitionInterface.

Definition at line 874 of file VSTEffect.cpp.

{
   return VSTPLUGINTYPE;
}

References VSTPLUGINTYPE.

◆ GetPath()

PluginPath VSTEffect::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 807 of file VSTEffect.cpp.

{
   return mPath;
}

References VSTEffectWrapper::mPath.

◆ GetSymbol()

ComponentInterfaceSymbol VSTEffect::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

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

Implements EffectDefinitionInterface.

Definition at line 853 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 PopulateUI().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VSTEffect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 817 of file VSTEffect.cpp.

{
   return { mVendor };
}

References VSTEffectWrapper::mVendor.

◆ GetVersion()

wxString VSTEffect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

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

overridevirtual

Whether there are preferences applying to the effect's family, for which a UI may be needed to change them

Implements EffectPlugin.

Definition at line 1751 of file VSTEffect.cpp.

{
   return true;
}

◆ ImportPresets()

OptionalMessage VSTEffect::ImportPresets	(	const EffectPlugin &	plugin,
		EffectSettings &	settings
	)		const

overridevirtual

Returns: nullopt for failure

Reimplemented from BasicEffectUIServices.

Definition at line 1673 of file VSTEffect.cpp.

{
   auto temp = std::make_unique<VSTEffect>(this->mPath);
   if (!temp->InitializePlugin())
      return {};
   return temp->ImportPresetsNC(settings);
}

References VSTEffectWrapper::mPath, and settings().

Here is the call graph for this function:

◆ ImportPresetsNC()

OptionalMessage VSTEffect::ImportPresetsNC ( EffectSettings & settings )

Definition at line 1682 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,
      nullptr);
 
   // 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,
         nullptr);
 
      return {};
   }
 
   if (!success)
   {
      AudacityMessageBox(
         XO("Unable to load presets file."),
         XO("Error Loading VST Presets"),
         wxOK | wxCENTRE,
         nullptr);
 
      return {};
   }
 
   if (!FetchSettings(GetSettings(settings)))
      return {};
 
   return MakeMessageFS(
      VSTEffectInstance::GetSettings(settings));
}

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

Here is the call graph for this function:

◆ InitializePlugin()

bool VSTEffect::InitializePlugin ( )

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

Implements EffectDefinitionInterface.

Definition at line 884 of file VSTEffect.cpp.

{
   return false;
}

◆ IsInteractive()

bool VSTEffect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 879 of file VSTEffect.cpp.

{
   return mInteractive;
}

References VSTEffectWrapper::mInteractive.

◆ LoadFactoryPreset()

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

overridevirtual

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

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 1534 of file VSTEffect.cpp.

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

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

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

Implements EffectSettingsManager.

Definition at line 1477 of file VSTEffect.cpp.

{
   VSTEffectSettings& vstSettings = GetSettings(settings);
 
   long index{};
   wxString key;
   double value = 0.0;
   if (parms.GetFirstEntry(key, index))
   {
      do
      {
         if (parms.Read(key, &value)) {
            auto &map = vstSettings.mParamsMap;
            auto iter = map.find(key);
            if (iter != map.end()) {
               if (iter->second)
                  // Should be guaranteed by MakeSettings
                  iter->second = value;
               else {
                  assert(false);
               }
            }
            else
               // Unknown parameter name in the file
               return false;
         }
      } while (parms.GetNextEntry(key, index));
   }
 
   // Loads key-value pairs only from a config file -- no chunk
   vstSettings.mChunk.resize(0);
   vstSettings.mVersion   = VSTEffectWrapper::mVersion;
   vstSettings.mUniqueID  = VSTEffectWrapper::mAEffect->uniqueID;
   vstSettings.mNumParams = VSTEffectWrapper::mAEffect->numParams;
 
   return true;
}

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

Referenced by LoadUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

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

overridevirtual

Change settings to a user-named preset

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 2100 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 {};
   }
 
   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);
         if (!FetchSettings(GetSettings(settings)))
            return {};
      }
 
      return MakeMessageFS(
         VSTEffectInstance::GetSettings(settings));
   }
 
   wxString parms;
   if (!GetConfig(*this,
      PluginSettings::Private, group, wxT("Parameters"), parms, wxEmptyString))
   {
      return {};
   }
 
   CommandParameters eap;
   if (!eap.SetParameters(parms))
   {
      return {};
   }
 
   const bool loadOK = LoadSettings(eap, settings) &&
      FetchSettings(GetSettings(settings));
   if (!loadOK)
      return {};
 
   return MakeMessageFS(
      VSTEffectInstance::GetSettings(settings));
}

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

Here is the call graph for this function:

◆ MakeEditor()

std::unique_ptr< EffectEditor > VSTEffect::MakeEditor	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)		const

finalprotectedvirtual

Will never be called.

Will not come here because Effect::PopulateUI is overridden

Implements StatelessEffectUIServices.

Definition at line 1594 of file VSTEffect.cpp.

{
   assert(false);
   return nullptr;
}

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

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

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

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

◆ OnUpdateDisplay()

void VSTEffect::OnUpdateDisplay ( wxCommandEvent & evt )

private

◆ PopulateUI()

std::unique_ptr< EffectEditor > VSTEffect::PopulateUI	(	const EffectPlugin &	plugin,
		ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)		const

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
pOutputs	null, or else points to outputs with 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 StatelessEffectUIServices.

Definition at line 1552 of file VSTEffect.cpp.

{
   auto parent = S.GetParent();
 
   // Determine whether fancy UI is available
   bool gui = mGui;
 
   // Then use fancy UI only if preferences say so
   if (gui)
      GetConfig(*this, PluginSettings::Shared, wxT("Options"),
                             wxT("UseGUI"),
                             gui,
                          true);
 
   auto pParent = S.GetParent();
 
   auto& vst2Instance = dynamic_cast<VSTEffectInstance&>(instance);
 
   auto editor = std::make_unique<VSTEffectEditor>(
      vst2Instance, gui, *this, access, pParent, mAEffect->numParams);
 
   // Also let the instance know about the validator, so it can forward
   // to it calls coming from the vst callback
   vst2Instance.SetOwningValidator(editor.get());
 
 
   // Build the appropriate dialog type
   if (mGui)
   {
      editor->BuildFancy(instance);
   }
   else
   {
      editor->BuildPlain(access, GetType(), mProjectRate);
   }
 
 
   return editor;
}

References PluginSettings::GetConfig(), GetType(), VSTEffectWrapper::mAEffect, VSTEffectWrapper::mGui, EffectBase::mProjectRate, 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?

Implements EffectDefinitionInterface.

Definition at line 889 of file VSTEffect.cpp.

{
   return RealtimeSince::Always;
 
   /* return GetType() == EffectTypeProcess
      ? RealtimeSince::Always
      : RealtimeSince::Never; */
}

References EffectDefinitionInterface::Always.

◆ 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

Implements EffectSettingsManager.

Definition at line 1455 of file VSTEffect.cpp.

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

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

Referenced by SaveUserPreset().

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.

Implements EffectSettingsManager.

Definition at line 2159 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(), VSTEffectWrapper::GetSettings(), VSTEffectWrapper::mAEffect, PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), settings(), VSTEffectWrapper::StoreSettings(), and wxT().

Here is the call graph for this function:

◆ ShowClientInterface()

int VSTEffect::ShowClientInterface	(	const EffectPlugin &	plugin,
		wxWindow &	parent,
		wxDialog &	dialog,
		EffectEditor *	pEditor,
		bool	forceModal
	)		const

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

Definition at line 1426 of file VSTEffect.cpp.

{
   //   mProcessLevel = 1;      // in GUI thread
 
   VSTEffectEditor* vstEditor = static_cast<VSTEffectEditor*>(pEditor);
 
   return vstEditor->ShowDialog(/* nonModal = */ SupportsRealtime() && !forceModal);
}

References VSTEffectEditor::ShowDialog(), and EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

◆ ShowOptions()

void VSTEffect::ShowOptions ( const EffectPlugin & plugin ) const

overridevirtual

Reimplemented from BasicEffectUIServices.

Definition at line 1756 of file VSTEffect.cpp.

{
   VSTEffectOptionsDialog{ *this }.ShowModal();
}

◆ SupportsAutomation()

bool VSTEffect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 898 of file VSTEffect.cpp.

{
   return mAutomatable;
}

References VSTEffectWrapper::mAutomatable.

◆ UpdateDisplay()

void VSTEffect::UpdateDisplay ( )

overrideprotectedvirtual

Reimplemented from VSTEffectWrapper.

Definition at line 2395 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;
}

Friends And Related Function Documentation

◆ VSTEffectsModule

friend class VSTEffectsModule

friend

Definition at line 445 of file VSTEffect.h.

Member Data Documentation

◆ mContainer

wxSizerItem* VSTEffect::mContainer {}

private

Definition at line 443 of file VSTEffect.h.

◆ mID

PluginID VSTEffect::mID

private

Definition at line 441 of file VSTEffect.h.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VSTEffect()

◆ ~VSTEffect()

Member Function Documentation

◆ BuildProgramBar()

◆ CanExportPresets()

◆ DoLoadFactoryPreset()

◆ DoMakeInstance()

◆ ExportPresets()

◆ GetDescription()

◆ GetEffectIDs()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ ImportPresets()

◆ ImportPresetsNC()

◆ InitializePlugin()

◆ IsDefault()

◆ IsInteractive()

◆ LoadFactoryPreset()

◆ LoadSettings()

◆ LoadUserPreset()

◆ MakeEditor()

◆ MakeInstance()

◆ MakeSettings()

◆ OnLoad()

◆ OnProgram()

◆ OnProgramText()

◆ OnSave()

◆ OnSettings()

◆ OnUpdateDisplay()

◆ PopulateUI()

◆ RealtimeSupport()

◆ SaveSettings()

◆ SaveUserPreset()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

◆ UpdateDisplay()

Friends And Related Function Documentation

◆ VSTEffectsModule

Member Data Documentation

◆ mContainer

◆ mID