DistortionBase::Instance Struct Reference

#include <DistortionBase.h>

Inheritance diagram for DistortionBase::Instance:

Collaboration diagram for DistortionBase::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
void	InstanceInit (EffectDistortionState &data, EffectSettings &settings, float sampleRate)
size_t	InstanceProcess (EffectSettings &settings, EffectDistortionState &data, const float *const *inBlock, float *const *outBlock, size_t blockLen)
void	MakeTable (EffectDistortionState &state, const EffectDistortionSettings &ms)
void	HardClip (EffectDistortionState &, const EffectDistortionSettings &)
void	SoftClip (EffectDistortionState &, const EffectDistortionSettings &)
void	ExponentialTable (const EffectDistortionSettings &)
void	LogarithmicTable (const EffectDistortionSettings &)
void	HalfSinTable (const EffectDistortionSettings &)
void	CubicTable (const EffectDistortionSettings &)
void	EvenHarmonicTable (const EffectDistortionSettings &)
void	SineTable (const EffectDistortionSettings &)
void	Leveller (const EffectDistortionSettings &)
void	Rectifier (const EffectDistortionSettings &)
void	HardLimiter (EffectDistortionState &state, const EffectDistortionSettings &)
void	CopyHalfTable ()
float	LogCurve (double threshold, float value, double ratio)
double	Cubic (const EffectDistortionSettings &, double x)
float	WaveShaper (float sample, EffectDistortionSettings &ms)
float	DCFilter (EffectDistortionState &data, float sample)
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
double	mTable [TABLESIZE]
EffectDistortionState	mMaster
std::vector< EffectDistortionState >	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 DistortionBase.h.

Constructor & Destructor Documentation

Instance()

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

inlineexplicit

Definition at line 96 of file DistortionBase.h.

          : PerTrackEffect::Instance { effect }
      {
      }

Member Function Documentation

CopyHalfTable()

void DistortionBase::Instance::CopyHalfTable

(

)

Definition at line 669 of file DistortionBase.cpp.

{
   // Copy negative half of table from positive half
   int count = TABLESIZE - 1;
   for (int n = 0; n < STEPS; n++)
   {
      mTable[n] = -mTable[count];
      count--;
   }
}

References STEPS, and TABLESIZE.

Cubic()

double DistortionBase::Instance::Cubic ( const EffectDistortionSettings &  ms, double  x  )

inline

Definition at line 519 of file DistortionBase.cpp.

{
   if (ms.mParam1 == 0.0)
      return x;
 
   return x - (std::pow(x, 3.0) / 3.0);
}

References EffectDistortionSettings::mParam1.

CubicTable()

void DistortionBase::Instance::CubicTable

(

const EffectDistortionSettings &

ms

)

Definition at line 487 of file DistortionBase.cpp.

{
   double amount = ms.mParam1 * std::sqrt(3.0) / 100.0;
   double gain = 1.0;
   if (amount != 0.0)
      gain = 1.0 / Cubic(ms, std::min(amount, 1.0));
 
   double stepsize = amount / STEPS;
   double x = -amount;
 
   if (amount == 0)
   {
      for (int i = 0; i < TABLESIZE; i++)
      {
         mTable[i] = (i / (double)STEPS) - 1.0;
      }
   }
   else
   {
      for (int i = 0; i < TABLESIZE; i++)
      {
         mTable[i] = gain * Cubic(ms, x);
         for (int j = 0; j < ms.mRepeats; j++)
         {
            mTable[i] = gain * Cubic(ms, mTable[i] * amount);
         }
         x += stepsize;
      }
   }
}

References min(), EffectDistortionSettings::mParam1, EffectDistortionSettings::mRepeats, staffpad::audio::simd::sqrt(), STEPS, and TABLESIZE.

Here is the call graph for this function:

DCFilter()

float DistortionBase::Instance::DCFilter	(	EffectDistortionState &	data,
		float	sample
	)

Definition at line 711 of file DistortionBase.cpp.

{
   // Rolling average gives less offset at the start than an IIR filter.
   const unsigned int queueLength = std::floor(data.samplerate / 20.0);
 
   data.queuetotal += sample;
   data.queuesamples.push(sample);
 
   if (data.queuesamples.size() > queueLength)
   {
      data.queuetotal -= data.queuesamples.front();
      data.queuesamples.pop();
   }
 
   return sample - (data.queuetotal / data.queuesamples.size());
}

References EffectDistortionState::queuesamples, EffectDistortionState::queuetotal, and EffectDistortionState::samplerate.

EvenHarmonicTable()

void DistortionBase::Instance::EvenHarmonicTable

(

const EffectDistortionSettings &

ms

)

Definition at line 527 of file DistortionBase.cpp.

{
   double amount = ms.mParam1 / -100.0;
   // double C = std::sin(std::max(0.001, mParams.mParam2) / 100.0) * 10.0;
   double C = std::max(0.001, ms.mParam2) / 10.0;
 
   double step = 1.0 / STEPS;
   double xval = -1.0;
 
   for (int i = 0; i < TABLESIZE; i++)
   {
      mTable[i] = ((1 + amount) * xval) -
                  (xval * (amount / std::tanh(C)) * std::tanh(C * xval));
      xval += step;
   }
}

References anonymous_namespace{DynamicRangeProcessorEditor.cpp}::C, EffectDistortionSettings::mParam1, EffectDistortionSettings::mParam2, STEPS, and TABLESIZE.

ExponentialTable()

void DistortionBase::Instance::ExponentialTable

(

const EffectDistortionSettings &

ms

)

Definition at line 424 of file DistortionBase.cpp.

{
   double amount =
      std::min(0.999, DB_TO_LINEAR(-1 * ms.mParam1)); // avoid divide by zero
 
   for (int n = STEPS; n < TABLESIZE; n++)
   {
      double linVal = n / (float)STEPS;
      double scale = -1.0 / (1.0 - amount); // unity gain at 0dB
      double curve = std::exp((linVal - 1) * std::log(amount));
      mTable[n] = scale * (curve - 1);
   }
   CopyHalfTable();
}

References DB_TO_LINEAR, min(), EffectDistortionSettings::mParam1, STEPS, and TABLESIZE.

Here is the call graph for this function:

GetAudioInCount()

unsigned DistortionBase::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 127 of file DistortionBase.cpp.

{
   return 1;
}

GetAudioOutCount()

unsigned DistortionBase::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 132 of file DistortionBase.cpp.

{
   return 1;
}

HalfSinTable()

void DistortionBase::Instance::HalfSinTable

(

const EffectDistortionSettings &

ms

)

Definition at line 466 of file DistortionBase.cpp.

{
   int iter = std::floor(ms.mParam1 / 20.0);
   double fractionalpart = (ms.mParam1 / 20.0) - iter;
   double stepsize = 1.0 / STEPS;
   double linVal = 0;
 
   for (int n = STEPS; n < TABLESIZE; n++)
   {
      mTable[n] = linVal;
      for (int i = 0; i < iter; i++)
      {
         mTable[n] = std::sin(mTable[n] * M_PI_2);
      }
      mTable[n] +=
         ((std::sin(mTable[n] * M_PI_2) - mTable[n]) * fractionalpart);
      linVal += stepsize;
   }
   CopyHalfTable();
}

References M_PI_2, EffectDistortionSettings::mParam1, STEPS, and TABLESIZE.

HardClip()

void DistortionBase::Instance::HardClip	(	EffectDistortionState &	state,
		const EffectDistortionSettings &	ms
	)

Definition at line 375 of file DistortionBase.cpp.

{
   const double threshold = DB_TO_LINEAR(ms.mThreshold_dB);
 
   double lowThresh = 1 - threshold;
   double highThresh = 1 + threshold;
 
   for (int n = 0; n < TABLESIZE; n++)
   {
      if (n < (STEPS * lowThresh))
         mTable[n] = -threshold;
      else if (n > (STEPS * highThresh))
         mTable[n] = threshold;
      else
         mTable[n] = n / (double)STEPS - 1;
 
      state.mMakeupGain = 1.0 / threshold;
   }
}

References DB_TO_LINEAR, EffectDistortionState::mMakeupGain, EffectDistortionSettings::mThreshold_dB, STEPS, and TABLESIZE.

HardLimiter()

void DistortionBase::Instance::HardLimiter	(	EffectDistortionState &	state,
		const EffectDistortionSettings &	settings
	)

Definition at line 658 of file DistortionBase.cpp.

{
   // The LADSPA "hardLimiter 1413" is basically hard clipping,
   // but with a 'kind of' wet/dry mix:
   // out = ((wet-residual)*clipped) + (residual*in)
   HardClip(state, settings);
}

References settings().

Here is the call graph for this function:

InstanceInit()

void DistortionBase::Instance::InstanceInit	(	EffectDistortionState &	data,
		EffectSettings &	settings,
		float	sampleRate
	)

Definition at line 218 of file DistortionBase.cpp.

{
   auto& ms = GetSettings(settings);
 
   data.samplerate = sampleRate;
   data.skipcount = 0;
   data.tablechoiceindx = ms.mTableChoiceIndx;
   data.dcblock = ms.mDCBlock;
   data.threshold = ms.mThreshold_dB;
   data.noisefloor = ms.mNoiseFloor;
   data.param1 = ms.mParam1;
   data.param2 = ms.mParam2;
   data.repeats = ms.mRepeats;
 
   // DC block filter variables
   data.queuetotal = 0.0;
 
   // std::queue<float>().swap(data.queuesamples);
   while (!data.queuesamples.empty())
      data.queuesamples.pop();
 
   MakeTable(data, ms);
 
   return;
}

References EffectDistortionState::dcblock, EffectWithSettings< EffectDistortionSettings, PerTrackEffect >::GetSettings(), EffectDistortionState::noisefloor, EffectDistortionState::param1, EffectDistortionState::param2, EffectDistortionState::queuesamples, EffectDistortionState::queuetotal, EffectDistortionState::repeats, EffectDistortionState::samplerate, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, settings(), EffectDistortionState::skipcount, EffectDistortionState::tablechoiceindx, and EffectDistortionState::threshold.

Here is the call graph for this function:

InstanceProcess()

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

Definition at line 245 of file DistortionBase.cpp.

{
   auto& ms = GetSettings(settings);
 
   const float* ibuf = inBlock[0];
   float* obuf = outBlock[0];
 
   bool update =
      (ms.mTableChoiceIndx == data.tablechoiceindx &&
       ms.mNoiseFloor == data.noisefloor &&
       ms.mThreshold_dB == data.threshold && ms.mParam1 == data.param1 &&
       ms.mParam2 == data.param2 && ms.mRepeats == data.repeats) ?
         false :
         true;
 
   double p1 = ms.mParam1 / 100.0;
   double p2 = ms.mParam2 / 100.0;
 
   data.tablechoiceindx = ms.mTableChoiceIndx;
   data.threshold = ms.mThreshold_dB;
   data.noisefloor = ms.mNoiseFloor;
   data.param1 = ms.mParam1;
   data.repeats = ms.mRepeats;
 
   for (decltype(blockLen) i = 0; i < blockLen; i++)
   {
      if (update && ((data.skipcount++) % skipsamples == 0))
      {
         MakeTable(data, ms);
      }
 
      switch (ms.mTableChoiceIndx)
      {
      case kHardClip:
         // Param2 = make-up gain.
         obuf[i] =
            WaveShaper(ibuf[i], ms) * ((1 - p2) + (data.mMakeupGain * p2));
         break;
      case kSoftClip:
         // Param2 = make-up gain.
         obuf[i] =
            WaveShaper(ibuf[i], ms) * ((1 - p2) + (data.mMakeupGain * p2));
         break;
      case kHalfSinCurve:
         obuf[i] = WaveShaper(ibuf[i], ms) * p2;
         break;
      case kExpCurve:
         obuf[i] = WaveShaper(ibuf[i], ms) * p2;
         break;
      case kLogCurve:
         obuf[i] = WaveShaper(ibuf[i], ms) * p2;
         break;
      case kCubic:
         obuf[i] = WaveShaper(ibuf[i], ms) * p2;
         break;
      case kEvenHarmonics:
         obuf[i] = WaveShaper(ibuf[i], ms);
         break;
      case kSinCurve:
         obuf[i] = WaveShaper(ibuf[i], ms) * p2;
         break;
      case kLeveller:
         obuf[i] = WaveShaper(ibuf[i], ms);
         break;
      case kRectifier:
         obuf[i] = WaveShaper(ibuf[i], ms);
         break;
      case kHardLimiter:
         // Mix equivalent to LADSPA effect's "Wet / Residual" mix
         obuf[i] = (WaveShaper(ibuf[i], ms) * (p1 - p2)) + (ibuf[i] * p2);
         break;
      default:
         obuf[i] = WaveShaper(ibuf[i], ms);
      }
      if (ms.mDCBlock)
      {
         obuf[i] = DCFilter(data, obuf[i]);
      }
   }
 
   return blockLen;
}

References EffectWithSettings< EffectDistortionSettings, PerTrackEffect >::GetSettings(), DistortionBase::kCubic, DistortionBase::kEvenHarmonics, DistortionBase::kExpCurve, DistortionBase::kHalfSinCurve, DistortionBase::kHardClip, DistortionBase::kHardLimiter, DistortionBase::kLeveller, DistortionBase::kLogCurve, DistortionBase::kRectifier, DistortionBase::kSinCurve, DistortionBase::kSoftClip, EffectDistortionState::mMakeupGain, EffectDistortionState::noisefloor, EffectDistortionState::param1, EffectDistortionState::param2, EffectDistortionState::repeats, settings(), EffectDistortionState::skipcount, skipsamples, EffectDistortionState::tablechoiceindx, and EffectDistortionState::threshold.

Here is the call graph for this function:

Leveller()

void DistortionBase::Instance::Leveller

(

const EffectDistortionSettings &

ms

)

Definition at line 567 of file DistortionBase.cpp.

{
   double noiseFloor = DB_TO_LINEAR(ms.mNoiseFloor);
   int numPasses = ms.mRepeats;
   double fractionalPass = ms.mParam1 / 100.0;
 
   const int numPoints = 6;
   const double gainFactors[numPoints] = { 0.80, 1.00, 1.20, 1.20, 1.00, 0.80 };
   double gainLimits[numPoints] = { 0.0001, 0.0, 0.1, 0.3, 0.5, 1.0 };
   double addOnValues[numPoints];
 
   gainLimits[1] = noiseFloor;
   /* In the original Leveller effect, behaviour was undefined for threshold >
    * 20 dB. If we want to support > 20 dB we need to scale the points to keep
    * them non-decreasing.
    *
    * if (noiseFloor > gainLimits[2]) {
    *    for (int i = 3; i < numPoints; i++) {
    *    gainLimits[i] = noiseFloor + ((1 - noiseFloor)*((gainLimits[i] - 0.1) /
    * 0.9));
    * }
    * gainLimits[2] = noiseFloor;
    * }
    */
 
   // Calculate add-on values
   addOnValues[0] = 0.0;
   for (int i = 0; i < numPoints - 1; i++)
   {
      addOnValues[i + 1] =
         addOnValues[i] +
         (gainLimits[i] * (gainFactors[i] - gainFactors[1 + i]));
   }
 
   // Positive half of table.
   // The original effect increased the 'strength' of the effect by
   // repeated passes over the audio data.
   // Here we model that more efficiently by repeated passes over a linear
   // table.
   for (int n = STEPS; n < TABLESIZE; n++)
   {
      mTable[n] = ((double)(n - STEPS) / (double)STEPS);
      for (int j = 0; j < numPasses; j++)
      {
         // Find the highest index for gain adjustment
         int index = numPoints - 1;
         for (int i = index; i >= 0 && mTable[n] < gainLimits[i]; i--)
         {
            index = i;
         }
         // the whole number of 'repeats'
         mTable[n] = (mTable[n] * gainFactors[index]) + addOnValues[index];
      }
      // Extrapolate for fine adjustment.
      // tiny fractions are not worth the processing time
      if (fractionalPass > 0.001)
      {
         int index = numPoints - 1;
         for (int i = index; i >= 0 && mTable[n] < gainLimits[i]; i--)
         {
            index = i;
         }
         mTable[n] += fractionalPass * ((mTable[n] * (gainFactors[index] - 1)) +
                                        addOnValues[index]);
      }
   }
   CopyHalfTable();
}

References DB_TO_LINEAR, EffectDistortionSettings::mNoiseFloor, EffectDistortionSettings::mParam1, EffectDistortionSettings::mRepeats, STEPS, and TABLESIZE.

LogarithmicTable()

void DistortionBase::Instance::LogarithmicTable

(

const EffectDistortionSettings &

ms

)

Definition at line 440 of file DistortionBase.cpp.

{
   double amount = ms.mParam1;
   double stepsize = 1.0 / STEPS;
   double linVal = 0;
 
   if (amount == 0)
   {
      for (int n = STEPS; n < TABLESIZE; n++)
      {
         mTable[n] = linVal;
         linVal += stepsize;
      }
   }
   else
   {
      for (int n = STEPS; n < TABLESIZE; n++)
      {
         mTable[n] = std::log(1 + (amount * linVal)) / std::log(1 + amount);
         linVal += stepsize;
      }
   }
   CopyHalfTable();
}

References EffectDistortionSettings::mParam1, STEPS, and TABLESIZE.

LogCurve()

float DistortionBase::Instance::LogCurve ( double  threshold, float  value, double  ratio  )

inline

Definition at line 418 of file DistortionBase.cpp.

{
   return threshold + ((std::exp(ratio * (threshold - value)) - 1) / -ratio);
}

MakeTable()

void DistortionBase::Instance::MakeTable	(	EffectDistortionState &	state,
		const EffectDistortionSettings &	ms
	)

Definition at line 330 of file DistortionBase.cpp.

{
   switch (ms.mTableChoiceIndx)
   {
   case kHardClip:
      HardClip(state, ms);
      break;
   case kSoftClip:
      SoftClip(state, ms);
      break;
   case kHalfSinCurve:
      HalfSinTable(ms);
      break;
   case kExpCurve:
      ExponentialTable(ms);
      break;
   case kLogCurve:
      LogarithmicTable(ms);
      break;
   case kCubic:
      CubicTable(ms);
      break;
   case kEvenHarmonics:
      EvenHarmonicTable(ms);
      break;
   case kSinCurve:
      SineTable(ms);
      break;
   case kLeveller:
      Leveller(ms);
      break;
   case kRectifier:
      Rectifier(ms);
      break;
   case kHardLimiter:
      HardLimiter(state, ms);
      break;
   }
}

References DistortionBase::kCubic, DistortionBase::kEvenHarmonics, DistortionBase::kExpCurve, DistortionBase::kHalfSinCurve, DistortionBase::kHardClip, DistortionBase::kHardLimiter, DistortionBase::kLeveller, DistortionBase::kLogCurve, DistortionBase::kRectifier, DistortionBase::kSinCurve, DistortionBase::kSoftClip, and EffectDistortionSettings::mTableChoiceIndx.

ProcessBlock()

size_t DistortionBase::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 144 of file DistortionBase.cpp.

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

References settings().

Here is the call graph for this function:

ProcessInitialize()

bool DistortionBase::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 137 of file DistortionBase.cpp.

{
   InstanceInit(mMaster, settings, sampleRate);
   return true;
}

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

Here is the call graph for this function:

RealtimeAddProcessor()

bool DistortionBase::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 158 of file DistortionBase.cpp.

{
   EffectDistortionState slave;
 
   InstanceInit(slave, settings, sampleRate);
 
   mSlaves.push_back(slave);
 
   return true;
}

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

Here is the call graph for this function:

RealtimeFinalize()

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

overridevirtualnoexcept

Returns

success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 170 of file DistortionBase.cpp.

{
   mSlaves.clear();
 
   return true;
}

RealtimeInitialize()

bool DistortionBase::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 151 of file DistortionBase.cpp.

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

RealtimeProcess()

size_t DistortionBase::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 177 of file DistortionBase.cpp.

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

References settings().

Here is the call graph for this function:

Rectifier()

void DistortionBase::Instance::Rectifier

(

const EffectDistortionSettings &

ms

)

Definition at line 636 of file DistortionBase.cpp.

{
   double amount = (ms.mParam1 / 50.0) - 1;
   double stepsize = 1.0 / STEPS;
   int index = STEPS;
 
   // positive half of waveform is passed unaltered.
   for (int n = 0; n <= STEPS; n++)
   {
      mTable[index] = n * stepsize;
      index += 1;
   }
 
   // negative half of table
   index = STEPS - 1;
   for (int n = 1; n <= STEPS; n++)
   {
      mTable[index] = n * stepsize * amount;
      index--;
   }
}

References EffectDistortionSettings::mParam1, and STEPS.

SineTable()

void DistortionBase::Instance::SineTable

(

const EffectDistortionSettings &

ms

)

Definition at line 545 of file DistortionBase.cpp.

{
   int iter = std::floor(ms.mParam1 / 20.0);
   double fractionalpart = (ms.mParam1 / 20.0) - iter;
   double stepsize = 1.0 / STEPS;
   double linVal = 0.0;
 
   for (int n = STEPS; n < TABLESIZE; n++)
   {
      mTable[n] = linVal;
      for (int i = 0; i < iter; i++)
      {
         mTable[n] = (1.0 + std::sin((mTable[n] * M_PI) - M_PI_2)) / 2.0;
      }
      mTable[n] +=
         (((1.0 + std::sin((mTable[n] * M_PI) - M_PI_2)) / 2.0) - mTable[n]) *
         fractionalpart;
      linVal += stepsize;
   }
   CopyHalfTable();
}

References M_PI, M_PI_2, EffectDistortionSettings::mParam1, STEPS, and TABLESIZE.

SoftClip()

void DistortionBase::Instance::SoftClip	(	EffectDistortionState &	state,
		const EffectDistortionSettings &	ms
	)

Definition at line 396 of file DistortionBase.cpp.

{
   const double thresholdLinear = DB_TO_LINEAR(ms.mThreshold_dB);
 
   double threshold = 1 + thresholdLinear;
   double amount = std::pow(2.0, 7.0 * ms.mParam1 / 100.0); // range 1 to 128
   double peak = LogCurve(thresholdLinear, 1.0, amount);
   state.mMakeupGain = 1.0 / peak;
   mTable[STEPS] = 0.0; // origin
 
   // positive half of table
   for (int n = STEPS; n < TABLESIZE; n++)
   {
      if (n < (STEPS * threshold)) // origin to threshold
         mTable[n] = n / (float)STEPS - 1;
      else
         mTable[n] = LogCurve(thresholdLinear, n / (double)STEPS - 1, amount);
   }
   CopyHalfTable();
}

References DB_TO_LINEAR, EffectDistortionState::mMakeupGain, EffectDistortionSettings::mParam1, EffectDistortionSettings::mThreshold_dB, STEPS, and TABLESIZE.

WaveShaper()

float DistortionBase::Instance::WaveShaper	(	float	sample,
		EffectDistortionSettings &	ms
	)

Definition at line 680 of file DistortionBase.cpp.

{
   float out;
   int index;
   double xOffset;
   double amount = 1;
 
   switch (ms.mTableChoiceIndx)
   {
   // Do any pre-processing here
   case kHardClip:
      // Pre-gain
      amount = ms.mParam1 / 100.0;
      sample *= 1 + amount;
      break;
   default:
      break;
   }
 
   index = std::floor(sample * STEPS) + STEPS;
   index = std::max<int>(std::min<int>(index, 2 * STEPS - 1), 0);
   xOffset = ((1 + sample) * STEPS) - index;
   xOffset = std::min<double>(std::max<double>(xOffset, 0.0), 1.0); // Clip at 0dB
 
   // linear interpolation: y = y0 + (y1-y0)*(x-x0)
   out = mTable[index] + (mTable[index + 1] - mTable[index]) * xOffset;
 
   return out;
}

References DistortionBase::kHardClip, EffectDistortionSettings::mParam1, EffectDistortionSettings::mTableChoiceIndx, and STEPS.

Member Data Documentation

mMaster

EffectDistortionState DistortionBase::Instance::mMaster

Definition at line 180 of file DistortionBase.h.

mSlaves

std::vector<EffectDistortionState> DistortionBase::Instance::mSlaves

Definition at line 181 of file DistortionBase.h.

mTable

double DistortionBase::Instance::mTable[TABLESIZE]

Definition at line 178 of file DistortionBase.h.

---

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

• DistortionBase.h
• DistortionBase.cpp