VSTEffectBase Class Reference

#include <VSTEffectBase.h>

Inheritance diagram for VSTEffectBase:

Collaboration diagram for VSTEffectBase:

Public Member Functions
	VSTEffectBase (const PluginPath &path)
	~VSTEffectBase () override
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)
bool	InitializePlugin ()
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...
bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...
bool	HasOptions () const override
EffectSettings	MakeSettings () const override
std::vector< int >	GetEffectIDs ()
Public Member Functions inherited from VSTWrapper
	VSTWrapper (const PluginPath &path)
	~VSTWrapper ()
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 (VSTSettings &vst3Settings, bool doFetch=true) const
bool	StoreSettings (const VSTSettings &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	SetBufferDelay (int samples)
std::unique_ptr< EffectInstance::Message >	MakeMessageFS (const VSTSettings &settings) const
Public Member Functions inherited from VSTLink
virtual	~VSTLink ()
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 VSTUIWrapper
virtual void	Idle ()
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 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
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 NumericFormatID	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, InstanceFinder finder={})
	Re-invoke DoEffect on another Effect object that implements the work. More...
Public Member Functions inherited from EffectBase
	EffectBase ()
	~EffectBase () override
bool	IsLinearEffect () const
bool	PreviewsFullSelection () const
void	SetTracks (TrackList *pTracks)
double	GetDefaultDuration ()
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...
bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
void	CountWaveTracks ()
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 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

Private Attributes
PluginID	mID

Additional Inherited Members
Public Types inherited from VSTWrapper
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...
Static Public Member Functions inherited from VSTWrapper
static VSTSettings &	GetSettings (EffectSettings &settings)
static const VSTSettings &	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 Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)
static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)
Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...
Public Attributes inherited from VSTWrapper
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
std::shared_ptr< TrackList >	mTracks {}
int	mNumTracks {}
BasicUI::ProgressDialog *	mProgress {}
double	mProjectRate {}
WaveTrackFactory *	mFactory {}
double	mT0 {}
double	mT1 {}
bool	mIsPreview { false }
Static Public Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")
static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")
static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")
static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")
Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const
bool	DoPass2 () const
bool	Process (EffectInstance &instance, EffectSettings &settings) const
std::shared_ptr< EffectOutputTracks >	MakeOutputTracks ()
void	DestroyOutputTracks () 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, sampleCount *start, sampleCount *len)
Protected Member Functions inherited from EffectBase
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...
void	SetLinearEffectFlag (bool linearEffectFlag)
void	SetPreviewFullSelectionFlag (bool previewDurationFlag)
bool	IsPreviewing () const
const TrackList *	inputTracks () const
const AudacityProject *	FindProject () const
Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}
Protected Attributes inherited from EffectBase
double	mF0 {}
double	mF1 {}
wxArrayString	mPresetNames
unsigned	mUIFlags { 0 }

Detailed Description

Definition at line 26 of file VSTEffectBase.h.

Constructor & Destructor Documentation

VSTEffectBase()

VSTEffectBase::VSTEffectBase

(

const PluginPath &

path

)

Definition at line 30 of file VSTEffectBase.cpp.

:  VSTWrapper(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;
}

~VSTEffectBase()

VSTEffectBase::~VSTEffectBase ( )

overridedefault

Member Function Documentation

CanExportPresets()

bool VSTEffectBase::CanExportPresets ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 267 of file VSTEffectBase.cpp.

{
   return true;
}

DoLoadFactoryPreset()

bool VSTEffectBase::DoLoadFactoryPreset

(

int

id

)

Definition at line 260 of file VSTEffectBase.cpp.

{
   callSetProgram(id);
 
   return true;
}

References VSTWrapper::callSetProgram().

Referenced by LoadFactoryPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString VSTEffectBase::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 79 of file VSTEffectBase.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 VSTWrapper::mAudioIns, VSTWrapper::mAudioOuts, and XO().

Here is the call graph for this function:

GetEffectIDs()

std::vector< int > VSTEffectBase::GetEffectIDs

(

)

Definition at line 277 of file VSTEffectBase.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 VSTWrapper::callDispatcher(), effGetPlugCategory, effShellGetNextPlugin, kPlugCategShell, VSTWrapper::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 VSTEffectBase::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 230 of file VSTEffectBase.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, VSTWrapper::GetString(), VSTWrapper::mAEffect, VSTWrapper::mVstVersion, and AEffect::numPrograms.

Here is the call graph for this function:

GetFamily()

EffectFamilySymbol VSTEffectBase::GetFamily ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 112 of file VSTEffectBase.cpp.

{
   return VSTPLUGINTYPE;
}

References VSTPLUGINTYPE.

GetPath()

PluginPath VSTEffectBase::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 45 of file VSTEffectBase.cpp.

{
   return mPath;
}

References VSTWrapper::mPath.

GetSymbol()

ComponentInterfaceSymbol VSTEffectBase::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 50 of file VSTEffectBase.cpp.

{
   return VSTWrapper::GetSymbol();
}

References VSTWrapper::GetSymbol().

Here is the call graph for this function:

GetType()

EffectType VSTEffectBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 91 of file VSTEffectBase.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, VSTWrapper::mAudioIns, and VSTWrapper::mAudioOuts.

Referenced by VSTEffect::PopulateUI().

Here is the caller graph for this function:

GetVendor()

VendorSymbol VSTEffectBase::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 55 of file VSTEffectBase.cpp.

{
   return { mVendor };
}

References VSTWrapper::mVendor.

GetVersion()

wxString VSTEffectBase::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 60 of file VSTEffectBase.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 VSTWrapper::mVersion, and wxT().

Here is the call graph for this function:

HasOptions()

bool VSTEffectBase::HasOptions ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 272 of file VSTEffectBase.cpp.

{
   return true;
}

InitializePlugin()

bool VSTEffectBase::InitializePlugin

(

)

Definition at line 141 of file VSTEffectBase.cpp.

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

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

Referenced by VSTEffectsModule::DiscoverPluginsAtPath().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDefault()

bool VSTEffectBase::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 122 of file VSTEffectBase.cpp.

{
   return false;
}

IsInteractive()

bool VSTEffectBase::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 117 of file VSTEffectBase.cpp.

{
   return mInteractive;
}

References VSTWrapper::mInteractive.

LoadFactoryPreset()

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

overridevirtual

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

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 249 of file VSTEffectBase.cpp.

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

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

Here is the call graph for this function:

LoadSettings()

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

overridevirtual

Restore settings from keys and values.

Returns

true on success

Reimplemented from Effect.

Definition at line 192 of file VSTEffectBase.cpp.

{
   VSTSettings& 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   = VSTWrapper::mVersion;
   vstSettings.mUniqueID  = VSTWrapper::mAEffect->uniqueID;
   vstSettings.mNumParams = VSTWrapper::mAEffect->numParams;
 
   return true;
}

References VSTWrapper::GetSettings(), key, VSTWrapper::mAEffect, VSTSettings::mChunk, VSTSettings::mNumParams, VSTSettings::mParamsMap, VSTSettings::mUniqueID, VSTSettings::mVersion, VSTWrapper::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 VSTEffectBase::LoadUserPreset ( const RegistryPath &  name, EffectSettings &  settings  ) const

overridevirtual

Change settings to a user-named preset

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 298 of file VSTEffectBase.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(
         VSTInstance::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(
      VSTInstance::GetSettings(settings));
}

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

Here is the call graph for this function:

MakeInstance()

std::shared_ptr< EffectInstance > VSTEffectBase::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 156 of file VSTEffectBase.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<VSTInstance>(
      *this, mPath, userBlockSizeC, userBlockSizeC, useLatency);
}

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

Here is the call graph for this function:

MakeSettings()

EffectSettings VSTEffectBase::MakeSettings ( ) const

overridevirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 398 of file VSTEffectBase.cpp.

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

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

Here is the call graph for this function:

RealtimeSupport()

auto VSTEffectBase::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 127 of file VSTEffectBase.cpp.

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

References EffectDefinitionInterface::Always.

SaveSettings()

bool VSTEffectBase::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 171 of file VSTEffectBase.cpp.

{
   const VSTSettings& 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 VSTWrapper::GetSettings(), VSTSettings::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 VSTEffectBase::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 356 of file VSTEffectBase.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 VSTWrapper::constCallDispatcher(), effFlagsProgramChunks, effGetChunk, Base64::Encode(), AEffect::flags, CommandParameters::GetParameters(), VSTWrapper::GetSettings(), VSTWrapper::mAEffect, PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), settings(), VSTWrapper::StoreSettings(), and wxT().

Here is the call graph for this function:

SupportsAutomation()

bool VSTEffectBase::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 136 of file VSTEffectBase.cpp.

{
   return mAutomatable;
}

References VSTWrapper::mAutomatable.

Member Data Documentation

mID

PluginID VSTEffectBase::mID

private

Definition at line 80 of file VSTEffectBase.h.

---

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

• VSTEffectBase.h
• VSTEffectBase.cpp