Temporary state of the computation. More...

#include <DtmfBase.h>

Inheritance diagram for DtmfBase::Instance:

Collaboration diagram for DtmfBase::Instance:

Public Member Functions
	Instance (const PerTrackEffect &effect, double t0)

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...

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...

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
const double	mT0

double	mSampleRate {}

sampleCount	numSamplesSequence

sampleCount	numSamplesTone

sampleCount	numSamplesSilence

sampleCount	diff

sampleCount	numRemaining

sampleCount	curTonePos

bool	isTone

int	curSeqPos

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

Temporary state of the computation.

Definition at line 54 of file DtmfBase.h.

Constructor & Destructor Documentation

◆ Instance()

DtmfBase::Instance::Instance	(	const PerTrackEffect &	effect,
		double	t0
	)

inline

Definition at line 56 of file DtmfBase.h.

          : PerTrackEffect::Instance { effect }
          , mT0 { t0 }
      {
      }

Member Function Documentation

◆ GetAudioInCount()

unsigned DtmfBase::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 69 of file DtmfBase.h.

      {
         return 0;
      }

◆ GetAudioOutCount()

unsigned DtmfBase::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 74 of file DtmfBase.h.

      {
         return 1;
      }

◆ ProcessBlock()

size_t DtmfBase::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 146 of file DtmfBase.cpp.

{
   auto& dtmfSettings = GetSettings(settings);
   float* buffer = outbuf[0];
   decltype(size) processed = 0;
 
   // for the whole dtmf sequence, we will be generating either tone or silence
   // according to a bool value, and this might be done in small chunks of size
   // 'block', as a single tone might sometimes be larger than the block
   // tone and silence generally have different duration, thus two generation
   // blocks
   //
   // Note: to overcome a 'clicking' noise introduced by the abrupt transition
   // from/to silence, I added a fade in/out of 1/250th of a second (4ms). This
   // can still be tweaked but gives excellent results at 44.1kHz: I haven't
   // tried other freqs. A problem might be if the tone duration is very short
   // (<10ms)... (?)
   //
   // One more problem is to deal with the approximations done when calculating
   // the duration of both tone and silence: in some cases the final sum might
   // not be same as the initial duration. So, to overcome this, we had a
   // redistribution block up, and now we will spread the remaining samples in
   // every bin in order to achieve the full duration: test case was to generate
   // an 11 tone DTMF sequence, in 4 seconds, and with DutyCycle=75%: after
   // generation you ended up with 3.999s or in other units: 3 seconds and 44097
   // samples.
   //
   while (size)
   {
      if (numRemaining == 0)
      {
         isTone = !isTone;
 
         if (isTone)
         {
            curSeqPos++;
            numRemaining = numSamplesTone;
            curTonePos = 0;
         }
         else
         {
            numRemaining = numSamplesSilence;
         }
 
         // the statement takes care of extracting one sample from the diff bin
         // and adding it into the current block until depletion
         numRemaining += (diff-- > 0 ? 1 : 0);
      }
 
      const auto len = limitSampleBufferSize(size, numRemaining);
 
      if (isTone)
      {
         // generate the tone and append
         assert(curSeqPos < dtmfSettings.dtmfNTones);
         MakeDtmfTone(
            buffer, len, mSampleRate, dtmfSettings.dtmfSequence[curSeqPos],
            curTonePos, numSamplesTone, dtmfSettings.dtmfAmplitude);
         curTonePos += len;
      }
      else
      {
         memset(buffer, 0, sizeof(float) * len);
      }
 
      numRemaining -= len;
 
      buffer += len;
      size -= len;
      processed += len;
   }
 
   return processed;
}

References EffectWithSettings< DtmfSettings, PerTrackEffect >::GetSettings(), limitSampleBufferSize(), DtmfBase::MakeDtmfTone(), settings(), and size.

Here is the call graph for this function:

◆ ProcessInitialize()

bool DtmfBase::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 79 of file DtmfBase.cpp.

{
   mSampleRate = sampleRate;
 
   auto& dtmfSettings = GetSettings(settings);
   if (dtmfSettings.dtmfNTones == 0)
   { // Bail if no DTFM sequence.
      using namespace BasicUI;
      // TODO:  don't use mProcessor for this
      ShowMessageBox(
         XO("DTMF sequence empty.\nCheck ALL settings for this effect."),
         MessageBoxOptions {}.IconStyle(Icon::Error));
      return false;
   }
 
   double duration = settings.extra.GetDuration();
 
   // all dtmf sequence durations in samples from seconds
   // MJS: Note that mDuration is in seconds but will have been quantised to the
   // units of the TTC. If this was 'samples' and the project rate was lower
   // than the track rate, extra samples may get created as mDuration may now be
   // > mT1 - mT0; However we are making our best efforts at creating what was
   // asked for.
 
   auto nT0 = (sampleCount)floor(mT0 * mSampleRate + 0.5);
   auto nT1 = (sampleCount)floor((mT0 + duration) * mSampleRate + 0.5);
   numSamplesSequence =
      nT1 - nT0; // needs to be exact number of samples selected
 
   // make under-estimates if anything, and then redistribute the few remaining
   // samples
   numSamplesTone = sampleCount(floor(dtmfSettings.dtmfTone * mSampleRate));
   numSamplesSilence =
      sampleCount(floor(dtmfSettings.dtmfSilence * mSampleRate));
 
   // recalculate the sum, and spread the difference - due to approximations.
   // Since diff should be in the order of "some" samples, a division (resulting
   // in zero) is not sufficient, so we add the additional remaining samples in
   // each tone/silence block, at least until available.
   diff = numSamplesSequence - (dtmfSettings.dtmfNTones * numSamplesTone) -
          (dtmfSettings.dtmfNTones - 1) * numSamplesSilence;
   while (diff > 2 * dtmfSettings.dtmfNTones - 1)
   { // more than one per thingToBeGenerated
      // in this case, both numSamplesTone and numSamplesSilence would change,
      // so it makes sense
      //  to recalculate diff here, otherwise just keep the value we already
      //  have
 
      // should always be the case that dtmfNTones>1, as if 0, we don't even
      // start processing, and with 1 there is no difference to spread (no
      // silence slot)...
      wxASSERT(dtmfSettings.dtmfNTones > 1);
      numSamplesTone += (diff / (dtmfSettings.dtmfNTones));
      numSamplesSilence += (diff / (dtmfSettings.dtmfNTones - 1));
      diff = numSamplesSequence - (dtmfSettings.dtmfNTones * numSamplesTone) -
             (dtmfSettings.dtmfNTones - 1) * numSamplesSilence;
   }
   wxASSERT(diff >= 0); // should never be negative
 
   curSeqPos = -1; // pointer to string in dtmfSequence
   isTone = false;
   numRemaining = 0;
 
   return true;
}