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:

Collaboration diagram for LadspaEffect:

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< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Add controls to effect panel; always succeeds. More...

bool	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 EffectParameterMethods &	Parameters () const

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override

EffectUIClientInterface *	GetEffectUIClientInterface () override
	Returns the EffectUIClientInterface instance for this effect. More...

std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, 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< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual bool	CanExportPresets ()=0

virtual void	ExportPresets (const EffectSettings &settings) const =0

virtual void	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () 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 EffectUIClientInterface *	GetEffectUIClientInterface ()=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< EffectInstance >	MakeInstance () 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 LadspaEffectSettings &	GetSettings (EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...

static const LadspaEffectSettings &	GetSettings (const EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...

static LadspaEffectSettings *	FetchParameters (PerTrackEffect &, EffectSettings &s)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (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_Descriptor *	mData {}

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< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
	Add controls to effect panel; always succeeds. More...

bool	TotalProgress (double frac, const TranslatableString &={}) const

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

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 TrackList *	inputTracks () const

const AudacityProject *	FindProject () 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::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

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.

   : mPath{ path }
   , mIndex{ index }
{
}

◆ ~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.

{
   return false;
}

◆ 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

src	settings to copy from
dst	settings to copy into
copyDirection	direction in which copy is performed

Returns: success

Reimplemented from EffectSettingsManager.

Definition at line 123 of file LadspaEffect.cpp.

{
   // Do not use the copy constructor of std::vector.  Do an in-place rewrite
   // of the destination vector, which will not allocate memory if dstControls
   // began with sufficient capacity.
   const auto portCount = mData->PortCount;
 
   auto &srcControls = GetSettings(src).controls;
   auto &dstControls = GetSettings(dst).controls;
 
   assert(srcControls.size() == portCount);
   assert(dstControls.size() == portCount);
 
   const auto portValuesCount =
      std::min(srcControls.size(), dstControls.size());
 
   if (portValuesCount != portCount)
      return false;
 
   const auto copyOutputs = copyDirection == SettingsCopyDirection::WorkerToMain;
 
   for (unsigned long p = 0; p < portCount; ++p)
   {
      LADSPA_PortDescriptor d = mData->PortDescriptors[p];
 
      if (!(LADSPA_IS_PORT_CONTROL(d)))
         continue;
 
      if (LADSPA_IS_PORT_INPUT(d) || copyOutputs)
         dstControls[p] = srcControls[p];
   }
 
   return true;
}

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.

{
   if (mData->deactivate)
   {
      mData->deactivate(handle);
   }
 
   mData->cleanup(handle);
}

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

◆ FullyInitializePlugin()

bool LadspaEffect::FullyInitializePlugin ( )

Definition at line 858 of file LadspaEffect.cpp.

{
   if (!InitializePlugin())
      return false;
 
   // Reading these values from the config file can't be done in the PluginHost
   // process but isn't needed only for plugin discovery.
 
   mUseLatency = LadspaEffect::LoadUseLatency(*this);
   return true;
}

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.

{
   return Verbatim( LAT1CTOWX(mData->Copyright) );
}

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.

{
   return {};
}

◆ 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.

{
   return LADSPAEFFECTS_FAMILY;
}

References LADSPAEFFECTS_FAMILY.

◆ GetPath()

PluginPath LadspaEffect::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 679 of file LadspaEffect.cpp.

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

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.

{
   return LAT1CTOWX(mData->Name);
}

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.

{
   if (mAudioIns == 0 && mAudioOuts == 0)
   {
      return EffectTypeTool;
   }
 
   if (mAudioIns == 0)
   {
      return EffectTypeGenerate;
   }
 
   if (mAudioOuts == 0)
   {
      return EffectTypeAnalyze;
   }
 
   return EffectTypeProcess;
}

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.

{
   return { LAT1CTOWX(mData->Maker) };
}

References LAT1CTOWX, _LADSPA_Descriptor::Maker, and mData.

◆ GetVersion()

wxString LadspaEffect::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 694 of file LadspaEffect.cpp.

{
   return "n/a";
}

◆ HasOptions()

bool LadspaEffect::HasOptions ( )

overridevirtual

Reimplemented from Effect.

Definition at line 1498 of file LadspaEffect.cpp.

{
   return true;
}

◆ 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.

{
   auto &controls = settings.controls;
   // (Re-)initialize with right-sized vector
   std::vector<float>(mData->PortCount).swap(controls);
 
   for (unsigned long p = 0; p < mData->PortCount; ++p) {
      LADSPA_PortDescriptor d = mData->PortDescriptors[p];
      if (LADSPA_IS_PORT_CONTROL(d) && LADSPA_IS_PORT_INPUT(d))
         // Determine the port's default value
         controls[p] = InputControlPortDefaultValue(
            mData->PortRangeHints[p], mProjectRate);
      else
         controls[p] = 0;
   }
   return true;
}

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.

{
   if (!Load())
      return false;
 
   mInputPorts.reinit( mData->PortCount );
   mOutputPorts.reinit( mData->PortCount );
   for (unsigned long p = 0; p < mData->PortCount; p++) {
      LADSPA_PortDescriptor d = mData->PortDescriptors[p];
 
      // Collect the audio ports
      if (LADSPA_IS_PORT_AUDIO(d)) {
         if (LADSPA_IS_PORT_INPUT(d))
            mInputPorts[mAudioIns++] = p;
         else if (LADSPA_IS_PORT_OUTPUT(d))
            mOutputPorts[mAudioOuts++] = p;
      }
      // Count control ports
      else if (LADSPA_IS_PORT_CONTROL(d)) {
         if (LADSPA_IS_PORT_INPUT(d)) {
            mInteractive = true;
            mNumInputControls++;
         }
         else if (LADSPA_IS_PORT_OUTPUT(d)) {
            // LADSPA effects have a convention of providing latency on an output
            // control port whose name is "latency".
            if (strcmp(mData->PortNames[p], "latency") == 0)
               mLatencyPort = p;
            else {
               mInteractive = true;
               mNumOutputControls++;
            }
         }
      }
   }
   return true;
}

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.

{
   /* Instantiate the plugin */
   LADSPA_Handle handle = mData->instantiate(mData, sampleRate);
   if (!handle)
      return nullptr;
 
   auto &controls = settings.controls;
   for (unsigned long p = 0; p < mData->PortCount; ++p) {
      LADSPA_PortDescriptor d = mData->PortDescriptors[p];
      if (LADSPA_IS_PORT_CONTROL(d))
         mData->connect_port(handle, p, &controls[p]);
   }
   if (mData->activate)
      mData->activate(handle);
 
   return handle;
}

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.

{
   return false;
}

◆ 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.

{
   return mInteractive;
}

References mInteractive.

◆ Load()

bool LadspaEffect::Load ( )

private

Definition at line 1513 of file LadspaEffect.cpp.

{
   if (mLib.IsLoaded())
   {
      return true;
   }
 
   wxFileName ff = mPath;
   wxString envpath;
   bool hadpath = wxGetEnv(wxT("PATH"), &envpath);
   wxSetEnv(wxT("PATH"), ff.GetPath() + wxFILE_SEP_PATH + envpath);
   wxString saveOldCWD = ff.GetCwd();
   ff.SetCwd();
 
   LADSPA_Descriptor_Function mainFn = NULL;
 
   if (mLib.Load(mPath, wxDL_NOW))
   {
      wxLogNull logNo;
 
      mainFn = (LADSPA_Descriptor_Function) mLib.GetSymbol(wxT("ladspa_descriptor"));
      if (mainFn)
      {
         mData = mainFn(mIndex);
         return true;
      }
   }
 
   if (mLib.IsLoaded())
   {
      mLib.Unload();
   }
 
   wxSetWorkingDirectory(saveOldCWD);
   hadpath ? wxSetEnv(wxT("PATH"), envpath) : wxUnsetEnv(wxT("PATH"));
 
   return false;
}

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.

{
   return true;
}

◆ LoadParameters()

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

private

Definition at line 1560 of file LadspaEffect.cpp.

{
   wxString parms;
   if (!GetConfig(*this, PluginSettings::Private, group, wxT("Parameters"),
      parms, wxEmptyString))
   {
      return false;
   }
 
   CommandParameters eap;
   if (!eap.SetParameters(parms))
   {
      return false;
   }
 
   return LoadSettings(eap, settings);
}

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.

{
   auto &controls = GetSettings(settings).controls;
   for (unsigned long p = 0; p < mData->PortCount; p++) {
      LADSPA_PortDescriptor descriptor = mData->PortDescriptors[p];
 
      if (LADSPA_IS_PORT_CONTROL(descriptor) &&
          LADSPA_IS_PORT_INPUT(descriptor)) {
         wxString labelText = LAT1CTOWX(mData->PortNames[p]);
         double d = 0.0;
         if (!parms.Read(labelText, &d))
            return false;
         controls[p] = d;
      }
   }
   return true;
}

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.

{
   bool result{};
   GetConfig(effect, PluginSettings::Shared,
      OptionsKey, UseLatencyKey, result, true /* default value */);
   return result;
}

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.

{
   return LoadParameters(name, settings);
}

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

settings may 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.

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

◆ 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.

{
   auto result = EffectSettings::Make<LadspaEffectSettings>( mData->PortCount );
   InitializeControls(GetSettings(result));
   return result;
}

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.

{
   auto result =
      std::make_unique<Validator>(*this, access, mProjectRate, GetType());
   result->PopulateUI(S);
   return result;
}

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.

{
   return GetType() == EffectTypeProcess
      ? RealtimeSince::Since_3_2
      : RealtimeSince::Never;
}

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.

{
   CommandParameters eap;
   if (!SaveSettings(settings, eap))
   {
      return false;
   }
 
   wxString parms;
   if (!eap.GetParameters(parms))
   {
      return false;
   }
 
   return SetConfig(*this, PluginSettings::Private,
      group, wxT("Parameters"), parms);
}

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.

{
   const auto &controls = GetSettings(settings).controls;
   for (unsigned long p = 0; p < mData->PortCount; p++) {
      LADSPA_PortDescriptor d = mData->PortDescriptors[p];
      if (LADSPA_IS_PORT_CONTROL(d) && LADSPA_IS_PORT_INPUT(d))
         if (!parms.Write(LAT1CTOWX(mData->PortNames[p]), controls[p]))
            return false;
   }
   return true;
}

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.

{
   return SetConfig(
      effect, PluginSettings::Shared, OptionsKey, UseLatencyKey, value);
}

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.

{
   return SaveParameters(name, settings);
}

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.

{
   dialog.Layout();
   dialog.Fit();
   dialog.SetMinSize(dialog.GetSize());
 
   if ((SupportsRealtime() || GetType() == EffectTypeAnalyze) && !forceModal)
   {
      dialog.Show();
      return 0;
   }
 
   return dialog.ShowModal();
}

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.

{
   LadspaEffectOptionsDialog dlg(mUIParent, *this, mUseLatency);
   dlg.ShowModal();
}

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.

{
   return mNumInputControls > 0;
}

References mNumInputControls.

◆ Unload()

void LadspaEffect::Unload ( )

private

Definition at line 1552 of file LadspaEffect.cpp.

{
   if (mLib.IsLoaded())
   {
      mLib.Unload();
   }
}

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

Definition at line 142 of file LadspaEffect.h.

Referenced by CopySettingsContents(), FreeInstance(), GetDescription(), GetSymbol(), GetVendor(), InitializeControls(), InitializePlugin(), InitInstance(), Load(), LoadSettings(), MakeSettings(), LadspaEffect::Instance::RealtimeResume(), LadspaEffect::Instance::RealtimeSuspend(), and SaveSettings().

◆ 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:

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LadspaEffect()

◆ ~LadspaEffect()

Member Function Documentation

◆ CanExportPresets()

◆ CopySettingsContents()

◆ ExportPresets()

◆ FreeInstance()

◆ FullyInitializePlugin()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ ImportPresets()

◆ InitializeControls()

◆ InitializePlugin()

◆ InitInstance()

◆ IsDefault()

◆ IsInteractive()

◆ Load()

◆ LoadFactoryPreset()

◆ LoadParameters()

◆ LoadSettings()

◆ LoadUseLatency()

◆ LoadUserPreset()

◆ MakeInstance()

◆ MakeSettings()

◆ PopulateOrExchange()

◆ RealtimeSupport()

◆ SaveParameters()

◆ SaveSettings()

◆ SaveUseLatency()

◆ SaveUserPreset()

◆ ShowClientInterface()

◆ ShowOptions()

◆ SupportsAutomation()

◆ Unload()

Friends And Related Function Documentation

◆ LadspaEffectsModule

Member Data Documentation

◆ mAudioIns

◆ mAudioOuts

◆ mBlockSize

◆ mData

◆ mIndex

◆ mInputPorts

◆ mInteractive

◆ mLatencyPort

◆ mLib

◆ mNumInputControls

◆ mNumOutputControls

◆ mOutputPorts

◆ mPath

◆ mUseLatency

◆ pluginName