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 &other)

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

bool	SupportsRealtime () const override
	Whether the effect supports realtime previewing (while audio is playing). More...

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

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

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

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

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

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

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

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

unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...

unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...

int	GetMidiInCount () const override
	Function that has not yet found a use. More...

int	GetMidiOutCount () const override
	Function that has not yet found a use. More...

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

sampleCount	GetLatency () override

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

bool	ProcessFinalize () override

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override

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

bool	RealtimeFinalize (EffectSettings &settings) noexcept override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart (EffectSettings &settings) override
	settings are possibly changed, since last call, by an asynchronous dialog More...

size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inbuf, float const outbuf, size_t numSamples) override

bool	RealtimeProcessEnd (EffectSettings &settings) noexcept override
	settings can be updated to let a dialog change appearance at idle More...

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

bool	InitializePlugin ()

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

std::shared_ptr< EffectInstance >	DoMakeInstance ()

bool	IsGraphicalUI () override

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

bool	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

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

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

virtual sampleCount	GetLatency ()

virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, sampleCount totalLen, ChannelNames chanMap=nullptr)

virtual bool	ProcessFinalize ()

virtual size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen)
	Called for destructive effect computation. More...

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

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

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual bool	RealtimeProcessStart (EffectSettings &settings)
	settings are possibly changed, since last call, by an asynchronous dialog More...

virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

Public Member Functions inherited from PerTrackEffect
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

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

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

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

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

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

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

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

bool	SupportsRealtime () const override
	Whether the effect supports realtime previewing (while audio is playing). More...

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

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

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

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

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

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

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

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

unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...

unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...

virtual const EffectParameterMethods &	Parameters () const

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

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

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, 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, bool forceModal=false)=0

virtual bool	IsGraphicalUI ()=0

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

virtual bool	CanExportPresets ()=0

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

virtual void	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

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

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () const =0

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

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

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

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

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

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

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

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

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

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

virtual unsigned	GetAudioInCount () const =0
	How many input buffers to allocate at once. More...

virtual unsigned	GetAudioOutCount () const =0
	How many output buffers to allocate at once. More...

virtual int	GetMidiInCount () const
	Function that has not yet found a use. More...

virtual int	GetMidiOutCount () const
	Function that has not yet found a use. More...

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

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

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

virtual EffectSettings	MakeSettings () const

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

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetType () const =0
	Type determines how it behaves. More...

virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...

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

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

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

virtual bool	SupportsRealtime () const =0
	Whether the effect supports realtime previewing (while audio is playing). More...

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

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

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

void	OnEffectWindowResize (wxSizeEvent &evt)

bool	LoadVSTUI (wxWindow *parent)

void	SyncParameters (EffectSettings &) const

bool	LoadPreset (const wxString &path)

void	ReloadUserOptions ()

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

Steinberg::IPtr< Steinberg::Vst::IComponent >	mEffectComponent

Steinberg::IPtr< Steinberg::Vst::IAudioProcessor >	mAudioProcessor

Steinberg::Vst::ProcessSetup	mSetup

const VST3::Hosting::ClassInfo	mEffectClassInfo

Steinberg::IPtr< Steinberg::Vst::IConnectionPoint >	mComponentConnectionProxy

Steinberg::IPtr< Steinberg::Vst::IConnectionPoint >	mControllerConnectionProxy

Steinberg::IPtr< Steinberg::IPlugView >	mPlugView

Steinberg::IPtr< Steinberg::Vst::IEditController >	mEditController

Steinberg::IPtr< internal::ComponentHandler >	mComponentHandler

wxWindow *	mParent { nullptr }

NumericTextCtrl *	mDuration { nullptr }

VST3ParametersWindow *	mPlainUI { nullptr }

internal::ComponentHandler::PendingChangesPtr	mPendingChanges

std::vector< std::shared_ptr< VST3Effect > >	mRealtimeGroupProcessors

bool	mRescanFactoryPresets { true }

RegistryPaths	mFactoryPresets

size_t	mUserBlockSize { 8192 }

bool	mUseLatency { true }

sampleCount	mInitialDelay { 0 }

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

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

Static Public Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")

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

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

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

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

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

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

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

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

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

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

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

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

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

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

void	CopyInputTracks (bool allSyncLockSelected=false)

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

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

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

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

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

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

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

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

wxWindow *	mUIParent {}

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

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Protected Attributes inherited from EffectUIClientInterface
friend	EffectUIValidator

friend	DefaultEffectUIValidator

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

Objects of this class connect Audacity with VST3 effects.

Definition at line 45 of file VST3Effect.h.

Constructor & Destructor Documentation

◆ VST3Effect() [1/2]

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

Definition at line 215 of file VST3Effect.cpp.

   : mModule(std::move(module)), mEffectClassInfo(std::move(effectClassInfo))
{
   using namespace Steinberg;
   Initialize();
 
   const auto& pluginFactory = mModule->getFactory();
   auto editController = FUnknownPtr<Vst::IEditController>(mEffectComponent);
   if(!editController)
   {
      //Plugin does not have a separate edit controller
      TUID controllerCID;
            
      if (mEffectComponent->getControllerClassId (controllerCID) == kResultTrue)
      {
         if(mEditController = pluginFactory.createInstance<Vst::IEditController> (VST3::UID (controllerCID)))
         {
            if(mEditController->initialize(&LocalContext()) != kResultOk)
            {
               wxLogMessage("Cannot create edit controller: initialization failed");
               mEditController = nullptr;
            }
         }
         else
            wxLogMessage("Cannot create edit controller: attempt failed");
      }
      else
         wxLogMessage("Cannot create edit controller: failed read controller Class ID from the effect component");
   }
   else
      mEditController = editController;
 
   if(mEditController)
   {
      mComponentHandler = owned(safenew internal::ComponentHandler);
      mEditController->setComponentHandler(mComponentHandler);
 
      auto componentConnectionPoint = FUnknownPtr<Vst::IConnectionPoint>{ mEffectComponent };
      auto controllerConnectionPoint = FUnknownPtr<Vst::IConnectionPoint>{ mEditController };
 
      if (componentConnectionPoint && controllerConnectionPoint)
      {
         mComponentConnectionProxy = owned(safenew internal::ConnectionProxy(componentConnectionPoint));
         mControllerConnectionProxy = owned(safenew internal::ConnectionProxy(controllerConnectionPoint));
 
         mComponentConnectionProxy->connect(controllerConnectionPoint);
         mControllerConnectionProxy->connect(componentConnectionPoint);
      }
   }
}

References Initialize(), anonymous_namespace{VST3Effect.cpp}::LocalContext(), mComponentConnectionProxy, mComponentHandler, mControllerConnectionProxy, mEditController, mEffectComponent, mModule, and safenew.

Here is the call graph for this function:

◆ VST3Effect() [2/2]

VST3Effect::VST3Effect ( const VST3Effect & other )

Definition at line 186 of file VST3Effect.cpp.

   : mModule(other.mModule), mEffectClassInfo(other.mEffectClassInfo)
{
   mUseLatency = other.mUseLatency;
   mUserBlockSize = other.mUserBlockSize;
   Initialize();
   mSetup = other.mSetup;
}

References Initialize(), mSetup, mUseLatency, and mUserBlockSize.

Here is the call graph for this function:

◆ ~VST3Effect()

VST3Effect::~VST3Effect ( )

override

Definition at line 195 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   CloseUI();
   
   if(mComponentConnectionProxy)
      mComponentConnectionProxy->disconnect(FUnknownPtr<Vst::IConnectionPoint>(mEditController));
   if(mControllerConnectionProxy)
      mControllerConnectionProxy->disconnect(FUnknownPtr<Vst::IConnectionPoint>(mEffectComponent));
 
   if(mEditController)
   {
      mEditController->setComponentHandler(nullptr);
      mEditController->terminate();
   }
   if(mEffectComponent)
      mEffectComponent->terminate();
}

References CloseUI(), mComponentConnectionProxy, mControllerConnectionProxy, mEditController, and mEffectComponent.

Here is the call graph for this function:

Member Function Documentation

◆ CanExportPresets()

bool VST3Effect::CanExportPresets ( )

overridevirtual

Reimplemented from Effect.

Definition at line 953 of file VST3Effect.cpp.

{
   return true;
}

◆ CloseUI()

bool VST3Effect::CloseUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 939 of file VST3Effect.cpp.

{
   mPlainUI = nullptr;
   mParent = nullptr;
   if(mPlugView)
   {
      mPlugView->setFrame(nullptr);
      mPlugView->removed();
      mPlugView = nullptr;
      return true;
   }
   return false;
}

References mParent, mPlainUI, and mPlugView.

Referenced by ~VST3Effect().

Here is the caller graph for this function:

◆ DoMakeInstance()

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

Definition at line 862 of file VST3Effect.cpp.

{
   ReloadUserOptions();
   return std::make_shared<Instance>(*this);
}

References ReloadUserOptions().

Referenced by MakeInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExportPresets()

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

overridevirtual

Reimplemented from Effect.

Definition at line 958 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;
   }
 
   if(!Vst::PresetFile::savePreset(
      fileStream,
      FUID::fromTUID (mEffectClassInfo.ID().data()),
      mEffectComponent.get(),
      mEditController.get()))
   {
      BasicUI::ShowMessageBox(
         XO("Failed to save VST3 preset to file"),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
      return;
   }
}

References mEditController, mEffectClassInfo, mEffectComponent, mParent, SelectFile(), BasicUI::ShowMessageBox(), and XO.

Here is the call graph for this function:

◆ GetAudioInCount()

unsigned VST3Effect::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

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

Reimplemented from Effect.

Definition at line 560 of file VST3Effect.cpp.

{
   return CountChannels(
      mEffectComponent,
      Steinberg::Vst::kAudio,
      Steinberg::Vst::kInput,
      Steinberg::Vst::kMain);
}

References anonymous_namespace{VST3Effect.cpp}::CountChannels(), anonymous_namespace{AudioSetupToolBar.cpp}::kInput, and mEffectComponent.

Here is the call graph for this function:

◆ GetAudioOutCount()

unsigned VST3Effect::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

Reimplemented from Effect.

Definition at line 569 of file VST3Effect.cpp.

{
   return CountChannels(
      mEffectComponent,
      Steinberg::Vst::kAudio,
      Steinberg::Vst::kOutput,
      Steinberg::Vst::kMain);
}

References anonymous_namespace{VST3Effect.cpp}::CountChannels(), anonymous_namespace{AudioSetupToolBar.cpp}::kOutput, and mEffectComponent.

Here is the call graph for this function:

◆ GetBlockSize()

size_t VST3Effect::GetBlockSize ( ) const

overridevirtual

Default implementation returns mEffectBlockSize

Reimplemented from StatefulPerTrackEffect.

Definition at line 597 of file VST3Effect.cpp.

{
   return mSetup.maxSamplesPerBlock;
}

References mSetup.

◆ GetDescription()

TranslatableString VST3Effect::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 289 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 473 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 308 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 181 of file VST3Effect.cpp.

{
   return XO("VST3");
}

References XO.

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

Here is the caller graph for this function:

◆ GetLatency()

sampleCount VST3Effect::GetLatency ( )

overridevirtual

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

Reimplemented from StatefulPerTrackEffect.

Definition at line 602 of file VST3Effect.cpp.

{
   if(mUseLatency)
   {
      if(!mRealtimeGroupProcessors.empty())
         return mRealtimeGroupProcessors[0]->GetLatency();
      auto delay = mInitialDelay;
      mInitialDelay = 0u;
      return delay;
   }
   return { 0u };
}

References mInitialDelay, mRealtimeGroupProcessors, and mUseLatency.

◆ GetMidiInCount()

int VST3Effect::GetMidiInCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 578 of file VST3Effect.cpp.

{
   //Dummy
   return 0;
}

◆ GetMidiOutCount()

int VST3Effect::GetMidiOutCount ( ) const

overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 584 of file VST3Effect.cpp.

{
   //Dummy
   return 0;
}

◆ GetPath()

PluginPath VST3Effect::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 269 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 274 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 295 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 PopulateUI().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VST3Effect::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 279 of file VST3Effect.cpp.

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

References mEffectClassInfo.

◆ GetVersion()

wxString VST3Effect::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 284 of file VST3Effect.cpp.

{
   return mEffectClassInfo.version();
}

References mEffectClassInfo.

◆ HasOptions()

bool VST3Effect::HasOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1028 of file VST3Effect.cpp.

{
   return true;
}

◆ ImportPresets()

void VST3Effect::ImportPresets ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

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

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

Here is the call graph for this function:

◆ Initialize()

void VST3Effect::Initialize ( )

private

Definition at line 147 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   const auto& pluginFactory = mModule->getFactory();
   if(auto effectComponent = pluginFactory.createInstance<Vst::IComponent>(mEffectClassInfo.ID()))
   {
      if(effectComponent->initialize(&LocalContext()) == kResultOk)
      {
         if(auto audioProcessor = FUnknownPtr<Vst::IAudioProcessor>(effectComponent))
         {
            mEffectComponent = effectComponent;
            mAudioProcessor = audioProcessor;
         }
         else
            //It's stated that "This interface must always be supported by audio processing plug-ins."
            throw std::runtime_error("VST3 plugin does not provide audio processor interface");
      }
      else
         throw std::runtime_error("Cannot initialize VST3 effect component");
   }
   else
      throw std::runtime_error("Cannot create VST3 effect component");
 
   //defaults
   mSetup.processMode = Vst::kOffline;
   mSetup.symbolicSampleSize = Vst::kSample32;
   mSetup.maxSamplesPerBlock = mUserBlockSize;
   mSetup.sampleRate = 44100.0;
 
   ActivateDefaultBuses(mEffectComponent.get(), Vst::kAudio, Vst::kInput, true);
   ActivateDefaultBuses(mEffectComponent.get(), Vst::kAudio, Vst::kOutput, true);
}

References anonymous_namespace{VST3Effect.cpp}::ActivateDefaultBuses(), anonymous_namespace{AudioSetupToolBar.cpp}::kInput, anonymous_namespace{AudioSetupToolBar.cpp}::kOutput, anonymous_namespace{VST3Effect.cpp}::LocalContext(), mAudioProcessor, mEffectClassInfo, mEffectComponent, mModule, mSetup, and mUserBlockSize.

Referenced by VST3Effect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializePlugin()

bool VST3Effect::InitializePlugin ( )

Definition at line 852 of file VST3Effect.cpp.

{
   return true;
}

◆ IsDefault()

bool VST3Effect::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 318 of file VST3Effect.cpp.

{
   return false;
}

◆ IsGraphicalUI()

bool VST3Effect::IsGraphicalUI ( )

overridevirtual

Reimplemented from Effect.

Definition at line 868 of file VST3Effect.cpp.

{
   return mPlugView != nullptr;
}

References mPlugView.

Referenced by ShowClientInterface().

Here is the caller graph for this function:

◆ IsInteractive()

bool VST3Effect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 313 of file VST3Effect.cpp.

{
   return mEditController != nullptr;
}

References mEditController.

◆ LoadFactoryDefaults()

bool VST3Effect::LoadFactoryDefaults ( EffectSettings & settings ) const

overridevirtual

Change settings back to "factory default".

Reimplemented from Effect.

Definition at line 504 of file VST3Effect.cpp.

{
   using namespace Steinberg;
   if(mComponentHandler == nullptr)
      return false;
 
   for(int i = 0, count = mEditController->getParameterCount(); i < count; ++i)
   {
      Vst::ParameterInfo parameterInfo { };
      if(mEditController->getParameterInfo(i, parameterInfo) == kResultOk)
      {
         if(parameterInfo.flags & Vst::ParameterInfo::kIsReadOnly)
            continue;
 
         if(mComponentHandler->beginEdit(parameterInfo.id) == kResultOk)
         {
            auto cleanup = finally([&]{
               mComponentHandler->endEdit(parameterInfo.id);
            });
            mComponentHandler->performEdit(parameterInfo.id, parameterInfo.defaultNormalizedValue);
         }
         mEditController->setParamNormalized(parameterInfo.id, parameterInfo.defaultNormalizedValue);
      }
   }
   
   if(mPlainUI != nullptr)
      mPlainUI->ReloadParameters();
 
   return true;
}

References mComponentHandler, mEditController, mPlainUI, and VST3ParametersWindow::ReloadParameters().

Here is the call graph for this function:

◆ 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 493 of file VST3Effect.cpp.

{
   if(id >= 0 && id < mFactoryPresets.size())
   {
      auto filename = wxFileName(GetFactoryPresetsPath(mEffectClassInfo), mFactoryPresets[id] + ".vstpreset");
      // To do: externalize state so const_cast isn't needed
      return const_cast<VST3Effect*>(this)->LoadPreset(filename.GetFullPath());
   }
   return true;
}

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

Here is the call graph for this function:

◆ LoadPreset()

bool VST3Effect::LoadPreset ( const wxString & path )

private

Definition at line 1181 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;
   }
 
   if(!Vst::PresetFile::loadPreset(
      fileStream,
      FUID::fromTUID(mEffectClassInfo.ID().data()),
      mEffectComponent.get(),
      mEditController.get()))
   {
      BasicUI::ShowMessageBox(
         XO("Unable to apply VST3 preset file %s").Format(path),
         BasicUI::MessageBoxOptions()
            .Caption(XO("Error"))
            .Parent(&dialogPlacement)
      );
      return false;
   }
 
   if(mPlainUI != nullptr)
      mPlainUI->ReloadParameters();
 
   return true;
}

References mEditController, mEffectClassInfo, mEffectComponent, mParent, mPlainUI, VST3ParametersWindow::ReloadParameters(), 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 378 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   if(mComponentHandler == nullptr)
      return false;
   
   long index { };
   wxString key;
   if(parms.GetFirstEntry(key, index))
   {
      do
      {
         Steinberg::Vst::ParamID id;
         Vst::ParamValue value;
         if(VST3Utils::ParseAutomationParameterKey(key, id) && parms.Read(key, &value))
         {
            if(mComponentHandler->beginEdit(id) == kResultOk)
            {
               auto cleanup = finally([&]{
                  mComponentHandler->endEdit(id);
               });
               mComponentHandler->performEdit(id, value);
            }
            mEditController->setParamNormalized(id, value);
         }
      } while(parms.GetNextEntry(key, index));
   }
 
   if(mPlainUI != nullptr)
      mPlainUI->ReloadParameters();
 
   return true;
}

References id, key, mComponentHandler, mEditController, mPlainUI, VST3Utils::ParseAutomationParameterKey(), and VST3ParametersWindow::ReloadParameters().

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 414 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   if(!mEditController)
      return false;   
 
   if(!PluginSettings::HasConfigValue(*this, PluginSettings::Private, name, processorStateKey))
      return false;
 
   wxString processorStateStr;
   if(!GetConfig(*this, PluginSettings::Private, name, processorStateKey, processorStateStr, wxEmptyString))
      return false;
   auto processorState = PresetsBufferStream::fromString(processorStateStr);
   if(mEffectComponent->setState(processorState) != kResultOk)
      return false;
 
   if(PluginSettings::HasConfigValue(*this, PluginSettings::Private, name, controllerStateKey))
   {
      wxString controllerStateStr;
      if(!GetConfig(*this, PluginSettings::Private, name, controllerStateKey, controllerStateStr, wxEmptyString))
         return false;
      auto controllerState = PresetsBufferStream::fromString(controllerStateStr);
 
      if(mEditController->setComponentState(processorState) != kResultOk ||
         mEditController->setState(controllerState) != kResultOk)
         return false;
   }
 
   SyncParameters(settings);
 
   if(mPlainUI != nullptr)
      mPlainUI->ReloadParameters();
 
   return true;
}

References anonymous_namespace{VST3Effect.cpp}::controllerStateKey, PluginSettings::GetConfig(), PluginSettings::HasConfigValue(), mEditController, mEffectComponent, mPlainUI, name, PluginSettings::Private, anonymous_namespace{VST3Effect.cpp}::processorStateKey, VST3ParametersWindow::ReloadParameters(), settings(), and SyncParameters().

Here is the call graph for this function:

◆ LoadVSTUI()

bool VST3Effect::LoadVSTUI ( wxWindow * parent )

private

Definition at line 1071 of file VST3Effect.cpp.

{
   using namespace Steinberg;
   if(mEditController == nullptr)
      return false;
 
   bool useGUI { true };
   GetConfig(*this, PluginSettings::Shared, wxT("Options"),
            wxT("UseGUI"),
            useGUI,
            useGUI);
   if(!useGUI)
      return false;
 
   if(const auto view = owned (mEditController->createView (Vst::ViewType::kEditor))) 
   {  
      parent->Bind(wxEVT_SIZE, &VST3Effect::OnEffectWindowResize, this);
 
      ViewRect defaultSize;
      if(view->getSize(&defaultSize) == kResultOk)
      {
         if(view->canResize() == Steinberg::kResultTrue)
         {
            ViewRect minSize {0, 0, parent->GetMinWidth(), parent->GetMinHeight()};
            ViewRect maxSize {0, 0, 10000, 10000};
            if(view->checkSizeConstraint(&minSize) != kResultOk)
               minSize = defaultSize;
 
            if(view->checkSizeConstraint(&maxSize) != kResultOk)
               maxSize = defaultSize;
 
            //No need to accommodate the off-by-one error with Steinberg::ViewRect
            //as we do it with wxRect
 
            if(defaultSize.getWidth() < minSize.getWidth())
               defaultSize.right = defaultSize.left + minSize.getWidth();
            if(defaultSize.getWidth() > maxSize.getWidth())
               defaultSize.right = defaultSize.left + maxSize.getWidth();
 
            if(defaultSize.getHeight() < minSize.getHeight())
               defaultSize.bottom = defaultSize.top + minSize.getHeight();
            if(defaultSize.getHeight() > maxSize.getHeight())
               defaultSize.bottom = defaultSize.top + maxSize.getHeight();
 
            parent->SetMinSize({minSize.getWidth(), minSize.getHeight()});
            parent->SetMaxSize({maxSize.getWidth(), maxSize.getHeight()});
         }
         else
         {
            parent->SetMinSize({defaultSize.getWidth(), defaultSize.getHeight()});
            parent->SetMaxSize(parent->GetMinSize());
         }
 
         parent->SetSize({defaultSize.getWidth(), defaultSize.getHeight()});
      }
 
#if __WXGTK__
      mPlugView = view;
      safenew internal::x11::SocketWindow(parent, wxID_ANY, view);
      return true;
#else
 
      static const auto platformType =
#  if __WXMAC__
         kPlatformTypeNSView;
#  elif __WXMSW__
         kPlatformTypeHWND;
#  else
#     error "Platform not supported"
#  endif
      auto plugFrame = owned(safenew internal::PlugFrame { parent });
      view->setFrame(plugFrame);
      if(view->attached(parent->GetHandle(), platformType) != kResultOk)
         return false;
 
      mPlugView = view;
 
      return true;
#endif
 
      
   }
   return false;
}

References PluginSettings::GetConfig(), mEditController, mPlugView, OnEffectWindowResize(), safenew, and PluginSettings::Shared.

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller 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)

Reimplemented from StatefulPerTrackEffect.

Definition at line 857 of file VST3Effect.cpp.

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

References DoMakeInstance().

Here is the call graph for this function:

◆ OnEffectWindowResize()

void VST3Effect::OnEffectWindowResize ( wxSizeEvent & evt )

private

Definition at line 1042 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   if(!mPlugView)
      return;
 
   const auto window = static_cast<wxWindow*>(evt.GetEventObject());
   const auto windowSize = evt.GetSize();
 
   {
      //Workaround to prevent dialog window resize when
      //plugin window reaches its maximum size
      auto root = wxGetTopLevelParent(window);
      wxSize maxRootSize = root->GetMaxSize();
 
      //remember the current dialog size as its new maximum size
      if(window->GetMaxWidth() != -1 && windowSize.GetWidth() >= window->GetMaxWidth())
         maxRootSize.SetWidth(root->GetSize().GetWidth());
      if(window->GetMaxHeight() != -1 && windowSize.GetHeight() >= window->GetMaxHeight())
         maxRootSize.SetHeight(root->GetSize().GetHeight());
      root->SetMaxSize(maxRootSize);
   }
   
   ViewRect plugViewSize { 0, 0, windowSize.x, windowSize.y };
   mPlugView->checkSizeConstraint(&plugViewSize);
   mPlugView->onSize(&plugViewSize);
}

References mPlugView.

Referenced by LoadVSTUI().

Here is the caller graph for this function:

◆ 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 873 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   mParent = S.GetParent();
 
   if(mComponentHandler != nullptr)
   {
      // PRL:  Is this sync really needed?
      access.ModifySettings([&](EffectSettings &settings){
         SyncParameters(settings);
      });
 
      auto parent = S.GetParent();
      if(GetType() == EffectTypeGenerate)
      {
         auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
         auto controlsRoot = safenew wxWindow(parent, wxID_ANY);
         if(!LoadVSTUI(controlsRoot))
            mPlainUI = VST3ParametersWindow::Setup(*controlsRoot, *mEditController, *mComponentHandler);
         vSizer->Add(controlsRoot);
 
         auto &extra = access.Get().extra;
         mDuration = safenew NumericTextCtrl(
               parent, wxID_ANY,
               NumericConverter::TIME,
               extra.GetDurationFormat(),
               extra.GetDuration(),
               mSetup.sampleRate,
               NumericTextCtrl::Options{}
                  .AutoPos(true)
            );
         mDuration->SetName( XO("Duration") );
 
         auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
         hSizer->Add(safenew wxStaticText(parent, wxID_ANY, _("Duration:")));
         hSizer->AddSpacer(5);
         hSizer->Add(mDuration);
         vSizer->AddSpacer(10);
         vSizer->Add(hSizer.release());
 
         parent->SetMinSize(vSizer->CalcMin());
         parent->SetSizer(vSizer.release());
      }
      else if(!LoadVSTUI(parent))
      {
         mPlainUI = VST3ParametersWindow::Setup(
            *parent,
            *mEditController,
            *mComponentHandler
         );
      }
 
      return std::make_unique<DefaultEffectUIValidator>(*this, access);
   }
   return nullptr;
}

References _, NumericTextCtrl::Options::AutoPos(), EffectTypeGenerate, EffectSettings::extra, EffectSettingsAccess::Get(), GetType(), LoadVSTUI(), mComponentHandler, mDuration, mEditController, EffectSettingsAccess::ModifySettings(), mParent, mPlainUI, mSetup, S, safenew, NumericTextCtrl::SetName(), settings(), VST3ParametersWindow::Setup(), SyncParameters(), NumericConverter::TIME, and XO.

Here is the call graph for this function:

◆ ProcessBlock()

size_t VST3Effect::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Reimplemented from StatefulPerTrackEffect.

Definition at line 739 of file VST3Effect.cpp.

{
   internal::ComponentHandler::PendingChangesPtr pendingChanges { nullptr };
   if(mComponentHandler)
      pendingChanges = mComponentHandler->getPendingChanges();
   return VST3ProcessBlock(mEffectComponent.get(), mSetup, inBlock, outBlock, blockLen, pendingChanges.get());
}

References mComponentHandler, mEffectComponent, mSetup, and anonymous_namespace{VST3Effect.cpp}::VST3ProcessBlock().

Here is the call graph for this function:

◆ ProcessFinalize()

bool VST3Effect::ProcessFinalize ( void )

overridevirtual

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Reimplemented from StatefulPerTrackEffect.

Definition at line 635 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   mAudioProcessor->setProcessing(false);
   return mEffectComponent->setActive(false) == Steinberg::kResultOk;
}

References mAudioProcessor, and mEffectComponent.

◆ ProcessInitialize()

bool VST3Effect::ProcessInitialize	(	EffectSettings &	settings,
		double	sampleRate,
		sampleCount	totalLen,
		ChannelNames	chanMap
	)

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Reimplemented from StatefulPerTrackEffect.

Definition at line 615 of file VST3Effect.cpp.

{
   mSetup.sampleRate = sampleRate;
   using namespace Steinberg;
 
   if(mAudioProcessor->canProcessSampleSize(mSetup.symbolicSampleSize) ==kResultTrue &&
      mAudioProcessor->setupProcessing(mSetup) == kResultOk)
   {
      if(mEffectComponent->setActive(true) == kResultOk)
      {
         SyncParameters(settings);//will do nothing for realtime effect
         mAudioProcessor->setProcessing(true);
         mInitialDelay = static_cast<decltype(mInitialDelay)>(mAudioProcessor->getLatencySamples());
         return true;
      }
   }
   return false;
}

References mAudioProcessor, mEffectComponent, mInitialDelay, mSetup, settings(), and SyncParameters().

Here is the call graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 756 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   try
   {
      auto effect = std::make_unique<VST3Effect>(*this);
      effect->mSetup.processMode = Vst::kRealtime;
      effect->mSetup.sampleRate = sampleRate;
      if(!effect->ProcessInitialize(settings, sampleRate, {0}, nullptr))
         throw std::runtime_error { "VST3 realtime initialization failed" };
 
      mRealtimeGroupProcessors.push_back(std::move(effect));
      return true;
   }
   catch(std::exception& e)
   {
      //make_unique<> isn't likely to fail here since this effect instance
      //somehow succeeded
      wxLogError("Failed to add realtime processor: %s", e.what());
   }
   return false;
}

References mRealtimeGroupProcessors, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool VST3Effect::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 781 of file VST3Effect.cpp.

{
   return GuardedCall<bool>([this]()
   {
      for(auto& processor : mRealtimeGroupProcessors)
         processor->ProcessFinalize();
 
      mRealtimeGroupProcessors.clear();
      mPendingChanges.reset();
      
      return true;
   });
}

◆ RealtimeInitialize()

bool VST3Effect::RealtimeInitialize	(	EffectSettings &	settings,
		double	sampleRate
	)

overridevirtual

Returns: success Default implementation does nothing, returns false (so assume realtime is not supported). Other member functions related to realtime return true or zero, but will not be called, unless a derived class overrides RealtimeInitialize. Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 748 of file VST3Effect.cpp.

{
   mSetup.sampleRate = sampleRate;
   //reload current parameters form the editor into parameter queues
   SyncParameters(settings);
   return true;
}

References mSetup, settings(), and SyncParameters().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t VST3Effect::RealtimeProcess	(	size_t	group,
		EffectSettings &	settings,
		const float const	inBuf,
		float const	outBuf,
		size_t	numSamples
	)

overridevirtual

Returns: success Default implementation does nothing, returns 0 Default implementation does nothing, returns 0

Reimplemented from StatefulEffectBase.

Definition at line 819 of file VST3Effect.cpp.

{
   if (group >= mRealtimeGroupProcessors.size())
      return 0;
   auto& effect = mRealtimeGroupProcessors[group];
   return VST3ProcessBlock(effect->mEffectComponent.get(), effect->mSetup, inBuf, outBuf, numSamples, mPendingChanges.get());
}

References mPendingChanges, mRealtimeGroupProcessors, and anonymous_namespace{VST3Effect.cpp}::VST3ProcessBlock().

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool VST3Effect::RealtimeProcessEnd ( EffectSettings & settings )

overridevirtualnoexcept

settings can be updated to let a dialog change appearance at idle

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 828 of file VST3Effect.cpp.

{
   return GuardedCall<bool>([this]()
   {
      mPendingChanges.reset();
      return true;
   });
}

◆ RealtimeProcessStart()

bool VST3Effect::RealtimeProcessStart ( EffectSettings & settings )

overridevirtual

settings are possibly changed, since last call, by an asynchronous dialog

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 809 of file VST3Effect.cpp.

{
   assert(mPendingChanges == nullptr);
 
   if(mComponentHandler != nullptr)
      //Same parameter changes are used among all of the realtime processors
      mPendingChanges = mComponentHandler->getPendingChanges();
   return true;
}

References mComponentHandler, and mPendingChanges.

◆ RealtimeResume()

bool VST3Effect::RealtimeResume ( )

overridevirtual

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 802 of file VST3Effect.cpp.

{
   for(auto& effect : mRealtimeGroupProcessors)
      effect->mAudioProcessor->setProcessing(true);
   return true;
}

References mRealtimeGroupProcessors.

◆ RealtimeSuspend()

bool VST3Effect::RealtimeSuspend ( )

overridevirtual

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 795 of file VST3Effect.cpp.

{
   for(auto& effect : mRealtimeGroupProcessors)
      effect->mAudioProcessor->setProcessing(false);
   return true;
}

References mRealtimeGroupProcessors.

◆ ReloadUserOptions()

void VST3Effect::ReloadUserOptions ( )

private

Definition at line 1220 of file VST3Effect.cpp.

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

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

Referenced by DoMakeInstance(), and ShowOptions().

Here is the call graph for this function:

Here is the caller 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 352 of file VST3Effect.cpp.

{
   if(mEditController == nullptr)
      return false;
 
   using namespace Steinberg;
   
   for(int i = 0, count = mEditController->getParameterCount(); i < count; ++i)
   {
      Vst::ParameterInfo parameterInfo { };
      if(mEditController->getParameterInfo(i, parameterInfo) == kResultOk)
      {
         if(parameterInfo.flags & Vst::ParameterInfo::kCanAutomate)
         {
            parms.Write(
               VST3Utils::MakeAutomationParameterKey(parameterInfo),
               mEditController->getParamNormalized(parameterInfo.id)
            );
         }
      }
   }
 
   return true;
}

References VST3Utils::MakeAutomationParameterKey(), and mEditController.

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 452 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   if(!mEditController)
      return false;
 
   auto processorState = owned(safenew PresetsBufferStream);
   if(mEffectComponent->getState(processorState) != kResultOk)
      return false;
 
   SetConfig(*this, PluginSettings::Private, name, processorStateKey, processorState->toString());
 
   auto controllerState = owned(safenew PresetsBufferStream);
   if(mEditController->getState(controllerState) == kResultOk)
      SetConfig(*this, PluginSettings::Private, name, controllerStateKey, controllerState->toString());
 
   return true;
}

References anonymous_namespace{VST3Effect.cpp}::controllerStateKey, mEditController, mEffectComponent, name, PluginSettings::Private, anonymous_namespace{VST3Effect.cpp}::processorStateKey, safenew, and PluginSettings::SetConfig().

Here is the call graph for this function:

◆ SetBlockSize()

size_t VST3Effect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Default implementation assigns mEffectBlockSize, returns it

Reimplemented from StatefulPerTrackEffect.

Definition at line 590 of file VST3Effect.cpp.

{
   mSetup.maxSamplesPerBlock = 
      static_cast<Steinberg::int32>(std::min(maxBlockSize, mUserBlockSize));
   return mSetup.maxSamplesPerBlock;
}

References min(), mSetup, and mUserBlockSize.

Referenced by ReloadUserOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowClientInterface()

int VST3Effect::ShowClientInterface	(	wxWindow &	parent,
		wxDialog &	dialog,
		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 837 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 IsGraphicalUI().

Here is the call graph for this function:

◆ ShowOptions()

void VST3Effect::ShowOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1033 of file VST3Effect.cpp.

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

References mParent, and ReloadUserOptions().

Here is the call graph for this function:

◆ SupportsAutomation()

bool VST3Effect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 332 of file VST3Effect.cpp.

{
   if(mEditController == nullptr)
      return false;
 
   using namespace Steinberg;
   
   for(int i = 0, count = mEditController->getParameterCount(); i < count; ++i)
   {
      Vst::ParameterInfo parameterInfo { };
      if(mEditController->getParameterInfo(i, parameterInfo) == kResultOk)
      {
         if(parameterInfo.flags & Vst::ParameterInfo::kCanAutomate)
            return true;
      }
   }
 
   return false;
}

References mEditController.

◆ SupportsRealtime()

bool VST3Effect::SupportsRealtime ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 323 of file VST3Effect.cpp.

{
   // TODO reenable after achieving statelessness
   // Also, as with old VST, perhaps only for plug-ins known not to be
   // just generators
   return false;
//   return true;
}

◆ SyncParameters()

void VST3Effect::SyncParameters ( EffectSettings & ) const

private

Definition at line 1157 of file VST3Effect.cpp.

{
   using namespace Steinberg;
 
   if(mComponentHandler != nullptr)
   {
      for(int i = 0, count = mEditController->getParameterCount(); i < count; ++i)
      {
         Vst::ParameterInfo parameterInfo { };
         if(mEditController->getParameterInfo(i, parameterInfo) == kResultOk)
         {
            if(parameterInfo.flags & Vst::ParameterInfo::kIsReadOnly)
               continue;
 
            if(mComponentHandler->beginEdit(parameterInfo.id) == kResultOk)
            {
               auto cleanup = finally([&]{ mComponentHandler->endEdit(parameterInfo.id); });
               mComponentHandler->performEdit(parameterInfo.id, mEditController->getParamNormalized(parameterInfo.id));
            }
         }
      }
   }
}

References mComponentHandler, and mEditController.

Referenced by LoadUserPreset(), PopulateUI(), ProcessInitialize(), and RealtimeInitialize().

Here is the caller graph for this function:

◆ ValidateUI()

bool VST3Effect::ValidateUI ( EffectSettings & settings )

overridevirtual

Reimplemented from Effect.

Definition at line 932 of file VST3Effect.cpp.

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

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

Here is the call graph for this function:

Member Data Documentation

◆ mAudioProcessor

Steinberg::IPtr<Steinberg::Vst::IAudioProcessor> VST3Effect::mAudioProcessor

private

Definition at line 53 of file VST3Effect.h.

Referenced by Initialize(), ProcessFinalize(), and ProcessInitialize().

◆ mComponentConnectionProxy

Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> VST3Effect::mComponentConnectionProxy

private

Definition at line 60 of file VST3Effect.h.

Referenced by VST3Effect(), and ~VST3Effect().

◆ mComponentHandler

Steinberg::IPtr<internal::ComponentHandler> VST3Effect::mComponentHandler

private

Definition at line 65 of file VST3Effect.h.

Referenced by LoadFactoryDefaults(), LoadSettings(), PopulateUI(), ProcessBlock(), RealtimeProcessStart(), SyncParameters(), and VST3Effect().

◆ mControllerConnectionProxy

Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> VST3Effect::mControllerConnectionProxy

private

Definition at line 61 of file VST3Effect.h.

Referenced by VST3Effect(), and ~VST3Effect().

◆ mDuration

NumericTextCtrl* VST3Effect::mDuration { nullptr }

private

Definition at line 67 of file VST3Effect.h.

Referenced by PopulateUI(), and ValidateUI().

◆ mEditController

Steinberg::IPtr<Steinberg::Vst::IEditController> VST3Effect::mEditController

private

Definition at line 64 of file VST3Effect.h.

Referenced by ExportPresets(), IsInteractive(), LoadFactoryDefaults(), LoadPreset(), LoadSettings(), LoadUserPreset(), LoadVSTUI(), PopulateUI(), SaveSettings(), SaveUserPreset(), SupportsAutomation(), SyncParameters(), VST3Effect(), and ~VST3Effect().

◆ mEffectClassInfo

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

private

Definition at line 55 of file VST3Effect.h.

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

◆ mEffectComponent

Steinberg::IPtr<Steinberg::Vst::IComponent> VST3Effect::mEffectComponent

private

Definition at line 52 of file VST3Effect.h.

Referenced by ExportPresets(), GetAudioInCount(), GetAudioOutCount(), Initialize(), LoadPreset(), LoadUserPreset(), ProcessBlock(), ProcessFinalize(), ProcessInitialize(), SaveUserPreset(), VST3Effect(), and ~VST3Effect().

◆ mFactoryPresets

RegistryPaths VST3Effect::mFactoryPresets

mutableprivate

Definition at line 79 of file VST3Effect.h.

Referenced by GetFactoryPresets(), and LoadFactoryPreset().

◆ mInitialDelay

sampleCount VST3Effect::mInitialDelay { 0 }

private

Definition at line 83 of file VST3Effect.h.

Referenced by GetLatency(), and ProcessInitialize().

◆ mModule

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

private

Definition at line 48 of file VST3Effect.h.

Referenced by GetPath(), Initialize(), and VST3Effect().

◆ mParent

wxWindow* VST3Effect::mParent { nullptr }

private

Definition at line 66 of file VST3Effect.h.

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

◆ mPendingChanges

internal::ComponentHandler::PendingChangesPtr VST3Effect::mPendingChanges

private

Definition at line 73 of file VST3Effect.h.

Referenced by RealtimeProcess(), and RealtimeProcessStart().

◆ mPlainUI

VST3ParametersWindow* VST3Effect::mPlainUI { nullptr }

private

Definition at line 69 of file VST3Effect.h.

Referenced by CloseUI(), LoadFactoryDefaults(), LoadPreset(), LoadSettings(), LoadUserPreset(), and PopulateUI().

◆ mPlugView

Steinberg::IPtr<Steinberg::IPlugView> VST3Effect::mPlugView

private

Definition at line 63 of file VST3Effect.h.

Referenced by CloseUI(), IsGraphicalUI(), LoadVSTUI(), and OnEffectWindowResize().

◆ mRealtimeGroupProcessors

std::vector<std::shared_ptr<VST3Effect> > VST3Effect::mRealtimeGroupProcessors

private

Definition at line 75 of file VST3Effect.h.

Referenced by GetLatency(), RealtimeAddProcessor(), RealtimeProcess(), RealtimeResume(), and RealtimeSuspend().

◆ mRescanFactoryPresets

bool VST3Effect::mRescanFactoryPresets { true }

mutableprivate

Definition at line 78 of file VST3Effect.h.

Referenced by GetFactoryPresets().

◆ mSetup

Steinberg::Vst::ProcessSetup VST3Effect::mSetup

private

Definition at line 54 of file VST3Effect.h.

Referenced by GetBlockSize(), Initialize(), PopulateUI(), ProcessBlock(), ProcessInitialize(), RealtimeInitialize(), SetBlockSize(), and VST3Effect().

◆ mUseLatency

bool VST3Effect::mUseLatency { true }

private

Definition at line 82 of file VST3Effect.h.

Referenced by GetLatency(), ReloadUserOptions(), and VST3Effect().

◆ mUserBlockSize

size_t VST3Effect::mUserBlockSize { 8192 }

private

Definition at line 81 of file VST3Effect.h.

Referenced by Initialize(), ReloadUserOptions(), SetBlockSize(), and VST3Effect().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VST3Effect() [1/2]

◆ VST3Effect() [2/2]

◆ ~VST3Effect()

Member Function Documentation

◆ CanExportPresets()

◆ CloseUI()

◆ DoMakeInstance()

◆ ExportPresets()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetFamilySymbol()

◆ GetLatency()

◆ GetMidiInCount()

◆ GetMidiOutCount()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ ImportPresets()

◆ Initialize()

◆ InitializePlugin()

◆ IsDefault()

◆ IsGraphicalUI()

◆ IsInteractive()

◆ LoadFactoryDefaults()

◆ LoadFactoryPreset()

◆ LoadPreset()

◆ LoadSettings()

◆ LoadUserPreset()

◆ LoadVSTUI()

◆ MakeInstance()

◆ OnEffectWindowResize()

◆ PopulateUI()

◆ ProcessBlock()

◆ ProcessFinalize()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

◆ ReloadUserOptions()

◆ SaveSettings()

◆ SaveUserPreset()

◆ SetBlockSize()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

◆ SupportsRealtime()

◆ SyncParameters()

◆ ValidateUI()

Member Data Documentation

◆ mAudioProcessor

◆ mComponentConnectionProxy

◆ mComponentHandler

◆ mControllerConnectionProxy

◆ mDuration

◆ mEditController

◆ mEffectClassInfo

◆ mEffectComponent

◆ mFactoryPresets

◆ mInitialDelay

◆ mModule

◆ mParent