Objects of this class connect Audacity with VST3 effects. More...

#include <VST3Effect.h>

Inheritance diagram for VST3Effect:

Collaboration diagram for VST3Effect:

Public Member Functions
	VST3Effect (std::shared_ptr< VST3::Hosting::Module > module, VST3::Hosting::ClassInfo effectClassInfo)

	VST3Effect (const VST3Effect &)=delete

	VST3Effect (VST3Effect &&)=delete

VST3Effect &	operator= (const VST3Effect &)=delete

VST3Effect &	operator= (VST3Effect &)=delete

	~VST3Effect () 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...

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

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

std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an 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	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

EffectSettings	MakeSettings () const override

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

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

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

Static Public Member Functions
static EffectFamilySymbol	GetFamilySymbol ()

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

static void	IncEffectCounter ()

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Private Member Functions
bool	LoadPreset (const wxString &path, EffectSettings &settings) const

Private Attributes
std::shared_ptr< VST3::Hosting::Module >	mModule

const VST3::Hosting::ClassInfo	mEffectClassInfo

wxWindow *	mParent { nullptr }

bool	mRescanFactoryPresets { true }

RegistryPaths	mFactoryPresets

Friends
class	VST3PluginValidator

Additional Inherited Members
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 Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")

static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")

static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")

static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

bool	Process (EffectInstance &instance, EffectSettings &settings) const

Protected Member Functions inherited from Effect
bool	EnablePreview (bool enable=true)

bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns `previewLength` More...

virtual std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
	Add controls to effect panel; always succeeds. More...

bool	TotalProgress (double frac, const TranslatableString &={}) const

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

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

Protected Member Functions inherited from EffectBase
void	Preview (EffectSettingsAccess &access, bool dryOnly) override

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

virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

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

Objects of this class connect Audacity with VST3 effects.

Definition at line 38 of file VST3Effect.h.

Constructor & Destructor Documentation

◆ VST3Effect() [1/3]

VST3Effect::VST3Effect	(	std::shared_ptr< VST3::Hosting::Module >	module,
		VST3::Hosting::ClassInfo	effectClassInfo
	)

Definition at line 107 of file VST3Effect.cpp.

      : mModule(std::move(module)), mEffectClassInfo(std::move(effectClassInfo))
{
}

◆ VST3Effect() [2/3]

VST3Effect::VST3Effect ( const VST3Effect & )

delete

◆ VST3Effect() [3/3]

VST3Effect::VST3Effect ( VST3Effect && )

delete

◆ ~VST3Effect()

VST3Effect::~VST3Effect ( )

override

Definition at line 100 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   CloseUI();
}

References CloseUI().

Here is the call graph for this function:

Member Function Documentation

◆ CanExportPresets()

bool VST3Effect::CanExportPresets ( )

overridevirtual

Reimplemented from Effect.

Definition at line 280 of file VST3Effect.cpp.

{
   return true;
}

◆ CloseUI()

bool VST3Effect::CloseUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 274 of file VST3Effect.cpp.

{
   mParent = nullptr;
   return true;
}

References mParent.

Referenced by ~VST3Effect().

Here is the caller graph for this function:

◆ CopySettingsContents()

bool VST3Effect::CopySettingsContents	(	const EffectSettings &	src,
		EffectSettings &	dst,
		SettingsCopyDirection	copyDirection
	)		const

overridevirtual

Update one settings object from another.

This may run in a worker thread, and should avoid memory allocations. Therefore do not copy the underlying std::any, but copy the contents of the contained objects.

Assume that src and dst were created and previously modified only by this

Default implementation does nothing and returns true

Parameters

src	settings to copy from
dst	settings to copy into
copyDirection	direction in which copy is performed

Returns: success

Reimplemented from EffectSettingsManager.

Definition at line 406 of file VST3Effect.cpp.

{
   VST3Wrapper::CopySettingsContents(src, dst, copyDirection);
   return true;
}

References VST3Wrapper::CopySettingsContents().

Here is the call graph for this function:

◆ ExportPresets()

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

overridevirtual

Reimplemented from Effect.

Definition at line 285 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   auto path = SelectFile(FileNames::Operation::Presets,
      XO("Save VST3 Preset As:"),
      wxEmptyString,
      wxEmptyString,
      wxT(".vstpreset"),
      {
        { XO("VST3 preset file"), { wxT("vstpreset") }, true }
      },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
      NULL);
 
   if (path.empty())
      return;
 
   auto dialogPlacement = wxWidgetsWindowPlacement { mParent };
 
   auto fileStream = owned(Vst::FileStream::open(path.c_str(), "wb"));
   if(!fileStream)
   {
      BasicUI::ShowMessageBox(
         //i18n-hint: VST3 preset export error
         XO("Cannot open file"),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
      return;
   }
 
   auto wrapper = std::make_unique<VST3Wrapper>(*mModule, mEffectClassInfo.ID());
   auto dummy = EffectSettings { settings };
   wrapper->FetchSettings(dummy);
 
   if (!wrapper->SavePreset(fileStream))
   {
      BasicUI::ShowMessageBox(
         XO("Failed to save VST3 preset to file"),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
   }
}

References mEffectClassInfo, mModule, mParent, SelectFile(), settings(), BasicUI::ShowMessageBox(), wxT(), and XO.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString VST3Effect::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 134 of file VST3Effect.cpp.

{
   //i18n-hint VST3 effect description string
   return XO("SubCategories: %s").Format( mEffectClassInfo.subCategoriesString() );
}

References mEffectClassInfo, and XO.

◆ GetFactoryPresets()

RegistryPaths VST3Effect::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 208 of file VST3Effect.cpp.

{
   if(!mRescanFactoryPresets)
      return mFactoryPresets;
 
   wxArrayString paths;
   wxDir::GetAllFiles(GetFactoryPresetsPath(mEffectClassInfo), &paths);
 
   RegistryPaths result;
   for(auto& path : paths)
   {
      wxFileName filename(path);
      result.push_back(filename.GetName());
   }
   mFactoryPresets = std::move(result);
   mRescanFactoryPresets = false;
 
   return mFactoryPresets;
}

References anonymous_namespace{VST3Effect.cpp}::GetFactoryPresetsPath(), mEffectClassInfo, mFactoryPresets, and mRescanFactoryPresets.

Here is the call graph for this function:

◆ GetFamily()

EffectFamilySymbol VST3Effect::GetFamily ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 153 of file VST3Effect.cpp.

{
   return VST3Effect::GetFamilySymbol();
}

References GetFamilySymbol().

Here is the call graph for this function:

◆ GetFamilySymbol()

EffectFamilySymbol VST3Effect::GetFamilySymbol ( )

static

Definition at line 95 of file VST3Effect.cpp.

{
   return XO("VST3");
}

References XO.

Referenced by GetFamily(), and VST3EffectsModule::GetOptionalFamilySymbol().

Here is the caller graph for this function:

◆ GetPath()

PluginPath VST3Effect::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 114 of file VST3Effect.cpp.

{
   return VST3Utils::MakePluginPathString( { mModule->getPath() }, mEffectClassInfo.ID().toString());
}

References VST3Utils::MakePluginPathString(), mEffectClassInfo, and mModule.

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol VST3Effect::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 119 of file VST3Effect.cpp.

{
   return wxString { mEffectClassInfo.name() };
}

References mEffectClassInfo.

◆ GetType()

EffectType VST3Effect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 140 of file VST3Effect.cpp.

{
   using namespace Steinberg::Vst::PlugType;
   if(mEffectClassInfo.subCategoriesString() == kFxGenerator)
      return EffectTypeGenerate;
   const auto& cats = mEffectClassInfo.subCategories();
 
   if(std::find(cats.begin(), cats.end(), kFx) != cats.end())
      return EffectTypeProcess;
 
   return EffectTypeNone;
}

References EffectTypeGenerate, EffectTypeNone, EffectTypeProcess, and mEffectClassInfo.

Referenced by RealtimeSupport().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VST3Effect::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 124 of file VST3Effect.cpp.

{
   return wxString { mEffectClassInfo.vendor() };
}

References mEffectClassInfo.

◆ GetVersion()

wxString VST3Effect::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 129 of file VST3Effect.cpp.

{
   return mEffectClassInfo.version();
}

References mEffectClassInfo.

◆ HasOptions()

bool VST3Effect::HasOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 354 of file VST3Effect.cpp.

{
   return true;
}

◆ ImportPresets()

void VST3Effect::ImportPresets ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 333 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   auto path = SelectFile(FileNames::Operation::Presets,
      XO("Load VST3 preset:"),
      wxEmptyString,
      wxEmptyString,
      wxT(".vstpreset"),
      {
         { XO("VST3 preset file"), { wxT("vstpreset") }, true }
      },
      wxFD_OPEN | wxRESIZE_BORDER,
      nullptr
   );
   if(path.empty())
      return;
 
   LoadPreset(path, settings);
}

References LoadPreset(), SelectFile(), settings(), wxT(), and XO.

Here is the call graph for this function:

◆ IsDefault()

bool VST3Effect::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 163 of file VST3Effect.cpp.

{
   return false;
}

◆ IsInteractive()

bool VST3Effect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 158 of file VST3Effect.cpp.

{
   return true;
}

◆ LoadFactoryPreset()

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

overridevirtual

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

Reimplemented from Effect.

Definition at line 228 of file VST3Effect.cpp.

{
   if(id >= 0 && id < mFactoryPresets.size())
   {
      auto filename = wxFileName(GetFactoryPresetsPath(mEffectClassInfo), mFactoryPresets[id] + ".vstpreset");
      return LoadPreset(filename.GetFullPath(), settings);
   }
   return true;
}

References anonymous_namespace{VST3Effect.cpp}::GetFactoryPresetsPath(), LoadPreset(), mEffectClassInfo, mFactoryPresets, and settings().

Here is the call graph for this function:

◆ LoadPreset()

bool VST3Effect::LoadPreset	(	const wxString &	path,
		EffectSettings &	settings
	)		const

private

Definition at line 365 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   auto dialogPlacement = wxWidgetsWindowPlacement { mParent };
 
   auto fileStream = owned(Vst::FileStream::open(path.c_str(), "rb"));
   if(!fileStream)
   {
      BasicUI::ShowMessageBox(
         XO("Cannot open VST3 preset file %s").Format(path),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
      return false;
   }
 
   auto wrapper = std::make_unique<VST3Wrapper>(*mModule, mEffectClassInfo.ID());
 
   if (!wrapper->LoadPreset(fileStream))
   {
      BasicUI::ShowMessageBox(
         XO("Unable to apply VST3 preset file %s").Format(path),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
      return false;
   }
 
   wrapper->StoreSettings(settings);
 
   return true;
}

References mEffectClassInfo, mModule, mParent, settings(), BasicUI::ShowMessageBox(), and XO.

Referenced by ImportPresets(), and LoadFactoryPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadSettings()

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

overridevirtual

Restore settings from keys and values.

Returns: true on success

Reimplemented from Effect.

Definition at line 187 of file VST3Effect.cpp.

{
   VST3Wrapper::LoadSettings(parms, settings);
   return true;
}

References VST3Wrapper::LoadSettings(), and settings().

Here is the call graph for this function:

◆ LoadUserPreset()

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

overridevirtual

Change settings to a user-named preset.

Reimplemented from Effect.

Definition at line 194 of file VST3Effect.cpp.

{
   VST3Wrapper::LoadUserPreset(*this, name, settings);
   return true;
}

References VST3Wrapper::LoadUserPreset(), name, and settings().

Here is the call graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > VST3Effect::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 254 of file VST3Effect.cpp.

{
   return std::make_shared<VST3Instance>(*this, *mModule, mEffectClassInfo.ID());
}

References mEffectClassInfo, and mModule.

◆ MakeSettings()

EffectSettings VST3Effect::MakeSettings ( ) const

overridevirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 401 of file VST3Effect.cpp.

{
   return VST3Wrapper::MakeSettings();
}

References VST3Wrapper::MakeSettings().

Here is the call graph for this function:

◆ operator=() [1/2]

VST3Effect & VST3Effect::operator= ( const VST3Effect & )

delete

◆ operator=() [2/2]

VST3Effect & VST3Effect::operator= ( VST3Effect & )

delete

◆ PopulateUI()

std::unique_ptr< EffectUIValidator > VST3Effect::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 259 of file VST3Effect.cpp.

{
   bool useGUI { true };
   GetConfig(*this, PluginSettings::Shared, wxT("Options"),
            wxT("UseGUI"),
            useGUI,
            useGUI);
 
   const auto vst3instance = dynamic_cast<VST3Instance*>(&instance);
   mParent = S.GetParent();
 
   return std::make_unique<VST3UIValidator>(mParent, vst3instance->GetWrapper(), *this, access, useGUI);
}

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

Here is the call graph for this function:

◆ RealtimeSupport()

auto VST3Effect::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 168 of file VST3Effect.cpp.

{
   return GetType() == EffectTypeProcess
      ? RealtimeSince::Since_3_2
      : RealtimeSince::Never;
}

References EffectTypeProcess, GetType(), EffectDefinitionInterface::Never, and EffectDefinitionInterface::Since_3_2.

Here is the call graph for this function:

◆ SaveSettings()

bool VST3Effect::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 180 of file VST3Effect.cpp.

{
   VST3Wrapper::SaveSettings(settings, parms);
   return true;
}

References VST3Wrapper::SaveSettings(), and settings().

Here is the call graph for this function:

◆ SaveUserPreset()

bool VST3Effect::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 201 of file VST3Effect.cpp.

{
   VST3Wrapper::SaveUserPreset(*this, name, settings);
   return true;
}

References name, VST3Wrapper::SaveUserPreset(), and settings().

Here is the call graph for this function:

◆ ShowClientInterface()

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

overridevirtual

Returns: 0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Reimplemented from Effect.

Definition at line 238 of file VST3Effect.cpp.

{
   if(!IsGraphicalUI())
   {
      //Restrict resize of the "plain" dialog
      dialog.SetMaxSize(dialog.GetSize());
      dialog.SetMinSize(dialog.GetSize());
   }
   if(forceModal)
      return dialog.ShowModal();
 
   dialog.Show();
   return 0;
}

References Effect::IsGraphicalUI().

Here is the call graph for this function:

◆ ShowOptions()

void VST3Effect::ShowOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 359 of file VST3Effect.cpp.

{
   VST3OptionsDialog dlg(mParent, *this);
   dlg.ShowModal();
}

References mParent.

◆ SupportsAutomation()

bool VST3Effect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 175 of file VST3Effect.cpp.

{
   return true;
}

Friends And Related Function Documentation

◆ VST3PluginValidator

friend class VST3PluginValidator

friend

Definition at line 40 of file VST3Effect.h.

Member Data Documentation

◆ mEffectClassInfo

const VST3::Hosting::ClassInfo VST3Effect::mEffectClassInfo

private

Definition at line 45 of file VST3Effect.h.

Referenced by ExportPresets(), GetDescription(), GetFactoryPresets(), GetPath(), GetSymbol(), GetType(), GetVendor(), GetVersion(), LoadFactoryPreset(), LoadPreset(), and MakeInstance().

◆ mFactoryPresets

RegistryPaths VST3Effect::mFactoryPresets

mutableprivate

Definition at line 51 of file VST3Effect.h.

Referenced by GetFactoryPresets(), and LoadFactoryPreset().

◆ mModule

std::shared_ptr<VST3::Hosting::Module> VST3Effect::mModule

private

Definition at line 44 of file VST3Effect.h.

Referenced by ExportPresets(), GetPath(), LoadPreset(), and MakeInstance().

◆ mParent

wxWindow* VST3Effect::mParent { nullptr }

private

Definition at line 47 of file VST3Effect.h.

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

◆ mRescanFactoryPresets

bool VST3Effect::mRescanFactoryPresets { true }

mutableprivate

Definition at line 50 of file VST3Effect.h.

Referenced by GetFactoryPresets().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VST3Effect() [1/3]

◆ VST3Effect() [2/3]

◆ VST3Effect() [3/3]

◆ ~VST3Effect()

Member Function Documentation

◆ CanExportPresets()

◆ CloseUI()

◆ CopySettingsContents()

◆ ExportPresets()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetFamilySymbol()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ ImportPresets()

◆ IsDefault()

◆ IsInteractive()

◆ LoadFactoryPreset()

◆ LoadPreset()

◆ LoadSettings()

◆ LoadUserPreset()

◆ MakeInstance()

◆ MakeSettings()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PopulateUI()

◆ RealtimeSupport()

◆ SaveSettings()

◆ SaveUserPreset()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

Friends And Related Function Documentation

◆ VST3PluginValidator

Member Data Documentation

◆ mEffectClassInfo

◆ mFactoryPresets

◆ mModule

◆ mParent

◆ mRescanFactoryPresets