![]() |
Audacity 3.2.0
|
An Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class. More...
#include <LadspaEffect.h>
Classes | |
struct | Instance |
struct | Validator |
Public Member Functions | |
LadspaEffect (const wxString &path, int index) | |
virtual | ~LadspaEffect () |
EffectSettings | MakeSettings () const override |
bool | CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override |
Update one settings object from another. More... | |
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... | |
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... | |
int | ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal) override |
bool | InitializePlugin () |
bool | InitializeControls (LadspaEffectSettings &settings) const |
std::shared_ptr< EffectInstance > | MakeInstance () const override |
Make an object maintaining short-term state of an Effect. More... | |
std::unique_ptr< EffectUIValidator > | PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override |
Add controls to effect panel; always succeeds. More... | |
bool | IsGraphicalUI () override |
bool | CanExportPresets () override |
void | ExportPresets (const EffectSettings &settings) const override |
void | ImportPresets (EffectSettings &settings) override |
bool | HasOptions () override |
void | ShowOptions () override |
![]() | |
EffectSettings | MakeSettings () const override |
bool | CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override |
![]() | |
~PerTrackEffect () override | |
![]() | |
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, EffectInstance &instance, 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 () |
![]() | |
EffectBase () | |
~EffectBase () override | |
![]() | |
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 |
![]() | |
EffectPlugin & | operator= (EffectPlugin &)=delete |
virtual | ~EffectPlugin () |
virtual const EffectSettingsManager & | GetDefinition () const =0 |
virtual int | ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, EffectInstance &instance, 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... | |
![]() | |
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... | |
![]() | |
virtual | ~EffectSettingsManager () |
virtual bool | VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) |
virtual bool | VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const |
![]() | |
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... | |
![]() | |
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 bool | LoadUseLatency (const EffectDefinitionInterface &effect) |
static bool | SaveUseLatency (const EffectDefinitionInterface &effect, bool value) |
![]() | |
static LadspaEffectSettings & | GetSettings (EffectSettings &settings) |
Assume settings originated from MakeSettings() and copies thereof. More... | |
static const LadspaEffectSettings & | GetSettings (const EffectSettings &settings) |
Assume settings originated from MakeSettings() and copies thereof. More... | |
static LadspaEffectSettings * | FetchParameters (PerTrackEffect &, EffectSettings &s) |
![]() | |
static Effect * | FetchParameters (Effect &e, EffectSettings &) |
static void | IncEffectCounter () |
![]() | |
static Identifier | GetSquashedName (const Identifier &ident) |
A utility that strips spaces and CamelCases a name. More... | |
Private Member Functions | |
bool | Load () |
void | Unload () |
bool | LoadParameters (const RegistryPath &group, EffectSettings &settings) const |
bool | SaveParameters (const RegistryPath &group, const EffectSettings &settings) const |
LADSPA_Handle | InitInstance (float sampleRate, LadspaEffectSettings &settings) const |
void | FreeInstance (LADSPA_Handle handle) const |
Private Attributes | |
const wxString | mPath |
const int | mIndex |
wxDynamicLibrary | mLib |
const LADSPA_Descriptor * | mData {} |
wxString | pluginName |
double | mSampleRate { 44100.0 } |
size_t | mBlockSize { 0 } |
bool | mInteractive { false } |
unsigned | mAudioIns { 0 } |
ArrayOf< unsigned long > | mInputPorts |
unsigned | mAudioOuts { 0 } |
ArrayOf< unsigned long > | mOutputPorts |
int | mNumInputControls { 0 } |
int | mNumOutputControls { 0 } |
bool | mUseLatency { true } |
int | mLatencyPort { -1 } |
Friends | |
class | LadspaEffectsModule |
Additional Inherited Members | |
![]() | |
enum | : long { DefaultMessageBoxStyle = wxOK | wxCENTRE } |
![]() | |
using | EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess > |
![]() | |
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>") |
![]() | |
bool | DoPass1 () const |
bool | DoPass2 () const |
bool | Process (EffectInstance &instance, EffectSettings &settings) const |
![]() | |
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) |
![]() | |
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 |
![]() | |
sampleCount | mSampleCnt {} |
![]() | |
wxWeakRef< wxDialog > | mHostUIDialog |
This smart pointer tracks the lifetime of the dialog. More... | |
wxWindow * | mUIParent {} |
![]() | |
BasicUI::ProgressDialog * | mProgress {} |
double | mProjectRate {} |
WaveTrackFactory * | mFactory {} |
std::shared_ptr< TrackList > | mOutputTracks |
double | mT0 {} |
double | mT1 {} |
wxArrayString | mPresetNames |
unsigned | mUIFlags { 0 } |
![]() | |
friend | EffectUIValidator |
friend | DefaultEffectUIValidator |
![]() | |
static int | nEffectsDone = 0 |
An Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class.
Definition at line 53 of file LadspaEffect.h.
LadspaEffect::LadspaEffect | ( | const wxString & | path, |
int | index | ||
) |
Definition at line 644 of file LadspaEffect.cpp.
|
virtual |
Definition at line 650 of file LadspaEffect.cpp.
|
overridevirtual |
Reimplemented from Effect.
Definition at line 1455 of file LadspaEffect.cpp.
|
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
src | settings to copy from |
dst | settings to copy into |
Reimplemented from EffectSettingsManager.
Definition at line 123 of file LadspaEffect.cpp.
References LadspaEffectSettings::controls, and EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings().
|
overridevirtual |
|
private |
Definition at line 1588 of file LadspaEffect.cpp.
References _LADSPA_Descriptor::cleanup, _LADSPA_Descriptor::deactivate, and mData.
|
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 899 of file LadspaEffect.cpp.
References mAudioIns.
|
overridevirtual |
How many output buffers to allocate at once.
Reimplemented from Effect.
Definition at line 904 of file LadspaEffect.cpp.
References mAudioOuts.
|
overridevirtual |
Reimplemented from Effect.
Definition at line 678 of file LadspaEffect.cpp.
References _LADSPA_Descriptor::Copyright, LAT1CTOWX, mData, and Verbatim().
|
overridevirtual |
Report names of factory presets.
Reimplemented from Effect.
Definition at line 1102 of file LadspaEffect.cpp.
|
overridevirtual |
Report identifier and user-visible name of the effect protocol.
Reimplemented from Effect.
Definition at line 707 of file LadspaEffect.cpp.
References LADSPAEFFECTS_FAMILY.
|
overridevirtual |
Function that has not yet found a use.
Reimplemented from EffectInstanceFactory.
Definition at line 909 of file LadspaEffect.cpp.
|
overridevirtual |
Function that has not yet found a use.
Reimplemented from EffectInstanceFactory.
Definition at line 914 of file LadspaEffect.cpp.
|
overridevirtual |
|
overridevirtual |
Reimplemented from Effect.
Definition at line 663 of file LadspaEffect.cpp.
References LAT1CTOWX, mData, and _LADSPA_Descriptor::Name.
|
overridevirtual |
Type determines how it behaves.
Reimplemented from Effect.
Definition at line 687 of file LadspaEffect.cpp.
References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, mAudioIns, and mAudioOuts.
Referenced by PopulateOrExchange(), ShowClientInterface(), and SupportsRealtime().
|
overridevirtual |
Reimplemented from Effect.
Definition at line 668 of file LadspaEffect.cpp.
References LAT1CTOWX, _LADSPA_Descriptor::Maker, and mData.
|
overridevirtual |
|
overridevirtual |
Reimplemented from Effect.
Definition at line 1468 of file LadspaEffect.cpp.
|
overridevirtual |
bool LadspaEffect::InitializeControls | ( | LadspaEffectSettings & | settings | ) | const |
Definition at line 837 of file LadspaEffect.cpp.
References anonymous_namespace{LadspaEffect.cpp}::InputControlPortDefaultValue(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, mData, mSampleRate, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortRangeHints, and settings().
Referenced by MakeSettings().
bool LadspaEffect::InitializePlugin | ( | ) |
Definition at line 797 of file LadspaEffect.cpp.
References LADSPA_IS_PORT_AUDIO, LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, LADSPA_IS_PORT_OUTPUT, Load(), LoadUseLatency(), mAudioIns, mAudioOuts, mData, mInputPorts, mInteractive, mLatencyPort, mNumInputControls, mNumOutputControls, mOutputPorts, mUseLatency, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortNames, and ArrayOf< X >::reinit().
Referenced by LadspaEffectsModule::DiscoverPluginsAtPath().
|
private |
Definition at line 1568 of file LadspaEffect.cpp.
References _LADSPA_Descriptor::activate, _LADSPA_Descriptor::connect_port, _LADSPA_Descriptor::instantiate, LADSPA_IS_PORT_CONTROL, mData, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, and settings().
|
overridevirtual |
Whether the effect sorts "above the line" in the menus.
Reimplemented from Effect.
Definition at line 717 of file LadspaEffect.cpp.
|
overridevirtual |
Reimplemented from Effect.
Definition at line 1440 of file LadspaEffect.cpp.
|
overridevirtual |
Whether the effect needs a dialog for entry of settings.
Reimplemented from Effect.
Definition at line 712 of file LadspaEffect.cpp.
References mInteractive.
|
private |
Definition at line 1483 of file LadspaEffect.cpp.
References mData, mIndex, mLib, and mPath.
Referenced by InitializePlugin().
|
overridevirtual |
Change settings to the preset whose name is GetFactoryPresets()[id]
Reimplemented from Effect.
Definition at line 1107 of file LadspaEffect.cpp.
|
private |
Definition at line 1530 of file LadspaEffect.cpp.
References PluginSettings::GetConfig(), LoadSettings(), PluginSettings::Private, CommandParameters::SetParameters(), and settings().
Referenced by LoadUserPreset().
|
overridevirtual |
Restore settings from keys and values.
Reimplemented from Effect.
Definition at line 1071 of file LadspaEffect.cpp.
References LadspaEffectSettings::controls, EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, LAT1CTOWX, mData, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortNames, and settings().
Referenced by LoadParameters().
|
static |
Definition at line 468 of file LadspaEffect.cpp.
References PluginSettings::GetConfig(), OptionsKey, PluginSettings::Shared, and UseLatencyKey.
Referenced by InitializePlugin().
|
overridevirtual |
Change settings to a user-named preset.
Reimplemented from Effect.
Definition at line 1090 of file LadspaEffect.cpp.
References LoadParameters(), name, and settings().
|
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.
settings | may be assumed to have a lifetime enclosing the instance's |
Implements EffectInstanceFactory.
Definition at line 894 of file LadspaEffect.cpp.
|
overridevirtual |
Produce an object holding new, independent settings
Default implementation returns an empty any
Reimplemented from EffectSettingsManager.
Definition at line 116 of file LadspaEffect.cpp.
References EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings(), InitializeControls(), mData, and _LADSPA_Descriptor::PortCount.
|
overridevirtual |
Add controls to effect panel; always succeeds.
Reimplemented from Effect.
Definition at line 1431 of file LadspaEffect.cpp.
References GetType(), mSampleRate, and S.
|
private |
Definition at line 1549 of file LadspaEffect.cpp.
References CommandParameters::GetParameters(), PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), and settings().
Referenced by SaveUserPreset().
|
overridevirtual |
Store settings as keys and values.
Reimplemented from Effect.
Definition at line 1058 of file LadspaEffect.cpp.
References LadspaEffectSettings::controls, EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, LAT1CTOWX, mData, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortNames, and settings().
Referenced by SaveParameters().
|
static |
Definition at line 476 of file LadspaEffect.cpp.
References OptionsKey, PluginSettings::SetConfig(), PluginSettings::Shared, and UseLatencyKey.
Referenced by LadspaEffectOptionsDialog::OnOk().
|
overridevirtual |
Save settings in the configuration file as a user-named preset.
Reimplemented from Effect.
Definition at line 1096 of file LadspaEffect.cpp.
References name, SaveParameters(), and settings().
|
overridevirtual |
Reimplemented from Effect.
Definition at line 1042 of file LadspaEffect.cpp.
References EffectTypeAnalyze, GetType(), and SupportsRealtime().
|
overridevirtual |
Reimplemented from Effect.
Definition at line 1473 of file LadspaEffect.cpp.
References Effect::mUIParent, and mUseLatency.
|
overridevirtual |
Whether the effect has any automatable controls.
Reimplemented from Effect.
Definition at line 727 of file LadspaEffect.cpp.
References mNumInputControls.
|
overridevirtual |
Whether the effect supports realtime previewing (while audio is playing).
Reimplemented from Effect.
Definition at line 722 of file LadspaEffect.cpp.
References EffectTypeGenerate, and GetType().
Referenced by ShowClientInterface().
|
private |
Definition at line 1522 of file LadspaEffect.cpp.
References mLib.
|
friend |
Definition at line 170 of file LadspaEffect.h.
|
private |
Definition at line 156 of file LadspaEffect.h.
Referenced by GetAudioInCount(), GetType(), and InitializePlugin().
|
private |
Definition at line 160 of file LadspaEffect.h.
Referenced by GetAudioOutCount(), GetType(), and InitializePlugin().
|
private |
Definition at line 152 of file LadspaEffect.h.
|
private |
Definition at line 147 of file LadspaEffect.h.
Referenced by FreeInstance(), GetDescription(), GetSymbol(), GetVendor(), InitializeControls(), InitializePlugin(), InitInstance(), Load(), LoadSettings(), MakeSettings(), and SaveSettings().
|
private |
Definition at line 144 of file LadspaEffect.h.
|
private |
Definition at line 158 of file LadspaEffect.h.
Referenced by InitializePlugin().
|
private |
Definition at line 154 of file LadspaEffect.h.
Referenced by InitializePlugin(), and IsInteractive().
|
private |
Definition at line 168 of file LadspaEffect.h.
Referenced by InitializePlugin().
|
private |
Definition at line 146 of file LadspaEffect.h.
|
private |
Definition at line 164 of file LadspaEffect.h.
Referenced by InitializePlugin(), and SupportsAutomation().
|
private |
Definition at line 165 of file LadspaEffect.h.
Referenced by InitializePlugin().
|
private |
Definition at line 162 of file LadspaEffect.h.
Referenced by InitializePlugin().
|
private |
Definition at line 143 of file LadspaEffect.h.
|
private |
Definition at line 151 of file LadspaEffect.h.
Referenced by InitializeControls(), LadspaEffect::Validator::OnSlider(), LadspaEffect::Validator::OnTextCtrl(), PopulateOrExchange(), LadspaEffect::Validator::PopulateUI(), and LadspaEffect::Instance::ProcessInitialize().
|
private |
Definition at line 167 of file LadspaEffect.h.
Referenced by InitializePlugin(), and ShowOptions().
|
private |
Definition at line 149 of file LadspaEffect.h.