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) 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< 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 IsGraphicalUI () override
 
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) 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...
 
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 EffectParameterMethodsParameters () const
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override
 
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, 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 ()
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
- Public Member Functions inherited from EffectUIClientInterface
virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< 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
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual const EffectSettingsManagerGetDefinition () 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...
 
- 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...
 
virtual unsigned GetAudioInCount () const =0
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const =0
 How many output buffers to allocate at once. More...
 
virtual int GetMidiInCount () const
 Function that has not yet found a use. More...
 
virtual int GetMidiOutCount () const
 Function that has not yet found a use. More...
 
- Public Member Functions inherited from EffectSettingsManager
virtual ~EffectSettingsManager ()
 
virtual bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
 
virtual bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType () const =0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification () const
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily () const =0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive () const =0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault () const =0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual bool SupportsRealtime () const =0
 Whether the effect supports realtime previewing (while audio is playing). More...
 
virtual bool SupportsAutomation () const =0
 Whether the effect has any automatable controls. More...
 
virtual bool EnablesDebug () const
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage () const
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage () const
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus () const
 Default is false. More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 

Static Public Member Functions

static 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
 
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

- Public Types inherited from Effect
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
- Static Public Attributes inherited from EffectPlugin
static const wxString kUserPresetIdent = wxT("User Preset:")
 
static const wxString kFactoryPresetIdent = wxT("Factory Preset:")
 
static const wxString kCurrentSettingsIdent = wxT("<Current Settings>")
 
static const wxString kFactoryDefaultsIdent = wxT("<Factory Defaults>")
 
- Protected Member Functions inherited from PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
- Protected Member Functions inherited from Effect
bool EnablePreview (bool enable=true)
 
bool CheckWhetherSkipEffect (const EffectSettings &settings) const override
 Default implementation returns false. More...
 
double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
 Default implementation returns previewLength More...
 
virtual std::unique_ptr< 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
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=0
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from Effect
wxWeakRef< wxDialog > mHostUIDialog
 This smart pointer tracks the lifetime of the dialog. More...
 
wxWindow * mUIParent {}
 
- Protected Attributes inherited from EffectBase
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
std::shared_ptr< TrackListmOutputTracks
 
double mT0 {}
 
double mT1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 
- Protected Attributes inherited from EffectUIClientInterface
friend EffectUIValidator
 
friend DefaultEffectUIValidator
 
- Static Protected Attributes inherited from EffectBase
static int nEffectsDone = 0
 

Detailed Description

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

645 : mPath{ path }
646 , mIndex{ index }
647{
648}
const wxString mPath
Definition: LadspaEffect.h:143
const int mIndex
Definition: LadspaEffect.h:144

◆ ~LadspaEffect()

LadspaEffect::~LadspaEffect ( )
virtual

Definition at line 650 of file LadspaEffect.cpp.

651{
652}

Member Function Documentation

◆ CanExportPresets()

bool LadspaEffect::CanExportPresets ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1455 of file LadspaEffect.cpp.

1456{
1457 return false;
1458}

◆ 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
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 auto &srcControls = GetSettings(src).controls;
130 auto &dstControls = GetSettings(dst).controls;
131 dstControls.resize(0);
132 copy(srcControls.begin(), srcControls.end(), back_inserter(dstControls));
133 return true;
134}
static LadspaEffectSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:415
std::vector< float > controls
Definition: LadspaEffect.h:50

References LadspaEffectSettings::controls, and EffectWithSettings< LadspaEffectSettings, PerTrackEffect >::GetSettings().

Here is the call graph for this function:

◆ ExportPresets()

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

Reimplemented from Effect.

Definition at line 1460 of file LadspaEffect.cpp.

1461{
1462}

◆ FreeInstance()

void LadspaEffect::FreeInstance ( LADSPA_Handle  handle) const
private

Definition at line 1588 of file LadspaEffect.cpp.

1589{
1590 if (mData->deactivate)
1591 {
1592 mData->deactivate(handle);
1593 }
1594
1595 mData->cleanup(handle);
1596}
const LADSPA_Descriptor * mData
Definition: LadspaEffect.h:147
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.

◆ GetAudioInCount()

unsigned LadspaEffect::GetAudioInCount ( ) const
overridevirtual

How many input buffers to allocate at once.

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

Reimplemented from Effect.

Definition at line 899 of file LadspaEffect.cpp.

900{
901 return mAudioIns;
902}
unsigned mAudioIns
Definition: LadspaEffect.h:156

References mAudioIns.

◆ GetAudioOutCount()

unsigned LadspaEffect::GetAudioOutCount ( ) const
overridevirtual

How many output buffers to allocate at once.

Reimplemented from Effect.

Definition at line 904 of file LadspaEffect.cpp.

905{
906 return mAudioOuts;
907}
unsigned mAudioOuts
Definition: LadspaEffect.h:160

References mAudioOuts.

◆ GetDescription()

TranslatableString LadspaEffect::GetDescription ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 678 of file LadspaEffect.cpp.

679{
680 return Verbatim( LAT1CTOWX(mData->Copyright) );
681}
#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 1102 of file LadspaEffect.cpp.

1103{
1104 return {};
1105}

◆ GetFamily()

EffectFamilySymbol LadspaEffect::GetFamily ( ) const
overridevirtual

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

Reimplemented from Effect.

Definition at line 707 of file LadspaEffect.cpp.

708{
710}
#define LADSPAEFFECTS_FAMILY
Definition: LadspaEffect.h:33

References LADSPAEFFECTS_FAMILY.

◆ GetMidiInCount()

int LadspaEffect::GetMidiInCount ( ) const
overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 909 of file LadspaEffect.cpp.

910{
911 return 0;
912}

◆ GetMidiOutCount()

int LadspaEffect::GetMidiOutCount ( ) const
overridevirtual

Function that has not yet found a use.

Reimplemented from EffectInstanceFactory.

Definition at line 914 of file LadspaEffect.cpp.

915{
916 return 0;
917}

◆ GetPath()

PluginPath LadspaEffect::GetPath ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 658 of file LadspaEffect.cpp.

659{
660 return wxString::Format(wxT("%s;%d"), mPath, mIndex);
661}

References mIndex, and mPath.

◆ GetSymbol()

ComponentInterfaceSymbol LadspaEffect::GetSymbol ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 663 of file LadspaEffect.cpp.

664{
665 return LAT1CTOWX(mData->Name);
666}
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 687 of file LadspaEffect.cpp.

688{
689 if (mAudioIns == 0 && mAudioOuts == 0)
690 {
691 return EffectTypeTool;
692 }
693
694 if (mAudioIns == 0)
695 {
696 return EffectTypeGenerate;
697 }
698
699 if (mAudioOuts == 0)
700 {
701 return EffectTypeAnalyze;
702 }
703
704 return EffectTypeProcess;
705}
@ EffectTypeAnalyze
@ EffectTypeGenerate
@ EffectTypeTool
@ EffectTypeProcess

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

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

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol LadspaEffect::GetVendor ( ) const
overridevirtual

Reimplemented from Effect.

Definition at line 668 of file LadspaEffect.cpp.

669{
670 return { LAT1CTOWX(mData->Maker) };
671}
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 673 of file LadspaEffect.cpp.

674{
675 return _("n/a");
676}
#define _(s)
Definition: Internat.h:75

References _.

◆ HasOptions()

bool LadspaEffect::HasOptions ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1468 of file LadspaEffect.cpp.

1469{
1470 return true;
1471}

◆ ImportPresets()

void LadspaEffect::ImportPresets ( EffectSettings settings)
overridevirtual

Reimplemented from Effect.

Definition at line 1464 of file LadspaEffect.cpp.

1465{
1466}

◆ InitializeControls()

bool LadspaEffect::InitializeControls ( LadspaEffectSettings settings) const

Definition at line 837 of file LadspaEffect.cpp.

838{
839 auto &controls = settings.controls;
840 // (Re-)initialize with right-sized vector
841 std::vector<float>(mData->PortCount).swap(controls);
842
843 for (unsigned long p = 0; p < mData->PortCount; ++p) {
846 // Determine the port's default value
847 controls[p] = InputControlPortDefaultValue(
849 else
850 controls[p] = 0;
851 }
852 return true;
853}
static Settings & settings()
Definition: TrackInfo.cpp:87
double mSampleRate
Definition: LadspaEffect.h:151
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
float InputControlPortDefaultValue(const LADSPA_PortRangeHint &hint, double sampleRate)
const LADSPA_PortDescriptor * PortDescriptors
Definition: ladspa.h:410
unsigned long PortCount
Definition: ladspa.h:406
const LADSPA_PortRangeHint * PortRangeHints
Definition: ladspa.h:419

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

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

◆ InitializePlugin()

bool LadspaEffect::InitializePlugin ( )

Definition at line 797 of file LadspaEffect.cpp.

798{
799 if (!Load())
800 return false;
801
803
806 for (unsigned long p = 0; p < mData->PortCount; p++) {
808
809 // Collect the audio ports
810 if (LADSPA_IS_PORT_AUDIO(d)) {
811 if (LADSPA_IS_PORT_INPUT(d))
812 mInputPorts[mAudioIns++] = p;
813 else if (LADSPA_IS_PORT_OUTPUT(d))
815 }
816 // Count control ports
817 else if (LADSPA_IS_PORT_CONTROL(d)) {
818 if (LADSPA_IS_PORT_INPUT(d)) {
819 mInteractive = true;
821 }
822 else if (LADSPA_IS_PORT_OUTPUT(d)) {
823 // LADSPA effects have a convention of providing latency on an output
824 // control port whose name is "latency".
825 if (strcmp(mData->PortNames[p], "latency") == 0)
826 mLatencyPort = p;
827 else {
828 mInteractive = true;
830 }
831 }
832 }
833 }
834 return true;
835}
void reinit(Integral count, bool initialize=false)
Definition: MemoryX.h:57
static bool LoadUseLatency(const EffectDefinitionInterface &effect)
int mNumInputControls
Definition: LadspaEffect.h:164
ArrayOf< unsigned long > mOutputPorts
Definition: LadspaEffect.h:162
ArrayOf< unsigned long > mInputPorts
Definition: LadspaEffect.h:158
int mNumOutputControls
Definition: LadspaEffect.h:165
#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(), 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().

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

1570{
1571 /* Instantiate the plugin */
1572 LADSPA_Handle handle = mData->instantiate(mData, sampleRate);
1573 if (!handle)
1574 return nullptr;
1575
1576 auto &controls = settings.controls;
1577 for (unsigned long p = 0; p < mData->PortCount; ++p) {
1580 mData->connect_port(handle, p, &controls[p]);
1581 }
1582 if (mData->activate)
1583 mData->activate(handle);
1584
1585 return handle;
1586}
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 717 of file LadspaEffect.cpp.

718{
719 return false;
720}

◆ IsGraphicalUI()

bool LadspaEffect::IsGraphicalUI ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1440 of file LadspaEffect.cpp.

1441{
1442 return false;
1443}

◆ IsInteractive()

bool LadspaEffect::IsInteractive ( ) const
overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 712 of file LadspaEffect.cpp.

713{
714 return mInteractive;
715}

References mInteractive.

◆ Load()

bool LadspaEffect::Load ( )
private

Definition at line 1483 of file LadspaEffect.cpp.

1484{
1485 if (mLib.IsLoaded())
1486 {
1487 return true;
1488 }
1489
1490 wxFileName ff = mPath;
1491 wxString envpath;
1492 bool hadpath = wxGetEnv(wxT("PATH"), &envpath);
1493 wxSetEnv(wxT("PATH"), ff.GetPath() + wxFILE_SEP_PATH + envpath);
1494 wxString saveOldCWD = ff.GetCwd();
1495 ff.SetCwd();
1496
1497 LADSPA_Descriptor_Function mainFn = NULL;
1498
1499 if (mLib.Load(mPath, wxDL_NOW))
1500 {
1501 wxLogNull logNo;
1502
1503 mainFn = (LADSPA_Descriptor_Function) mLib.GetSymbol(wxT("ladspa_descriptor"));
1504 if (mainFn)
1505 {
1506 mData = mainFn(mIndex);
1507 return true;
1508 }
1509 }
1510
1511 if (mLib.IsLoaded())
1512 {
1513 mLib.Unload();
1514 }
1515
1516 wxSetWorkingDirectory(saveOldCWD);
1517 hadpath ? wxSetEnv(wxT("PATH"), envpath) : wxUnsetEnv(wxT("PATH"));
1518
1519 return false;
1520}
wxDynamicLibrary mLib
Definition: LadspaEffect.h:146
const LADSPA_Descriptor *(* LADSPA_Descriptor_Function)(unsigned long Index)
Definition: ladspa.h:593

References mData, mIndex, mLib, and mPath.

Referenced by InitializePlugin().

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

1108{
1109 return true;
1110}

◆ LoadParameters()

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

Definition at line 1530 of file LadspaEffect.cpp.

1532{
1533 wxString parms;
1534 if (!GetConfig(*this, PluginSettings::Private, group, wxT("Parameters"),
1535 parms, wxEmptyString))
1536 {
1537 return false;
1538 }
1539
1541 if (!eap.SetParameters(parms))
1542 {
1543 return false;
1544 }
1545
1546 return LoadSettings(eap, settings);
1547}
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(), and settings().

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

1073{
1074 auto &controls = GetSettings(settings).controls;
1075 for (unsigned long p = 0; p < mData->PortCount; p++) {
1077
1078 if (LADSPA_IS_PORT_CONTROL(descriptor) &&
1079 LADSPA_IS_PORT_INPUT(descriptor)) {
1080 wxString labelText = LAT1CTOWX(mData->PortNames[p]);
1081 double d = 0.0;
1082 if (!parms.Read(labelText, &d))
1083 return false;
1084 controls[p] = d;
1085 }
1086 }
1087 return true;
1088}

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

469{
470 bool result{};
472 OptionsKey, UseLatencyKey, result, true /* default value */);
473 return result;
474}
static const wchar_t * UseLatencyKey
static const wchar_t * OptionsKey

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

Referenced by InitializePlugin().

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

1092{
1093 return LoadParameters(name, settings);
1094}
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

Implements EffectInstanceFactory.

Definition at line 894 of file LadspaEffect.cpp.

895{
896 return std::make_shared<Instance>(*this);
897}

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

1433{
1434 auto result =
1435 std::make_unique<Validator>(*this, access, mSampleRate, GetType());
1436 result->PopulateUI(S);
1437 return result;
1438}
#define S(N)
Definition: ToChars.cpp:64
EffectType GetType() const override
Type determines how it behaves.

References GetType(), mSampleRate, and S.

Here is the call graph for this function:

◆ SaveParameters()

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

Definition at line 1549 of file LadspaEffect.cpp.

1551{
1553 if (!SaveSettings(settings, eap))
1554 {
1555 return false;
1556 }
1557
1558 wxString parms;
1559 if (!eap.GetParameters(parms))
1560 {
1561 return false;
1562 }
1563
1564 return SetConfig(*this, PluginSettings::Private,
1565 group, wxT("Parameters"), parms);
1566}
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(), and settings().

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.

Returns
true on success

Reimplemented from Effect.

Definition at line 1058 of file LadspaEffect.cpp.

1060{
1061 const auto &controls = GetSettings(settings).controls;
1062 for (unsigned long p = 0; p < mData->PortCount; p++) {
1065 if (!parms.Write(LAT1CTOWX(mData->PortNames[p]), controls[p]))
1066 return false;
1067 }
1068 return true;
1069}

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

478{
479 return SetConfig(
481}

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

1098{
1099 return SaveParameters(name, settings);
1100}
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,
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 1042 of file LadspaEffect.cpp.

1044{
1045 dialog.Layout();
1046 dialog.Fit();
1047 dialog.SetMinSize(dialog.GetSize());
1048
1049 if ((SupportsRealtime() || GetType() == EffectTypeAnalyze) && !forceModal)
1050 {
1051 dialog.Show();
1052 return 0;
1053 }
1054
1055 return dialog.ShowModal();
1056}
bool SupportsRealtime() const override
Whether the effect supports realtime previewing (while audio is playing).

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

Here is the call graph for this function:

◆ ShowOptions()

void LadspaEffect::ShowOptions ( )
overridevirtual

Reimplemented from Effect.

Definition at line 1473 of file LadspaEffect.cpp.

1474{
1476 dlg.ShowModal();
1477}
wxWindow * mUIParent
Definition: Effect.h:389

References Effect::mUIParent, and mUseLatency.

◆ SupportsAutomation()

bool LadspaEffect::SupportsAutomation ( ) const
overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 727 of file LadspaEffect.cpp.

728{
729 return mNumInputControls > 0;
730}

References mNumInputControls.

◆ SupportsRealtime()

bool LadspaEffect::SupportsRealtime ( ) const
overridevirtual

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

Reimplemented from Effect.

Definition at line 722 of file LadspaEffect.cpp.

723{
724 return GetType() != EffectTypeGenerate;
725}

References EffectTypeGenerate, and GetType().

Referenced by ShowClientInterface().

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

◆ Unload()

void LadspaEffect::Unload ( )
private

Definition at line 1522 of file LadspaEffect.cpp.

1523{
1524 if (mLib.IsLoaded())
1525 {
1526 mLib.Unload();
1527 }
1528}

References mLib.

Friends And Related Function Documentation

◆ LadspaEffectsModule

friend class LadspaEffectsModule
friend

Definition at line 170 of file LadspaEffect.h.

Member Data Documentation

◆ mAudioIns

unsigned LadspaEffect::mAudioIns { 0 }
private

Definition at line 156 of file LadspaEffect.h.

Referenced by GetAudioInCount(), GetType(), and InitializePlugin().

◆ mAudioOuts

unsigned LadspaEffect::mAudioOuts { 0 }
private

Definition at line 160 of file LadspaEffect.h.

Referenced by GetAudioOutCount(), GetType(), and InitializePlugin().

◆ mBlockSize

size_t LadspaEffect::mBlockSize { 0 }
private

Definition at line 152 of file LadspaEffect.h.

◆ mData

const LADSPA_Descriptor* LadspaEffect::mData {}
private

◆ mIndex

const int LadspaEffect::mIndex
private

Definition at line 144 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ mInputPorts

ArrayOf<unsigned long> LadspaEffect::mInputPorts
private

Definition at line 158 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mInteractive

bool LadspaEffect::mInteractive { false }
private

Definition at line 154 of file LadspaEffect.h.

Referenced by InitializePlugin(), and IsInteractive().

◆ mLatencyPort

int LadspaEffect::mLatencyPort { -1 }
private

Definition at line 168 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mLib

wxDynamicLibrary LadspaEffect::mLib
private

Definition at line 146 of file LadspaEffect.h.

Referenced by Load(), and Unload().

◆ mNumInputControls

int LadspaEffect::mNumInputControls { 0 }
private

Definition at line 164 of file LadspaEffect.h.

Referenced by InitializePlugin(), and SupportsAutomation().

◆ mNumOutputControls

int LadspaEffect::mNumOutputControls { 0 }
private

Definition at line 165 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mOutputPorts

ArrayOf<unsigned long> LadspaEffect::mOutputPorts
private

Definition at line 162 of file LadspaEffect.h.

Referenced by InitializePlugin().

◆ mPath

const wxString LadspaEffect::mPath
private

Definition at line 143 of file LadspaEffect.h.

Referenced by GetPath(), and Load().

◆ mSampleRate

double LadspaEffect::mSampleRate { 44100.0 }
private

◆ mUseLatency

bool LadspaEffect::mUseLatency { true }
private

Definition at line 167 of file LadspaEffect.h.

Referenced by InitializePlugin(), and ShowOptions().

◆ pluginName

wxString LadspaEffect::pluginName
private

Definition at line 149 of file LadspaEffect.h.


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