Audacity 3.2.0
Classes | 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  Editor
 
struct  Instance
 

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...
 
std::unique_ptr< EffectOutputsMakeOutputs () const override
 Produce an object to hold values to send to effect output meters. 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...
 
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
 
bool InitializePlugin ()
 
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< EffectEditorMakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
 Called only from PopulateUI, to add controls to effect panel. 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
 
- Public Member Functions inherited from EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >
EffectSettings MakeSettings () const override
 
bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
 
- 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
 
- 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
 
- Public Member Functions inherited from StatelessEffectUIServices
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
 

Private Member Functions

bool Load ()
 
void Unload ()
 
OptionalMessage LoadParameters (const RegistryPath &group, EffectSettings &settings) const
 
bool SaveParameters (const RegistryPath &group, const EffectSettings &settings) const
 
LADSPA_Handle InitInstance (float sampleRate, LadspaEffectSettings &settings, LadspaEffectOutputs *pOutputs) 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 }
 
int mLatencyPort { -1 }
 

Friends

class LadspaEffectsModule
 

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 }
 
- Static Public Member Functions inherited from EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >
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 (StatelessPerTrackEffect &, 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...
 
- Static Public Member Functions inherited from EffectUIServices
static int DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
 
- 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

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

Definition at line 65 of file LadspaEffect.h.

Constructor & Destructor Documentation

◆ LadspaEffect()

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

Definition at line 708 of file LadspaEffect.cpp.

709 : mPath{ path }
710 , mIndex{ index }
711{
712}
const wxString mPath
Definition: LadspaEffect.h:151
const int mIndex
Definition: LadspaEffect.h:152

◆ ~LadspaEffect()

LadspaEffect::~LadspaEffect ( )
virtual

Definition at line 714 of file LadspaEffect.cpp.

715{
716}

Member Function Documentation

◆ CanExportPresets()

bool LadspaEffect::CanExportPresets ( ) const
overridevirtual

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

Implements EffectPlugin.

Definition at line 1543 of file LadspaEffect.cpp.

1544{
1545 return false;
1546}

◆ CopySettingsContents()

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

129{
130 // Do not use the copy constructor of std::vector. Do an in-place rewrite
131 // of the destination vector, which will not allocate memory if dstControls
132 // began with sufficient capacity.
133 const auto portCount = mData->PortCount;
134
135 auto &srcControls = GetSettings(src).controls;
136 auto &dstControls = GetSettings(dst).controls;
137
138 assert(srcControls.size() == portCount);
139 assert(dstControls.size() == portCount);
140
141 const auto portValuesCount =
142 std::min(srcControls.size(), dstControls.size());
143
144 if (portValuesCount != portCount)
145 return false;
146
147 for (unsigned long p = 0; p < portCount; ++p)
148 {
150
151 if (!(LADSPA_IS_PORT_CONTROL(d)))
152 continue;
153
155 dstControls[p] = srcControls[p];
156 }
157
158 return true;
159}
int min(int a, int b)
static LadspaEffectSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:177
const LADSPA_Descriptor * mData
Definition: LadspaEffect.h:155
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, StatelessPerTrackEffect >::GetSettings(), LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, mData, min(), _LADSPA_Descriptor::PortCount, and _LADSPA_Descriptor::PortDescriptors.

Here is the call graph for this function:

◆ ExportPresets()

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

Reimplemented from BasicEffectUIServices.

Definition at line 1548 of file LadspaEffect.cpp.

1550{
1551}

◆ FreeInstance()

void LadspaEffect::FreeInstance ( LADSPA_Handle  handle) const
private

Definition at line 1688 of file LadspaEffect.cpp.

1689{
1690 if (mData->deactivate)
1691 {
1692 mData->deactivate(handle);
1693 }
1694
1695 mData->cleanup(handle);
1696}
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.

◆ GetDescription()

TranslatableString LadspaEffect::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 742 of file LadspaEffect.cpp.

743{
744 return Verbatim( LAT1CTOWX(mData->Copyright) );
745}
#define LAT1CTOWX(X)
Definition: Internat.h:158
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.

Implements EffectSettingsManager.

Definition at line 1179 of file LadspaEffect.cpp.

1180{
1181 return {};
1182}

◆ GetFamily()

EffectFamilySymbol LadspaEffect::GetFamily ( ) const
overridevirtual

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

Implements EffectDefinitionInterface.

Definition at line 771 of file LadspaEffect.cpp.

772{
774}
#define LADSPAEFFECTS_FAMILY
Definition: LadspaEffect.h:33

References LADSPAEFFECTS_FAMILY.

◆ GetPath()

PluginPath LadspaEffect::GetPath ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 722 of file LadspaEffect.cpp.

723{
724 return wxString::Format(wxT("%s;%d"), mPath, mIndex);
725}
wxT("CloseDown"))

References mIndex, mPath, and wxT().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol LadspaEffect::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 727 of file LadspaEffect.cpp.

728{
729 return LAT1CTOWX(mData->Name);
730}
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.

Implements EffectDefinitionInterface.

Definition at line 751 of file LadspaEffect.cpp.

752{
753 if (mAudioIns == 0 && mAudioOuts == 0)
754 {
755 return EffectTypeTool;
756 }
757
758 if (mAudioIns == 0)
759 {
760 return EffectTypeGenerate;
761 }
762
763 if (mAudioOuts == 0)
764 {
765 return EffectTypeAnalyze;
766 }
767
768 return EffectTypeProcess;
769}
@ EffectTypeAnalyze
@ EffectTypeGenerate
@ EffectTypeTool
@ EffectTypeProcess
unsigned mAudioOuts
Definition: LadspaEffect.h:167
unsigned mAudioIns
Definition: LadspaEffect.h:163

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

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

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol LadspaEffect::GetVendor ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 732 of file LadspaEffect.cpp.

733{
734 return { LAT1CTOWX(mData->Maker) };
735}
const char * Maker
Definition: ladspa.h:397

References LAT1CTOWX, _LADSPA_Descriptor::Maker, and mData.

◆ GetVersion()

wxString LadspaEffect::GetVersion ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 737 of file LadspaEffect.cpp.

738{
739 return "n/a";
740}

◆ HasOptions()

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

1560{
1561 return true;
1562}

◆ ImportPresets()

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

Reimplemented from BasicEffectUIServices.

Definition at line 1553 of file LadspaEffect.cpp.

1555{
1556 return { nullptr };
1557}

◆ InitializeControls()

bool LadspaEffect::InitializeControls ( LadspaEffectSettings settings) const

Definition at line 901 of file LadspaEffect.cpp.

902{
903 auto &controls = settings.controls;
904 // (Re-)initialize with right-sized vector
905 std::vector<float>(mData->PortCount).swap(controls);
906
907 for (unsigned long p = 0; p < mData->PortCount; ++p) {
910 // Determine the port's default value
911 controls[p] = InputControlPortDefaultValue(
913 else
914 controls[p] = 0;
915 }
916 return true;
917}
static Settings & settings()
Definition: TrackInfo.cpp:87
double mProjectRate
Definition: EffectBase.h:105
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 863 of file LadspaEffect.cpp.

864{
865 if (!Load())
866 return false;
867
870 for (unsigned long p = 0; p < mData->PortCount; p++) {
872
873 // Collect the audio ports
874 if (LADSPA_IS_PORT_AUDIO(d)) {
876 mInputPorts[mAudioIns++] = p;
877 else if (LADSPA_IS_PORT_OUTPUT(d))
879 }
880 // Count control ports
881 else if (LADSPA_IS_PORT_CONTROL(d)) {
882 if (LADSPA_IS_PORT_INPUT(d)) {
883 mInteractive = true;
885 }
886 else if (LADSPA_IS_PORT_OUTPUT(d)) {
887 // LADSPA effects have a convention of providing latency on an output
888 // control port whose name is "latency".
889 if (strcmp(mData->PortNames[p], "latency") == 0)
890 mLatencyPort = p;
891 else {
892 mInteractive = true;
894 }
895 }
896 }
897 }
898 return true;
899}
void reinit(Integral count, bool initialize=false)
Definition: MemoryX.h:57
int mNumInputControls
Definition: LadspaEffect.h:171
ArrayOf< unsigned long > mOutputPorts
Definition: LadspaEffect.h:169
ArrayOf< unsigned long > mInputPorts
Definition: LadspaEffect.h:165
int mNumOutputControls
Definition: LadspaEffect.h:172
#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().

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,
LadspaEffectOutputs pOutputs 
) const
private

Definition at line 1660 of file LadspaEffect.cpp.

1663{
1664 /* Instantiate the plugin */
1665 LADSPA_Handle handle = mData->instantiate(mData, sampleRate);
1666 if (!handle)
1667 return nullptr;
1668
1669 auto &controls = settings.controls;
1670 for (unsigned long p = 0; p < mData->PortCount; ++p) {
1672 if (LADSPA_IS_PORT_CONTROL(d)) {
1673 if (LADSPA_IS_PORT_INPUT(d))
1674 mData->connect_port(handle, p, &controls[p]);
1675 else {
1676 static LADSPA_Data sink;
1677 mData->connect_port(handle, p,
1678 pOutputs ? &pOutputs->controls[p] : &sink);
1679 }
1680 }
1681 }
1682 if (mData->activate)
1683 mData->activate(handle);
1684
1685 return handle;
1686}
float LADSPA_Data
Definition: ladspa.h:84
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
std::vector< float > controls
Definition: LadspaEffect.h:62

References _LADSPA_Descriptor::activate, _LADSPA_Descriptor::connect_port, LadspaEffectOutputs::controls, _LADSPA_Descriptor::instantiate, LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, 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.

Implements EffectDefinitionInterface.

Definition at line 781 of file LadspaEffect.cpp.

782{
783 return false;
784}

◆ IsInteractive()

bool LadspaEffect::IsInteractive ( ) const
overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 776 of file LadspaEffect.cpp.

777{
778 return mInteractive;
779}

References mInteractive.

◆ Load()

bool LadspaEffect::Load ( )
private

Definition at line 1573 of file LadspaEffect.cpp.

1574{
1575 if (mLib.IsLoaded())
1576 {
1577 return true;
1578 }
1579
1580 wxFileName ff = mPath;
1581 wxString envpath;
1582 bool hadpath = wxGetEnv(wxT("PATH"), &envpath);
1583 wxSetEnv(wxT("PATH"), ff.GetPath() + wxFILE_SEP_PATH + envpath);
1584 wxString saveOldCWD = ff.GetCwd();
1585 ff.SetCwd();
1586
1587 LADSPA_Descriptor_Function mainFn = NULL;
1588
1589 if (mLib.Load(mPath, wxDL_NOW))
1590 {
1591 wxLogNull logNo;
1592
1593 mainFn = (LADSPA_Descriptor_Function) mLib.GetSymbol(wxT("ladspa_descriptor"));
1594 if (mainFn)
1595 {
1596 mData = mainFn(mIndex);
1597 return true;
1598 }
1599 }
1600
1601 if (mLib.IsLoaded())
1602 {
1603 mLib.Unload();
1604 }
1605
1606 wxSetWorkingDirectory(saveOldCWD);
1607 hadpath ? wxSetEnv(wxT("PATH"), envpath) : wxUnsetEnv(wxT("PATH"));
1608
1609 return false;
1610}
wxDynamicLibrary mLib
Definition: LadspaEffect.h:154
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()

OptionalMessage LadspaEffect::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 1184 of file LadspaEffect.cpp.

1185{
1186 return { nullptr };
1187}

◆ LoadParameters()

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

Definition at line 1620 of file LadspaEffect.cpp.

1622{
1623 wxString parms;
1624 if (!GetConfig(*this, PluginSettings::Private, group, wxT("Parameters"),
1625 parms, wxEmptyString))
1626 {
1627 return {};
1628 }
1629
1631 if (!eap.SetParameters(parms))
1632 {
1633 return {};
1634 }
1635
1636 if (!LoadSettings(eap, settings))
1637 return {};
1638 return { nullptr };
1639}
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

Implements EffectSettingsManager.

Definition at line 1148 of file LadspaEffect.cpp.

1150{
1151 auto &controls = GetSettings(settings).controls;
1152 for (unsigned long p = 0; p < mData->PortCount; p++) {
1154
1155 if (LADSPA_IS_PORT_CONTROL(descriptor) &&
1156 LADSPA_IS_PORT_INPUT(descriptor)) {
1157 wxString labelText = LAT1CTOWX(mData->PortNames[p]);
1158 double d = 0.0;
1159 if (!parms.Read(labelText, &d))
1160 return false;
1161 controls[p] = d;
1162 }
1163 }
1164 return true;
1165}

References LadspaEffectSettings::controls, EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >::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:

◆ LoadUserPreset()

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

Change settings to a user-named preset

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 1167 of file LadspaEffect.cpp.

1169{
1170 return LoadParameters(name, settings);
1171}
const TranslatableString name
Definition: Distortion.cpp:76
OptionalMessage LoadParameters(const RegistryPath &group, EffectSettings &settings) const

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

Here is the call graph for this function:

◆ MakeEditor()

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

Called only from PopulateUI, to add controls to effect panel.

Returns
also returned from PopulateUI
Postcondition
result: result != nullptr

Implements StatelessEffectUIServices.

Definition at line 1512 of file LadspaEffect.cpp.

1515{
1516 auto pValues = static_cast<const LadspaEffectOutputs *>(pOutputs);
1517 auto result = std::make_unique<Editor>(*this, access, mProjectRate,
1518 GetType(), pValues);
1519 result->PopulateUI(S);
1520 return result;
1521}
#define S(N)
Definition: ToChars.cpp:64
EffectType GetType() const override
Type determines how it behaves.
Carry output control port information back to main thread.
Definition: LadspaEffect.h:54

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

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 969 of file LadspaEffect.cpp.

970{
971 return std::make_shared<Instance>(*this);
972}

◆ MakeOutputs()

auto LadspaEffect::MakeOutputs ( ) const
overridevirtual

Produce an object to hold values to send to effect output meters.

Default implementation returns nullptr

Reimplemented from EffectSettingsManager.

Definition at line 161 of file LadspaEffect.cpp.

162{
163 auto result = std::make_unique<LadspaEffectOutputs>();
164 result->controls.resize(mData->PortCount);
165 return result;
166}

References mData, and _LADSPA_Descriptor::PortCount.

◆ 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 120 of file LadspaEffect.cpp.

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

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

Here is the call graph for this function:

◆ RealtimeSupport()

auto LadspaEffect::RealtimeSupport ( ) const
overridevirtual

Since which version of Audacity has the effect supported realtime?

Implements EffectDefinitionInterface.

Definition at line 786 of file LadspaEffect.cpp.

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

Here is the call graph for this function:

◆ SaveParameters()

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

Definition at line 1641 of file LadspaEffect.cpp.

1643{
1645 if (!SaveSettings(settings, eap))
1646 {
1647 return false;
1648 }
1649
1650 wxString parms;
1651 if (!eap.GetParameters(parms))
1652 {
1653 return false;
1654 }
1655
1656 return SetConfig(*this, PluginSettings::Private,
1657 group, wxT("Parameters"), parms);
1658}
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

Implements EffectSettingsManager.

Definition at line 1135 of file LadspaEffect.cpp.

1137{
1138 const auto &controls = GetSettings(settings).controls;
1139 for (unsigned long p = 0; p < mData->PortCount; p++) {
1142 if (!parms.Write(LAT1CTOWX(mData->PortNames[p]), controls[p]))
1143 return false;
1144 }
1145 return true;
1146}

References LadspaEffectSettings::controls, EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >::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:

◆ SaveUserPreset()

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

1175{
1176 return SaveParameters(name, settings);
1177}
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 ( 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 1118 of file LadspaEffect.cpp.

1121{
1122 dialog.Layout();
1123 dialog.Fit();
1124 dialog.SetMinSize(dialog.GetSize());
1125
1126 if ((SupportsRealtime() || GetType() == EffectTypeAnalyze) && !forceModal)
1127 {
1128 dialog.Show();
1129 return 0;
1130 }
1131
1132 return dialog.ShowModal();
1133}

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

Here is the call graph for this function:

◆ ShowOptions()

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

Reimplemented from BasicEffectUIServices.

Definition at line 1564 of file LadspaEffect.cpp.

1565{
1566 LadspaEffectOptionsDialog{ *this }.ShowModal();
1567}

◆ SupportsAutomation()

bool LadspaEffect::SupportsAutomation ( ) const
overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 793 of file LadspaEffect.cpp.

794{
795 return mNumInputControls > 0;
796}

References mNumInputControls.

◆ Unload()

void LadspaEffect::Unload ( )
private

Definition at line 1612 of file LadspaEffect.cpp.

1613{
1614 if (mLib.IsLoaded())
1615 {
1616 mLib.Unload();
1617 }
1618}

References mLib.

Friends And Related Function Documentation

◆ LadspaEffectsModule

friend class LadspaEffectsModule
friend

Definition at line 176 of file LadspaEffect.h.

Member Data Documentation

◆ mAudioIns

unsigned LadspaEffect::mAudioIns { 0 }
private

Definition at line 163 of file LadspaEffect.h.

Referenced by GetType(), and InitializePlugin().

◆ mAudioOuts

unsigned LadspaEffect::mAudioOuts { 0 }
private

Definition at line 167 of file LadspaEffect.h.

Referenced by GetType(), and InitializePlugin().

◆ mBlockSize

size_t LadspaEffect::mBlockSize { 0 }
private

Definition at line 159 of file LadspaEffect.h.

◆ mData

const LADSPA_Descriptor* LadspaEffect::mData {}
private

◆ mIndex

const int LadspaEffect::mIndex
private

Definition at line 152 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ mInputPorts

ArrayOf<unsigned long> LadspaEffect::mInputPorts
private

Definition at line 165 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mInteractive

bool LadspaEffect::mInteractive { false }
private

Definition at line 161 of file LadspaEffect.h.

Referenced by InitializePlugin(), and IsInteractive().

◆ mLatencyPort

int LadspaEffect::mLatencyPort { -1 }
private

Definition at line 174 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mLib

wxDynamicLibrary LadspaEffect::mLib
private

Definition at line 154 of file LadspaEffect.h.

Referenced by Load(), and Unload().

◆ mNumInputControls

int LadspaEffect::mNumInputControls { 0 }
private

Definition at line 171 of file LadspaEffect.h.

Referenced by InitializePlugin(), and SupportsAutomation().

◆ mNumOutputControls

int LadspaEffect::mNumOutputControls { 0 }
private

Definition at line 172 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mOutputPorts

ArrayOf<unsigned long> LadspaEffect::mOutputPorts
private

Definition at line 169 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mPath

const wxString LadspaEffect::mPath
private

Definition at line 151 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ pluginName

wxString LadspaEffect::pluginName
private

Definition at line 157 of file LadspaEffect.h.


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