StatefulEffectBase::Instance Class Reference

Calls through to members of StatefulEffectBase. More...

#include <StatefulEffectBase.h>

Inheritance diagram for StatefulEffectBase::Instance:

Collaboration diagram for StatefulEffectBase::Instance:

Public Member Functions
	Instance (StatefulEffectBase &effect)
	~Instance () override
bool	Init () override
	Call once to set up state for whole list of tracks to be processed. More...
size_t	GetBlockSize () const override
size_t	SetBlockSize (size_t maxBlockSize) override
bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override
bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate) override
bool	RealtimeSuspend () override
bool	RealtimeResume () override
bool	RealtimeProcessStart (MessagePackage &package) override
	settings are possibly changed, since last call, by an asynchronous dialog More...
size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples) override
bool	RealtimeProcessEnd (EffectSettings &settings) noexcept override
	settings can be updated to let a dialog change appearance at idle More...
bool	RealtimeFinalize (EffectSettings &settings) noexcept override
unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...
unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...
bool	NeedsDither () const override
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...

Protected Member Functions
StatefulEffectBase &	GetEffect () const

Protected Attributes
StatefulEffectBase &	mEffect

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

Detailed Description

Calls through to members of StatefulEffectBase.

Definition at line 26 of file StatefulEffectBase.h.

Constructor & Destructor Documentation

Instance()

StatefulEffectBase::Instance::Instance ( StatefulEffectBase &  effect )

explicit

Definition at line 17 of file StatefulEffectBase.cpp.

   : mEffect{ effect }
{
}

~Instance()

StatefulEffectBase::Instance::~Instance ( )

overridedefault

Member Function Documentation

GetAudioInCount()

unsigned StatefulEffectBase::Instance::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 87 of file StatefulEffectBase.cpp.

{
   return GetEffect().GetAudioInCount();
}

GetAudioOutCount()

unsigned StatefulEffectBase::Instance::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 92 of file StatefulEffectBase.cpp.

{
   return GetEffect().GetAudioOutCount();
}

GetBlockSize()

size_t StatefulEffectBase::Instance::GetBlockSize ( ) const

overridevirtual

Implements EffectInstance.

Definition at line 77 of file StatefulEffectBase.cpp.

{
   return GetEffect().GetBlockSize();
}

GetEffect()

StatefulEffectBase & StatefulEffectBase::Instance::GetEffect ( ) const

inlineprotected

Definition at line 62 of file StatefulEffectBase.h.

{ return mEffect; }

Referenced by StatefulEffect::Instance::Process().

Here is the caller graph for this function:

Init()

bool StatefulEffectBase::Instance::Init ( )

overridevirtual

Call once to set up state for whole list of tracks to be processed.

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstanceEx.

Definition at line 24 of file StatefulEffectBase.cpp.

{
   return GetEffect().Init();
}

NeedsDither()

bool StatefulEffectBase::Instance::NeedsDither ( ) const

overridevirtual

If true (default result), then results require dither if later rendered to a narrower sample format

Reimplemented from EffectInstance.

Definition at line 97 of file StatefulEffectBase.cpp.

{
   return GetEffect().NeedsDither();
}

ProcessFinalize()

bool StatefulEffectBase::Instance::ProcessFinalize ( )

overridevirtualnoexcept

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Implements EffectInstance.

Reimplemented in StatefulPerTrackEffect::Instance.

Definition at line 109 of file StatefulEffectBase.cpp.

{
   return GetEffect().ProcessFinalize();
}

ProcessInitialize()

bool StatefulEffectBase::Instance::ProcessInitialize ( EffectSettings &  settings, double  sampleRate, ChannelNames  chanMap  )

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters

chanMap

null or array terminated with ChannelNameEOL. Do not retain the pointer

Postcondition

GetAudioInCount() and GetAudioOutCount() are well defined

Implements EffectInstance.

Reimplemented in StatefulPerTrackEffect::Instance.

Definition at line 102 of file StatefulEffectBase.cpp.

{
   return GetEffect()
      .ProcessInitialize(settings, sampleRate, chanMap);
}

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

Here is the call graph for this function:

RealtimeAddProcessor()

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

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 35 of file StatefulEffectBase.cpp.

{
   return GetEffect()
      .RealtimeAddProcessor(settings, pOutputs, numChannels, sampleRate);
}

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

Here is the call graph for this function:

RealtimeFinalize()

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

overridevirtualnoexcept

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 72 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeFinalize(settings);
}

References settings().

Here is the call graph for this function:

RealtimeInitialize()

bool StatefulEffectBase::Instance::RealtimeInitialize ( EffectSettings &  settings, double  sampleRate  )

overridevirtual

Returns

success

Postcondition

GetAudioInCount() and GetAudioOutCount() are well defined

Default implementation does nothing, returns false (so assume realtime is not supported). Other member functions related to realtime return true or zero, but will not be called, unless a derived class overrides RealtimeInitialize.

Reimplemented from EffectInstance.

Definition at line 29 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeInitialize(settings, sampleRate);
}

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

Here is the call graph for this function:

RealtimeProcess()

size_t StatefulEffectBase::Instance::RealtimeProcess ( size_t  group, EffectSettings &  settings, const float *const *  inBuf, float *const *  outBuf, size_t  numSamples  )

overridevirtual

Returns

success Default implementation does nothing, returns 0

Reimplemented from EffectInstance.

Definition at line 59 of file StatefulEffectBase.cpp.

{
   return GetEffect()
      .RealtimeProcess(group, settings, inBuf, outBuf, numSamples);
}

References settings().

Here is the call graph for this function:

RealtimeProcessEnd()

bool StatefulEffectBase::Instance::RealtimeProcessEnd ( EffectSettings &  settings )

overridevirtualnoexcept

settings can be updated to let a dialog change appearance at idle

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 67 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeProcessEnd(settings);
}

References settings().

Here is the call graph for this function:

RealtimeProcessStart()

bool StatefulEffectBase::Instance::RealtimeProcessStart ( MessagePackage &  package )

overridevirtual

settings are possibly changed, since last call, by an asynchronous dialog

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 53 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeProcessStart(package);
}

RealtimeResume()

bool StatefulEffectBase::Instance::RealtimeResume ( )

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 48 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeResume();
}

RealtimeSuspend()

bool StatefulEffectBase::Instance::RealtimeSuspend ( )

overridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 43 of file StatefulEffectBase.cpp.

{
   return GetEffect().RealtimeSuspend();
}

SetBlockSize()

size_t StatefulEffectBase::Instance::SetBlockSize ( size_t  maxBlockSize )

overridevirtual

Implements EffectInstance.

Definition at line 82 of file StatefulEffectBase.cpp.

{
   return GetEffect().SetBlockSize(maxBlockSize);
}

References anonymous_namespace{StaffPadTimeAndPitch.cpp}::maxBlockSize.

Member Data Documentation

mEffect

StatefulEffectBase& StatefulEffectBase::Instance::mEffect

protected

Definition at line 61 of file StatefulEffectBase.h.

---

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

• StatefulEffectBase.h
• StatefulEffectBase.cpp