LV2EffectBase Class Reference

#include <LV2EffectBase.h>

Inheritance diagram for LV2EffectBase:

Collaboration diagram for LV2EffectBase:

Public Member Functions
	LV2EffectBase (const LilvPlugin &plug)
	~LV2EffectBase () override
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	InitializePlugin ()
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
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...
OptionalMessage	LoadParameters (const RegistryPath &group, EffectSettings &settings) const
bool	SaveParameters (const RegistryPath &group, const EffectSettings &settings) const
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)
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

Public Attributes
const LilvPlugin &	mPlug
const LV2FeaturesList	mFeatures { mPlug }
const LV2Ports	mPorts { mPlug }
bool	mWantsOptionsInterface { false }
bool	mWantsStateInterface { false }
size_t	mFramePos {}
FloatBuffers	mCVInBuffers
FloatBuffers	mCVOutBuffers
double	mLength {}
bool	mFactoryPresetsLoaded { false }
RegistryPaths	mFactoryPresetNames
wxArrayString	mFactoryPresetUris
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 }

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

Detailed Description

Definition at line 29 of file LV2EffectBase.h.

Constructor & Destructor Documentation

LV2EffectBase()

LV2EffectBase::LV2EffectBase

(

const LilvPlugin &

plug

)

Definition at line 28 of file LV2EffectBase.cpp.

                                                   : mPlug{ plug }
{
}

~LV2EffectBase()

LV2EffectBase::~LV2EffectBase ( )

overridedefault

Member Function Documentation

CanExportPresets()

bool LV2EffectBase::CanExportPresets ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 332 of file LV2EffectBase.cpp.

{
   return false;
}

CopySettingsContents()

bool LV2EffectBase::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

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 164 of file LV2EffectBase.cpp.

{
   auto &srcControls = GetSettings(src).values;
   auto &dstControls = GetSettings(dst).values;
 
   const auto &controlPorts = mPorts.mControlPorts;
   const auto portsCount = controlPorts.size();
   // 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.
   // And that will be true if dstControls originated with MakeSettings() or a
   // copy of it, because the set of control ports does not vary after
   // initialization of the plug-in.
   assert(srcControls.size() == portsCount);
   assert(dstControls.size() == portsCount);
   // But let's be sure
   const auto portValuesCount =
      std::min(srcControls.size(), dstControls.size());
 
   if (portValuesCount != portsCount)
      return false;
 
   size_t portIndex {};
 
   for (auto& port : controlPorts)
   {
      if (port->mIsInput)
         dstControls[portIndex] = srcControls[portIndex];
 
      ++portIndex;
   }
 
   // Ignore mpState
 
   return true;
}

References GetSettings(), LV2Ports::mControlPorts, min(), mPorts, and LV2EffectSettings::values.

Here is the call graph for this function:

GetDescription()

TranslatableString LV2EffectBase::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 65 of file LV2EffectBase.cpp.

{
   return XO("n/a");
}

References XO().

Here is the call graph for this function:

GetFactoryPresets()

RegistryPaths LV2EffectBase::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Reimplemented from Effect.

Definition at line 276 of file LV2EffectBase.cpp.

{
   using namespace LV2Symbols;
   if (mFactoryPresetsLoaded)
      return mFactoryPresetNames;
 
   if (LilvNodesPtr presets{ lilv_plugin_get_related(&mPlug, node_Preset) }) {
      LILV_FOREACH(nodes, i, presets.get()) {
         const auto preset = lilv_nodes_get(presets.get(), i);
 
         mFactoryPresetUris.push_back(LilvString(preset));
 
         lilv_world_load_resource(gWorld, preset);
 
         if (LilvNodesPtr labels{ lilv_world_find_nodes(gWorld, preset,
            node_Label, nullptr) }) {
            const auto label = lilv_nodes_get_first(labels.get());
            mFactoryPresetNames.push_back(LilvString(label));
         }
         else
            mFactoryPresetNames.push_back(
               LilvString(preset).AfterLast(wxT('#')));
      }
   }
 
   mFactoryPresetsLoaded = true;
 
   return mFactoryPresetNames;
}

References LV2Symbols::gWorld, label, LilvString(), mFactoryPresetNames, mFactoryPresetsLoaded, mFactoryPresetUris, mPlug, preset, and wxT().

Here is the call graph for this function:

GetFamily()

EffectFamilySymbol LV2EffectBase::GetFamily ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 94 of file LV2EffectBase.cpp.

{
   return LV2EFFECTS_FAMILY;
}

References LV2EFFECTS_FAMILY.

GetPath()

PluginPath LV2EffectBase::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 38 of file LV2EffectBase.cpp.

{
   return LilvString(lilv_plugin_get_uri(&mPlug));
}

References LilvString(), and mPlug.

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol LV2EffectBase::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 43 of file LV2EffectBase.cpp.

{
   return LV2FeaturesList::GetPluginSymbol(mPlug);
}

References LV2FeaturesList::GetPluginSymbol(), and mPlug.

Here is the call graph for this function:

GetType()

EffectType LV2EffectBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 74 of file LV2EffectBase.cpp.

{
   if (mPorts.mAudioIn == 0 && mPorts.mAudioOut == 0)
   {
      return EffectTypeTool;
   }
 
   if (mPorts.mAudioIn == 0)
   {
      return EffectTypeGenerate;
   }
 
   if (mPorts.mAudioOut == 0)
   {
      return EffectTypeAnalyze;
   }
 
   return EffectTypeProcess;
}

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, LV2Ports::mAudioIn, LV2Ports::mAudioOut, and mPorts.

Referenced by LV2Effect::PopulateUI(), RealtimeSupport(), and LV2Effect::ShowClientInterface().

Here is the caller graph for this function:

GetVendor()

VendorSymbol LV2EffectBase::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 48 of file LV2EffectBase.cpp.

{
   wxString vendor = LilvStringMove(lilv_plugin_get_author_name(&mPlug));
 
   if (vendor.empty())
   {
      return XO("n/a");
   }
 
   return {vendor};
}

References LilvStringMove(), mPlug, and XO().

Referenced by LV2Effect::PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVersion()

wxString LV2EffectBase::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 60 of file LV2EffectBase.cpp.

{
   return wxT("1.0");
}

References wxT().

Here is the call graph for this function:

HasOptions()

bool LV2EffectBase::HasOptions ( ) const

overridevirtual

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 337 of file LV2EffectBase.cpp.

{
   return true;
}

InitializePlugin()

bool LV2EffectBase::InitializePlugin

(

)

Definition at line 122 of file LV2EffectBase.cpp.

{
   if (!mFeatures.mOk)
      return false;
 
   // Do a check only on temporary feature list objects
   auto instanceFeatures = LV2InstanceFeaturesList{ mFeatures };
   if (!instanceFeatures.mOk)
      return false;
   if (!LV2InstanceFeaturesList::ValidatePlugin::Call(mPlug, instanceFeatures))
      return false;
 
   // Determine available extensions
   mWantsOptionsInterface = false;
   mWantsStateInterface = false;
   if (LilvNodesPtr extdata{ lilv_plugin_get_extension_data(&mPlug) }) {
      LILV_FOREACH(nodes, i, extdata.get()) {
         const auto node = lilv_nodes_get(extdata.get(), i);
         const auto uri = lilv_node_as_string(node);
         if (strcmp(uri, LV2_OPTIONS__interface) == 0)
            mWantsOptionsInterface = true;
         else if (strcmp(uri, LV2_STATE__interface) == 0)
            mWantsStateInterface = true;
      }
   }
 
   return true;
}

References GlobalHook< ValidatePlugin, std::remove_pointer_t< decltype(DefaultFunction)>, DefaultFunction, Options... >::Call(), mFeatures, LV2FeaturesList::mOk, mPlug, mWantsOptionsInterface, and mWantsStateInterface.

Referenced by LV2EffectsModule::DiscoverPluginsAtPath().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDefault()

bool LV2EffectBase::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 104 of file LV2EffectBase.cpp.

{
   return false;
}

IsInteractive()

bool LV2EffectBase::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 99 of file LV2EffectBase.cpp.

{
   return mPorts.mControlPorts.size() != 0;
}

References LV2Ports::mControlPorts, and mPorts.

LoadFactoryPreset()

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

overridevirtual

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

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 307 of file LV2EffectBase.cpp.

{
   using namespace LV2Symbols;
   if (id < 0 || id >= (int) mFactoryPresetUris.size())
      return {};
 
   LilvNodePtr preset{ lilv_new_uri(gWorld, mFactoryPresetUris[id].ToUTF8()) };
   if (!preset)
      return {};
 
   using LilvStatePtr = Lilv_ptr<LilvState, lilv_state_free>;
   LilvStatePtr state{
      lilv_state_new_from_world(gWorld,
         mFeatures.URIDMapFeature(), preset.get())
   };
   if (!state)
      return {};
 
   auto &mySettings = GetSettings(settings);
   mPorts.EmitPortValues(*state, mySettings);
   // Save the state, for whatever might not be contained in port values
   mySettings.mpState = move(state);
   return { nullptr };
}

References LV2Ports::EmitPortValues(), GetSettings(), LV2Symbols::gWorld, mFactoryPresetUris, mFeatures, mPorts, preset, settings(), audacity::ToUTF8(), and LV2FeaturesList::URIDMapFeature().

Here is the call graph for this function:

LoadParameters()

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

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

overridevirtual

Restore settings from keys and values.

Returns

true on success

Reimplemented from Effect.

Definition at line 233 of file LV2EffectBase.cpp.

{
   // First pass validates values
   for (auto & port : mPorts.mControlPorts) {
      if (port->mIsInput) {
         double d = 0.0;
         if (!parms.Read(port->mName, &d))
            return false;
         // Use unscaled range here
         if (d < port->mMin || d > port->mMax)
            return false;
      }
   }
 
   // Second pass actually sets the values
   auto &values = GetSettings(settings).values;
   size_t index = 0;
   for (auto & port : mPorts.mControlPorts) {
      if (port->mIsInput) {
         double d = 0.0;
         if (!parms.Read(port->mName, &d))
            return false;
         values[index] = d;
      }
      ++index;
   }
 
   return true;
}

References GetSettings(), LV2Ports::mControlPorts, mPorts, settings(), LV2EffectSettings::values, and values.

Referenced by LoadParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadUserPreset()

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

overridevirtual

Change settings to a user-named preset

Returns

nullopt for failure

Reimplemented from Effect.

Definition at line 264 of file LV2EffectBase.cpp.

{
   return LoadParameters(name, settings);
}

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

Here is the call graph for this function:

MakeInstance()

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

{
   auto result = std::make_shared<LV2Instance>(*this, mFeatures, mPorts);
   if (result->IsOk())
      return result;
   return nullptr;
}

References mFeatures, and mPorts.

MakeOutputs()

auto LV2EffectBase::MakeOutputs ( ) const

overridevirtual

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

Default implementation returns nullptr

Reimplemented from EffectSettingsManager.

Definition at line 202 of file LV2EffectBase.cpp.

{
   auto result = std::make_unique<LV2EffectOutputs>();
   auto &values = result->values;
   // This may waste a bit of space on input ports, but not likely much
   values.resize(mPorts.mControlPorts.size());
   return result;
}

References LV2Ports::mControlPorts, mPorts, and values.

MakeSettings()

EffectSettings LV2EffectBase::MakeSettings ( ) const

overridevirtual

Produce an object holding new, independent settings

Default implementation returns an empty any

Reimplemented from EffectSettingsManager.

Definition at line 151 of file LV2EffectBase.cpp.

{
   auto result = EffectSettings::Make<LV2EffectSettings>();
   auto &settings = GetSettings(result);
   // This may waste a bit of space on output ports, but not likely much
   settings.values.reserve(mPorts.mControlPorts.size());
   for (auto &controlPort : mPorts.mControlPorts) {
      auto &value = settings.values.emplace_back();
      value = controlPort->mDef;
   }
   return result;
}

References GetSettings(), LV2Ports::mControlPorts, mPorts, and settings().

Here is the call graph for this function:

RealtimeSupport()

auto LV2EffectBase::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 109 of file LV2EffectBase.cpp.

{
   // TODO reenable after achieving statelessness
   return GetType() == EffectTypeProcess
      ? RealtimeSince::Always
      : RealtimeSince::Never;
}

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

Here is the call graph for this function:

SaveParameters()

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

Definition at line 361 of file LV2EffectBase.cpp.

{
   // PRL: This function just dumps the several control port values to the
   // config files.  Should it be reimplemented with
   // lilv_state_new_from_instance to capture -- I don't know what -- other
   // important state?
 
   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 LV2EffectBase::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 219 of file LV2EffectBase.cpp.

{
   auto &values = GetSettings(settings).values;
   size_t index = 0;
   for (auto & port : mPorts.mControlPorts) {
      if (port->mIsInput)
         if (!parms.Write(port->mName, values[index]))
            return false;
      ++index;
   }
   return true;
}

References GetSettings(), LV2Ports::mControlPorts, mPorts, settings(), LV2EffectSettings::values, and values.

Referenced by SaveParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveUserPreset()

bool LV2EffectBase::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 270 of file LV2EffectBase.cpp.

{
   return SaveParameters(name, settings);
}

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

Here is the call graph for this function:

SupportsAutomation()

bool LV2EffectBase::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Reimplemented from Effect.

Definition at line 117 of file LV2EffectBase.cpp.

{
   return true;
}

Member Data Documentation

mCVInBuffers

FloatBuffers LV2EffectBase::mCVInBuffers

Definition at line 97 of file LV2EffectBase.h.

mCVOutBuffers

FloatBuffers LV2EffectBase::mCVOutBuffers

Definition at line 98 of file LV2EffectBase.h.

mFactoryPresetNames

RegistryPaths LV2EffectBase::mFactoryPresetNames

mutable

Definition at line 104 of file LV2EffectBase.h.

Referenced by GetFactoryPresets().

mFactoryPresetsLoaded

bool LV2EffectBase::mFactoryPresetsLoaded { false }

mutable

Definition at line 103 of file LV2EffectBase.h.

Referenced by GetFactoryPresets().

mFactoryPresetUris

wxArrayString LV2EffectBase::mFactoryPresetUris

mutable

Definition at line 105 of file LV2EffectBase.h.

Referenced by GetFactoryPresets(), and LoadFactoryPreset().

mFeatures

const LV2FeaturesList LV2EffectBase::mFeatures { mPlug }

Definition at line 88 of file LV2EffectBase.h.

Referenced by InitializePlugin(), LoadFactoryPreset(), MakeInstance(), LV2Effect::PopulateUI(), and LV2Effect::ShowClientInterface().

mFramePos

size_t LV2EffectBase::mFramePos {}

Definition at line 95 of file LV2EffectBase.h.

mLength

double LV2EffectBase::mLength {}

Definition at line 100 of file LV2EffectBase.h.

mPlug

const LilvPlugin& LV2EffectBase::mPlug

Definition at line 87 of file LV2EffectBase.h.

Referenced by GetFactoryPresets(), GetPath(), GetSymbol(), GetVendor(), InitializePlugin(), and LV2Effect::PopulateUI().

mPorts

const LV2Ports LV2EffectBase::mPorts { mPlug }

Definition at line 90 of file LV2EffectBase.h.

Referenced by CopySettingsContents(), GetType(), IsInteractive(), LoadFactoryPreset(), LoadSettings(), MakeInstance(), MakeOutputs(), MakeSettings(), LV2Effect::PopulateUI(), and SaveSettings().

mWantsOptionsInterface

bool LV2EffectBase::mWantsOptionsInterface { false }

Definition at line 92 of file LV2EffectBase.h.

Referenced by InitializePlugin().

mWantsStateInterface

bool LV2EffectBase::mWantsStateInterface { false }

Definition at line 93 of file LV2EffectBase.h.

Referenced by InitializePlugin().

---

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

• LV2EffectBase.h
• LV2EffectBase.cpp