#include <LV2Instance.h>

Inheritance diagram for LV2Instance:

Collaboration diagram for LV2Instance:

Public Member Functions
	LV2Instance (const PerTrackEffect &effect, const LV2FeaturesList &features, const LV2Ports &ports)

	~LV2Instance () override

bool	IsOk () const

const LV2PortStates &	GetPortStates () const

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) 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

const LV2Wrapper *	GetMaster () const

void	MakeMaster (const EffectSettings &settings, double sampleRate)

std::unique_ptr< LV2Wrapper >	MakeWrapper (const EffectSettings &settings, double sampleRate, EffectOutputs *pOutputs)

size_t	GetBlockSize () const override

size_t	SetBlockSize (size_t maxBlockSize) 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...

bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override

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

bool	RealtimeFinalize (EffectSettings &settings) noexcept 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...

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

Private Attributes
LV2InstanceFeaturesList	mFeatures

const LV2Ports &	mPorts

LV2PortStates	mPortStates { mPorts }

std::unique_ptr< LV2Wrapper >	mMaster
	Holds lv2 library state for destructive processing. More...

std::vector< std::unique_ptr< LV2Wrapper > >	mSlaves
	Each holds lv2 library state for realtime processing of one track. More...

LV2_Atom_Forge	mForge {}

float	mPositionSpeed { 1.0f }

int64_t	mPositionFrame { 0 }

size_t	mUserBlockSize {}

size_t	mNumSamples {}

bool	mRolling { true }

bool	mUseLatency { false }

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

Detailed Description

Definition at line 27 of file LV2Instance.h.

Constructor & Destructor Documentation

◆ LV2Instance()

LV2Instance::LV2Instance	(	const PerTrackEffect &	effect,
		const LV2FeaturesList &	features,
		const LV2Ports &	ports
	)

Definition at line 27 of file LV2Instance.cpp.

   : PerTrackEffect::Instance{ effect }
   , mFeatures{ features }
   , mPorts{ ports }
{
   LV2Preferences::GetUseLatency(effect, mUseLatency);
 
   int userBlockSize;
   LV2Preferences::GetBufferSize(effect, userBlockSize);
   mUserBlockSize = std::max(1, userBlockSize);
   lv2_atom_forge_init(&mForge, mFeatures.Base().URIDMapFeature());
}

References LV2InstanceFeaturesList::Base(), LV2Preferences::GetBufferSize(), LV2Preferences::GetUseLatency(), mFeatures, mForge, mUseLatency, mUserBlockSize, and LV2FeaturesList::URIDMapFeature().

Here is the call graph for this function:

◆ ~LV2Instance()

LV2Instance::~LV2Instance ( )

overridedefault

Member Function Documentation

◆ GetAudioInCount()

unsigned LV2Instance::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 82 of file LV2Instance.cpp.

{
   return mPorts.mAudioIn;
}

References LV2Ports::mAudioIn, and mPorts.

◆ GetAudioOutCount()

unsigned LV2Instance::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 87 of file LV2Instance.cpp.

{
   return mPorts.mAudioOut;
}

References LV2Ports::mAudioOut, and mPorts.

◆ GetBlockSize()

size_t LV2Instance::GetBlockSize ( ) const

overridevirtual

Implements EffectInstance.

Definition at line 77 of file LV2Instance.cpp.

{
   return mFeatures.mBlockSize;
}

References LV2InstanceFeaturesList::mBlockSize, and mFeatures.

Referenced by ProcessBlock(), ProcessInitialize(), RealtimeInitialize(), RealtimeProcess(), and SetBlockSize().

Here is the caller graph for this function:

◆ GetLatency()

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

overridevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 92 of file LV2Instance.cpp.

{
   if (mMaster && mUseLatency && mPorts.mLatencyPort >= 0)
      return mMaster->GetLatency();
   return 0;
}

◆ GetMaster()

const LV2Wrapper * LV2Instance::GetMaster ( ) const

inline

Definition at line 46 of file LV2Instance.h.

46{ return mMaster.get(); }

Referenced by LV2Editor::UpdateUI().

Here is the caller graph for this function:

◆ GetPortStates()

const LV2PortStates & LV2Instance::GetPortStates ( ) const

inline

Definition at line 36 of file LV2Instance.h.

36{ return mPortStates; }

LV2Instance::mPortStates

LV2PortStates mPortStates

Definition: LV2Instance.h:78

◆ IsOk()

bool LV2Instance::IsOk ( ) const

inline

Definition at line 34 of file LV2Instance.h.

34{ return mFeatures.mOk; }

LV2InstanceFeaturesList::mOk

const bool mOk

Definition: LV2InstanceFeaturesList.h:72

◆ MakeMaster()

void LV2Instance::MakeMaster	(	const EffectSettings &	settings,
		double	sampleRate
	)

Do nothing if there is already an LV2Wrapper with the desired rate. The wrapper object remains until this is destroyed or the wrapper is re-made with another rate.

Definition at line 44 of file LV2Instance.cpp.

{
   // Come here only when doing non-realtime application of the effect, in which
   // case, we don't care about capturing the output ports
   if (mMaster && sampleRate == mFeatures.mSampleRate) {
      // Already made but be sure to connect control ports to the right place
      mMaster->ConnectControlPorts(mPorts, GetSettings(settings), nullptr);
      return;
   }
   mMaster = MakeWrapper(settings, sampleRate, nullptr);
   SetBlockSize(mUserBlockSize);
}

References GetSettings(), MakeWrapper(), mFeatures, mMaster, mPorts, LV2InstanceFeaturesList::mSampleRate, mUserBlockSize, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, SetBlockSize(), and settings().

Referenced by ProcessInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeWrapper()

std::unique_ptr< LV2Wrapper > LV2Instance::MakeWrapper	(	const EffectSettings &	settings,
		double	sampleRate,
		EffectOutputs *	pOutputs
	)

Definition at line 59 of file LV2Instance.cpp.

{
   return LV2Wrapper::Create(mFeatures, mPorts, mPortStates,
      GetSettings(settings), sampleRate, pOutputs);
}

References LV2Wrapper::Create(), GetSettings(), mFeatures, mPorts, mPortStates, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Referenced by MakeMaster(), and LV2Effect::PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 113 of file LV2Instance.cpp.

{
   using namespace LV2Symbols;
   if (size > GetBlockSize())
      return 0;
   assert(mMaster); // else ProcessInitialize() returned false, I'm not called
   const auto instance = &mMaster->GetInstance();
 
   int i = 0;
   int o = 0;
   for (auto & port : mPorts.mAudioPorts)
      lilv_instance_connect_port(instance,
         port->mIndex,
         const_cast<float*>(port->mIsInput ? inbuf[i++] : outbuf[o++]));
 
   for (auto & state : mPortStates.mAtomPortStates)
      state->SendToInstance(mForge, mPositionFrame, mPositionSpeed);
 
   lilv_instance_run(instance, size);
 
   // Main thread consumes responses
   mMaster->ConsumeResponses();
 
   for (auto & state : mPortStates.mAtomPortStates)
      state->ResetForInstanceOutput();
 
   return size;
}

References GetBlockSize(), LV2PortStates::mAtomPortStates, LV2Ports::mAudioPorts, mForge, mMaster, mPorts, mPortStates, mPositionFrame, mPositionSpeed, and size.

Here is the call graph for this function:

◆ ProcessInitialize()

bool LV2Instance::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 101 of file LV2Instance.cpp.

{
   MakeMaster(settings, sampleRate);
   if (!mMaster)
      return false;
   for (auto & state : mPortStates.mCVPortStates)
      state.mBuffer.reinit(GetBlockSize(), state.mpPort->mIsInput);
   mMaster->Activate();
   return true;
}

References GetBlockSize(), MakeMaster(), LV2PortStates::mCVPortStates, mMaster, mPortStates, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 160 of file LV2Instance.cpp.

{
   // 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 pInstance = LV2Wrapper::Create(mFeatures,
      mPorts, mPortStates, GetSettings(settings), sampleRate,
      mSlaves.empty() ? static_cast<LV2EffectOutputs *>(pOutputs) : nullptr);
   if (!pInstance)
      return false;
   pInstance->Activate();
   mSlaves.push_back(move(pInstance));
   return true;
}

References LV2Wrapper::Create(), GetSettings(), mFeatures, mPorts, mPortStates, mSlaves, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool LV2Instance::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 150 of file LV2Instance.cpp.

{
return GuardedCall<bool>([&]{
   mSlaves.clear();
   for (auto & state : mPortStates.mCVPortStates)
      state.mBuffer.reset();
   return true;
});
}

◆ RealtimeInitialize()

bool LV2Instance::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 143 of file LV2Instance.cpp.

{
   for (auto & state : mPortStates.mCVPortStates)
      state.mBuffer.reinit(GetBlockSize(), state.mpPort->mIsInput);
   return true;
}

References GetBlockSize(), LV2PortStates::mCVPortStates, and mPortStates.

Here is the call graph for this function:

◆ RealtimeProcess()

size_t LV2Instance::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 212 of file LV2Instance.cpp.

{
   if (group >= mSlaves.size())
      return 0;
   assert(numSamples <= (size_t) GetBlockSize());
 
   if (group < 0 || group >= (int) mSlaves.size())
      return 0;
 
   const auto slave = mSlaves[group].get();
   const auto instance = &slave->GetInstance();
 
   int i = 0;
   int o = 0;
   for (auto & port : mPorts.mAudioPorts)
      lilv_instance_connect_port(instance,
         port->mIndex,
         const_cast<float*>(port->mIsInput ? inbuf[i++] : outbuf[o++]));
 
   mNumSamples = std::max(numSamples, mNumSamples);
 
   if (mRolling)
      lilv_instance_run(instance, numSamples);
   else
      while (--i >= 0)
         for (decltype(numSamples) s = 0; s < numSamples; s++)
            outbuf[i][s] = inbuf[i][s];
 
   // Background thread consumes responses from yet another worker thread
   slave->ConsumeResponses();
 
   for (auto & state : mPortStates.mAtomPortStates)
      state->ResetForInstanceOutput();
 
   if (group == 0)
      mPositionFrame += numSamples;
 
   return numSamples;
}

References GetBlockSize(), LV2PortStates::mAtomPortStates, LV2Ports::mAudioPorts, mNumSamples, mPorts, mPortStates, mPositionFrame, mRolling, and mSlaves.

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool LV2Instance::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 253 of file LV2Instance.cpp.

{
return GuardedCall<bool>([&]{
   // Nothing to do if we did process any samples
   if (mNumSamples == 0)
      return true;
 
   // Why is this not also done on the destructive processing path?
   // Because it is soon dimissing the modal dialog anyway.
   for (auto & state : mPortStates.mAtomPortStates)
      state->ReceiveFromInstance();
 
   mNumSamples = 0;
 
   return true;
});
}

◆ RealtimeProcessStart()

bool LV2Instance::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 204 of file LV2Instance.cpp.

{
   mNumSamples = 0;
   for (auto & state : mPortStates.mAtomPortStates)
      state->SendToInstance(mForge, mPositionFrame, mPositionSpeed);
   return true;
}

References LV2PortStates::mAtomPortStates, mForge, mNumSamples, mPortStates, mPositionFrame, and mPositionSpeed.

◆ RealtimeResume()

bool LV2Instance::RealtimeResume ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 190 of file LV2Instance.cpp.

{
   if (mMaster)
      mMaster->Activate();
   for (auto &pSlave : mSlaves)
      pSlave->Activate();
 
   mPositionSpeed = 1.0;
   mPositionFrame = 0;
   mRolling = true;
 
   return true;
}

References mMaster, mPositionFrame, mPositionSpeed, mRolling, and mSlaves.

◆ RealtimeSuspend()

bool LV2Instance::RealtimeSuspend ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 176 of file LV2Instance.cpp.

{
   if (mMaster)
      mMaster->Deactivate();
   for (auto &pSlave : mSlaves)
      pSlave->Deactivate();
 
   mPositionSpeed = 0.0;
   mPositionFrame = 0;
   mRolling = false;
 
   return true;
}

References mMaster, mPositionFrame, mPositionSpeed, mRolling, and mSlaves.

◆ SetBlockSize()

size_t LV2Instance::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectInstance.

Definition at line 66 of file LV2Instance.cpp.

{
   mFeatures.mBlockSize = std::max(mFeatures.mMinBlockSize,
      std::min({maxBlockSize, mUserBlockSize, mFeatures.mMaxBlockSize}));
   if (mMaster)
      mMaster->SendBlockSize();
   for (auto &pSlave : mSlaves)
      pSlave->SendBlockSize();
   return GetBlockSize();
}

References GetBlockSize(), LV2InstanceFeaturesList::mBlockSize, mFeatures, min(), mMaster, LV2InstanceFeaturesList::mMinBlockSize, and mSlaves.

Referenced by MakeMaster().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mFeatures

LV2InstanceFeaturesList LV2Instance::mFeatures

private

Definition at line 76 of file LV2Instance.h.

Referenced by GetBlockSize(), LV2Instance(), MakeMaster(), MakeWrapper(), RealtimeAddProcessor(), and SetBlockSize().

◆ mForge

LV2_Atom_Forge LV2Instance::mForge {}

private

Definition at line 86 of file LV2Instance.h.

Referenced by LV2Instance(), ProcessBlock(), and RealtimeProcessStart().

◆ mMaster

std::unique_ptr<LV2Wrapper> LV2Instance::mMaster

private

Holds lv2 library state for destructive processing.

Definition at line 81 of file LV2Instance.h.

Referenced by MakeMaster(), ProcessBlock(), ProcessInitialize(), RealtimeResume(), RealtimeSuspend(), and SetBlockSize().

◆ mNumSamples

size_t LV2Instance::mNumSamples {}

private

Definition at line 94 of file LV2Instance.h.

Referenced by RealtimeProcess(), and RealtimeProcessStart().

◆ mPorts

const LV2Ports& LV2Instance::mPorts

private

Definition at line 77 of file LV2Instance.h.

Referenced by GetAudioInCount(), GetAudioOutCount(), MakeMaster(), MakeWrapper(), ProcessBlock(), RealtimeAddProcessor(), and RealtimeProcess().

◆ mPortStates

LV2PortStates LV2Instance::mPortStates { mPorts }

private

Definition at line 78 of file LV2Instance.h.

Referenced by MakeWrapper(), ProcessBlock(), ProcessInitialize(), RealtimeAddProcessor(), RealtimeInitialize(), RealtimeProcess(), and RealtimeProcessStart().

◆ mPositionFrame

int64_t LV2Instance::mPositionFrame { 0 }

private

Definition at line 90 of file LV2Instance.h.

Referenced by ProcessBlock(), RealtimeProcess(), RealtimeProcessStart(), RealtimeResume(), and RealtimeSuspend().

◆ mPositionSpeed

float LV2Instance::mPositionSpeed { 1.0f }

private

Definition at line 89 of file LV2Instance.h.

Referenced by ProcessBlock(), RealtimeProcessStart(), RealtimeResume(), and RealtimeSuspend().

◆ mRolling

bool LV2Instance::mRolling { true }

private

Definition at line 95 of file LV2Instance.h.

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

◆ mSlaves

std::vector<std::unique_ptr<LV2Wrapper> > LV2Instance::mSlaves

private

Each holds lv2 library state for realtime processing of one track.

Definition at line 84 of file LV2Instance.h.

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

◆ mUseLatency

bool LV2Instance::mUseLatency { false }

private

Definition at line 96 of file LV2Instance.h.

Referenced by LV2Instance().

◆ mUserBlockSize

size_t LV2Instance::mUserBlockSize {}

private

Definition at line 92 of file LV2Instance.h.

Referenced by LV2Instance(), and MakeMaster().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LV2Instance()

◆ ~LV2Instance()

Member Function Documentation

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetLatency()

◆ GetMaster()

◆ GetPortStates()

◆ IsOk()

◆ MakeMaster()

◆ MakeWrapper()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

◆ SetBlockSize()

Member Data Documentation

◆ mFeatures

◆ mForge

◆ mMaster

◆ mNumSamples

◆ mPorts

◆ mPortStates

◆ mPositionFrame

◆ mPositionSpeed

◆ mRolling

◆ mSlaves

◆ mUseLatency

◆ mUserBlockSize