Manager of a handle to an LV2 plug-in instantiation. More...

#include <LV2Wrapper.h>

Collaboration diagram for LV2Wrapper:

Classes
struct	CreateToken
	To compel use of the factory. More...

struct	LV2Work

Public Member Functions
	LV2Wrapper (CreateToken &&, LV2InstanceFeaturesList &baseFeatures, const LilvPlugin &plugin, float sampleRate)
	Constructor may spawn a thread. More...

	~LV2Wrapper ()
	If a thread was started, joins it. More...

void	ConnectControlPorts (const LV2Ports &ports, const LV2EffectSettings &settings, EffectOutputs *pOutputs)

void	ConnectPorts (const LV2Ports &ports, LV2PortStates &portStates, const LV2EffectSettings &settings, EffectOutputs *pOutputs)

void	Activate ()

void	Deactivate ()

LilvInstance &	GetInstance () const

LV2_Handle	GetHandle () const

float	GetLatency () const

void	SetFreeWheeling (bool enable)

void	SendBlockSize ()

void	ConsumeResponses ()

LV2_Worker_Status	ScheduleWork (uint32_t size, const void *data)

LV2_Worker_Status	Respond (uint32_t size, const void *data)

LV2WrapperFeaturesList &	GetFeatures ()

const LV2WrapperFeaturesList &	GetFeatures () const

Static Public Member Functions
static std::unique_ptr< LV2Wrapper >	Create (LV2InstanceFeaturesList &baseFeatures, const LV2Ports &ports, LV2PortStates &portStates, const LV2EffectSettings &settings, float sampleRate, EffectOutputs *pOutputs)
	Factory. More...

static LV2_Worker_Status	schedule_work (LV2_Worker_Schedule_Handle handle, uint32_t size, const void *data)

static LV2_Worker_Status	respond (LV2_Worker_Respond_Handle handle, uint32_t size, const void *data)

Private Member Functions
void	ThreadFunction ()

Private Attributes
LV2_Worker_Schedule	mWorkerSchedule { this, LV2Wrapper::schedule_work }

LV2WrapperFeaturesList	mFeaturesList

const LilvInstancePtr	mInstance

const LV2_Handle	mHandle

const LV2_Options_Interface *const	mOptionsInterface

const LV2_State_Interface *const	mStateInterface

const LV2_Worker_Interface *const	mWorkerInterface

std::thread	mThread

wxMessageQueue< LV2Work >	mRequests

wxMessageQueue< LV2Work >	mResponses

float	mLatency { 0.0 }

bool	mFreeWheeling { false }
	If true, do not spawn extra worker threads. More...

bool	mStopWorker { false }

bool	mActivated { false }

Detailed Description

Manager of a handle to an LV2 plug-in instantiation.

Definition at line 44 of file LV2Wrapper.h.

Constructor & Destructor Documentation

◆ LV2Wrapper()

LV2Wrapper::LV2Wrapper	(	CreateToken &&	,
		LV2InstanceFeaturesList &	baseFeatures,
		const LilvPlugin &	plugin,
		float	sampleRate
	)

Constructor may spawn a thread.

Definition at line 124 of file LV2Wrapper.cpp.

   : mFeaturesList{ baseFeatures, sampleRate, &mWorkerSchedule }
, mInstance{ [&instanceFeaturesList = mFeaturesList, &plugin, sampleRate](){
   auto features = instanceFeaturesList.GetFeaturePointers();
 
#if defined(__WXMSW__)
   // Plugins may have dependencies that need to be loaded from the same path
   // as the main DLL, so add this plugin's path to the DLL search order.
   const auto libNode = lilv_plugin_get_library_uri(&plugin);
   const auto libUri = lilv_node_as_uri(libNode);
   LilvCharsPtr libPath{ lilv_file_uri_parse(libUri, nullptr) };
   const auto path = wxPathOnly(libPath.get());
   SetDllDirectory(path.c_str());
   auto cleanup = finally([]{ SetDllDirectory(nullptr); });
#endif
 
   auto result = lilv_plugin_instantiate(&plugin, sampleRate, features.data());
   return result ? result : throw std::exception{};
}()}
, mHandle{ lilv_instance_get_handle(mInstance.get()) }
, mOptionsInterface{ static_cast<const LV2_Options_Interface *>(
   lilv_instance_get_extension_data(mInstance.get(), LV2_OPTIONS__interface))
}
, mStateInterface{ static_cast<const LV2_State_Interface *>(
   lilv_instance_get_extension_data(mInstance.get(), LV2_STATE__interface))
}
, mWorkerInterface{ static_cast<const LV2_Worker_Interface *>(
   lilv_instance_get_extension_data(mInstance.get(), LV2_WORKER__interface))
}
{
   if (mWorkerInterface)
      mThread = std::thread{
         std::mem_fn( &LV2Wrapper::ThreadFunction ), std::ref(*this)
      };
}

References anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

◆ ~LV2Wrapper()

LV2Wrapper::~LV2Wrapper ( )

If a thread was started, joins it.

Definition at line 110 of file LV2Wrapper.cpp.

{
   if (mInstance) {
      if (mThread.joinable()) {
         // Even if we have been freewheeling, this unblocks the unused thread
         // so it can be joined
         mStopWorker = true;
         mRequests.Post({ 0, NULL });  // Must do after writing mStopWorker
         mThread.join();
      }
      Deactivate();
   }
}

References Deactivate(), mInstance, mRequests, mStopWorker, and mThread.

Here is the call graph for this function:

Member Function Documentation

◆ Activate()

void LV2Wrapper::Activate ( )

Definition at line 161 of file LV2Wrapper.cpp.

{
   if (!mActivated) {
      lilv_instance_activate(&GetInstance());
      mActivated = true;
   }
}

References GetInstance(), and mActivated.

Here is the call graph for this function:

◆ ConnectControlPorts()

void LV2Wrapper::ConnectControlPorts	(	const LV2Ports &	ports,
		const LV2EffectSettings &	settings,
		EffectOutputs *	pOutputs
	)

Definition at line 64 of file LV2Wrapper.cpp.

{
   const auto instance = &GetInstance();
   static float blackHole;
   auto pValues = static_cast<LV2EffectOutputs *>(pOutputs);
 
   // Connect all control ports
   const auto latencyPort = ports.mLatencyPort;
   if (latencyPort >= 0)
      lilv_instance_connect_port(instance, latencyPort, &mLatency);
 
   auto &values = settings.values;
   size_t index = 0;
   for (auto & port : ports.mControlPorts) {
      void *const location = port->mIsInput
         // Settings slots for input ports must pass to the library
         // as nominal pointers to non-const
         ? &const_cast<float&>(values[index])
         : pValues ? &pValues->values[index]
         : &blackHole
      ;
      lilv_instance_connect_port(instance, port->mIndex, location);
      ++index;
   }
}

References GetInstance(), LV2Ports::mControlPorts, mLatency, LV2Ports::mLatencyPort, settings(), and values.

Referenced by ConnectPorts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConnectPorts()

void LV2Wrapper::ConnectPorts	(	const LV2Ports &	ports,
		LV2PortStates &	portStates,
		const LV2EffectSettings &	settings,
		EffectOutputs *	pOutputs
	)

Definition at line 92 of file LV2Wrapper.cpp.

{
   ConnectControlPorts(ports, settings, pOutputs);
 
   const auto instance = &GetInstance();
 
   // Connect all atom ports
   for (auto & state : portStates.mAtomPortStates)
      lilv_instance_connect_port(instance,
         state->mpPort->mIndex, state->mBuffer.get());
 
   // We don't fully support CV ports, so connect them to dummy buffers for now.
   for (auto & state : portStates.mCVPortStates)
      lilv_instance_connect_port(instance, state.mpPort->mIndex,
         state.mBuffer.get());
}

References ConnectControlPorts(), GetInstance(), LV2PortStates::mAtomPortStates, LV2PortStates::mCVPortStates, and settings().

Here is the call graph for this function:

◆ ConsumeResponses()

void LV2Wrapper::ConsumeResponses ( )

Definition at line 223 of file LV2Wrapper.cpp.

{
   if (mWorkerInterface) {
      LV2Work work{};
      while (mResponses.ReceiveTimeout(0, work) == wxMSGQUEUE_NO_ERROR)
         // Invoke foreign instance code in main (destructive) or
         // audio thread (real-time) processing
         mWorkerInterface->work_response(mHandle, work.size, work.data);
      if (mWorkerInterface->end_run)
         // More foreign code
         mWorkerInterface->end_run(mHandle);
   }
}

References mHandle, mResponses, and mWorkerInterface.

◆ Create()

std::unique_ptr< LV2Wrapper > LV2Wrapper::Create	(	LV2InstanceFeaturesList &	baseFeatures,
		const LV2Ports &	ports,
		LV2PortStates &	portStates,
		const LV2EffectSettings &	settings,
		float	sampleRate,
		EffectOutputs *	pOutputs
	)

static

Factory.

Definition at line 32 of file LV2Wrapper.cpp.

{
   auto &plug = baseFeatures.mPlug;
 
   std::unique_ptr<LV2Wrapper> wrapper;
   try {
      wrapper = std::make_unique<LV2Wrapper>(CreateToken{},
         baseFeatures, plug, sampleRate);
   } catch(const std::exception&) {
      return nullptr;
   }
 
   const auto instance = &wrapper->GetInstance();
   wrapper->SendBlockSize();
   wrapper->ConnectPorts(ports, portStates, settings, pOutputs);
 
   // Give plugin a chance to initialize.  The SWH plugins (like AllPass) need
   // this before it can be safely deleted.
   lilv_instance_activate(instance);
   lilv_instance_deactivate(instance);
 
   // Send to the dialog whatever was the result of that "pulse"
   for (auto & state : portStates.mAtomPortStates)
      state->ReceiveFromInstance();
 
   return wrapper;
}

References LV2PortStates::mAtomPortStates, LV2FeaturesListBase::mPlug, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Referenced by LV2Instance::MakeWrapper(), LV2Instance::RealtimeAddProcessor(), and anonymous_namespace{LoadLV2.cpp}::LV2PluginValidator::Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Deactivate()

void LV2Wrapper::Deactivate ( )

Definition at line 169 of file LV2Wrapper.cpp.

{
   if (mActivated) {
      lilv_instance_deactivate(&GetInstance());
      mActivated = false;
   }
}

References GetInstance(), and mActivated.

Referenced by ~LV2Wrapper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFeatures() [1/2]

LV2WrapperFeaturesList & LV2Wrapper::GetFeatures ( )

inline

Definition at line 92 of file LV2Wrapper.h.

92{ return mFeaturesList; }

◆ GetFeatures() [2/2]

const LV2WrapperFeaturesList & LV2Wrapper::GetFeatures ( ) const

inline

Definition at line 93 of file LV2Wrapper.h.

93{ return mFeaturesList; }

◆ GetHandle()

LV2_Handle LV2Wrapper::GetHandle ( ) const

Definition at line 182 of file LV2Wrapper.cpp.

{
   return mHandle;
}

References mHandle.

◆ GetInstance()

LilvInstance & LV2Wrapper::GetInstance ( ) const

Definition at line 177 of file LV2Wrapper.cpp.

{
   return *mInstance;
}

References mInstance.

Referenced by Activate(), ConnectControlPorts(), ConnectPorts(), and Deactivate().

Here is the caller graph for this function:

◆ GetLatency()

float LV2Wrapper::GetLatency ( ) const

Definition at line 187 of file LV2Wrapper.cpp.

{
   return mLatency;
}

References mLatency.

◆ respond()

LV2_Worker_Status LV2Wrapper::respond	(	LV2_Worker_Respond_Handle	handle,
		uint32_t	size,
		const void *	data
	)

static

Definition at line 260 of file LV2Wrapper.cpp.

{
   return static_cast<LV2Wrapper*>(handle)->Respond(size, data);
}

References Respond(), and size.

Referenced by ScheduleWork(), and ThreadFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Respond()

LV2_Worker_Status LV2Wrapper::Respond	(	uint32_t	size,
		const void *	data
	)

Definition at line 266 of file LV2Wrapper.cpp.

{
   // Put in the queue, for another thread -- when not "freewheeling."
   // Otherwise it is just roundabout communication within a thread
   const auto err = mResponses.Post({ size, data });
   return (err == wxMSGQUEUE_NO_ERROR)
      ? LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
}

References mResponses, and size.

Referenced by respond().

Here is the caller graph for this function:

◆ schedule_work()

LV2_Worker_Status LV2Wrapper::schedule_work	(	LV2_Worker_Schedule_Handle	handle,
		uint32_t	size,
		const void *	data
	)

static

Definition at line 238 of file LV2Wrapper.cpp.

{
   return static_cast<LV2Wrapper *>(handle)->ScheduleWork(size, data);
}

References ScheduleWork(), and size.

Here is the call graph for this function:

◆ ScheduleWork()

LV2_Worker_Status LV2Wrapper::ScheduleWork	(	uint32_t	size,
		const void *	data
	)

Definition at line 244 of file LV2Wrapper.cpp.

{
   if (mFreeWheeling)
      // Not using another thread
      return mWorkerInterface->work(mHandle, respond, this, size, data);
   else {
      // Put in the queue for the worker thread
      // which will then do mWorkerInterface->work
      const auto err = mRequests.Post({ size, data });
      return (err == wxMSGQUEUE_NO_ERROR)
         ? LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
   }
}

References mFreeWheeling, mHandle, mRequests, mWorkerInterface, respond(), and size.

Referenced by schedule_work().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendBlockSize()

void LV2Wrapper::SendBlockSize ( )

Definition at line 198 of file LV2Wrapper.cpp.

{
   if (auto pOption = mFeaturesList.Base().NominalBlockLengthOption()
      ; pOption && mOptionsInterface && mOptionsInterface->set
   ){
      LV2_Options_Option options[2]{ *pOption, {} };
      // I assume the pointer to temporary options is not retained by
      // well written plug-ins, but they may watch the location at the pointer
      // that is in the option structure.
      mOptionsInterface->set(mHandle, options);
   }
}

References LV2WrapperFeaturesList::Base(), mFeaturesList, mHandle, mOptionsInterface, and LV2InstanceFeaturesList::NominalBlockLengthOption().

Here is the call graph for this function:

◆ SetFreeWheeling()

void LV2Wrapper::SetFreeWheeling ( bool enable )

Definition at line 193 of file LV2Wrapper.cpp.

{
   mFreeWheeling = enable;
}

References mFreeWheeling.

◆ ThreadFunction()

void LV2Wrapper::ThreadFunction ( )

private

Definition at line 212 of file LV2Wrapper.cpp.

{
   for (LV2Work work{};
      // Must test mStopWorker only after reading mRequests
      mRequests.Receive(work) == wxMSGQUEUE_NO_ERROR && !mStopWorker;
   )
      // Call foreign instance code in this thread, which is neither the
      // main nor the audio thread
      mWorkerInterface->work(mHandle, respond, this, work.size, work.data);
}

References mHandle, mRequests, mStopWorker, mWorkerInterface, and respond().

Here is the call graph for this function:

Member Data Documentation

◆ mActivated

bool LV2Wrapper::mActivated { false }

private

Definition at line 127 of file LV2Wrapper.h.

Referenced by Activate(), and Deactivate().

◆ mFeaturesList

LV2WrapperFeaturesList LV2Wrapper::mFeaturesList

private

Definition at line 101 of file LV2Wrapper.h.

Referenced by SendBlockSize().

◆ mFreeWheeling

bool LV2Wrapper::mFreeWheeling { false }

private

If true, do not spawn extra worker threads.

Definition at line 122 of file LV2Wrapper.h.

Referenced by ScheduleWork(), and SetFreeWheeling().

◆ mHandle

const LV2_Handle LV2Wrapper::mHandle

private

Definition at line 105 of file LV2Wrapper.h.

Referenced by ConsumeResponses(), GetHandle(), ScheduleWork(), SendBlockSize(), and ThreadFunction().

◆ mInstance

const LilvInstancePtr LV2Wrapper::mInstance

private

Invariant: not null

Definition at line 104 of file LV2Wrapper.h.

Referenced by GetInstance(), and ~LV2Wrapper().

◆ mLatency

float LV2Wrapper::mLatency { 0.0 }

private

Definition at line 119 of file LV2Wrapper.h.

Referenced by ConnectControlPorts(), and GetLatency().

◆ mOptionsInterface

const LV2_Options_Interface* const LV2Wrapper::mOptionsInterface

private

Definition at line 110 of file LV2Wrapper.h.

Referenced by SendBlockSize().

◆ mRequests

wxMessageQueue<LV2Work> LV2Wrapper::mRequests

private

Definition at line 117 of file LV2Wrapper.h.

Referenced by ScheduleWork(), ThreadFunction(), and ~LV2Wrapper().

◆ mResponses

wxMessageQueue<LV2Work> LV2Wrapper::mResponses

private

Definition at line 118 of file LV2Wrapper.h.

Referenced by ConsumeResponses(), and Respond().

◆ mStateInterface

const LV2_State_Interface* const LV2Wrapper::mStateInterface

private

Definition at line 112 of file LV2Wrapper.h.

◆ mStopWorker

bool LV2Wrapper::mStopWorker { false }

private

Written by main thread, read by worker, but atomic isn't needed because mRequests provides synchronization

Definition at line 126 of file LV2Wrapper.h.

Referenced by ThreadFunction(), and ~LV2Wrapper().

◆ mThread

std::thread LV2Wrapper::mThread

private

Definition at line 116 of file LV2Wrapper.h.

Referenced by ~LV2Wrapper().

◆ mWorkerInterface

const LV2_Worker_Interface* const LV2Wrapper::mWorkerInterface

private

Definition at line 114 of file LV2Wrapper.h.

Referenced by ConsumeResponses(), ScheduleWork(), and ThreadFunction().

◆ mWorkerSchedule

LV2_Worker_Schedule LV2Wrapper::mWorkerSchedule { this, LV2Wrapper::schedule_work }

private

Definition at line 99 of file LV2Wrapper.h.

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

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LV2Wrapper()

◆ ~LV2Wrapper()

Member Function Documentation

◆ Activate()

◆ ConnectControlPorts()

◆ ConnectPorts()

◆ ConsumeResponses()

◆ Create()

◆ Deactivate()

◆ GetFeatures() [1/2]

◆ GetFeatures() [2/2]

◆ GetHandle()

◆ GetInstance()

◆ GetLatency()

◆ respond()

◆ Respond()

◆ schedule_work()

◆ ScheduleWork()

◆ SendBlockSize()

◆ SetFreeWheeling()

◆ ThreadFunction()

Member Data Documentation

◆ mActivated

◆ mFeaturesList

◆ mFreeWheeling

◆ mHandle

◆ mInstance

◆ mLatency

◆ mOptionsInterface

◆ mRequests

◆ mResponses

◆ mStateInterface

◆ mStopWorker

◆ mThread

◆ mWorkerInterface

◆ mWorkerSchedule