#include <VSTInstance.h>

Inheritance diagram for VSTInstance:

Collaboration diagram for VSTInstance:

Public Member Functions
	VSTInstance (const PerTrackEffect &effect, const PluginPath &path, size_t blockSize, size_t userBlockSize, bool useLatency)

	~VSTInstance () override

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

bool	ProcessFinalize () noexcept override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

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	UsesMessages () const noexcept 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...

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	IsReady ()

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	DoProcessInitialize (double sampleRate)

void	PowerOn ()

void	PowerOff ()

std::unique_ptr< Message >	MakeMessage () const override
	Called on the main thread, in which the result may be cloned. More...

std::unique_ptr< Message >	MakeMessage (int id, double value) const

void	Automate (int index, float value) override

void	NeedIdle () override

void	SizeWindow (int w, int h) override

void	SetBufferDelay (int samples) override

void	SetOwningValidator (VSTUIWrapper *vi)

bool	OnePresetWasLoadedWhilePlaying ()

void	DeferChunkApplication ()

bool	HasGUI () 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 void	RealtimePassThrough (size_t group, EffectSettings &settings, const float const inBuf, size_t numSamples)
	Called instead of `RealtimeProcess` when the effect is bypassed. Default implementation does nothing. More...

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 VSTWrapper
	VSTWrapper (const PluginPath &path)

	~VSTWrapper ()

intptr_t	callDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt) override

intptr_t	constCallDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt) const

float	callGetParameter (int index) const

void	callSetChunk (bool isPgm, int len, void *buf)

void	callSetChunk (bool isPgm, int len, void buf, VstPatchChunkInfo info) const

int	GetString (wxString &outstr, int opcode, int index=0) const

wxString	GetString (int opcode, int index=0) const

void	ForEachParameter (ParameterVisitor visitor) const

bool	FetchSettings (VSTSettings &vst3Settings, bool doFetch=true) const

bool	StoreSettings (const VSTSettings &vst3settings) const

VstPatchChunkInfo	GetChunkInfo () const

bool	IsCompatible (const VstPatchChunkInfo &) const

bool	LoadXML (const wxFileName &fn)

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

void	HandleXMLEndTag (const std::string_view &tag) override

void	HandleXMLContent (const std::string_view &content) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

void	SetString (int opcode, const wxString &str, int index=0)

ComponentInterfaceSymbol	GetSymbol () const

void	callSetParameter (int index, float value) const

void	SaveXML (const wxFileName &fn) const

bool	LoadFXB (const wxFileName &fn)

bool	LoadFXP (const wxFileName &fn)

bool	LoadFXProgram (unsigned char **bptr, ssize_t &len, int index, bool dryrun)

void	callSetProgram (int index)

void	SaveFXB (const wxFileName &fn) const

void	SaveFXP (const wxFileName &fn) const

void	SaveFXProgram (wxMemoryBuffer &buf, int index) const

bool	Load ()

void	Unload ()

void	ResetModuleAndHandle ()

VstTimeInfo *	GetTimeInfo ()

float	GetSampleRate ()

int	GetProcessLevel ()

virtual void	SetBufferDelay (int samples)

std::unique_ptr< EffectInstance::Message >	MakeMessageFS (const VSTSettings &settings) const

Public Member Functions inherited from VSTLink
virtual	~VSTLink ()

virtual intptr_t	callDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt)=0

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from VSTUIWrapper
virtual void	Idle ()

virtual void	NeedIdle ()

virtual void	SizeWindow (int w, int h)

virtual void	Automate (int index, float value)

virtual void	Flush ()

Public Attributes
const bool	mUseLatency

size_t	mBlockSize { 8192 }

Public Attributes inherited from VSTWrapper
AEffect *	mAEffect = nullptr

std::thread::id	mMainThreadId

std::recursive_mutex	mDispatcherLock

int	mVstVersion

wxString	mName

bool	mInSet

bool	mInChunk

wxString	mChunk

long	mXMLVersion

VstPatchChunkInfo	mXMLInfo

intptr_t	mCurrentEffectID {}

PluginPath	mPath

ModuleHandle	mModule {}

wxString	mVendor

wxString	mDescription

int	mVersion

bool	mInteractive { false }

unsigned	mAudioIns { 0 }

unsigned	mAudioOuts { 0 }

int	mMidiIns { 0 }

int	mMidiOuts { 0 }

bool	mAutomatable

BundleHandle	mBundleRef

ResourceHandle	mResource

VstTimeInfo	mTimeInfo

int	mBufferDelay { 0 }

int	mProcessLevel { 1 }

bool	mGui { false }

Private Member Functions
void	callProcessReplacing (const float const inputs, float const outputs, int sampleframes)

void	ApplyChunk (std::vector< char > &chunk)

bool	ChunkMustBeAppliedInMainThread () const

Private Attributes
VSTInstanceArray	mSlaves

bool	mHasPower { false }

size_t	mUserBlockSize { mBlockSize }

bool	mReady { false }

bool	mRecruited { false }

VSTUIWrapper *	mpOwningValidator {}

std::atomic_bool	mPresetLoadedWhilePlaying { false }

std::mutex	mDeferredChunkMutex

std::vector< char >	mChunkToSetAtIdleTime {}

bool	mIsMeldaPlugin { false }

Additional Inherited Members
Public Types inherited from EffectInstance
using	Message = EffectSettingsAccess::Message

using	SampleCount = uint64_t

Public Types inherited from VSTWrapper
using	ParameterVisitor = std::function< bool(const ParameterInfo &pi) >

using	ModuleHandle = std::unique_ptr< wxDynamicLibrary >

using	BundleHandle = CF_ptr< CFBundleRef >

Static Public Member Functions inherited from VSTWrapper
static VSTSettings &	GetSettings (EffectSettings &settings)

static const VSTSettings &	GetSettings (const EffectSettings &settings)

static intptr_t	AudioMaster (AEffect effect, int32_t opcode, int32_t index, intptr_t value, void ptr, float opt)

Protected Attributes inherited from PerTrackEffect::Instance
const PerTrackEffect &	mProcessor

Detailed Description

Definition at line 25 of file VSTInstance.h.

Constructor & Destructor Documentation

◆ VSTInstance()

VSTInstance::VSTInstance	(	const PerTrackEffect &	effect,
		const PluginPath &	path,
		size_t	blockSize,
		size_t	userBlockSize,
		bool	useLatency
	)

Definition at line 451 of file VSTInstance.cpp.

   : PerTrackEffect::Instance(effect)
   , VSTWrapper(path)
   , mUseLatency{ useLatency }
{
   // what also happens in the effect ctor
   //
   memset(&mTimeInfo, 0, sizeof(mTimeInfo));
   mTimeInfo.samplePos = 0.0;
   mTimeInfo.sampleRate = 44100.0;  // this is a bogus value, but it's only for the display
   mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
   mTimeInfo.tempo = 120.0;
   mTimeInfo.timeSigNumerator = 4;
   mTimeInfo.timeSigDenominator = 4;
   mTimeInfo.flags = kVstTempoValid | kVstNanosValid;
 
   mBlockSize = blockSize;
   mUserBlockSize = userBlockSize;
 
   Load();
 
   if (!IsReady() )
   {
      // Set some defaults since some VSTs need them...these will be reset when
      // normal or realtime processing begins
      mBlockSize = 8192;
      DoProcessInitialize(44100.0);
   }
 
   mIsMeldaPlugin = (mVendor == "MeldaProduction");
}

References DoProcessInitialize(), VstTimeInfo::flags, IsReady(), kVstNanosValid, kVstTempoValid, VSTWrapper::Load(), mBlockSize, mIsMeldaPlugin, VSTWrapper::mTimeInfo, mUserBlockSize, VSTWrapper::mVendor, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Here is the call graph for this function:

◆ ~VSTInstance()

VSTInstance::~VSTInstance ( )

override

Definition at line 491 of file VSTInstance.cpp.

{
   PowerOff();
}

References PowerOff().

Here is the call graph for this function:

Member Function Documentation

◆ ApplyChunk()

void VSTInstance::ApplyChunk ( std::vector< char > & chunk )

private

Definition at line 236 of file VSTInstance.cpp.

{
   VstPatchChunkInfo info = {
      1, mAEffect->uniqueID, mAEffect->version, mAEffect->numParams, "" };
 
   const auto len = chunk.size();
   const auto data = chunk.data();
 
   callSetChunk(true, len, data, &info);
   for (auto& slave : mSlaves)
      slave->callSetChunk(true, len, data, &info);
}

References VSTWrapper::callSetChunk(), VSTWrapper::mAEffect, mSlaves, AEffect::numParams, AEffect::uniqueID, and AEffect::version.

Referenced by DeferChunkApplication(), and RealtimeProcessStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Automate()

void VSTInstance::Automate	(	int	index,
		float	value
	)

overridevirtual

Reimplemented from VSTUIWrapper.

Definition at line 440 of file VSTInstance.cpp.

{
   if (mMainThreadId != std::this_thread::get_id())
      return;
 
   if (mpOwningValidator)
   {
      mpOwningValidator->Automate(index, value);
   }
}

References VSTUIWrapper::Automate(), VSTWrapper::mMainThreadId, and mpOwningValidator.

Here is the call graph for this function:

◆ callProcessReplacing()

void VSTInstance::callProcessReplacing	(	const float const	inputs,
		float const	outputs,
		int	sampleframes
	)

private

Definition at line 432 of file VSTInstance.cpp.

{
   mAEffect->processReplacing(mAEffect,
      const_cast<float**>(inputs),
      const_cast<float**>(outputs), sampleframes);
}

References VSTWrapper::mAEffect, and AEffect::processReplacing.

Referenced by ProcessBlock().

Here is the caller graph for this function:

◆ ChunkMustBeAppliedInMainThread()

bool VSTInstance::ChunkMustBeAppliedInMainThread ( ) const

private

Definition at line 249 of file VSTInstance.cpp.

{
   // Some plugins (e.g. Melda) can not have their chunk set in the
   // audio thread, resulting in making the whole app hang.
   // This is why we defer the setting of the chunk in the main thread.
 
   const bool IsAudioThread = (mMainThreadId != std::this_thread::get_id());
 
   return IsAudioThread && mIsMeldaPlugin;
}

References mIsMeldaPlugin, and VSTWrapper::mMainThreadId.

Referenced by RealtimeProcessStart().

Here is the caller graph for this function:

◆ DeferChunkApplication()

void VSTInstance::DeferChunkApplication ( )

Definition at line 225 of file VSTInstance.cpp.

{
   std::lock_guard<std::mutex> guard(mDeferredChunkMutex);
 
   if (! mChunkToSetAtIdleTime.empty() )
   {
      ApplyChunk(mChunkToSetAtIdleTime);
      mChunkToSetAtIdleTime.resize(0);
   }
}

References ApplyChunk(), mChunkToSetAtIdleTime, and mDeferredChunkMutex.

Referenced by VSTEditor::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoProcessInitialize()

bool VSTInstance::DoProcessInitialize ( double sampleRate )

Definition at line 96 of file VSTInstance.cpp.

{
   // Initialize time info
   memset(&mTimeInfo, 0, sizeof(mTimeInfo));
   mTimeInfo.sampleRate = sampleRate;
   mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
   mTimeInfo.tempo = 120.0;
   mTimeInfo.timeSigNumerator = 4;
   mTimeInfo.timeSigDenominator = 4;
   mTimeInfo.flags = kVstTempoValid | kVstNanosValid | kVstTransportPlaying;
 
   // Set processing parameters...power must be off for this
   callDispatcher(effSetSampleRate, 0, 0, NULL, sampleRate);
   callDispatcher(effSetBlockSize, 0, mBlockSize, NULL, 0.0);
 
   // Turn on the power
   PowerOn();
 
   // Set the initial buffer delay
   SetBufferDelay(mAEffect->initialDelay);
 
   mReady = true;
   return true;
}

References VSTWrapper::callDispatcher(), effSetBlockSize, effSetSampleRate, VstTimeInfo::flags, AEffect::initialDelay, kVstNanosValid, kVstTempoValid, kVstTransportPlaying, VSTWrapper::mAEffect, mBlockSize, mReady, VSTWrapper::mTimeInfo, VstTimeInfo::nanoSeconds, PowerOn(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, VstTimeInfo::sampleRate, SetBufferDelay(), VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Referenced by ProcessInitialize(), and VSTInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioInCount()

unsigned VSTInstance::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 37 of file VSTInstance.cpp.

{
   return mAudioIns;
}

References VSTWrapper::mAudioIns.

Referenced by SetBlockSize().

Here is the caller graph for this function:

◆ GetAudioOutCount()

unsigned VSTInstance::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 42 of file VSTInstance.cpp.

{
   return mAudioOuts;
}

References VSTWrapper::mAudioOuts.

Referenced by SetBlockSize().

Here is the caller graph for this function:

◆ GetBlockSize()

size_t VSTInstance::GetBlockSize ( ) const

overridevirtual

Implements EffectInstance.

Definition at line 64 of file VSTInstance.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ GetLatency()

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

overridevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 69 of file VSTInstance.cpp.

{
   if (mUseLatency)
      return mBufferDelay;
   return 0;
}

◆ HasGUI()

bool VSTInstance::HasGUI ( ) const

inline

Definition at line 105 of file VSTInstance.h.

105{ return mGui; }

VSTWrapper::mGui

bool mGui

Definition: VSTWrapper.h:295

References VSTWrapper::mGui.

◆ IsReady()

bool VSTInstance::IsReady ( )

Definition at line 77 of file VSTInstance.cpp.

{
   return mReady;
}

References mReady.

Referenced by VSTInstance().

Here is the caller graph for this function:

◆ MakeMessage() [1/2]

std::unique_ptr< EffectInstance::Message > VSTInstance::MakeMessage ( ) const

overridevirtual

Called on the main thread, in which the result may be cloned.

Default implementation returns a null

Reimplemented from EffectInstance.

Definition at line 17 of file VSTInstance.cpp.

{
   // The purpose here is just to allocate vectors (chunk and paramVector)
   // with sufficient size, not to get the values too
   VSTSettings settings;
   FetchSettings(settings, /* doFetch = */ false);
 
   VSTMessage::ParamVector paramVector;
   paramVector.resize(mAEffect->numParams, std::nullopt);
 
   return std::make_unique<VSTMessage>( std::move(settings.mChunk), std::move(paramVector) );
}

References VSTWrapper::FetchSettings(), VSTWrapper::mAEffect, AEffect::numParams, and settings().

Referenced by VSTEditor::ValidateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeMessage() [2/2]

std::unique_ptr< EffectInstance::Message > VSTInstance::MakeMessage	(	int	id,
		double	value
	)		const

Definition at line 31 of file VSTInstance.cpp.

{
   return std::make_unique<VSTMessage>(id, value, mAEffect->numParams);
}

References VSTWrapper::mAEffect, and AEffect::numParams.

◆ NeedIdle()

void VSTInstance::NeedIdle ( )

overridevirtual

Reimplemented from VSTUIWrapper.

Definition at line 369 of file VSTInstance.cpp.

{
   if (mpOwningValidator)
   {
      mpOwningValidator->NeedIdle();
   }
}

References mpOwningValidator, and VSTUIWrapper::NeedIdle().

Here is the call graph for this function:

◆ OnePresetWasLoadedWhilePlaying()

bool VSTInstance::OnePresetWasLoadedWhilePlaying ( )

Definition at line 220 of file VSTInstance.cpp.

{
   return mPresetLoadedWhilePlaying.exchange(false);
}

References mPresetLoadedWhilePlaying.

◆ PowerOff()

void VSTInstance::PowerOff ( )

Definition at line 395 of file VSTInstance.cpp.

{
   if (mHasPower)
   {
      // Tell the effect we're going to stop processing
      if (mVstVersion >= 2)
      {
         callDispatcher(effStopProcess, 0, 0, NULL, 0.0);
      }
 
      // Turn the power off
      callDispatcher(effMainsChanged, 0, 0, NULL, 0.0);
 
      // Set state
      mHasPower = false;
   }
}

References VSTWrapper::callDispatcher(), effMainsChanged, effStopProcess, mHasPower, and VSTWrapper::mVstVersion.

Referenced by ProcessFinalize(), RealtimeSuspend(), and ~VSTInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PowerOn()

void VSTInstance::PowerOn ( )

Definition at line 377 of file VSTInstance.cpp.

{
   if (!mHasPower)
   {
      // Turn the power on
      callDispatcher(effMainsChanged, 0, 1, NULL, 0.0);
 
      // Tell the effect we're going to start processing
      if (mVstVersion >= 2)
      {
         callDispatcher(effStartProcess, 0, 0, NULL, 0.0);
      }
 
      // Set state
      mHasPower = true;
   }
}

References VSTWrapper::callDispatcher(), effMainsChanged, effStartProcess, mHasPower, and VSTWrapper::mVstVersion.

Referenced by VSTEditor::BuildFancy(), DoProcessInitialize(), and RealtimeResume().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 133 of file VSTInstance.cpp.

{
   // Only call the effect if there's something to do...some do not like zero-length block
   if (blockLen)
   {
      // Go let the plugin moleste the samples
      callProcessReplacing(inBlock, outBlock, blockLen);
 
      // And track the position
      mTimeInfo.samplePos += (double) blockLen;
   }
 
   return blockLen;
}

References callProcessReplacing(), VSTWrapper::mTimeInfo, and VstTimeInfo::samplePos.

Referenced by RealtimeProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessFinalize()

bool VSTInstance::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 121 of file VSTInstance.cpp.

{
   return GuardedCall<bool>([&] {
      mReady = false;
 
      PowerOff();
 
      return true;
   });
 
}

References mReady, and PowerOff().

Here is the call graph for this function:

◆ ProcessInitialize()

bool VSTInstance::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 82 of file VSTInstance.cpp.

{
   // Issue 3942: Copy the contents of settings first.
   // settings may refer to what is in the RealtimeEffectState, but that might
   // get reassigned by EffectSettingsAccess::Set, when the validator's
   // Automate() is called-back by the plug-in during callSetParameter.
   // So this avoids a dangling reference.
   auto copiedSettings = GetSettings(settings);
   StoreSettings(copiedSettings);
 
   return DoProcessInitialize(sampleRate);
}

References DoProcessInitialize(), VSTWrapper::GetSettings(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, settings(), and VSTWrapper::StoreSettings().

Referenced by RealtimeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 159 of file VSTInstance.cpp.

{
   if (!mRecruited)
   {
      // Assign self to the first processor
      mRecruited = true;
      return true;
   }
 
   auto &effect = static_cast<const PerTrackEffect &>(mProcessor);
   auto slave = std::make_unique<VSTInstance>(
      const_cast<PerTrackEffect &>(effect),
      mPath, mBlockSize, mUserBlockSize, mUseLatency);
 
   slave->SetBlockSize(mBlockSize);
 
   if (!slave->ProcessInitialize(settings, sampleRate, ChannelNames()))
      return false;
 
   mSlaves.emplace_back(move(slave));
   return true;
}

References mBlockSize, VSTWrapper::mPath, PerTrackEffect::Instance::mProcessor, mRecruited, mSlaves, mUseLatency, mUserBlockSize, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool VSTInstance::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 183 of file VSTInstance.cpp.

{
return GuardedCall<bool>([&]{
 
   if (mpOwningValidator)
      mpOwningValidator->Flush();
 
   mRecruited = false;
 
   for (const auto &slave : mSlaves)
      slave->ProcessFinalize();
   mSlaves.clear();
 
   return ProcessFinalize();
});
}

References for().

Here is the call graph for this function:

◆ RealtimeInitialize()

bool VSTInstance::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 149 of file VSTInstance.cpp.

{
   // Temporarily disconnect from any validator, so that setting the chunk
   // does not cause Automate() callbacks (as some effects will do) that then
   // would send slider movement messages that might destroy information in
   // the settings.
   auto vr = valueRestorer(mpOwningValidator, (VSTUIWrapper*)nullptr);
   return ProcessInitialize(settings, sampleRate, {});
}

References mpOwningValidator, ProcessInitialize(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, settings(), and valueRestorer().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t VSTInstance::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 336 of file VSTInstance.cpp.

{
   if (!mRecruited)
   {
      // unexpected!
      return 0;
   }
 
   wxASSERT(numSamples <= mBlockSize);
 
   if (group == 0)
   {
      // use the recruited "this" instance
      return ProcessBlock(settings, inbuf, outbuf, numSamples);
   }
   else if (group <= mSlaves.size())
   {
      // use the slave which maps to the group
      return mSlaves[group - 1]->ProcessBlock(settings, inbuf, outbuf, numSamples);
   }
   else
      return 0;
}

References mBlockSize, mRecruited, mSlaves, ProcessBlock(), and settings().

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool VSTInstance::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 361 of file VSTInstance.cpp.

{
   if ( ChunkMustBeAppliedInMainThread() )
      mDeferredChunkMutex.unlock();
 
   return true;
}

◆ RealtimeProcessStart()

bool VSTInstance::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 265 of file VSTInstance.cpp.

{
   const bool applyChunkInMainThread = ChunkMustBeAppliedInMainThread();
 
   if (applyChunkInMainThread)
      mDeferredChunkMutex.lock();
 
   if (!package.pMessage)
      return true;
 
   auto& message = static_cast<VSTMessage&>(*package.pMessage);
 
   auto &chunk = message.mChunk;
 
   if (!chunk.empty())
   {
      if (applyChunkInMainThread)
      {
         // Apply the chunk later
         //
         mChunkToSetAtIdleTime = chunk;
      }
      else
      {
         // Apply the chunk now
         ApplyChunk(chunk);
      }
 
      // Don't apply the chunk again until another message supplies a chunk
      chunk.resize(0);
 
      // Don't return yet.  Maybe some slider movements also accumulated after
      // the change of the chunk.
 
      const bool IsAudioThread = (mMainThreadId != std::this_thread::get_id());
      if (IsAudioThread)
      {
         // At the moment, the only reason why this method would be called in the audio thread,
         // is because a preset was loaded while playing
 
         mPresetLoadedWhilePlaying.store(true);
      }
 
   }
 
 
   assert(message.mParamsVec.size() == mAEffect->numParams);
 
   for (size_t paramID=0; paramID < mAEffect->numParams; paramID++)
   {
      if (message.mParamsVec[paramID])
      {
         float val = (float)(*message.mParamsVec[paramID]);
 
         // set the change on the recruited "this" instance
         callSetParameter(paramID, val);
 
         // set the change on any existing slaves
         for (auto& slave : mSlaves)
         {
            slave->callSetParameter(paramID, val);
         }
 
         // clear the used info
         message.mParamsVec[paramID] = std::nullopt;
      }
   }
 
   return true;
}

References ApplyChunk(), VSTWrapper::callSetParameter(), ChunkMustBeAppliedInMainThread(), VSTWrapper::mAEffect, VSTMessage::mChunk, mChunkToSetAtIdleTime, mDeferredChunkMutex, VSTWrapper::mMainThreadId, mPresetLoadedWhilePlaying, mSlaves, AEffect::numParams, and EffectInstance::MessagePackage::pMessage.

Here is the call graph for this function:

◆ RealtimeResume()

bool VSTInstance::RealtimeResume ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 210 of file VSTInstance.cpp.

{
   PowerOn();
 
   for (const auto &slave : mSlaves)
      slave->PowerOn();
 
   return true;
}

References mSlaves, and PowerOn().

Here is the call graph for this function:

◆ RealtimeSuspend()

bool VSTInstance::RealtimeSuspend ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 200 of file VSTInstance.cpp.

{
   PowerOff();
 
   for (const auto &slave : mSlaves)
      slave->PowerOff();
 
   return true;
}

References mSlaves, and PowerOff().

Here is the call graph for this function:

◆ SetBlockSize()

size_t VSTInstance::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectInstance.

Definition at line 47 of file VSTInstance.cpp.

{
   // Issue 3935 for IEM plug-ins, VST 2 versions:
   // It is mysterious why this further limitation of size works to
   // prevent the crashes in destructive processing, or why this is not
   // needed for non-destructive, but here it is
   // Those plugins report many channels (like 64) but most others will not
   // be affected by these lines with the default size of 8192
   // Note it may make the Block Size option of the settings dialog misleading
   auto numChannels = std::max({ 1u, GetAudioInCount(), GetAudioOutCount() });
   maxBlockSize = std::max(size_t(1),
      std::min(maxBlockSize, size_t(0x8000u / numChannels)));
 
   mBlockSize = std::min( maxBlockSize, mUserBlockSize );
   return mBlockSize;
}

References GetAudioInCount(), GetAudioOutCount(), anonymous_namespace{StaffPadTimeAndPitch.cpp}::maxBlockSize, mBlockSize, min(), and mUserBlockSize.

Here is the call graph for this function:

◆ SetBufferDelay()

void VSTInstance::SetBufferDelay ( int samples )

overridevirtual

Reimplemented from VSTWrapper.

Definition at line 421 of file VSTInstance.cpp.

{
   // We do not support negative delay
   if (samples >= 0 && mUseLatency)
   {
      mBufferDelay = samples;
   }
 
   return;
}

References VSTWrapper::mBufferDelay, and mUseLatency.

Referenced by DoProcessInitialize().

Here is the caller graph for this function:

◆ SetOwningValidator()

void VSTInstance::SetOwningValidator ( VSTUIWrapper * vi )

Definition at line 496 of file VSTInstance.cpp.

{
   mpOwningValidator = vi;
}

References mpOwningValidator.

Referenced by VSTEditor::OnClose(), and VSTEditor::~VSTEditor().

Here is the caller graph for this function:

◆ SizeWindow()

void VSTInstance::SizeWindow	(	int	w,
		int	h
	)

overridevirtual

Reimplemented from VSTUIWrapper.

Definition at line 413 of file VSTInstance.cpp.

{
   if (mpOwningValidator)
   {
      mpOwningValidator->SizeWindow(w, h);
   }
}

References mpOwningValidator, and VSTUIWrapper::SizeWindow().

Here is the call graph for this function:

◆ UsesMessages()

bool VSTInstance::UsesMessages ( ) const

overridevirtualnoexcept

If true, the effect makes no use EffectSettings for inter-thread comminication

Default implementation returns false. In future, all effects should be rewritten to use messages and this function will be removed.

Reimplemented from EffectInstance.

Definition at line 260 of file VSTInstance.cpp.

{
   return true;
}

Member Data Documentation

◆ mBlockSize

size_t VSTInstance::mBlockSize { 8192 }

Definition at line 84 of file VSTInstance.h.

Referenced by DoProcessInitialize(), GetBlockSize(), RealtimeAddProcessor(), RealtimeProcess(), SetBlockSize(), and VSTInstance().

◆ mChunkToSetAtIdleTime

std::vector<char> VSTInstance::mChunkToSetAtIdleTime {}

private

Definition at line 127 of file VSTInstance.h.

Referenced by DeferChunkApplication(), and RealtimeProcessStart().

◆ mDeferredChunkMutex

std::mutex VSTInstance::mDeferredChunkMutex

private

Definition at line 126 of file VSTInstance.h.

Referenced by DeferChunkApplication(), and RealtimeProcessStart().

◆ mHasPower

bool VSTInstance::mHasPower { false }

private

Definition at line 114 of file VSTInstance.h.

Referenced by PowerOff(), and PowerOn().

◆ mIsMeldaPlugin

bool VSTInstance::mIsMeldaPlugin { false }

private

Definition at line 133 of file VSTInstance.h.

Referenced by ChunkMustBeAppliedInMainThread(), and VSTInstance().

◆ mpOwningValidator

VSTUIWrapper* VSTInstance::mpOwningValidator {}

private

Definition at line 122 of file VSTInstance.h.

Referenced by Automate(), NeedIdle(), RealtimeInitialize(), SetOwningValidator(), and SizeWindow().

◆ mPresetLoadedWhilePlaying

std::atomic_bool VSTInstance::mPresetLoadedWhilePlaying { false }

private

Definition at line 124 of file VSTInstance.h.

Referenced by OnePresetWasLoadedWhilePlaying(), and RealtimeProcessStart().

◆ mReady

bool VSTInstance::mReady { false }

private

Definition at line 118 of file VSTInstance.h.

Referenced by DoProcessInitialize(), IsReady(), and ProcessFinalize().

◆ mRecruited

bool VSTInstance::mRecruited { false }

private

Definition at line 120 of file VSTInstance.h.

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

◆ mSlaves

VSTInstanceArray VSTInstance::mSlaves

private

Definition at line 112 of file VSTInstance.h.

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

◆ mUseLatency

const bool VSTInstance::mUseLatency

Definition at line 82 of file VSTInstance.h.

Referenced by RealtimeAddProcessor(), and SetBufferDelay().

◆ mUserBlockSize

size_t VSTInstance::mUserBlockSize { mBlockSize }

private

Definition at line 116 of file VSTInstance.h.

Referenced by RealtimeAddProcessor(), SetBlockSize(), and VSTInstance().

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VSTInstance()

◆ ~VSTInstance()

Member Function Documentation

◆ ApplyChunk()

◆ Automate()

◆ callProcessReplacing()

◆ ChunkMustBeAppliedInMainThread()

◆ DeferChunkApplication()

◆ DoProcessInitialize()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetLatency()

◆ HasGUI()

◆ IsReady()

◆ MakeMessage() [1/2]

◆ MakeMessage() [2/2]

◆ NeedIdle()

◆ OnePresetWasLoadedWhilePlaying()

◆ PowerOff()

◆ PowerOn()

◆ ProcessBlock()

◆ ProcessFinalize()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

◆ SetBlockSize()

◆ SetBufferDelay()

◆ SetOwningValidator()

◆ SizeWindow()

◆ UsesMessages()

Member Data Documentation

◆ mBlockSize

◆ mChunkToSetAtIdleTime

◆ mDeferredChunkMutex

◆ mHasPower

◆ mIsMeldaPlugin

◆ mpOwningValidator

◆ mPresetLoadedWhilePlaying

◆ mReady

◆ mRecruited

◆ mSlaves

◆ mUseLatency

◆ mUserBlockSize