Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
VST3Effect Class Referencefinal

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

#include <VST3Effect.h>

Inheritance diagram for VST3Effect:
[legend]
Collaboration diagram for VST3Effect:
[legend]

Public Member Functions

 VST3Effect (std::shared_ptr< VST3::Hosting::Module > module, VST3::Hosting::ClassInfo effectClassInfo)
 
 VST3Effect (const VST3Effect &)=delete
 
 VST3Effect (VST3Effect &&)=delete
 
VST3Effectoperator= (const VST3Effect &)=delete
 
VST3Effectoperator= (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...
 
OptionalMessage LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
OptionalMessage LoadFactoryPreset (int id, EffectSettings &settings) const override
 
int ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
std::unique_ptr< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
 Adds controls to a panel that is given as the parent window of S More...
 
bool CanExportPresets () const override
 Whether the effect supports export of presets to files, and importing too. More...
 
void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override
 
OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override
 
bool HasOptions () const override
 
void ShowOptions (const EffectPlugin &plugin) const override
 
EffectSettings MakeSettings () const override
 
bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
 Update one settings object from another. More...
 
- Public Member Functions inherited from StatelessPerTrackEffect
 ~StatelessPerTrackEffect () override
 
- Public Member Functions inherited from PerTrackEffect
 ~PerTrackEffect () override
 
- Public Member Functions inherited from Effect
 Effect ()
 
virtual ~Effect ()
 
PluginPath GetPath () const override
 
bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
 
bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
 
ComponentInterfaceSymbol GetSymbol () const override
 
VendorSymbol GetVendor () const override
 
wxString GetVersion () const override
 
TranslatableString GetDescription () const override
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
EffectFamilySymbol GetFamily () const override
 Report identifier and user-visible name of the effect protocol. More...
 
bool IsInteractive () const override
 Whether the effect needs a dialog for entry of settings. More...
 
bool IsDefault () const override
 Whether the effect sorts "above the line" in the menus. More...
 
RealtimeSince RealtimeSupport () const override
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsAutomation () const override
 Whether the effect has any automatable controls. More...
 
bool SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
 Store settings as keys and values. More...
 
bool LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
 Restore settings from keys and values. More...
 
OptionalMessage LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
OptionalMessage LoadFactoryPreset (int id, EffectSettings &settings) const override
 
OptionalMessage LoadFactoryDefaults (EffectSettings &settings) const override
 
virtual const EffectParameterMethodsParameters () const
 
bool CanExportPresets () const override
 Whether the effect supports export of presets to files, and importing too. More...
 
bool HasOptions () const override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatSymbol GetSelectionFormat ()
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings)
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
void SetTracks (TrackList *pTracks)
 
bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual bool HasOptions () const =0
 
virtual bool CanExportPresets () const =0
 Whether the effect supports export of presets to files, and importing too. More...
 
virtual const EffectSettingsManagerGetDefinition () const =0
 
virtual void Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
 Calculate temporary tracks of limited length with effect applied and play. More...
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0
 
virtual bool IsBatchProcessing () const =0
 
virtual void SetBatchProcessing ()=0
 
virtual void UnsetBatchProcessing ()=0
 
virtual bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 
- Public Member Functions inherited from EffectInstanceFactory
virtual ~EffectInstanceFactory ()
 
virtual std::shared_ptr< EffectInstanceMakeInstance () const =0
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from EffectSettingsManager
virtual ~EffectSettingsManager ()
 
virtual bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
 
virtual bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
 
virtual std::unique_ptr< EffectOutputsMakeOutputs () const
 Produce an object to hold values to send to effect output meters. More...
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType () const =0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification () const
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily () const =0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive () const =0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault () const =0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual RealtimeSince RealtimeSupport () const =0
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsRealtime () const
 
virtual bool SupportsAutomation () const =0
 Whether the effect has any automatable controls. More...
 
virtual bool EnablesDebug () const
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage () const
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage () const
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus () const
 Default is false. More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 
std::unique_ptr< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
 Adds controls to a panel that is given as the parent window of S More...
 
virtual std::unique_ptr< EffectEditorMakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
 Called only from PopulateUI, to add controls to effect panel. More...
 
- Public Member Functions inherited from BasicEffectUIServices
int ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override
 
void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override
 
OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override
 
void ShowOptions (const EffectPlugin &plugin) const override
 
bool ValidateUI (const EffectPlugin &context, EffectSettings &) const override
 
bool CloseUI () const override
 
- Public Member Functions inherited from EffectUIServices
virtual ~EffectUIServices ()
 
virtual int ShowHostInterface (EffectPlugin &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)
 
virtual int ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0
 
virtual std::unique_ptr< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0
 
virtual OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0
 
virtual void ShowOptions (const EffectPlugin &plugin) const =0
 
virtual bool ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0
 
virtual bool CloseUI () const =0
 

Static Public Member Functions

static EffectFamilySymbol GetFamilySymbol ()
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
static void IncEffectCounter ()
 
- Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier GetSquashedName (const Identifier &ident)
 A utility that strips spaces and CamelCases a name. More...
 
- Static Public Member Functions inherited from EffectUIServices
static int DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
 

Private Member Functions

virtual std::unique_ptr< EffectEditorMakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const final
 Will never be called. More...
 
void LoadPreset (const wxString &id, EffectSettings &settings) const
 

Private Attributes

std::shared_ptr< VST3::Hosting::Module > mModule
 
const VST3::Hosting::ClassInfo mEffectClassInfo
 
bool mRescanFactoryPresets { true }
 
RegistryPaths mFactoryPresetNames
 
std::vector< wxString > mFactoryPresetIDs
 

Friends

class VST3PluginValidator
 

Additional Inherited Members

- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
using InstancePointer = std::shared_ptr< EffectInstanceEx >
 
using InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , After_3_1 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Public Types inherited from EffectUIServices
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Attributes inherited from EffectBase
TrackListmTracks {}
 
- 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 CheckWhetherSkipEffect (const EffectSettings &settings) const override
 Default implementation returns false. More...
 
double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
 Default implementation returns previewLength More...
 
bool TotalProgress (double frac, const TranslatableString &={}) const
 
bool TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const
 
bool TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const
 
int GetNumWaveTracks () const
 
int GetNumWaveGroups () const
 
void GetBounds (const WaveTrack &track, const WaveTrack *pRight, sampleCount *start, sampleCount *len)
 
void CopyInputTracks (bool allSyncLockSelected=false)
 
TrackAddToOutputTracks (const std::shared_ptr< Track > &t)
 
- Protected Member Functions inherited from EffectBase
virtual std::any BeginPreview (const EffectSettings &settings)
 Called when Preview() starts, to allow temporary effect state changes. More...
 
void Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
 Calculate temporary tracks of limited length with effect applied and play. More...
 
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
void IncludeNotSelectedPreviewTracks (bool includeNotSelected)
 
void ReplaceProcessedTracks (const bool bGoodResult)
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from EffectBase
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
std::shared_ptr< TrackListmOutputTracks
 
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 46 of file VST3Effect.cpp.

49 : mModule(std::move(module)), mEffectClassInfo(std::move(effectClassInfo))
50{
51}
const VST3::Hosting::ClassInfo mEffectClassInfo
Definition: VST3Effect.h:45
std::shared_ptr< VST3::Hosting::Module > mModule
Definition: VST3Effect.h:44

◆ VST3Effect() [2/3]

VST3Effect::VST3Effect ( const VST3Effect )
delete

◆ VST3Effect() [3/3]

VST3Effect::VST3Effect ( VST3Effect &&  )
delete

◆ ~VST3Effect()

VST3Effect::~VST3Effect ( )
override

Definition at line 39 of file VST3Effect.cpp.

40{
41 using namespace Steinberg;
42
43 CloseUI();
44}
bool CloseUI() const override

References BasicEffectUIServices::CloseUI().

Here is the call graph for this function:

Member Function Documentation

◆ CanExportPresets()

bool VST3Effect::CanExportPresets ( ) const
overridevirtual

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

Implements EffectPlugin.

Definition at line 226 of file VST3Effect.cpp.

227{
228 return true;
229}

◆ CopySettingsContents()

bool VST3Effect::CopySettingsContents ( const EffectSettings src,
EffectSettings dst 
) 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
srcsettings to copy from
dstsettings to copy into
copyDirectiondirection in which copy is performed
Returns
success

Reimplemented from EffectSettingsManager.

Definition at line 305 of file VST3Effect.cpp.

306{
308 return true;
309}
static void CopySettingsContents(const EffectSettings &src, EffectSettings &dst)

References VST3Wrapper::CopySettingsContents().

Here is the call graph for this function:

◆ ExportPresets()

void VST3Effect::ExportPresets ( const EffectPlugin plugin,
const EffectSettings settings 
) const
overridevirtual

Reimplemented from BasicEffectUIServices.

Definition at line 231 of file VST3Effect.cpp.

233{
234 using namespace Steinberg;
235
236 const auto path = SelectFile(FileNames::Operation::Presets,
237 XO("Save VST3 Preset As:"),
238 wxEmptyString,
239 wxEmptyString,
240 wxT(".vstpreset"),
241 {
242 { XO("VST3 preset file"), { wxT("vstpreset") }, true }
243 },
244 wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
245 NULL);
246
247 if (path.empty())
248 return;
249
250 auto wrapper = std::make_unique<VST3Wrapper>(*mModule, mEffectClassInfo);
251 wrapper->InitializeComponents();
252
253 auto dummy = EffectSettings { settings };
254 wrapper->FetchSettings(dummy);
255 wrapper->SavePresetToFile(path);
256}
wxT("CloseDown"))
XO("Cut/Copy/Paste")
FilePath SelectFile(FileNames::Operation op, const TranslatableString &message, const FilePath &default_path, const FilePath &default_filename, const FileExtension &default_extension, const FileTypes &fileTypes, int flags, wxWindow *parent)
Definition: SelectFile.cpp:17
static Settings & settings()
Definition: TrackInfo.cpp:87
Externalized state of a plug-in.

References mEffectClassInfo, mModule, SelectFile(), settings(), wxT(), and XO().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString VST3Effect::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 73 of file VST3Effect.cpp.

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

References mEffectClassInfo, and XO().

Here is the call graph for this function:

◆ GetFactoryPresets()

RegistryPaths VST3Effect::GetFactoryPresets ( ) const
overridevirtual

Report names of factory presets.

Implements EffectSettingsManager.

Definition at line 146 of file VST3Effect.cpp.

147{
149 return mFactoryPresetNames;
150
152 for(auto& desc : wrapper.FindFactoryPresets())
153 {
154 mFactoryPresetNames.push_back(desc.displayName);
155 mFactoryPresetIDs.push_back(desc.id);
156 }
157 mRescanFactoryPresets = false;
158
159 return mFactoryPresetNames;
160}
const TranslatableString desc
Definition: ExportPCM.cpp:55
std::vector< wxString > mFactoryPresetIDs
Definition: VST3Effect.h:50
bool mRescanFactoryPresets
Definition: VST3Effect.h:48
RegistryPaths mFactoryPresetNames
Definition: VST3Effect.h:49

References desc, VST3Wrapper::FindFactoryPresets(), mEffectClassInfo, mFactoryPresetIDs, mFactoryPresetNames, mModule, 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.

Implements EffectDefinitionInterface.

Definition at line 92 of file VST3Effect.cpp.

93{
95}
static EffectFamilySymbol GetFamilySymbol()
Definition: VST3Effect.cpp:34

References GetFamilySymbol().

Here is the call graph for this function:

◆ GetFamilySymbol()

EffectFamilySymbol VST3Effect::GetFamilySymbol ( )
static

Definition at line 34 of file VST3Effect.cpp.

35{
36 return XO("VST3");
37}

References XO().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetPath()

PluginPath VST3Effect::GetPath ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 53 of file VST3Effect.cpp.

54{
55 return VST3Utils::MakePluginPathString( { mModule->getPath() }, mEffectClassInfo.ID().toString());
56}
static wxString MakePluginPathString(const wxString &modulePath, const std::string &effectUIDString)
Definition: VST3Utils.cpp:70

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

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol VST3Effect::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 58 of file VST3Effect.cpp.

59{
60 return wxString { mEffectClassInfo.name() };
61}

References mEffectClassInfo.

◆ GetType()

EffectType VST3Effect::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 79 of file VST3Effect.cpp.

80{
81 using namespace Steinberg::Vst::PlugType;
82 if(mEffectClassInfo.subCategoriesString() == kFxGenerator)
83 return EffectTypeGenerate;
84 const auto& cats = mEffectClassInfo.subCategories();
85
86 if(std::find(cats.begin(), cats.end(), kFx) != cats.end())
87 return EffectTypeProcess;
88
89 return EffectTypeNone;
90}
@ EffectTypeGenerate
@ EffectTypeNone
@ EffectTypeProcess

References EffectTypeGenerate, EffectTypeNone, EffectTypeProcess, and mEffectClassInfo.

Referenced by RealtimeSupport().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VST3Effect::GetVendor ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 63 of file VST3Effect.cpp.

64{
65 return wxString { mEffectClassInfo.vendor() };
66}

References mEffectClassInfo.

◆ GetVersion()

wxString VST3Effect::GetVersion ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 68 of file VST3Effect.cpp.

69{
70 return mEffectClassInfo.version();
71}

References mEffectClassInfo.

◆ HasOptions()

bool VST3Effect::HasOptions ( ) const
overridevirtual

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

Implements EffectPlugin.

Definition at line 282 of file VST3Effect.cpp.

283{
284 return true;
285}

◆ ImportPresets()

OptionalMessage VST3Effect::ImportPresets ( const EffectPlugin plugin,
EffectSettings settings 
) const
overridevirtual
Returns
nullopt for failure

Reimplemented from BasicEffectUIServices.

Definition at line 258 of file VST3Effect.cpp.

260{
261 using namespace Steinberg;
262
263 const auto path = SelectFile(FileNames::Operation::Presets,
264 XO("Load VST3 preset:"),
265 wxEmptyString,
266 wxEmptyString,
267 wxT(".vstpreset"),
268 {
269 { XO("VST3 preset file"), { wxT("vstpreset") }, true }
270 },
271 wxFD_OPEN | wxRESIZE_BORDER,
272 nullptr
273 );
274 if(path.empty())
275 return {};
276
277 LoadPreset(path, settings);
278
279 return { nullptr };
280}
void LoadPreset(const wxString &id, EffectSettings &settings) const
Definition: VST3Effect.cpp:292

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.

Implements EffectDefinitionInterface.

Definition at line 102 of file VST3Effect.cpp.

103{
104 return false;
105}

◆ IsInteractive()

bool VST3Effect::IsInteractive ( ) const
overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 97 of file VST3Effect.cpp.

98{
99 return true;
100}

◆ LoadFactoryPreset()

OptionalMessage VST3Effect::LoadFactoryPreset ( int  id,
EffectSettings settings 
) const
overridevirtual

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

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 162 of file VST3Effect.cpp.

163{
164 if(index >= 0 && index < mFactoryPresetIDs.size())
165 {
167 wrapper.InitializeComponents();
168 wrapper.LoadPreset(mFactoryPresetIDs[index]);
169 wrapper.FlushParameters(settings);
170 wrapper.StoreSettings(settings);
171 return { nullptr };
172 }
173 return { };
174}

References VST3Wrapper::FlushParameters(), VST3Wrapper::InitializeComponents(), VST3Wrapper::LoadPreset(), mEffectClassInfo, mFactoryPresetIDs, mModule, settings(), and VST3Wrapper::StoreSettings().

Here is the call graph for this function:

◆ LoadPreset()

void VST3Effect::LoadPreset ( const wxString &  id,
EffectSettings settings 
) const
private

Definition at line 292 of file VST3Effect.cpp.

293{
294 auto wrapper = std::make_unique<VST3Wrapper>(*mModule, mEffectClassInfo);
295 wrapper->InitializeComponents();
296 wrapper->LoadPreset(id);
297 wrapper->StoreSettings(settings);
298}

References mEffectClassInfo, mModule, and settings().

Referenced by ImportPresets().

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

Implements EffectSettingsManager.

Definition at line 126 of file VST3Effect.cpp.

128{
130 return true;
131}
static void LoadSettings(const CommandParameters &parms, EffectSettings &settings)

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

Here is the call graph for this function:

◆ LoadUserPreset()

OptionalMessage VST3Effect::LoadUserPreset ( const RegistryPath name,
EffectSettings settings 
) const
overridevirtual

Change settings to a user-named preset

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 133 of file VST3Effect.cpp.

135{
137}
const TranslatableString name
Definition: Distortion.cpp:76
static OptionalMessage LoadUserPreset(const EffectDefinitionInterface &effect, const RegistryPath &name, EffectSettings &settings)

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

Here is the call graph for this function:

◆ MakeEditor()

std::unique_ptr< EffectEditor > VST3Effect::MakeEditor ( ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access,
const EffectOutputs pOutputs 
) const
finalprivatevirtual

Will never be called.

Will not come here because Effect::PopulateUI is overridden

Implements StatelessEffectUIServices.

Definition at line 217 of file VST3Effect.cpp.

220{
222 assert(false);
223 return nullptr;
224}

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

197{
198 return std::make_shared<VST3Instance>(*this, *mModule, mEffectClassInfo);
199}

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

301{
303}
static EffectSettings 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< EffectEditor > VST3Effect::PopulateUI ( const EffectPlugin plugin,
ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access,
const EffectOutputs pOutputs 
) const
overridevirtual

Adds controls to a panel that is given as the parent window of S

Parameters
Sinterface for adding controls to a panel in a dialog
instanceguaranteed to have a lifetime containing that of the returned object
accessguaranteed to have a lifetime containing that of the returned object
pOutputsnull, or else points to outputs with lifetime containing that of the returned object
Returns
null for failure; else an object invoked to retrieve values of UI controls; it might also hold some state needed to implement event handlers of the controls; it will exist only while the dialog continues to exist

Reimplemented from StatelessEffectUIServices.

Definition at line 201 of file VST3Effect.cpp.

204{
205 bool useGUI { true };
206 GetConfig(*this, PluginSettings::Shared, wxT("Options"),
207 wxT("UseGUI"),
208 useGUI,
209 useGUI);
210
211 const auto vst3instance = dynamic_cast<VST3Instance*>(&instance);
212
213 return std::make_unique<VST3Editor>(S.GetParent(),
214 vst3instance->GetWrapper(), *this, access, useGUI);
215}
#define S(N)
Definition: ToChars.cpp:64
bool GetConfig(const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, Value &var, const Value &defval)

References PluginSettings::GetConfig(), 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?

Implements EffectDefinitionInterface.

Definition at line 107 of file VST3Effect.cpp.

108{
109 return GetType() == EffectTypeProcess
112}
EffectType GetType() const override
Type determines how it behaves.
Definition: VST3Effect.cpp:79

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

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

Implements EffectSettingsManager.

Definition at line 119 of file VST3Effect.cpp.

121{
123 return true;
124}
static void SaveSettings(const EffectSettings &settings, CommandParameters &parms)

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.

Implements EffectSettingsManager.

Definition at line 139 of file VST3Effect.cpp.

141{
143 return true;
144}
static void SaveUserPreset(const EffectDefinitionInterface &effect, const RegistryPath &name, const EffectSettings &settings)

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

Here is the call graph for this function:

◆ ShowClientInterface()

int VST3Effect::ShowClientInterface ( const EffectPlugin plugin,
wxWindow &  parent,
wxDialog &  dialog,
EffectEditor pEditor,
bool  forceModal 
) const
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 BasicEffectUIServices.

Definition at line 176 of file VST3Effect.cpp.

179{
180#ifdef __WXMSW__
181 if(pEditor->IsGraphicalUI())
182 //Not all platforms support window style change.
183 //Plugins that support resizing provide their own handles,
184 //which may overlap with system handle. Not all plugins
185 //support free sizing (e.g. fixed steps or fixed ratio)
186 dialog.SetWindowStyle(dialog.GetWindowStyle() & ~(wxRESIZE_BORDER | wxMAXIMIZE_BOX));
187#endif
188
189 if(forceModal)
190 return dialog.ShowModal();
191
192 dialog.Show();
193 return 0;
194}
virtual bool IsGraphicalUI()

References EffectEditor::IsGraphicalUI().

Here is the call graph for this function:

◆ ShowOptions()

void VST3Effect::ShowOptions ( const EffectPlugin plugin) const
overridevirtual

Reimplemented from BasicEffectUIServices.

Definition at line 287 of file VST3Effect.cpp.

288{
289 VST3OptionsDialog{ *this }.ShowModal();
290}

◆ SupportsAutomation()

bool VST3Effect::SupportsAutomation ( ) const
overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 114 of file VST3Effect.cpp.

115{
116 return true;
117}

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

◆ mFactoryPresetIDs

std::vector<wxString> VST3Effect::mFactoryPresetIDs
mutableprivate

Definition at line 50 of file VST3Effect.h.

Referenced by GetFactoryPresets(), and LoadFactoryPreset().

◆ mFactoryPresetNames

RegistryPaths VST3Effect::mFactoryPresetNames
mutableprivate

Definition at line 49 of file VST3Effect.h.

Referenced by GetFactoryPresets().

◆ mModule

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

◆ mRescanFactoryPresets

bool VST3Effect::mRescanFactoryPresets { true }
mutableprivate

Definition at line 48 of file VST3Effect.h.

Referenced by GetFactoryPresets().


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