#include <PhaserBase.h>

Inheritance diagram for PhaserBase::Instance:

Collaboration diagram for PhaserBase::Instance:

Public Member Functions
	Instance (const PerTrackEffect &effect)

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

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

bool	RealtimeInitialize (EffectSettings &settings, double) override

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

bool	RealtimeFinalize (EffectSettings &settings) noexcept override

size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inbuf, float const outbuf, size_t numSamples) 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...

void	InstanceInit (EffectSettings &settings, EffectPhaserState &data, float sampleRate)

size_t	InstanceProcess (EffectSettings &settings, EffectPhaserState &data, const float const inBlock, float const outBlock, size_t blockLen)

void	Coefficients (double hz, double slope, double gain, double samplerate, int type, double &a0, double &a1, double &a2, double &b0, double &b1, double &b2)

float	DoFilter (EffectPhaserState &data, float in)

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 EffectInstanceWithBlockSize
	~EffectInstanceWithBlockSize () override

size_t	GetBlockSize () const override

size_t	SetBlockSize (size_t maxBlockSize) override

Public Attributes
EffectPhaserState	mState

std::vector< PhaserBase::Instance >	mSlaves

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

using	SampleCount = uint64_t

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

Protected Attributes inherited from EffectInstanceWithBlockSize
size_t	mBlockSize { 0 }

Detailed Description

Definition at line 92 of file PhaserBase.h.

Constructor & Destructor Documentation

◆ Instance()

PhaserBase::Instance::Instance ( const PerTrackEffect & effect )

inlineexplicit

Definition at line 96 of file PhaserBase.h.

          : PerTrackEffect::Instance { effect }
      {
      }

Member Function Documentation

◆ Coefficients()

void PhaserBase::Instance::Coefficients	(	double	hz,
		double	slope,
		double	gain,
		double	samplerate,
		int	type,
		double &	a0,
		double &	a1,
		double &	a2,
		double &	b0,
		double &	b1,
		double &	b2
	)

◆ DoFilter()

float PhaserBase::Instance::DoFilter	(	EffectPhaserState &	data,
		float	in
	)

◆ GetAudioInCount()

unsigned PhaserBase::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 89 of file PhaserBase.cpp.

{
   return 1;
}

◆ GetAudioOutCount()

unsigned PhaserBase::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 94 of file PhaserBase.cpp.

{
   return 1;
}

◆ InstanceInit()

void PhaserBase::Instance::InstanceInit	(	EffectSettings &	settings,
		EffectPhaserState &	data,
		float	sampleRate
	)

Definition at line 153 of file PhaserBase.cpp.

{
   auto& ms = GetSettings(settings);
 
   data.samplerate = sampleRate;
 
   for (int j = 0; j < ms.mStages; j++)
   {
      data.old[j] = 0;
   }
 
   data.skipcount = 0;
   data.gain = 0;
   data.fbout = 0;
   data.laststages = 0;
   data.outgain = 0;
 
   return;
}

References EffectPhaserState::fbout, EffectPhaserState::gain, EffectWithSettings< EffectPhaserSettings, PerTrackEffect >::GetSettings(), EffectPhaserState::laststages, EffectPhaserState::old, EffectPhaserState::outgain, EffectPhaserState::samplerate, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, settings(), and EffectPhaserState::skipcount.

Here is the call graph for this function:

◆ InstanceProcess()

size_t PhaserBase::Instance::InstanceProcess	(	EffectSettings &	settings,
		EffectPhaserState &	data,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

Definition at line 174 of file PhaserBase.cpp.

{
   auto& ms = GetSettings(settings);
 
   const float* ibuf = inBlock[0];
   float* obuf = outBlock[0];
 
   for (int j = data.laststages; j < ms.mStages; j++)
   {
      data.old[j] = 0;
   }
   data.laststages = ms.mStages;
 
   data.lfoskip = ms.mFreq * 2 * M_PI / data.samplerate;
   data.phase = ms.mPhase * M_PI / 180;
   data.outgain = DB_TO_LINEAR(ms.mOutGain);
 
   for (decltype(blockLen) i = 0; i < blockLen; i++)
   {
      double in = ibuf[i];
 
      double m =
         in + data.fbout * ms.mFeedback /
                 101; // Feedback must be less than 100% to avoid infinite gain.
 
      if (((data.skipcount++) % lfoskipsamples) == 0)
      {
         // compute sine between 0 and 1
         data.gain =
            (1.0 +
             cos(data.skipcount.as_double() * data.lfoskip + data.phase)) /
            2.0;
 
         // change lfo shape
         data.gain = expm1(data.gain * phaserlfoshape) / expm1(phaserlfoshape);
 
         // attenuate the lfo
         data.gain = 1.0 - data.gain / 255.0 * ms.mDepth;
      }
 
      // phasing routine
      for (int j = 0; j < ms.mStages; j++)
      {
         double tmp = data.old[j];
         data.old[j] = data.gain * tmp + m;
         m = tmp - data.gain * data.old[j];
      }
      data.fbout = m;
 
      obuf[i] =
         (float)(data.outgain * (m * ms.mDryWet + in * (255 - ms.mDryWet)) / 255);
   }
 
   return blockLen;
}

References sampleCount::as_double(), DB_TO_LINEAR, EffectPhaserState::fbout, EffectPhaserState::gain, EffectWithSettings< EffectPhaserSettings, PerTrackEffect >::GetSettings(), EffectPhaserState::laststages, EffectPhaserState::lfoskip, lfoskipsamples, M_PI, EffectPhaserState::old, EffectPhaserState::outgain, EffectPhaserState::phase, phaserlfoshape, EffectPhaserState::samplerate, settings(), and EffectPhaserState::skipcount.

Here is the call graph for this function:

◆ ProcessBlock()

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

overridevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 108 of file PhaserBase.cpp.

{
   return InstanceProcess(settings, mState, inBlock, outBlock, blockLen);
}

References mState, and settings().

Here is the call graph for this function:

◆ ProcessInitialize()

bool PhaserBase::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.

Definition at line 99 of file PhaserBase.cpp.

{
   InstanceInit(settings, mState, sampleRate);
   if (chanMap[0] == ChannelNameFrontRight)
      mState.phase += M_PI;
   return true;
}

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

Here is the call graph for this function:

◆ RealtimeAddProcessor()

bool PhaserBase::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 122 of file PhaserBase.cpp.

{
   PhaserBase::Instance slave(mProcessor);
 
   InstanceInit(settings, slave.mState, sampleRate);
 
   mSlaves.push_back(slave);
 
   return true;
}

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

Here is the call graph for this function:

◆ RealtimeFinalize()

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

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 134 of file PhaserBase.cpp.

{
   mSlaves.clear();
 
   return true;
}

◆ RealtimeInitialize()

bool PhaserBase::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 115 of file PhaserBase.cpp.

{
   SetBlockSize(512);
   mSlaves.clear();
   return true;
}

◆ RealtimeProcess()

size_t PhaserBase::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 141 of file PhaserBase.cpp.

{
   if (group >= mSlaves.size())
      return 0;
   return InstanceProcess(
      settings, mSlaves[group].mState, inbuf, outbuf, numSamples);
}

References mState, and settings().

Here is the call graph for this function:

Member Data Documentation

◆ mSlaves

std::vector<PhaserBase::Instance> PhaserBase::Instance::mSlaves

Definition at line 139 of file PhaserBase.h.

◆ mState

EffectPhaserState PhaserBase::Instance::mState

Definition at line 138 of file PhaserBase.h.

Referenced by RealtimeAddProcessor().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Instance()

Member Function Documentation

◆ Coefficients()

◆ DoFilter()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ InstanceInit()

◆ InstanceProcess()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

Member Data Documentation

◆ mSlaves

◆ mState