#include <VSTEffect.h>

Inheritance diagram for VSTEffectInstance:

Collaboration diagram for VSTEffectInstance:

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

	~VSTEffectInstance () 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 (VSTEffectUIWrapper *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 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 VSTEffectWrapper
	VSTEffectWrapper (const PluginPath &path)

	~VSTEffectWrapper ()

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 (VSTEffectSettings &vst3Settings, bool doFetch=true) const

bool	StoreSettings (const VSTEffectSettings &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	UpdateDisplay ()

virtual void	SetBufferDelay (int samples)

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

Public Member Functions inherited from VSTEffectLink
virtual	~VSTEffectLink ()

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 VSTEffectUIWrapper
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 VSTEffectWrapper
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 }

VSTEffectUIWrapper *	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 VSTEffectWrapper
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 VSTEffectWrapper
static VSTEffectSettings &	GetSettings (EffectSettings &settings)

static const VSTEffectSettings &	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 488 of file VSTEffect.h.

Constructor & Destructor Documentation

◆ VSTEffectInstance()

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

Definition at line 4006 of file VSTEffect.cpp.

   : PerTrackEffect::Instance(effect)
   , VSTEffectWrapper(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, VSTEffectWrapper::Load(), mBlockSize, mIsMeldaPlugin, VSTEffectWrapper::mTimeInfo, mUserBlockSize, VSTEffectWrapper::mVendor, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Here is the call graph for this function:

◆ ~VSTEffectInstance()

VSTEffectInstance::~VSTEffectInstance ( )

override

Definition at line 4047 of file VSTEffect.cpp.

{
   PowerOff();
}

References PowerOff().

Here is the call graph for this function:

Member Function Documentation

◆ ApplyChunk()

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

private

Definition at line 1265 of file VSTEffect.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 VSTEffectWrapper::callSetChunk(), VSTEffectWrapper::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 VSTEffectInstance::Automate	(	int	index,
		float	value
	)

overridevirtual

Reimplemented from VSTEffectUIWrapper.

Definition at line 3984 of file VSTEffect.cpp.

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

References VSTEffectUIWrapper::Automate(), VSTEffectWrapper::mMainThreadId, and mpOwningValidator.

Here is the call graph for this function:

◆ callProcessReplacing()

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

private

Definition at line 2473 of file VSTEffect.cpp.

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

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

Referenced by ProcessBlock().

Here is the caller graph for this function:

◆ ChunkMustBeAppliedInMainThread()

bool VSTEffectInstance::ChunkMustBeAppliedInMainThread ( ) const

private

Definition at line 1279 of file VSTEffect.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 VSTEffectWrapper::mMainThreadId.

Referenced by RealtimeProcessStart().

Here is the caller graph for this function:

◆ DeferChunkApplication()

void VSTEffectInstance::DeferChunkApplication ( )

Definition at line 1253 of file VSTEffect.cpp.

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

References ApplyChunk(), mChunkToSetAtIdleTime, and mDeferredChunkMutex.

Referenced by VSTEffectEditor::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoProcessInitialize()

bool VSTEffectInstance::DoProcessInitialize ( double sampleRate )

Definition at line 1120 of file VSTEffect.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 VSTEffectWrapper::callDispatcher(), effSetBlockSize, effSetSampleRate, VstTimeInfo::flags, AEffect::initialDelay, kVstNanosValid, kVstTempoValid, kVstTransportPlaying, VSTEffectWrapper::mAEffect, mBlockSize, mReady, VSTEffectWrapper::mTimeInfo, VstTimeInfo::nanoSeconds, PowerOn(), VstTimeInfo::sampleRate, SetBufferDelay(), VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Referenced by ProcessInitialize(), and VSTEffectInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioInCount()

unsigned VSTEffectInstance::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 1061 of file VSTEffect.cpp.

{
   return mAudioIns;
}

References VSTEffectWrapper::mAudioIns.

Referenced by SetBlockSize().

Here is the caller graph for this function:

◆ GetAudioOutCount()

unsigned VSTEffectInstance::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 1066 of file VSTEffect.cpp.

{
   return mAudioOuts;
}

References VSTEffectWrapper::mAudioOuts.

Referenced by SetBlockSize().

Here is the caller graph for this function:

◆ GetBlockSize()

size_t VSTEffectInstance::GetBlockSize ( ) const

overridevirtual

Implements EffectInstance.

Definition at line 1088 of file VSTEffect.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ GetLatency()

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

overridevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 1093 of file VSTEffect.cpp.

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

◆ HasGUI()

bool VSTEffectInstance::HasGUI ( ) const

inline

Definition at line 568 of file VSTEffect.h.

568{ return mGui; }

VSTEffectWrapper::mGui

bool mGui

Definition: VSTEffect.h:310

References VSTEffectWrapper::mGui.

◆ IsReady()

bool VSTEffectInstance::IsReady ( )

Definition at line 1101 of file VSTEffect.cpp.

{
   return mReady;
}

References mReady.

Referenced by VSTEffectInstance().

Here is the caller graph for this function:

◆ MakeMessage() [1/2]

std::unique_ptr< EffectInstance::Message > VSTEffectInstance::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 1021 of file VSTEffect.cpp.

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

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

Referenced by VSTEffectEditor::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 > VSTEffectInstance::MakeMessage	(	int	id,
		double	value
	)		const

Definition at line 1035 of file VSTEffect.cpp.

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

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

◆ NeedIdle()

void VSTEffectInstance::NeedIdle ( )

overridevirtual

Reimplemented from VSTEffectUIWrapper.

Definition at line 2238 of file VSTEffect.cpp.

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

References mpOwningValidator, and VSTEffectUIWrapper::NeedIdle().

Here is the call graph for this function:

◆ OnePresetWasLoadedWhilePlaying()

bool VSTEffectInstance::OnePresetWasLoadedWhilePlaying ( )

Definition at line 1248 of file VSTEffect.cpp.

{
   return mPresetLoadedWhilePlaying.exchange(false);
}

References mPresetLoadedWhilePlaying.

◆ PowerOff()

void VSTEffectInstance::PowerOff ( )

Definition at line 2294 of file VSTEffect.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 VSTEffectWrapper::callDispatcher(), effMainsChanged, effStopProcess, mHasPower, and VSTEffectWrapper::mVstVersion.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PowerOn()

void VSTEffectInstance::PowerOn ( )

Definition at line 2276 of file VSTEffect.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 VSTEffectWrapper::callDispatcher(), effMainsChanged, effStartProcess, mHasPower, and VSTEffectWrapper::mVstVersion.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 1159 of file VSTEffect.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(), VSTEffectWrapper::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 VSTEffectInstance::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 1146 of file VSTEffect.cpp.

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

References mReady, and PowerOff().

Here is the call graph for this function:

◆ ProcessInitialize()

bool VSTEffectInstance::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 1106 of file VSTEffect.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(), VSTEffectWrapper::GetSettings(), settings(), and VSTEffectWrapper::StoreSettings().

Referenced by RealtimeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1186 of file VSTEffect.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<VSTEffectInstance>(
      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, VSTEffectWrapper::mPath, PerTrackEffect::Instance::mProcessor, mRecruited, mSlaves, mUseLatency, mUserBlockSize, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool VSTEffectInstance::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1210 of file VSTEffect.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 VSTEffectInstance::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 1176 of file VSTEffect.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, (VSTEffectUIWrapper*)nullptr);
   return ProcessInitialize(settings, sampleRate, {});
}

References mpOwningValidator, ProcessInitialize(), settings(), and valueRestorer().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t VSTEffectInstance::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 1367 of file VSTEffect.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 VSTEffectInstance::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 1392 of file VSTEffect.cpp.

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

◆ RealtimeProcessStart()

bool VSTEffectInstance::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 1296 of file VSTEffect.cpp.

{
   const bool applyChunkInMainThread = ChunkMustBeAppliedInMainThread();
 
   if (applyChunkInMainThread)
      mDeferredChunkMutex.lock();
 
   if (!package.pMessage)
      return true;
 
   auto& message = static_cast<VSTEffectMessage&>(*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(), VSTEffectWrapper::callSetParameter(), ChunkMustBeAppliedInMainThread(), VSTEffectWrapper::mAEffect, mChunkToSetAtIdleTime, mDeferredChunkMutex, VSTEffectWrapper::mMainThreadId, mPresetLoadedWhilePlaying, mSlaves, AEffect::numParams, and EffectInstance::MessagePackage::pMessage.

Here is the call graph for this function:

◆ RealtimeResume()

bool VSTEffectInstance::RealtimeResume ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1237 of file VSTEffect.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 VSTEffectInstance::RealtimeSuspend ( )

overridevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 1227 of file VSTEffect.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 VSTEffectInstance::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectInstance.

Definition at line 1071 of file VSTEffect.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(), mBlockSize, min(), and mUserBlockSize.

Here is the call graph for this function:

◆ SetBufferDelay()

void VSTEffectInstance::SetBufferDelay ( int samples )

overridevirtual

Reimplemented from VSTEffectWrapper.

Definition at line 2414 of file VSTEffect.cpp.

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

References VSTEffectWrapper::mBufferDelay, and mUseLatency.

Referenced by DoProcessInitialize().

Here is the caller graph for this function:

◆ SetOwningValidator()

void VSTEffectInstance::SetOwningValidator ( VSTEffectUIWrapper * vi )

Definition at line 4053 of file VSTEffect.cpp.

{
   mpOwningValidator = vi;
}

References mpOwningValidator.

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

Here is the caller graph for this function:

◆ SizeWindow()

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

overridevirtual

Reimplemented from VSTEffectUIWrapper.

Definition at line 2316 of file VSTEffect.cpp.

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

References mpOwningValidator, and VSTEffectUIWrapper::SizeWindow().

Here is the call graph for this function:

◆ UsesMessages()

bool VSTEffectInstance::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 1291 of file VSTEffect.cpp.

{
   return true;
}

Member Data Documentation

◆ mBlockSize

size_t VSTEffectInstance::mBlockSize { 8192 }

Definition at line 547 of file VSTEffect.h.

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

◆ mChunkToSetAtIdleTime

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

private

Definition at line 590 of file VSTEffect.h.

Referenced by DeferChunkApplication(), and RealtimeProcessStart().

◆ mDeferredChunkMutex

std::mutex VSTEffectInstance::mDeferredChunkMutex

private

Definition at line 589 of file VSTEffect.h.

Referenced by DeferChunkApplication(), and RealtimeProcessStart().

◆ mHasPower

bool VSTEffectInstance::mHasPower { false }

private

Definition at line 577 of file VSTEffect.h.

Referenced by PowerOff(), and PowerOn().

◆ mIsMeldaPlugin

bool VSTEffectInstance::mIsMeldaPlugin { false }

private

Definition at line 596 of file VSTEffect.h.

Referenced by ChunkMustBeAppliedInMainThread(), and VSTEffectInstance().

◆ mpOwningValidator

VSTEffectUIWrapper* VSTEffectInstance::mpOwningValidator {}

private

Definition at line 585 of file VSTEffect.h.

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

◆ mPresetLoadedWhilePlaying

std::atomic_bool VSTEffectInstance::mPresetLoadedWhilePlaying { false }

private

Definition at line 587 of file VSTEffect.h.

Referenced by OnePresetWasLoadedWhilePlaying(), and RealtimeProcessStart().

◆ mReady

bool VSTEffectInstance::mReady { false }

private

Definition at line 581 of file VSTEffect.h.

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

◆ mRecruited

bool VSTEffectInstance::mRecruited { false }

private

Definition at line 583 of file VSTEffect.h.

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

◆ mSlaves

VSTInstanceArray VSTEffectInstance::mSlaves

private

Definition at line 575 of file VSTEffect.h.

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

◆ mUseLatency

const bool VSTEffectInstance::mUseLatency

Definition at line 545 of file VSTEffect.h.

Referenced by RealtimeAddProcessor(), and SetBufferDelay().

◆ mUserBlockSize

size_t VSTEffectInstance::mUserBlockSize { mBlockSize }

private

Definition at line 579 of file VSTEffect.h.

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

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

◆ VSTEffectInstance()

◆ ~VSTEffectInstance()

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