Inheritance diagram for LadspaEffect::Instance:

Collaboration diagram for LadspaEffect::Instance:

Public Member Functions
	Instance (const PerTrackEffect &processor)

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

const LadspaEffect &	GetEffect () 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

Public Attributes
bool	mReady { false }

LADSPA_Handle	mMaster {}

std::vector< LADSPA_Handle >	mSlaves

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

Constructor & Destructor Documentation

◆ Instance()

LadspaEffect::Instance::Instance ( const PerTrackEffect & processor )

explicit

Definition at line 963 of file LadspaEffect.cpp.

   : PerTrackEffect::Instance{ processor }
   , mUseLatency{ LoadUseLatency(processor) }
{
}

Member Function Documentation

◆ GetAudioInCount()

unsigned LadspaEffect::Instance::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 1055 of file LadspaEffect.cpp.

{
   return GetEffect().mAudioIns;
}

◆ GetAudioOutCount()

unsigned LadspaEffect::Instance::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 1050 of file LadspaEffect.cpp.

{
   return GetEffect().mAudioOuts;
}

◆ GetEffect()

const LadspaEffect & LadspaEffect::Instance::GetEffect ( ) const

inline

Definition at line 951 of file LadspaEffect.cpp.

952 { return static_cast<const LadspaEffect &>(mProcessor); }

LadspaEffect

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

Definition: LadspaEffect.h:67

PerTrackEffect::Instance::mProcessor

const PerTrackEffect & mProcessor

Definition: PerTrackEffect.h:54

References PerTrackEffect::Instance::mProcessor.

◆ GetLatency()

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

overridevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 974 of file LadspaEffect.cpp.

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

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

Here is the call graph for this function:

◆ ProcessBlock()

size_t LadspaEffect::Instance::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 1013 of file LadspaEffect.cpp.

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

◆ ProcessFinalize()

bool LadspaEffect::Instance::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:

Implements EffectInstance.

Definition at line 1000 of file LadspaEffect.cpp.

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

◆ ProcessInitialize()

bool LadspaEffect::Instance::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

Implements EffectInstance.

Definition at line 984 of file LadspaEffect.cpp.

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

References EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1033 of file LadspaEffect.cpp.

{
   auto &effect = GetEffect();
   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 = effect.InitInstance(sampleRate, ladspaSettings, pLadspaOutputs);
   if (!slave)
      return false;
   mSlaves.push_back(slave);
   return true;
}

References EffectWithSettings< LadspaEffectSettings, StatelessPerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool LadspaEffect::Instance::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1060 of file LadspaEffect.cpp.

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

◆ RealtimeInitialize()

bool LadspaEffect::Instance::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 1028 of file LadspaEffect.cpp.

{
   return true;
}

◆ RealtimeProcess()

size_t LadspaEffect::Instance::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 1093 of file LadspaEffect.cpp.

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

◆ RealtimeProcessEnd()

bool LadspaEffect::Instance::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 1113 of file LadspaEffect.cpp.

{
   return true;
}

◆ RealtimeProcessStart()

bool LadspaEffect::Instance::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 1088 of file LadspaEffect.cpp.

{
   return true;
}

◆ RealtimeResume()

bool LadspaEffect::Instance::RealtimeResume ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1080 of file LadspaEffect.cpp.

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

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

◆ RealtimeSuspend()

bool LadspaEffect::Instance::RealtimeSuspend ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1072 of file LadspaEffect.cpp.

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

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

Member Data Documentation

◆ mMaster

LADSPA_Handle LadspaEffect::Instance::mMaster {}

Definition at line 955 of file LadspaEffect.cpp.

◆ mReady

bool LadspaEffect::Instance::mReady { false }

Definition at line 954 of file LadspaEffect.cpp.

◆ mSlaves

std::vector<LADSPA_Handle> LadspaEffect::Instance::mSlaves

Definition at line 958 of file LadspaEffect.cpp.

◆ mUseLatency

const bool LadspaEffect::Instance::mUseLatency

Definition at line 960 of file LadspaEffect.cpp.

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

LadspaEffect.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Instance()

Member Function Documentation

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetEffect()

◆ GetLatency()

◆ ProcessBlock()

◆ ProcessFinalize()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

Member Data Documentation

◆ mMaster

◆ mReady

◆ mSlaves

◆ mUseLatency