LadspaEffectBase Class Reference

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

#include <LadspaEffectBase.h>

Inheritance diagram for LadspaEffectBase:

Collaboration diagram for LadspaEffectBase:

Public Member Functions
	LadspaEffectBase (const wxString &path, int index)
	~LadspaEffectBase () override
bool	InitializePlugin ()
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
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 EffectParameterMethods &	Parameters () const
bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...
bool	HasOptions () const override
const EffectSettingsManager &	GetDefinition () const override
virtual NumericFormatID	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, InstanceFinder finder={})
	Re-invoke DoEffect on another Effect object that implements the work. More...
Public Member Functions inherited from EffectBase
	EffectBase ()
	~EffectBase () override
bool	IsLinearEffect () const
bool	PreviewsFullSelection () const
void	SetTracks (TrackList *pTracks)
double	GetDefaultDuration ()
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...
bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
void	CountWaveTracks ()
Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (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 EffectSettingsManager &	GetDefinition () const =0
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< 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

Protected Member Functions
EffectSettings	MakeSettings () const override
bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
	Update one settings object from another. More...
std::unique_ptr< EffectOutputs >	MakeOutputs () 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
bool	InitializeControls (LadspaEffectSettings &settings) const
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...
bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...
bool	HasOptions () const override
bool	Load ()
void	Unload ()
OptionalMessage	LoadParameters (const RegistryPath &group, EffectSettings &settings) const
bool	SaveParameters (const RegistryPath &group, const EffectSettings &settings) const
Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const
bool	DoPass2 () const
bool	Process (EffectInstance &instance, EffectSettings &settings) const
std::shared_ptr< EffectOutputTracks >	MakeOutputTracks ()
void	DestroyOutputTracks () 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, sampleCount *start, sampleCount *len)
Protected Member Functions inherited from EffectBase
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...
void	SetLinearEffectFlag (bool linearEffectFlag)
void	SetPreviewFullSelectionFlag (bool previewDurationFlag)
bool	IsPreviewing () const
const TrackList *	inputTracks () const
const AudacityProject *	FindProject () const

Protected 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
unsigned	mNumInputControls { 0 }
unsigned	mNumOutputControls { 0 }
int	mLatencyPort { -1 }
Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}
Protected Attributes inherited from EffectBase
double	mF0 {}
double	mF1 {}
wxArrayString	mPresetNames
unsigned	mUIFlags { 0 }

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...
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 Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)
static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)
Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...
Public Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mTracks {}
int	mNumTracks {}
BasicUI::ProgressDialog *	mProgress {}
double	mProjectRate {}
WaveTrackFactory *	mFactory {}
double	mT0 {}
double	mT1 {}
bool	mIsPreview { false }
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>")

Detailed Description

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

Definition at line 24 of file LadspaEffectBase.h.

Constructor & Destructor Documentation

LadspaEffectBase()

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

Definition at line 76 of file LadspaEffectBase.cpp.

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

~LadspaEffectBase()

LadspaEffectBase::~LadspaEffectBase ( )

overridedefault

Member Function Documentation

CanExportPresets()

bool LadspaEffectBase::CanExportPresets ( ) const

overrideprotectedvirtual

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

Reimplemented from Effect.

Definition at line 346 of file LadspaEffectBase.cpp.

{
   return false;
}

CopySettingsContents()

bool LadspaEffectBase::CopySettingsContents ( const EffectSettings &  src, EffectSettings &  dst  ) const

overrideprotectedvirtual

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 35 of file LadspaEffectBase.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;
 
   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))
         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, and _LADSPA_Descriptor::PortDescriptors.

Here is the call graph for this function:

GetDescription()

TranslatableString LadspaEffectBase::GetDescription ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 108 of file LadspaEffectBase.cpp.

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

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

Here is the call graph for this function:

GetFactoryPresets()

RegistryPaths LadspaEffectBase::GetFactoryPresets ( ) const

overrideprotectedvirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 336 of file LadspaEffectBase.cpp.

{
   return {};
}

GetFamily()

EffectFamilySymbol LadspaEffectBase::GetFamily ( ) const

overrideprotectedvirtual

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

Reimplemented from Effect.

Definition at line 137 of file LadspaEffectBase.cpp.

{
   return LADSPAEFFECTS_FAMILY;
}

References LADSPAEFFECTS_FAMILY.

GetPath()

PluginPath LadspaEffectBase::GetPath ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 88 of file LadspaEffectBase.cpp.

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

References mIndex, mPath, and wxT().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol LadspaEffectBase::GetSymbol ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 93 of file LadspaEffectBase.cpp.

{
   return LAT1CTOWX(mData->Name);
}

References LAT1CTOWX, mData, and _LADSPA_Descriptor::Name.

GetType()

EffectType LadspaEffectBase::GetType ( ) const

overrideprotectedvirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 117 of file LadspaEffectBase.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 LadspaEffect::MakeEditor(), RealtimeSupport(), and LadspaEffect::ShowClientInterface().

Here is the caller graph for this function:

GetVendor()

VendorSymbol LadspaEffectBase::GetVendor ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 98 of file LadspaEffectBase.cpp.

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

References LAT1CTOWX, _LADSPA_Descriptor::Maker, and mData.

GetVersion()

wxString LadspaEffectBase::GetVersion ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 103 of file LadspaEffectBase.cpp.

{
   return "n/a";
}

HasOptions()

bool LadspaEffectBase::HasOptions ( ) const

overrideprotectedvirtual

Whether there are preferences applying to the effect's family, for which a UI may be needed to change them

Reimplemented from Effect.

Definition at line 351 of file LadspaEffectBase.cpp.

{
   return true;
}

InitializeControls()

bool LadspaEffectBase::InitializeControls ( LadspaEffectSettings &  settings ) const

protected

Definition at line 267 of file LadspaEffectBase.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{LadspaEffectBase.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 LadspaEffect::LadspaEffectBase().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializePlugin()

bool LadspaEffectBase::InitializePlugin

(

)

Definition at line 229 of file LadspaEffectBase.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().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDefault()

bool LadspaEffectBase::IsDefault ( ) const

overrideprotectedvirtual

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

Reimplemented from Effect.

Definition at line 147 of file LadspaEffectBase.cpp.

{
   return false;
}

IsInteractive()

bool LadspaEffectBase::IsInteractive ( ) const

overrideprotectedvirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 142 of file LadspaEffectBase.cpp.

{
   return mInteractive;
}

References mInteractive.

Load()

bool LadspaEffectBase::Load ( )

protected

Definition at line 360 of file LadspaEffectBase.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()

OptionalMessage LadspaEffectBase::LoadFactoryPreset ( int  id, EffectSettings &  settings  ) const

overrideprotectedvirtual

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

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 341 of file LadspaEffectBase.cpp.

{
   return { nullptr };
}

LoadParameters()

OptionalMessage LadspaEffectBase::LoadParameters ( const RegistryPath &  group, EffectSettings &  settings  ) const

protected

Definition at line 407 of file LadspaEffectBase.cpp.

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

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 LadspaEffectBase::LoadSettings ( const CommandParameters &  parms, EffectSettings &  settings  ) const

overrideprotectedvirtual

Restore settings from keys and values.

Returns

true on success

Reimplemented from Effect.

Definition at line 305 of file LadspaEffectBase.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:

LoadUserPreset()

OptionalMessage LadspaEffectBase::LoadUserPreset ( const RegistryPath &  name, EffectSettings &  settings  ) const

overrideprotectedvirtual

Change settings to a user-named preset

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 324 of file LadspaEffectBase.cpp.

{
   return LoadParameters(name, settings);
}

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

Here is the call graph for this function:

MakeInstance()

std::shared_ptr< EffectInstance > LadspaEffectBase::MakeInstance ( ) const

overrideprotectedvirtual

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 285 of file LadspaEffectBase.cpp.

{
   return std::make_shared<LadspaInstance>(*this, mData,
      mInputPorts, mOutputPorts, mAudioIns, mAudioOuts,
      mLatencyPort);
}

References mAudioIns, mAudioOuts, mData, mInputPorts, mLatencyPort, and mOutputPorts.

MakeOutputs()

auto LadspaEffectBase::MakeOutputs ( ) const

overrideprotectedvirtual

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

Default implementation returns nullptr

Reimplemented from EffectSettingsManager.

Definition at line 69 of file LadspaEffectBase.cpp.

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

References mData, and _LADSPA_Descriptor::PortCount.

MakeSettings()

EffectSettings LadspaEffectBase::MakeSettings ( ) const

overrideprotectedvirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 28 of file LadspaEffectBase.cpp.

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

RealtimeSupport()

auto LadspaEffectBase::RealtimeSupport ( ) const

overrideprotectedvirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 152 of file LadspaEffectBase.cpp.

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

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

Here is the call graph for this function:

SaveParameters()

bool LadspaEffectBase::SaveParameters ( const RegistryPath &  group, const EffectSettings &  settings  ) const

protected

Definition at line 428 of file LadspaEffectBase.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 LadspaEffectBase::SaveSettings ( const EffectSettings &  settings, CommandParameters &  parms  ) const

overrideprotectedvirtual

Store settings as keys and values.

The override may assume parms is initially empty

Returns

true on success

Reimplemented from Effect.

Definition at line 292 of file LadspaEffectBase.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:

SaveUserPreset()

bool LadspaEffectBase::SaveUserPreset ( const RegistryPath &  name, const EffectSettings &  settings  ) const

overrideprotectedvirtual

Save settings in the configuration file as a user-named preset.

Reimplemented from Effect.

Definition at line 330 of file LadspaEffectBase.cpp.

{
   return SaveParameters(name, settings);
}

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

Here is the call graph for this function:

SupportsAutomation()

bool LadspaEffectBase::SupportsAutomation ( ) const

overrideprotectedvirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 159 of file LadspaEffectBase.cpp.

{
   return mNumInputControls > 0;
}

References mNumInputControls.

Unload()

void LadspaEffectBase::Unload ( )

protected

Definition at line 399 of file LadspaEffectBase.cpp.

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

References mLib.

Member Data Documentation

mAudioIns

unsigned LadspaEffectBase::mAudioIns { 0 }

protected

Definition at line 95 of file LadspaEffectBase.h.

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

mAudioOuts

unsigned LadspaEffectBase::mAudioOuts { 0 }

protected

Definition at line 99 of file LadspaEffectBase.h.

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

mBlockSize

size_t LadspaEffectBase::mBlockSize { 0 }

protected

Definition at line 91 of file LadspaEffectBase.h.

mData

const LADSPA_Descriptor* LadspaEffectBase::mData {}

protected

Definition at line 87 of file LadspaEffectBase.h.

Referenced by CopySettingsContents(), GetDescription(), GetSymbol(), GetVendor(), InitializeControls(), InitializePlugin(), LadspaEffect::LadspaEffectBase(), Load(), LoadSettings(), MakeInstance(), MakeOutputs(), and SaveSettings().

mIndex

const int LadspaEffectBase::mIndex

protected

Definition at line 84 of file LadspaEffectBase.h.

Referenced by GetPath(), and Load().

mInputPorts

ArrayOf<unsigned long> LadspaEffectBase::mInputPorts

protected

Definition at line 97 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), and MakeInstance().

mInteractive

bool LadspaEffectBase::mInteractive { false }

protected

Definition at line 93 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), and IsInteractive().

mLatencyPort

int LadspaEffectBase::mLatencyPort { -1 }

protected

Definition at line 106 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), and MakeInstance().

mLib

wxDynamicLibrary LadspaEffectBase::mLib

protected

Definition at line 86 of file LadspaEffectBase.h.

Referenced by Load(), and Unload().

mNumInputControls

unsigned LadspaEffectBase::mNumInputControls { 0 }

protected

Definition at line 103 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), LadspaEffect::MakeEditor(), and SupportsAutomation().

mNumOutputControls

unsigned LadspaEffectBase::mNumOutputControls { 0 }

protected

Definition at line 104 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), and LadspaEffect::MakeEditor().

mOutputPorts

ArrayOf<unsigned long> LadspaEffectBase::mOutputPorts

protected

Definition at line 101 of file LadspaEffectBase.h.

Referenced by InitializePlugin(), and MakeInstance().

mPath

const wxString LadspaEffectBase::mPath

protected

Definition at line 83 of file LadspaEffectBase.h.

Referenced by GetPath(), and Load().

pluginName

wxString LadspaEffectBase::pluginName

protected

Definition at line 89 of file LadspaEffectBase.h.

---

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

• LadspaEffectBase.h
• LadspaEffectBase.cpp