EffectReverb::Instance Struct Reference

Inheritance diagram for EffectReverb::Instance:

Collaboration diagram for EffectReverb::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	ProcessFinalize (void) noexcept override
bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override
bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *, 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
bool	RealtimeSuspend () override
unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...
unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...
bool	InstanceInit (EffectSettings &settings, double sampleRate, EffectReverbState &data, ChannelNames chanMap, bool forceStereo)
size_t	InstanceProcess (EffectSettings &settings, EffectReverbState &data, const float *const *inBlock, float *const *outBlock, size_t blockLen)
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 EffectInstanceWithBlockSize
	~EffectInstanceWithBlockSize () override
size_t	GetBlockSize () const override
size_t	SetBlockSize (size_t maxBlockSize) override

Public Attributes
EffectReverbState	mState
std::vector< EffectReverb::Instance >	mSlaves
unsigned	mChannels { 2 }
EffectReverbSettings	mLastAppliedSettings
double	mLastSampleRate { 0 }

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 183 of file Reverb.cpp.

Constructor & Destructor Documentation

Instance()

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

inlineexplicit

Definition at line 187 of file Reverb.cpp.

      : PerTrackEffect::Instance{ effect }
   {}

Member Function Documentation

GetAudioInCount()

unsigned EffectReverb::Instance::GetAudioInCount ( ) const

inlineoverridevirtual

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 293 of file Reverb.cpp.

   {
      return mChannels;
   }

References mChannels.

GetAudioOutCount()

unsigned EffectReverb::Instance::GetAudioOutCount ( ) const

inlineoverridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 288 of file Reverb.cpp.

   {
      return mChannels;
   }

References mChannels.

InstanceInit()

bool EffectReverb::Instance::InstanceInit	(	EffectSettings &	settings,
		double	sampleRate,
		EffectReverbState &	data,
		ChannelNames	chanMap,
		bool	forceStereo
	)

Definition at line 374 of file Reverb.cpp.

{
   auto& rs = GetSettings(settings);
 
   bool isStereo = false;
   state.mNumChans = 1;
   if (    (chanMap && chanMap[0] != ChannelNameEOL && chanMap[1] == ChannelNameFrontRight)
        || forceStereo )
   {
      isStereo = true;
      state.mNumChans = 2;
   }
 
   state.mP = std::make_unique<Reverb_priv_ex[]>(state.mNumChans);
 
   for (unsigned int i = 0; i < state.mNumChans; i++)
   {
      reverb_create(&state.mP[i].reverb,
                    sampleRate,
                    rs.mWetGain,
                    rs.mRoomSize,
                    rs.mReverberance,
                    rs.mHfDamping,
                    rs.mPreDelay,
                    rs.mStereoWidth * (isStereo ? 1 : 0),
                    rs.mToneLow,
                    rs.mToneHigh,
                    BLOCK,
                    state.mP[i].wet);
   }
 
   return true;
}

References BLOCK, ChannelNameEOL, ChannelNameFrontRight, EffectWithSettings< EffectReverbSettings, StatelessPerTrackEffect >::GetSettings(), EffectReverbState::mNumChans, EffectReverbState::mP, reverb_create(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Referenced by RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

InstanceProcess()

size_t EffectReverb::Instance::InstanceProcess	(	EffectSettings &	settings,
		EffectReverbState &	data,
		const float *const *	inBlock,
		float *const *	outBlock,
		size_t	blockLen
	)

Definition at line 421 of file Reverb.cpp.

{
   auto& rs = GetSettings(settings);
 
   const float *ichans[2] = {NULL, NULL};
   float *ochans[2] = {NULL, NULL};
 
   for (unsigned int c = 0; c < state.mNumChans; c++)
   {
      ichans[c] = inBlock[c];
      ochans[c] = outBlock[c];
   }
   
   float const dryMult = rs.mWetOnly ? 0 : dB_to_linear(rs.mDryGain);
 
   auto remaining = blockLen;
 
   while (remaining)
   {
      auto len = std::min(remaining, decltype(remaining)(BLOCK));
      for (unsigned int c = 0; c < state.mNumChans; c++)
      {
         // Write the input samples to the reverb fifo.  Returned value is the address of the
         // fifo buffer which contains a copy of the input samples.
         state.mP[c].dry = (float *) fifo_write(&state.mP[c].reverb.input_fifo, len, ichans[c]);
         reverb_process(&state.mP[c].reverb, len);
      }
 
      if (state.mNumChans == 2)
      {
         for (decltype(len) i = 0; i < len; i++)
         {
            for (int w = 0; w < 2; w++)
            {
               ochans[w][i] = dryMult *
                              state.mP[w].dry[i] +
                              0.5 *
                              (state.mP[0].wet[w][i] + state.mP[1].wet[w][i]);
            }
         }
      }
      else
      {
         for (decltype(len) i = 0; i < len; i++)
         {
            ochans[0][i] = dryMult * 
                           state.mP[0].dry[i] +
                           state.mP[0].wet[0][i];
         }
      }
 
      remaining -= len;
 
      for (unsigned int c = 0; c < state.mNumChans; c++)
      {
         ichans[c] += len;
         ochans[c] += len;
      }
   }
 
   return blockLen;
}

References BLOCK, dB_to_linear, fifo_write(), EffectWithSettings< EffectReverbSettings, StatelessPerTrackEffect >::GetSettings(), min(), EffectReverbState::mNumChans, EffectReverbState::mP, reverb_process(), and settings().

Referenced by RealtimeProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessBlock()

size_t EffectReverb::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 415 of file Reverb.cpp.

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

References mState, and settings().

Here is the call graph for this function:

ProcessFinalize()

bool EffectReverb::Instance::ProcessFinalize ( void  )

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 410 of file Reverb.cpp.

{
   return true;
}

ProcessInitialize()

bool EffectReverb::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 362 of file Reverb.cpp.

{
   // For descructive processing, fix the number of channels, maybe as 1 not 2
   auto& rs = GetSettings(settings);
   mChannels = rs.mStereoWidth ? 2 : 1;
 
   return InstanceInit(settings,
      sampleRate, mState, chanMap, /* forceStereo = */ false);
}

References EffectWithSettings< EffectReverbSettings, StatelessPerTrackEffect >::GetSettings(), mState, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

RealtimeAddProcessor()

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

inlineoverridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 212 of file Reverb.cpp.

   {
      EffectReverb::Instance slave(mProcessor);
 
      // The notion of ChannelNames is unavailable here,
      // so we'll have to force the stereo init, if this is the case
      //
      InstanceInit(settings, sampleRate,
         slave.mState, /*ChannelNames=*/nullptr, /*forceStereo=*/(numChannels == 2));
 
      mSlaves.push_back( std::move(slave) );
      return true;
   }

References InstanceInit(), PerTrackEffect::Instance::mProcessor, mSlaves, mState, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

RealtimeFinalize()

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

inlineoverridevirtualnoexcept

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 227 of file Reverb.cpp.

   {
      mSlaves.clear();
      return true;
   }

References mSlaves.

RealtimeInitialize()

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

inlineoverridevirtual

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 201 of file Reverb.cpp.

   {
      SetBlockSize(512);
      mSlaves.clear();
 
      mLastAppliedSettings = GetSettings(settings);
      mLastSampleRate = sampleRate;
 
      return true;
   }

References EffectWithSettings< EffectReverbSettings, StatelessPerTrackEffect >::GetSettings(), mLastAppliedSettings, mLastSampleRate, mSlaves, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, EffectInstanceWithBlockSize::SetBlockSize(), and settings().

Here is the call graph for this function:

RealtimeProcess()

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

inlineoverridevirtual

Returns

success Default implementation does nothing, returns 0

Reimplemented from EffectInstance.

Definition at line 233 of file Reverb.cpp.

   {
 
      const auto& incomingSettings = GetSettings(settings);
      if ( !(incomingSettings == mLastAppliedSettings) )
      {
         const bool onlySimpleOnes = OnlySimpleParametersChanged(incomingSettings, mLastAppliedSettings);
 
         for (auto& slave : mSlaves)
         {
            for (unsigned int i = 0; i < slave.mState.mNumChans; i++)
            {
               auto& reverbCore = slave.mState.mP[i].reverb;
               const auto& is = incomingSettings;
 
               if (onlySimpleOnes)
               {
                  reverb_set_simple_params(&reverbCore, mLastSampleRate,
                                           is.mWetGain, is.mReverberance, is.mHfDamping, is.mToneLow, is.mToneHigh);
               }
               else
               {
                  // One of the non-simple parameters changed, so we need to do a full reinit
                  reverb_init(&reverbCore, mLastSampleRate,
                              is.mWetGain, is.mRoomSize, is.mReverberance, is.mHfDamping,
                              is.mPreDelay, is.mStereoWidth, is.mToneLow, is.mToneHigh   );
               }
            }
         }         
 
         mLastAppliedSettings = incomingSettings;
      }
 
 
      if (group >= mSlaves.size())
         return 0;
      return InstanceProcess(settings, mSlaves[group].mState, inbuf, outbuf, numSamples);
   }

References EffectWithSettings< EffectReverbSettings, StatelessPerTrackEffect >::GetSettings(), InstanceProcess(), mLastAppliedSettings, mLastSampleRate, mSlaves, mState, OnlySimpleParametersChanged(), reverb_init(), reverb_set_simple_params(), and settings().

Here is the call graph for this function:

RealtimeSuspend()

bool EffectReverb::Instance::RealtimeSuspend ( )

inlineoverridevirtual

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 274 of file Reverb.cpp.

   {
      for (auto& slave : mSlaves)
      {
         for (unsigned int i = 0; i < slave.mState.mNumChans; i++)
         {
            reverb_clear( &(slave.mState.mP[i].reverb) );
         }
      }
 
      return true;
   }

References mSlaves, and reverb_clear().

Here is the call graph for this function:

Member Data Documentation

mChannels

unsigned EffectReverb::Instance::mChannels { 2 }

Definition at line 307 of file Reverb.cpp.

Referenced by GetAudioInCount(), and GetAudioOutCount().

mLastAppliedSettings

EffectReverbSettings EffectReverb::Instance::mLastAppliedSettings

Definition at line 309 of file Reverb.cpp.

Referenced by RealtimeInitialize(), and RealtimeProcess().

mLastSampleRate

double EffectReverb::Instance::mLastSampleRate { 0 }

Definition at line 310 of file Reverb.cpp.

Referenced by RealtimeInitialize(), and RealtimeProcess().

mSlaves

std::vector<EffectReverb::Instance> EffectReverb::Instance::mSlaves

Definition at line 305 of file Reverb.cpp.

Referenced by RealtimeAddProcessor(), RealtimeFinalize(), RealtimeInitialize(), RealtimeProcess(), and RealtimeSuspend().

mState

EffectReverbState EffectReverb::Instance::mState

Definition at line 304 of file Reverb.cpp.

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

---

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

• Reverb.cpp