LadspaInstance Struct Reference

#include <LadspaInstance.h>

Inheritance diagram for LadspaInstance:

Collaboration diagram for LadspaInstance:

Public Member Functions
	LadspaInstance (const PerTrackEffect &processor, const LADSPA_Descriptor *pData, const ArrayOf< unsigned long > &inputPorts, const ArrayOf< unsigned long > &outputPorts, unsigned audioIns, unsigned audioOuts, int latencyPort)
bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override
bool	ProcessFinalize () noexcept override
size_t	ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen) override
	Called for destructive effect computation. More...
SampleCount	GetLatency (const EffectSettings &settings, double sampleRate) const override
bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override
bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate) override
bool	RealtimeSuspend () override
bool	RealtimeResume () override
bool	RealtimeProcessStart (MessagePackage &package) override
	settings are possibly changed, since last call, by an asynchronous dialog More...
size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples) override
bool	RealtimeProcessEnd (EffectSettings &settings) noexcept override
	settings can be updated to let a dialog change appearance at idle More...
bool	RealtimeFinalize (EffectSettings &settings) noexcept override
unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...
unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...
LADSPA_Handle	InitInstance (float sampleRate, LadspaEffectSettings &settings, LadspaEffectOutputs *pOutputs) const
void	FreeInstance (LADSPA_Handle handle) const
Public Member Functions inherited from PerTrackEffect::Instance
	Instance (const PerTrackEffect &processor)
	~Instance () override
bool	Process (EffectSettings &settings) final
	Uses the other virtual functions of this class. More...
bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override
bool	ProcessFinalize () noexcept override
Public Member Functions inherited from EffectInstanceEx
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...
virtual bool	Process (EffectSettings &settings)=0
	Actually do the effect here. More...
	~EffectInstanceEx () override
Public Member Functions inherited from EffectInstance
virtual	~EffectInstance ()
virtual size_t	GetBlockSize () const =0
virtual size_t	SetBlockSize (size_t maxBlockSize)=0
virtual unsigned	GetAudioInCount () const =0
	How many input buffers to allocate at once. More...
virtual unsigned	GetAudioOutCount () const =0
	How many output buffers to allocate at once. More...
virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)
virtual bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)
virtual bool	RealtimeSuspend ()
virtual bool	RealtimeResume ()
virtual std::unique_ptr< Message >	MakeMessage () const
	Called on the main thread, in which the result may be cloned. More...
virtual bool	UsesMessages () const noexcept
virtual bool	RealtimeProcessStart (MessagePackage &package)
	settings are possibly changed, since last call, by an asynchronous dialog More...
virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...
virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept
virtual size_t	GetTailSize () const
virtual SampleCount	GetLatency (const EffectSettings &settings, double sampleRate) const
virtual bool	NeedsDither () const
virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap)=0
virtual bool	ProcessFinalize () noexcept=0
virtual size_t	ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen)=0
	Called for destructive effect computation. More...
Public Member Functions inherited from EffectInstanceWithBlockSize
	~EffectInstanceWithBlockSize () override
size_t	GetBlockSize () const override
size_t	SetBlockSize (size_t maxBlockSize) override

Static Public Member Functions
static bool	LoadUseLatency (const EffectDefinitionInterface &effect)
	Get the preference for using latency. More...
static bool	SaveUseLatency (const EffectDefinitionInterface &effect, bool value)
	Set the preference for using latency. More...
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...

Public Attributes
const LADSPA_Descriptor *const	mData
const ArrayOf< unsigned long > &	mInputPorts
const ArrayOf< unsigned long > &	mOutputPorts
bool	mReady { false }
LADSPA_Handle	mMaster {}
std::vector< LADSPA_Handle >	mSlaves
const unsigned	mAudioIns
const unsigned	mAudioOuts
const int	mLatencyPort
const bool	mUseLatency

Additional Inherited Members
Public Types inherited from EffectInstance
using	Message = EffectSettingsAccess::Message
using	SampleCount = uint64_t
Protected Attributes inherited from PerTrackEffect::Instance
const PerTrackEffect &	mProcessor
Protected Attributes inherited from EffectInstanceWithBlockSize
size_t	mBlockSize { 0 }

Detailed Description

Definition at line 39 of file LadspaInstance.h.

Constructor & Destructor Documentation

LadspaInstance()

LadspaInstance::LadspaInstance	(	const PerTrackEffect &	processor,
		const LADSPA_Descriptor *	pData,
		const ArrayOf< unsigned long > &	inputPorts,
		const ArrayOf< unsigned long > &	outputPorts,
		unsigned	audioIns,
		unsigned	audioOuts,
		int	latencyPort
	)

Definition at line 117 of file LadspaInstance.cpp.

   : PerTrackEffect::Instance{ processor }
   , mData{ pData }, mInputPorts{ inputPorts }, mOutputPorts{ outputPorts }
   , mAudioIns{ audioIns }, mAudioOuts{ audioOuts }
   , mLatencyPort{ latencyPort }
   , mUseLatency{ LoadUseLatency(processor) }
{
   
}

Member Function Documentation

FreeInstance()

void LadspaInstance::FreeInstance

(

LADSPA_Handle

handle

)

const

Definition at line 297 of file LadspaInstance.cpp.

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

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

Referenced by ProcessFinalize().

Here is the caller graph for this function:

GetAudioInCount()

unsigned LadspaInstance::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 208 of file LadspaInstance.cpp.

{
   return mAudioIns;
}

References mAudioIns.

GetAudioOutCount()

unsigned LadspaInstance::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 203 of file LadspaInstance.cpp.

{
   return mAudioOuts;
}

References mAudioOuts.

GetLatency()

auto LadspaInstance::GetLatency ( const EffectSettings &  settings, double  sampleRate  ) const

overridevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 131 of file LadspaInstance.cpp.

{
   auto &controls = GetSettings(settings).controls;
   if (mUseLatency && mLatencyPort >= 0)
      return controls[mLatencyPort];
   return 0;
}

References GetSettings(), and settings().

Here is the call graph for this function:

GetSettings() [1/2]

static const LadspaEffectSettings & LadspaInstance::GetSettings ( const EffectSettings &  settings )

inlinestatic

Assume settings originated from MakeSettings() and copies thereof.

Definition at line 59 of file LadspaInstance.h.

   {
      return GetSettings(const_cast<EffectSettings &>(settings));
   }

References GetSettings(), and settings().

Here is the call graph for this function:

GetSettings() [2/2]

static LadspaEffectSettings & LadspaInstance::GetSettings ( EffectSettings &  settings )

inlinestatic

Assume settings originated from MakeSettings() and copies thereof.

Definition at line 51 of file LadspaInstance.h.

   {
      auto pSettings = settings.cast<LadspaEffectSettings>();
      assert(pSettings);
      return *pSettings;
   }

References settings().

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

InitInstance()

LADSPA_Handle LadspaInstance::InitInstance	(	float	sampleRate,
		LadspaEffectSettings &	settings,
		LadspaEffectOutputs *	pOutputs
	)		const

Definition at line 269 of file LadspaInstance.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)) {
         if (LADSPA_IS_PORT_INPUT(d))
            mData->connect_port(handle, p, &controls[p]);
         else {
            static LADSPA_Data sink;
            mData->connect_port(handle, p,
               pOutputs ? &pOutputs->controls[p] : &sink);
         }
      }
   }
   if (mData->activate)
      mData->activate(handle);
 
   return handle;
}

References _LADSPA_Descriptor::activate, _LADSPA_Descriptor::connect_port, LadspaEffectOutputs::controls, _LADSPA_Descriptor::instantiate, LADSPA_IS_PORT_CONTROL, LADSPA_IS_PORT_INPUT, mData, _LADSPA_Descriptor::PortCount, _LADSPA_Descriptor::PortDescriptors, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadUseLatency()

bool LadspaInstance::LoadUseLatency ( const EffectDefinitionInterface &  effect )

static

Get the preference for using latency.

Definition at line 20 of file LadspaInstance.cpp.

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

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

Here is the call graph for this function:

ProcessBlock()

size_t LadspaInstance::ProcessBlock ( EffectSettings &  settings, const float *const *  inBlock, float *const *  outBlock, size_t  blockLen  )

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 168 of file LadspaInstance.cpp.

{
   for (unsigned i = 0; i < mAudioIns; ++i)
      mData->connect_port(mMaster, mInputPorts[i],
         const_cast<float*>(inBlock[i]));
 
   for (unsigned i = 0; i < mAudioOuts; ++i)
      mData->connect_port(mMaster, mOutputPorts[i], outBlock[i]);
 
   mData->run(mMaster, blockLen);
   return blockLen;
}

References _LADSPA_Descriptor::connect_port, mAudioIns, mAudioOuts, mData, mInputPorts, mMaster, mOutputPorts, and _LADSPA_Descriptor::run.

ProcessFinalize()

bool LadspaInstance::ProcessFinalize ( )

overridevirtualnoexcept

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Reimplemented from PerTrackEffect::Instance.

Definition at line 155 of file LadspaInstance.cpp.

{
return GuardedCall<bool>([&]{
   if (mReady) {
      mReady = false;
      FreeInstance(mMaster);
      mMaster = nullptr;
   }
 
   return true;
});
}

References FreeInstance(), mMaster, and mReady.

Here is the call graph for this function:

ProcessInitialize()

bool LadspaInstance::ProcessInitialize ( EffectSettings &  settings, double  sampleRate, ChannelNames  chanMap  )

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters

chanMap

null or array terminated with ChannelNameEOL. Do not retain the pointer

Postcondition

GetAudioInCount() and GetAudioOutCount() are well defined

Reimplemented from PerTrackEffect::Instance.

Definition at line 140 of file LadspaInstance.cpp.

{
   /* Instantiate the plugin */
   if (!mReady) {
      auto &ladspaSettings = GetSettings(settings);
      // Destructive effect processing doesn't need output ports
      mMaster = InitInstance(sampleRate, ladspaSettings, nullptr);
      if (!mMaster)
         return false;
      mReady = true;
   }
   return true;
}

References GetSettings(), InitInstance(), mMaster, mReady, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

RealtimeAddProcessor()

bool LadspaInstance::RealtimeAddProcessor ( EffectSettings &  settings, EffectOutputs *  pOutputs, unsigned  numChannels, float  sampleRate  )

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 187 of file LadspaInstance.cpp.

{
   auto &ladspaSettings = GetSettings(settings);
   // Connect to outputs only if this is the first processor for the track.
   // (What's right when a mono effect is on a stereo channel?  Unclear, but
   // this definitely causes connection with the first channel.)
   auto pLadspaOutputs = mSlaves.empty()
      ? static_cast<LadspaEffectOutputs *>(pOutputs) : nullptr;
   auto slave = InitInstance(sampleRate, ladspaSettings, pLadspaOutputs);
   if (!slave)
      return false;
   mSlaves.push_back(slave);
   return true;
}

References GetSettings(), InitInstance(), mSlaves, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

RealtimeFinalize()

bool LadspaInstance::RealtimeFinalize ( EffectSettings &  settings )

overridevirtualnoexcept

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 213 of file LadspaInstance.cpp.

{
return GuardedCall<bool>([&]{
   for (size_t i = 0, cnt = mSlaves.size(); i < cnt; ++i)
      FreeInstance(mSlaves[i]);
   mSlaves.clear();
 
   return true;
});
}

RealtimeInitialize()

bool LadspaInstance::RealtimeInitialize ( EffectSettings &  settings, double  sampleRate  )

overridevirtual

Returns

success

Postcondition

GetAudioInCount() and GetAudioOutCount() are well defined

Default implementation does nothing, returns false (so assume realtime is not supported). Other member functions related to realtime return true or zero, but will not be called, unless a derived class overrides RealtimeInitialize.

Reimplemented from EffectInstance.

Definition at line 182 of file LadspaInstance.cpp.

{
   return true;
}

RealtimeProcess()

size_t LadspaInstance::RealtimeProcess ( size_t  group, EffectSettings &  settings, const float *const *  inBuf, float *const *  outBuf, size_t  numSamples  )

overridevirtual

Returns

success Default implementation does nothing, returns 0

Reimplemented from EffectInstance.

Definition at line 245 of file LadspaInstance.cpp.

{
   if (group >= mSlaves.size())
      return 0;
 
   for (unsigned i = 0; i < mAudioIns; ++i)
      mData->connect_port(mSlaves[group], mInputPorts[i],
         const_cast<float*>(inbuf[i]));
 
   for (unsigned i = 0; i < mAudioOuts; ++i)
      mData->connect_port(
         mSlaves[group], mOutputPorts[i], outbuf[i]);
 
   mData->run(mSlaves[group], numSamples);
 
   return numSamples;
}

References _LADSPA_Descriptor::connect_port, mAudioIns, mAudioOuts, mData, mInputPorts, mOutputPorts, mSlaves, and _LADSPA_Descriptor::run.

RealtimeProcessEnd()

bool LadspaInstance::RealtimeProcessEnd ( EffectSettings &  settings )

overridevirtualnoexcept

settings can be updated to let a dialog change appearance at idle

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 264 of file LadspaInstance.cpp.

{
   return true;
}

RealtimeProcessStart()

bool LadspaInstance::RealtimeProcessStart ( MessagePackage &  package )

overridevirtual

settings are possibly changed, since last call, by an asynchronous dialog

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 240 of file LadspaInstance.cpp.

{
   return true;
}

RealtimeResume()

bool LadspaInstance::RealtimeResume ( )

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 232 of file LadspaInstance.cpp.

{
   if (auto fn = mData->activate)
      for (auto &slave : mSlaves)
         fn(slave);
   return true;
}

References _LADSPA_Descriptor::activate, fn, mData, and mSlaves.

RealtimeSuspend()

bool LadspaInstance::RealtimeSuspend ( )

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 224 of file LadspaInstance.cpp.

{
   if (auto fn = mData->deactivate)
      for (auto &slave : mSlaves)
         fn(slave);
   return true;
}

References _LADSPA_Descriptor::deactivate, fn, mData, and mSlaves.

SaveUseLatency()

bool LadspaInstance::SaveUseLatency ( const EffectDefinitionInterface &  effect, bool  value  )

static

Set the preference for using latency.

Definition at line 28 of file LadspaInstance.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:

Member Data Documentation

mAudioIns

const unsigned LadspaInstance::mAudioIns

Definition at line 111 of file LadspaInstance.h.

Referenced by GetAudioInCount(), ProcessBlock(), and RealtimeProcess().

mAudioOuts

const unsigned LadspaInstance::mAudioOuts

Definition at line 112 of file LadspaInstance.h.

Referenced by GetAudioOutCount(), ProcessBlock(), and RealtimeProcess().

mData

const LADSPA_Descriptor* const LadspaInstance::mData

Definition at line 101 of file LadspaInstance.h.

Referenced by FreeInstance(), InitInstance(), LadspaEditor::OnSlider(), LadspaEditor::OnTextCtrl(), LadspaEditor::PopulateUI(), ProcessBlock(), RealtimeProcess(), RealtimeResume(), RealtimeSuspend(), LadspaEditor::RefreshControls(), and LadspaEditor::UpdateControls().

mInputPorts

const ArrayOf<unsigned long>& LadspaInstance::mInputPorts

Definition at line 102 of file LadspaInstance.h.

Referenced by ProcessBlock(), and RealtimeProcess().

mLatencyPort

const int LadspaInstance::mLatencyPort

Definition at line 113 of file LadspaInstance.h.

mMaster

LADSPA_Handle LadspaInstance::mMaster {}

Definition at line 106 of file LadspaInstance.h.

Referenced by ProcessBlock(), ProcessFinalize(), and ProcessInitialize().

mOutputPorts

const ArrayOf<unsigned long>& LadspaInstance::mOutputPorts

Definition at line 103 of file LadspaInstance.h.

Referenced by ProcessBlock(), and RealtimeProcess().

mReady

bool LadspaInstance::mReady { false }

Definition at line 105 of file LadspaInstance.h.

Referenced by ProcessFinalize(), and ProcessInitialize().

mSlaves

std::vector<LADSPA_Handle> LadspaInstance::mSlaves

Definition at line 109 of file LadspaInstance.h.

Referenced by RealtimeAddProcessor(), RealtimeProcess(), RealtimeResume(), and RealtimeSuspend().

mUseLatency

const bool LadspaInstance::mUseLatency

Definition at line 114 of file LadspaInstance.h.

---

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

• LadspaInstance.h
• LadspaInstance.cpp