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

An Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class. More...

#include <LadspaEffect.h>

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

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, SettingsCopyDirection copyDirection) 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...
 
RealtimeSince RealtimeSupport () const override
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsAutomation () const override
 Whether the effect has any automatable controls. More...
 
bool SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
 Store settings as keys and values. More...
 
bool LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
 Restore settings from keys and values. More...
 
bool LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 Change settings to a user-named preset. More...
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
bool LoadFactoryPreset (int id, EffectSettings &settings) const override
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override
 
bool InitializePlugin ()
 
bool FullyInitializePlugin ()
 
bool InitializeControls (LadspaEffectSettings &settings) const
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
 Add controls to effect panel; always succeeds. More...
 
bool CanExportPresets () override
 
void ExportPresets (const EffectSettings &settings) const override
 
void ImportPresets (EffectSettings &settings) override
 
bool HasOptions () override
 
void ShowOptions () override
 
- Public Member Functions inherited from EffectWithSettings< LadspaEffectSettings, PerTrackEffect >
EffectSettings MakeSettings () const override
 
bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst, SettingsCopyDirection) const 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...
 
bool LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 Change settings to a user-named preset. More...
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
bool LoadFactoryPreset (int id, EffectSettings &settings) const override
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
 
bool LoadFactoryDefaults (EffectSettings &settings) const override
 Change settings back to "factory default". More...
 
virtual const EffectParameterMethodsParameters () const
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override
 
EffectUIClientInterfaceGetEffectUIClientInterface () override
 Returns the EffectUIClientInterface instance for this effect. More...
 
std::unique_ptr< EffectUIValidatorPopulateUI (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 EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatSymbol GetSelectionFormat ()
 
int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
 Usually applies factory to self and given access. More...
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
bool LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
bool TransferDataToWindow (const EffectSettings &settings) override
 Update controls for the settings. More...
 
bool TransferDataFromWindow (EffectSettings &settings) override
 Update the given settings from controls. More...
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings)
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
int MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
 
bool EnableApply (bool enable=true)
 
wxWindow * GetUIParent ()
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
- Public Member Functions inherited from EffectUIClientInterface
virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual bool CanExportPresets ()=0
 
virtual void ExportPresets (const EffectSettings &settings) const =0
 
virtual void ImportPresets (EffectSettings &settings)=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=0
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=0
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual const EffectSettingsManagerGetDefinition () 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 EffectUIClientInterfaceGetEffectUIClientInterface ()=0
 Returns the EffectUIClientInterface instance for this effect. More...
 
virtual void Preview (EffectSettingsAccess &access, bool dryOnly)=0
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual bool LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0
 
virtual bool IsBatchProcessing () const =0
 
virtual void SetBatchProcessing ()=0
 
virtual void UnsetBatchProcessing ()=0
 
virtual bool DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 Unfortunately complicated dual-use function. More...
 
virtual bool TransferDataToWindow (const EffectSettings &settings)=0
 Update controls for the settings. More...
 
virtual bool TransferDataFromWindow (EffectSettings &settings)=0
 Update the given settings from controls. More...
 
- Public Member Functions inherited from EffectInstanceFactory
virtual ~EffectInstanceFactory ()
 
virtual std::shared_ptr< 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
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType () const =0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification () const
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily () const =0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive () const =0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault () const =0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual RealtimeSince RealtimeSupport () const =0
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsRealtime () const
 
virtual bool SupportsAutomation () const =0
 Whether the effect has any automatable controls. More...
 
virtual bool EnablesDebug () const
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage () const
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage () const
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus () const
 Default is false. More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 

Static Public Member Functions

static bool LoadUseLatency (const EffectDefinitionInterface &effect)
 
static bool SaveUseLatency (const EffectDefinitionInterface &effect, bool value)
 
- Static Public Member Functions inherited from EffectWithSettings< LadspaEffectSettings, PerTrackEffect >
static LadspaEffectSettingsGetSettings (EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static const LadspaEffectSettingsGetSettings (const EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static LadspaEffectSettingsFetchParameters (PerTrackEffect &, EffectSettings &s)
 
- 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...
 

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_DescriptormData {}
 
wxString pluginName
 
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

- Public Types inherited from Effect
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , Since_3_2 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Static Public Attributes inherited from EffectPlugin
static const wxString kUserPresetIdent = wxT("User Preset:")
 
static const wxString kFactoryPresetIdent = wxT("Factory Preset:")
 
static const wxString kCurrentSettingsIdent = wxT("<Current Settings>")
 
static const wxString kFactoryDefaultsIdent = wxT("<Factory Defaults>")
 
- Protected Member Functions inherited from PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
- Protected Member Functions inherited from Effect
bool EnablePreview (bool enable=true)
 
bool CheckWhetherSkipEffect (const EffectSettings &settings) const override
 Default implementation returns false. More...
 
double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
 Default implementation returns previewLength More...
 
virtual std::unique_ptr< EffectUIValidatorPopulateOrExchange (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< AddedAnalysisTrackAddAnalysisTrack (const wxString &name=wxString())
 
ModifiedAnalysisTrack ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())
 
TrackAddToOutputTracks (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 TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from Effect
wxWeakRef< wxDialog > mHostUIDialog
 This smart pointer tracks the lifetime of the dialog. More...
 
wxWindow * mUIParent {}
 
- Protected Attributes inherited from EffectBase
BasicUI::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

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.

Constructor & Destructor Documentation

◆ LadspaEffect()

LadspaEffect::LadspaEffect ( const wxString &  path,
int  index 
)

Definition at line 665 of file LadspaEffect.cpp.

666 : mPath{ path }
667 , mIndex{ index }
668{
669}
const wxString mPath
Definition: LadspaEffect.h:138
const int mIndex
Definition: LadspaEffect.h:139

◆ ~LadspaEffect()

LadspaEffect::~LadspaEffect ( )
virtual

Definition at line 671 of file LadspaEffect.cpp.

672{
673}

Member Function Documentation

◆ CanExportPresets()

bool LadspaEffect::CanExportPresets ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1485 of file LadspaEffect.cpp.

1486{
1487 return false;
1488}

◆ CopySettingsContents()

bool LadspaEffect::CopySettingsContents ( const EffectSettings src,
EffectSettings dst,
SettingsCopyDirection  copyDirection 
) const
overridevirtual

Update one settings object from another.

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

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

Default implementation does nothing and returns true

Parameters
srcsettings to copy from
dstsettings to copy into
copyDirectiondirection in which copy is performed
Returns
success

Reimplemented from EffectSettingsManager.

Definition at line 123 of file LadspaEffect.cpp.

125{
126 // Do not use the copy constructor of std::vector. Do an in-place rewrite
127 // of the destination vector, which will not allocate memory if dstControls
128 // began with sufficient capacity.
129 const auto portCount = mData->PortCount;
130
131 auto &srcControls = GetSettings(src).controls;
132 auto &dstControls = GetSettings(dst).controls;
133
134 assert(srcControls.size() == portCount);
135 assert(dstControls.size() == portCount);
136
137 const auto portValuesCount =
138 std::min(srcControls.size(), dstControls.size());
139
140 if (portValuesCount != portCount)
141 return false;
142
143 const auto copyOutputs = copyDirection == SettingsCopyDirection::WorkerToMain;
144
145 for (unsigned long p = 0; p < portCount; ++p)
146 {
148
149 if (!(LADSPA_IS_PORT_CONTROL(d)))
150 continue;
151
152 if (LADSPA_IS_PORT_INPUT(d) || copyOutputs)
153 dstControls[p] = srcControls[p];
154 }
155
156 return true;
157}
int min(int a, int b)
@ WorkerToMain
Worker thread settings replicated to main thread.
static LadspaEffectSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:330
const LADSPA_Descriptor * mData
Definition: LadspaEffect.h:142
int LADSPA_PortDescriptor
Definition: ladspa.h:152
#define LADSPA_IS_PORT_INPUT(x)
Definition: ladspa.h:168
#define LADSPA_IS_PORT_CONTROL(x)
Definition: ladspa.h:170
const LADSPA_PortDescriptor * PortDescriptors
Definition: ladspa.h:410
unsigned long PortCount
Definition: ladspa.h:406
std::vector< float > controls
Definition: LadspaEffect.h:50

References LadspaEffectSettings::controls, EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, mData, min(), _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, and WorkerToMain.

Here is the call graph for this function:

◆ ExportPresets()

void LadspaEffect::ExportPresets ( const EffectSettings settings) const
overridevirtual

Reimplemented from Effect.

Definition at line 1490 of file LadspaEffect.cpp.

1491{
1492}

◆ FreeInstance()

void LadspaEffect::FreeInstance ( LADSPA_Handle  handle) const
private

Definition at line 1618 of file LadspaEffect.cpp.

1619{
1620 if (mData->deactivate)
1621 {
1622 mData->deactivate(handle);
1623 }
1624
1625 mData->cleanup(handle);
1626}
void(* deactivate)(LADSPA_Handle Instance)
Definition: ladspa.h:549
void(* cleanup)(LADSPA_Handle Instance)
Definition: ladspa.h:558

References _LADSPA_Descriptor::cleanup, _LADSPA_Descriptor::deactivate, and mData.

◆ FullyInitializePlugin()

bool LadspaEffect::FullyInitializePlugin ( )

Definition at line 858 of file LadspaEffect.cpp.

859{
860 if (!InitializePlugin())
861 return false;
862
863 // Reading these values from the config file can't be done in the PluginHost
864 // process but isn't needed only for plugin discovery.
865
867 return true;
868}
static bool LoadUseLatency(const EffectDefinitionInterface &effect)
bool InitializePlugin()

References InitializePlugin(), LoadUseLatency(), and mUseLatency.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString LadspaEffect::GetDescription ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 699 of file LadspaEffect.cpp.

700{
701 return Verbatim( LAT1CTOWX(mData->Copyright) );
702}
#define LAT1CTOWX(X)
Definition: Internat.h:160
TranslatableString Verbatim(wxString str)
Require calls to the one-argument constructor to go through this distinct global function name.
const char * Copyright
Definition: ladspa.h:402

References _LADSPA_Descriptor::Copyright, LAT1CTOWX, mData, and Verbatim().

Here is the call graph for this function:

◆ GetFactoryPresets()

RegistryPaths LadspaEffect::GetFactoryPresets ( ) const
overridevirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 1137 of file LadspaEffect.cpp.

1138{
1139 return {};
1140}

◆ GetFamily()

EffectFamilySymbol LadspaEffect::GetFamily ( ) const
overridevirtual

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

Reimplemented from Effect.

Definition at line 728 of file LadspaEffect.cpp.

729{
731}
#define LADSPAEFFECTS_FAMILY
Definition: LadspaEffect.h:33

References LADSPAEFFECTS_FAMILY.

◆ GetPath()

PluginPath LadspaEffect::GetPath ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 679 of file LadspaEffect.cpp.

680{
681 return wxString::Format(wxT("%s;%d"), mPath, mIndex);
682}
wxT("CloseDown"))

References mIndex, mPath, and wxT().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol LadspaEffect::GetSymbol ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 684 of file LadspaEffect.cpp.

685{
686 return LAT1CTOWX(mData->Name);
687}
const char * Name
Definition: ladspa.h:393

References LAT1CTOWX, mData, and _LADSPA_Descriptor::Name.

◆ GetType()

EffectType LadspaEffect::GetType ( ) const
overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 708 of file LadspaEffect.cpp.

709{
710 if (mAudioIns == 0 && mAudioOuts == 0)
711 {
712 return EffectTypeTool;
713 }
714
715 if (mAudioIns == 0)
716 {
717 return EffectTypeGenerate;
718 }
719
720 if (mAudioOuts == 0)
721 {
722 return EffectTypeAnalyze;
723 }
724
725 return EffectTypeProcess;
726}
@ EffectTypeAnalyze
@ EffectTypeGenerate
@ EffectTypeTool
@ EffectTypeProcess
unsigned mAudioOuts
Definition: LadspaEffect.h:154
unsigned mAudioIns
Definition: LadspaEffect.h:150

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, mAudioIns, and mAudioOuts.

Referenced by PopulateOrExchange(), RealtimeSupport(), and ShowClientInterface().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol LadspaEffect::GetVendor ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 689 of file LadspaEffect.cpp.

690{
691 return { LAT1CTOWX(mData->Maker) };
692}
const char * Maker
Definition: ladspa.h:397

References LAT1CTOWX, _LADSPA_Descriptor::Maker, and mData.

◆ GetVersion()

wxString LadspaEffect::GetVersion ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 694 of file LadspaEffect.cpp.

695{
696 return "n/a";
697}

◆ HasOptions()

bool LadspaEffect::HasOptions ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1498 of file LadspaEffect.cpp.

1499{
1500 return true;
1501}

◆ ImportPresets()

void LadspaEffect::ImportPresets ( EffectSettings settings)
overridevirtual

Reimplemented from Effect.

Definition at line 1494 of file LadspaEffect.cpp.

1495{
1496}

◆ InitializeControls()

bool LadspaEffect::InitializeControls ( LadspaEffectSettings settings) const

Definition at line 870 of file LadspaEffect.cpp.

871{
872 auto &controls = settings.controls;
873 // (Re-)initialize with right-sized vector
874 std::vector<float>(mData->PortCount).swap(controls);
875
876 for (unsigned long p = 0; p < mData->PortCount; ++p) {
879 // Determine the port's default value
880 controls[p] = InputControlPortDefaultValue(
882 else
883 controls[p] = 0;
884 }
885 return true;
886}
static Settings & settings()
Definition: TrackInfo.cpp:87
double mProjectRate
Definition: EffectBase.h:99
float InputControlPortDefaultValue(const LADSPA_PortRangeHint &hint, double sampleRate)
const LADSPA_PortRangeHint * PortRangeHints
Definition: ladspa.h:419

References anonymous_namespace{LadspaEffect.cpp}::InputControlPortDefaultValue(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, mData, EffectBase::mProjectRate, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortRangeHints, and settings().

Referenced by MakeSettings().

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

◆ InitializePlugin()

bool LadspaEffect::InitializePlugin ( )

Definition at line 820 of file LadspaEffect.cpp.

821{
822 if (!Load())
823 return false;
824
827 for (unsigned long p = 0; p < mData->PortCount; p++) {
829
830 // Collect the audio ports
831 if (LADSPA_IS_PORT_AUDIO(d)) {
833 mInputPorts[mAudioIns++] = p;
834 else if (LADSPA_IS_PORT_OUTPUT(d))
836 }
837 // Count control ports
838 else if (LADSPA_IS_PORT_CONTROL(d)) {
839 if (LADSPA_IS_PORT_INPUT(d)) {
840 mInteractive = true;
842 }
843 else if (LADSPA_IS_PORT_OUTPUT(d)) {
844 // LADSPA effects have a convention of providing latency on an output
845 // control port whose name is "latency".
846 if (strcmp(mData->PortNames[p], "latency") == 0)
847 mLatencyPort = p;
848 else {
849 mInteractive = true;
851 }
852 }
853 }
854 }
855 return true;
856}
void reinit(Integral count, bool initialize=false)
Definition: MemoryX.h:57
int mNumInputControls
Definition: LadspaEffect.h:158
ArrayOf< unsigned long > mOutputPorts
Definition: LadspaEffect.h:156
ArrayOf< unsigned long > mInputPorts
Definition: LadspaEffect.h:152
int mNumOutputControls
Definition: LadspaEffect.h:159
#define LADSPA_IS_PORT_AUDIO(x)
Definition: ladspa.h:171
#define LADSPA_IS_PORT_OUTPUT(x)
Definition: ladspa.h:169
const char *const * PortNames
Definition: ladspa.h:415

References LADSPA_IS_PORT_AUDIO, LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, LADSPA_IS_PORT_OUTPUT, Load(), mAudioIns, mAudioOuts, mData, mInputPorts, mInteractive, mLatencyPort, mNumInputControls, mNumOutputControls, mOutputPorts, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, _LADSPA_Descriptor::PortNames, and ArrayOf< X >::reinit().

Referenced by LadspaEffectsModule::DiscoverPluginsAtPath(), and FullyInitializePlugin().

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

◆ InitInstance()

LADSPA_Handle LadspaEffect::InitInstance ( float  sampleRate,
LadspaEffectSettings settings 
) const
private

Definition at line 1598 of file LadspaEffect.cpp.

1600{
1601 /* Instantiate the plugin */
1602 LADSPA_Handle handle = mData->instantiate(mData, sampleRate);
1603 if (!handle)
1604 return nullptr;
1605
1606 auto &controls = settings.controls;
1607 for (unsigned long p = 0; p < mData->PortCount; ++p) {
1610 mData->connect_port(handle, p, &controls[p]);
1611 }
1612 if (mData->activate)
1613 mData->activate(handle);
1614
1615 return handle;
1616}
void * LADSPA_Handle
Definition: ladspa.h:363
LADSPA_Handle(* instantiate)(const struct _LADSPA_Descriptor *Descriptor, unsigned long SampleRate)
Definition: ladspa.h:437
void(* activate)(LADSPA_Handle Instance)
Definition: ladspa.h:489
void(* connect_port)(LADSPA_Handle Instance, unsigned long Port, LADSPA_Data *DataLocation)
Definition: ladspa.h:466

References _LADSPA_Descriptor::activate, _LADSPA_Descriptor::connect_port, _LADSPA_Descriptor::instantiate, LADSPA_IS_PORT_CONTROL, mData, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, and settings().

Here is the call graph for this function:

◆ IsDefault()

bool LadspaEffect::IsDefault ( ) const
overridevirtual

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

Reimplemented from Effect.

Definition at line 738 of file LadspaEffect.cpp.

739{
740 return false;
741}

◆ IsInteractive()

bool LadspaEffect::IsInteractive ( ) const
overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 733 of file LadspaEffect.cpp.

734{
735 return mInteractive;
736}

References mInteractive.

◆ Load()

bool LadspaEffect::Load ( )
private

Definition at line 1513 of file LadspaEffect.cpp.

1514{
1515 if (mLib.IsLoaded())
1516 {
1517 return true;
1518 }
1519
1520 wxFileName ff = mPath;
1521 wxString envpath;
1522 bool hadpath = wxGetEnv(wxT("PATH"), &envpath);
1523 wxSetEnv(wxT("PATH"), ff.GetPath() + wxFILE_SEP_PATH + envpath);
1524 wxString saveOldCWD = ff.GetCwd();
1525 ff.SetCwd();
1526
1527 LADSPA_Descriptor_Function mainFn = NULL;
1528
1529 if (mLib.Load(mPath, wxDL_NOW))
1530 {
1531 wxLogNull logNo;
1532
1533 mainFn = (LADSPA_Descriptor_Function) mLib.GetSymbol(wxT("ladspa_descriptor"));
1534 if (mainFn)
1535 {
1536 mData = mainFn(mIndex);
1537 return true;
1538 }
1539 }
1540
1541 if (mLib.IsLoaded())
1542 {
1543 mLib.Unload();
1544 }
1545
1546 wxSetWorkingDirectory(saveOldCWD);
1547 hadpath ? wxSetEnv(wxT("PATH"), envpath) : wxUnsetEnv(wxT("PATH"));
1548
1549 return false;
1550}
wxDynamicLibrary mLib
Definition: LadspaEffect.h:141
const LADSPA_Descriptor *(* LADSPA_Descriptor_Function)(unsigned long Index)
Definition: ladspa.h:593

References mData, mIndex, mLib, mPath, and wxT().

Referenced by InitializePlugin().

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

◆ LoadFactoryPreset()

bool LadspaEffect::LoadFactoryPreset ( int  id,
EffectSettings settings 
) const
overridevirtual

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

Reimplemented from Effect.

Definition at line 1142 of file LadspaEffect.cpp.

1143{
1144 return true;
1145}

◆ LoadParameters()

bool LadspaEffect::LoadParameters ( const RegistryPath group,
EffectSettings settings 
) const
private

Definition at line 1560 of file LadspaEffect.cpp.

1562{
1563 wxString parms;
1564 if (!GetConfig(*this, PluginSettings::Private, group, wxT("Parameters"),
1565 parms, wxEmptyString))
1566 {
1567 return false;
1568 }
1569
1571 if (!eap.SetParameters(parms))
1572 {
1573 return false;
1574 }
1575
1576 return LoadSettings(eap, settings);
1577}
CommandParameters, derived from wxFileConfig, is essentially doing the same things as the SettingsVis...
bool SetParameters(const wxString &parms)
bool LoadSettings(const CommandParameters &parms, EffectSettings &settings) const override
Restore settings from keys and values.
bool GetConfig(const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, Value &var, const Value &defval)

References PluginSettings::GetConfig(), LoadSettings(), PluginSettings::Private, CommandParameters::SetParameters(), settings(), and wxT().

Referenced by LoadUserPreset().

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

◆ LoadSettings()

bool LadspaEffect::LoadSettings ( const CommandParameters parms,
EffectSettings settings 
) const
overridevirtual

Restore settings from keys and values.

Returns
true on success

Reimplemented from Effect.

Definition at line 1106 of file LadspaEffect.cpp.

1108{
1109 auto &controls = GetSettings(settings).controls;
1110 for (unsigned long p = 0; p < mData->PortCount; p++) {
1112
1113 if (LADSPA_IS_PORT_CONTROL(descriptor) &&
1114 LADSPA_IS_PORT_INPUT(descriptor)) {
1115 wxString labelText = LAT1CTOWX(mData->PortNames[p]);
1116 double d = 0.0;
1117 if (!parms.Read(labelText, &d))
1118 return false;
1119 controls[p] = d;
1120 }
1121 }
1122 return true;
1123}

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

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

◆ LoadUseLatency()

bool LadspaEffect::LoadUseLatency ( const EffectDefinitionInterface effect)
static

Definition at line 489 of file LadspaEffect.cpp.

490{
491 bool result{};
493 OptionsKey, UseLatencyKey, result, true /* default value */);
494 return result;
495}
static const wchar_t * UseLatencyKey
static const wchar_t * OptionsKey

References PluginSettings::GetConfig(), OptionsKey, PluginSettings::Shared, and UseLatencyKey.

Referenced by FullyInitializePlugin().

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

◆ LoadUserPreset()

bool LadspaEffect::LoadUserPreset ( const RegistryPath name,
EffectSettings settings 
) const
overridevirtual

Change settings to a user-named preset.

Reimplemented from Effect.

Definition at line 1125 of file LadspaEffect.cpp.

1127{
1128 return LoadParameters(name, settings);
1129}
const TranslatableString name
Definition: Distortion.cpp:82
bool LoadParameters(const RegistryPath &group, EffectSettings &settings) const

References LoadParameters(), name, and settings().

Here is the call graph for this function:

◆ MakeInstance()

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

931{
932 return std::make_shared<Instance>(*this);
933}

◆ MakeSettings()

EffectSettings LadspaEffect::MakeSettings ( ) const
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.

117{
118 auto result = EffectSettings::Make<LadspaEffectSettings>( mData->PortCount );
120 return result;
121}
bool InitializeControls(LadspaEffectSettings &settings) const

References EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings(), InitializeControls(), mData, and _LADSPA_Descriptor::PortCount.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > LadspaEffect::PopulateOrExchange ( ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access 
)
overridevirtual

Add controls to effect panel; always succeeds.

Returns
if not null, then return it from Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

Reimplemented from Effect.

Definition at line 1466 of file LadspaEffect.cpp.

1468{
1469 auto result =
1470 std::make_unique<Validator>(*this, access, mProjectRate, GetType());
1471 result->PopulateUI(S);
1472 return result;
1473}
#define S(N)
Definition: ToChars.cpp:64
EffectType GetType() const override
Type determines how it behaves.

References GetType(), EffectBase::mProjectRate, and S.

Here is the call graph for this function:

◆ RealtimeSupport()

auto LadspaEffect::RealtimeSupport ( ) const
overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 743 of file LadspaEffect.cpp.

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

Here is the call graph for this function:

◆ SaveParameters()

bool LadspaEffect::SaveParameters ( const RegistryPath group,
const EffectSettings settings 
) const
private

Definition at line 1579 of file LadspaEffect.cpp.

1581{
1583 if (!SaveSettings(settings, eap))
1584 {
1585 return false;
1586 }
1587
1588 wxString parms;
1589 if (!eap.GetParameters(parms))
1590 {
1591 return false;
1592 }
1593
1594 return SetConfig(*this, PluginSettings::Private,
1595 group, wxT("Parameters"), parms);
1596}
bool GetParameters(wxString &parms)
bool SaveSettings(const EffectSettings &settings, CommandParameters &parms) const override
Store settings as keys and values.
bool SetConfig(const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, const Value &value)

References CommandParameters::GetParameters(), PluginSettings::Private, SaveSettings(), PluginSettings::SetConfig(), settings(), and wxT().

Referenced by SaveUserPreset().

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

◆ SaveSettings()

bool LadspaEffect::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 1093 of file LadspaEffect.cpp.

1095{
1096 const auto &controls = GetSettings(settings).controls;
1097 for (unsigned long p = 0; p < mData->PortCount; p++) {
1100 if (!parms.Write(LAT1CTOWX(mData->PortNames[p]), controls[p]))
1101 return false;
1102 }
1103 return true;
1104}

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

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

◆ SaveUseLatency()

bool LadspaEffect::SaveUseLatency ( const EffectDefinitionInterface effect,
bool  value 
)
static

Definition at line 497 of file LadspaEffect.cpp.

499{
500 return SetConfig(
502}

References OptionsKey, PluginSettings::SetConfig(), PluginSettings::Shared, and UseLatencyKey.

Referenced by LadspaEffectOptionsDialog::OnOk().

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

◆ SaveUserPreset()

bool LadspaEffect::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 1131 of file LadspaEffect.cpp.

1133{
1134 return SaveParameters(name, settings);
1135}
bool SaveParameters(const RegistryPath &group, const EffectSettings &settings) const

References name, SaveParameters(), and settings().

Here is the call graph for this function:

◆ ShowClientInterface()

int LadspaEffect::ShowClientInterface ( wxWindow &  parent,
wxDialog &  dialog,
EffectUIValidator pValidator,
bool  forceModal 
)
overridevirtual
Returns
0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Reimplemented from Effect.

Definition at line 1077 of file LadspaEffect.cpp.

1079{
1080 dialog.Layout();
1081 dialog.Fit();
1082 dialog.SetMinSize(dialog.GetSize());
1083
1084 if ((SupportsRealtime() || GetType() == EffectTypeAnalyze) && !forceModal)
1085 {
1086 dialog.Show();
1087 return 0;
1088 }
1089
1090 return dialog.ShowModal();
1091}

References EffectTypeAnalyze, GetType(), and EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

◆ ShowOptions()

void LadspaEffect::ShowOptions ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1503 of file LadspaEffect.cpp.

1504{
1506 dlg.ShowModal();
1507}
wxWindow * mUIParent
Definition: Effect.h:304

References Effect::mUIParent, and mUseLatency.

◆ SupportsAutomation()

bool LadspaEffect::SupportsAutomation ( ) const
overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 750 of file LadspaEffect.cpp.

751{
752 return mNumInputControls > 0;
753}

References mNumInputControls.

◆ Unload()

void LadspaEffect::Unload ( )
private

Definition at line 1552 of file LadspaEffect.cpp.

1553{
1554 if (mLib.IsLoaded())
1555 {
1556 mLib.Unload();
1557 }
1558}

References mLib.

Friends And Related Function Documentation

◆ LadspaEffectsModule

friend class LadspaEffectsModule
friend

Definition at line 164 of file LadspaEffect.h.

Member Data Documentation

◆ mAudioIns

unsigned LadspaEffect::mAudioIns { 0 }
private

Definition at line 150 of file LadspaEffect.h.

Referenced by GetType(), and InitializePlugin().

◆ mAudioOuts

unsigned LadspaEffect::mAudioOuts { 0 }
private

Definition at line 154 of file LadspaEffect.h.

Referenced by GetType(), and InitializePlugin().

◆ mBlockSize

size_t LadspaEffect::mBlockSize { 0 }
private

Definition at line 146 of file LadspaEffect.h.

◆ mData

const LADSPA_Descriptor* LadspaEffect::mData {}
private

◆ mIndex

const int LadspaEffect::mIndex
private

Definition at line 139 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ mInputPorts

ArrayOf<unsigned long> LadspaEffect::mInputPorts
private

Definition at line 152 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mInteractive

bool LadspaEffect::mInteractive { false }
private

Definition at line 148 of file LadspaEffect.h.

Referenced by InitializePlugin(), and IsInteractive().

◆ mLatencyPort

int LadspaEffect::mLatencyPort { -1 }
private

Definition at line 162 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mLib

wxDynamicLibrary LadspaEffect::mLib
private

Definition at line 141 of file LadspaEffect.h.

Referenced by Load(), and Unload().

◆ mNumInputControls

int LadspaEffect::mNumInputControls { 0 }
private

Definition at line 158 of file LadspaEffect.h.

Referenced by InitializePlugin(), and SupportsAutomation().

◆ mNumOutputControls

int LadspaEffect::mNumOutputControls { 0 }
private

Definition at line 159 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mOutputPorts

ArrayOf<unsigned long> LadspaEffect::mOutputPorts
private

Definition at line 156 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mPath

const wxString LadspaEffect::mPath
private

Definition at line 138 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ mUseLatency

bool LadspaEffect::mUseLatency { true }
private

Definition at line 161 of file LadspaEffect.h.

Referenced by FullyInitializePlugin(), and ShowOptions().

◆ pluginName

wxString LadspaEffect::pluginName
private

Definition at line 144 of file LadspaEffect.h.


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