An Effect derived from EffectTwoPassSimpleMono. More...

#include <LegacyCompressorBase.h>

Inheritance diagram for LegacyCompressorBase:

Collaboration diagram for LegacyCompressorBase:

Public Member Functions
	LegacyCompressorBase ()

virtual	~LegacyCompressorBase ()

ComponentInterfaceSymbol	GetSymbol () const override

TranslatableString	GetDescription () const override

ManualPageID	ManualPage () const override
	Name of a page in the Audacity alpha manual, default is empty. More...

EffectType	GetType () const override
	Type determines how it behaves. More...

Public Member Functions inherited from EffectTwoPassSimpleMono
	~EffectTwoPassSimpleMono () override

bool	Process (EffectInstance &instance, EffectSettings &settings) override

Public Member Functions inherited from StatefulEffect
	~StatefulEffect () override

std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0

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 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	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

virtual unsigned	GetAudioInCount () const
	How many input buffers to allocate at once. More...

virtual unsigned	GetAudioOutCount () const
	How many output buffers to allocate at once. More...

virtual sampleCount	GetLatency () const

virtual bool	NeedsDither () const

virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)

virtual bool	ProcessFinalize () noexcept

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override

bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...

RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...

bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...

bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...

OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override

bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...

RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...

OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatID	GetSelectionFormat ()

bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override

OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

bool	Delegate (Effect &delegate, EffectSettings &settings, InstanceFinder finder={})
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

bool	IsLinearEffect () const

bool	PreviewsFullSelection () const

void	SetTracks (TrackList *pTracks)

double	GetDefaultDuration ()

virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	CountWaveTracks ()

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

virtual bool	CanExportPresets () const =0
	Whether the effect supports export of presets to files, and importing too. More...

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0

virtual OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

virtual bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

virtual std::shared_ptr< EffectInstance >	MakeInstance () const =0
	Make an object maintaining short-term state of an Effect. More...

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

virtual bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)

virtual bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const

virtual EffectSettings	MakeSettings () const

virtual bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const
	Update one settings object from another. More...

virtual std::unique_ptr< EffectOutputs >	MakeOutputs () const
	Produce an object to hold values to send to effect output meters. More...

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetType () const =0
	Type determines how it behaves. More...

virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...

virtual EffectFamilySymbol	GetFamily () const =0
	Report identifier and user-visible name of the effect protocol. More...

virtual bool	IsInteractive () const =0
	Whether the effect needs a dialog for entry of settings. More...

virtual bool	IsDefault () const =0
	Whether the effect sorts "above the line" in the menus. More...

virtual RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsRealtime () const

virtual bool	SupportsAutomation () const =0
	Whether the effect has any automatable controls. More...

virtual bool	EnablesDebug () const
	Whether the effect dialog should have a Debug button; default, always false. More...

virtual ManualPageID	ManualPage () const
	Name of a page in the Audacity alpha manual, default is empty. More...

virtual FilePath	HelpPage () const
	Fully qualified local help file name, default is empty. More...

virtual bool	IsHiddenFromMenus () const
	Default is false. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static LegacyCompressorBase *	FetchParameters (LegacyCompressorBase &e, EffectSettings &)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)

static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol

Static Public Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")

static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")

static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")

static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")

Protected Member Functions
bool	InitPass1 () override

bool	InitPass2 () override

bool	NewTrackPass1 () override

bool	ProcessPass2 (float *buffer, size_t len) override

bool	TwoBufferProcessPass1 (float buffer1, size_t len1, float buffer2, size_t len2) override

const EffectParameterMethods &	Parameters () const override

Protected Member Functions inherited from EffectTwoPassSimpleMono
virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual bool	NewTrackPass1 ()

virtual bool	NewTrackPass2 ()

virtual bool	ProcessPass1 (float *WXUNUSED(buffer), size_t WXUNUSED(len))
	Override this method to actually process audio. More...

virtual bool	ProcessPass2 (float *WXUNUSED(buffer), size_t WXUNUSED(len))

virtual bool	TwoBufferProcessPass1 (float buffer1, size_t len1, float buffer2, size_t len2)

virtual bool	TwoBufferProcessPass2 (float buffer1, size_t len1, float buffer2, size_t len2)

void	DisableSecondPass ()
	Call this if you know in advance that no second pass will be needed. More...

Protected Member Functions inherited from Effect
bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns `previewLength` More...

bool	TotalProgress (double frac, const TranslatableString &={}) const

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

void	GetBounds (const WaveTrack &track, sampleCount start, sampleCount len)

Protected Member Functions inherited from EffectBase
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
double	mRMSSum

size_t	mCircleSize

size_t	mCirclePos

Doubles	mCircle

double	mAttackTime

double	mThresholdDB

double	mNoiseFloorDB

double	mRatio

bool	mNormalize

bool	mUsePeak

double	mDecayTime

double	mAttackFactor

double	mAttackInverseFactor

double	mDecayFactor

double	mThreshold

double	mCompression

double	mNoiseFloor

int	mNoiseCounter

double	mGain

double	mLastLevel

Floats	mFollow1

Floats	mFollow2

size_t	mFollowLen

double	mMax

Protected Attributes inherited from EffectTwoPassSimpleMono
int	mCurTrackNum

double	mCurRate

double	mCurT0

double	mCurT1

int	mPass

bool	mSecondPassDisabled

std::shared_ptr< TrackList >	mWorkTracks

TrackList *	mTrackLists [2]

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static constexpr EffectParameter	Threshold

static constexpr EffectParameter	NoiseFloor

static constexpr EffectParameter	Ratio

static constexpr EffectParameter	AttackTime

static constexpr EffectParameter	ReleaseTime

static constexpr EffectParameter	Normalize

static constexpr EffectParameter	UsePeak

Private Member Functions
void	FreshenCircle ()

float	AvgCircle (float x)

void	Follow (float buffer, float env, size_t len, float *previous, size_t previous_len)

float	DoCompression (float x, double env)

Additional Inherited Members
Public Types inherited from StatefulEffectBase
using	MessagePackage = EffectInstance::MessagePackage

Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

using	InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >

Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , After_3_1 , Always }
	In which versions of Audacity was an effect realtime capable? More...

Public Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mTracks {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

Detailed Description

An Effect derived from EffectTwoPassSimpleMono.

Martyn Shaw made it inherit from EffectTwoPassSimpleMono 10/2005.
Steve Jolly made it inherit from EffectSimpleMono.
GUI added and implementation improved by Dominic Mazzoni, 5/11/2003.

Definition at line 19 of file LegacyCompressorBase.h.

Constructor & Destructor Documentation

◆ LegacyCompressorBase()

LegacyCompressorBase::LegacyCompressorBase ( )

Definition at line 45 of file LegacyCompressorBase.cpp.

{
   Parameters().Reset(*this);
 
   mThreshold = 0.25;
   mNoiseFloor = 0.01;
   mCompression = 0.5;
   mFollowLen = 0;
 
   SetLinearEffectFlag(false);
}

References mCompression, mFollowLen, mNoiseFloor, mThreshold, Parameters(), EffectParameterMethods::Reset(), and EffectBase::SetLinearEffectFlag().

Referenced by Parameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~LegacyCompressorBase()

LegacyCompressorBase::~LegacyCompressorBase ( )

virtual

Definition at line 57 of file LegacyCompressorBase.cpp.

58{

59}

Member Function Documentation

◆ AvgCircle()

float LegacyCompressorBase::AvgCircle ( float x )

private

Definition at line 212 of file LegacyCompressorBase.cpp.

{
   float level;
 
   // Calculate current level from root-mean-squared of
   // circular buffer ("RMS")
   mRMSSum -= mCircle[mCirclePos];
   mCircle[mCirclePos] = value * value;
   mRMSSum += mCircle[mCirclePos];
   level = sqrt(mRMSSum / mCircleSize);
   mCirclePos = (mCirclePos + 1) % mCircleSize;
 
   return level;
}

References mCircle, mCirclePos, mCircleSize, mRMSSum, and staffpad::audio::simd::sqrt().

Referenced by Follow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoCompression()

float LegacyCompressorBase::DoCompression	(	float	x,
		double	env
	)

private

Definition at line 354 of file LegacyCompressorBase.cpp.

{
   float out;
   if (mUsePeak)
   {
      // Peak values map 1.0 to 1.0 - 'upward' compression
      out = value * pow(1.0 / env, mCompression);
   }
   else
   {
      // With RMS-based compression don't change values below mThreshold -
      // 'downward' compression
      out = value * pow(mThreshold / env, mCompression);
   }
 
   // Retain the maximum value for use in the normalization pass
   if (mMax < fabs(out))
      mMax = fabs(out);
 
   return out;
}

References mCompression, mMax, mThreshold, and mUsePeak.

Referenced by TwoBufferProcessPass1().

Here is the caller graph for this function:

◆ FetchParameters()

static LegacyCompressorBase * LegacyCompressorBase::FetchParameters	(	LegacyCompressorBase &	e,
		EffectSettings &
	)

inlinestatic

Definition at line 23 of file LegacyCompressorBase.h.

   {
      return &e;
   }

◆ Follow()

void LegacyCompressorBase::Follow	(	float *	buffer,
		float *	env,
		size_t	len,
		float *	previous,
		size_t	previous_len
	)

private

Definition at line 227 of file LegacyCompressorBase.cpp.

{
   /*
 
   "Follow"ing algorithm by Roger B. Dannenberg, taken from
   Nyquist.  His description follows.  -DMM
 
   Description: this is a sophisticated envelope follower.
    The input is an envelope, e.g. something produced with
    the AVG function. The purpose of this function is to
    generate a smooth envelope that is generally not less
    than the input signal. In other words, we want to "ride"
    the peaks of the signal with a smooth function. The
    algorithm is as follows: keep a current output value
    (called the "value"). The value is allowed to increase
    by at most rise_factor and decrease by at most fall_factor.
    Therefore, the next value should be between
    value * rise_factor and value * fall_factor. If the input
    is in this range, then the next value is simply the input.
    If the input is less than value * fall_factor, then the
    next value is just value * fall_factor, which will be greater
    than the input signal. If the input is greater than value *
    rise_factor, then we compute a rising envelope that meets
    the input value by working bacwards in time, changing the
    previous values to input / rise_factor, input / rise_factor^2,
    input / rise_factor^3, etc. until this NEW envelope intersects
    the previously computed values. There is only a limited buffer
    in which we can work backwards, so if the NEW envelope does not
    intersect the old one, then make yet another pass, this time
    from the oldest buffered value forward, increasing on each
    sample by rise_factor to produce a maximal envelope. This will
    still be less than the input.
 
    The value has a lower limit of floor to make sure value has a
    reasonable positive value from which to begin an attack.
   */
   double level, last;
 
   if (!mUsePeak)
   {
      // Update RMS sum directly from the circle buffer
      // to avoid accumulation of rounding errors
      FreshenCircle();
   }
   // First apply a peak detect with the requested decay rate
   last = mLastLevel;
   for (size_t i = 0; i < len; i++)
   {
      if (mUsePeak)
         level = fabs(buffer[i]);
      else // use RMS
         level = AvgCircle(buffer[i]);
      // Don't increase gain when signal is continuously below the noise floor
      if (level < mNoiseFloor)
      {
         mNoiseCounter++;
      }
      else
      {
         mNoiseCounter = 0;
      }
      if (mNoiseCounter < 100)
      {
         last *= mDecayFactor;
         if (last < mThreshold)
            last = mThreshold;
         if (level > last)
            last = level;
      }
      env[i] = last;
   }
   mLastLevel = last;
 
   // Next do the same process in reverse direction to get the requested attack
   // rate
   last = mLastLevel;
   for (size_t i = len; i--;)
   {
      last *= mAttackInverseFactor;
      if (last < mThreshold)
         last = mThreshold;
      if (env[i] < last)
         env[i] = last;
      else
         last = env[i];
   }
 
   if ((previous != NULL) && (previous_len > 0))
   {
      // If the previous envelope was passed, propagate the rise back until we
      // intersect
      for (size_t i = previous_len; i--;)
      {
         last *= mAttackInverseFactor;
         if (last < mThreshold)
            last = mThreshold;
         if (previous[i] < last)
            previous[i] = last;
         else // Intersected the previous envelope buffer, so we are finished
            return;
      }
      // If we can't back up far enough, project the starting level forward
      // until we intersect the desired envelope
      last = previous[0];
      for (size_t i = 1; i < previous_len; i++)
      {
         last *= mAttackFactor;
         if (previous[i] > last)
            previous[i] = last;
         else // Intersected the desired envelope, so we are finished
            return;
      }
      // If we still didn't intersect, then continue ramp up into current buffer
      for (size_t i = 0; i < len; i++)
      {
         last *= mAttackFactor;
         if (buffer[i] > last)
            buffer[i] = last;
         else // Finally got an intersect
            return;
      }
      // If we still didn't intersect, then reset mLastLevel
      mLastLevel = last;
   }
}

References AvgCircle(), FreshenCircle(), mAttackFactor, mAttackInverseFactor, mDecayFactor, mLastLevel, mNoiseCounter, mNoiseFloor, mThreshold, and mUsePeak.

Referenced by TwoBufferProcessPass1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FreshenCircle()

void LegacyCompressorBase::FreshenCircle ( )

private

Definition at line 203 of file LegacyCompressorBase.cpp.

{
   // Recompute the RMS sum periodically to prevent accumulation of rounding
   // errors during long waveforms
   mRMSSum = 0;
   for (size_t i = 0; i < mCircleSize; i++)
      mRMSSum += mCircle[i];
}

References mCircle, mCircleSize, and mRMSSum.

Referenced by Follow().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString LegacyCompressorBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 68 of file LegacyCompressorBase.cpp.

{
   return XO("Compresses the dynamic range of audio");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol LegacyCompressorBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 63 of file LegacyCompressorBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType LegacyCompressorBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 80 of file LegacyCompressorBase.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ InitPass1()

bool LegacyCompressorBase::InitPass1 ( )

overrideprotectedvirtual

Override these methods if you need to initialize something before each pass. Return false if processing should stop.

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 112 of file LegacyCompressorBase.cpp.

{
   mMax = 0.0;
   if (!mNormalize)
      DisableSecondPass();
 
   // Find the maximum block length required for any track
   size_t maxlen = inputTracks()->Selected<const WaveTrack>().max(
      &WaveTrack::GetMaxBlockSize);
   mFollow1.reset();
   mFollow2.reset();
   // Allocate buffers for the envelope
   if (maxlen > 0)
   {
      mFollow1.reinit(maxlen);
      mFollow2.reinit(maxlen);
   }
   mFollowLen = maxlen;
 
   return true;
}

References EffectTwoPassSimpleMono::DisableSecondPass(), WaveTrack::GetMaxBlockSize(), EffectBase::inputTracks(), mFollow1, mFollow2, mFollowLen, mMax, mNormalize, ArrayOf< X >::reinit(), and TrackList::Selected().

Here is the call graph for this function:

◆ InitPass2()

bool LegacyCompressorBase::InitPass2 ( )

overrideprotectedvirtual

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 134 of file LegacyCompressorBase.cpp.

{
   // Actually, this should not even be called, because we call
   // DisableSecondPass() before, if mNormalize is false.
   return mNormalize;
}

References mNormalize.

◆ ManualPage()

ManualPageID LegacyCompressorBase::ManualPage ( ) const

overridevirtual

Name of a page in the Audacity alpha manual, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 73 of file LegacyCompressorBase.cpp.

{
   return L"Compressor";
}

◆ NewTrackPass1()

bool LegacyCompressorBase::NewTrackPass1 ( )

overrideprotectedvirtual

Override these methods if you need to do things before every track (including the first one)

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 87 of file LegacyCompressorBase.cpp.

{
   mThreshold = DB_TO_LINEAR(mThresholdDB);
   mNoiseFloor = DB_TO_LINEAR(mNoiseFloorDB);
   mNoiseCounter = 100;
 
   mAttackInverseFactor = exp(log(mThreshold) / (mCurRate * mAttackTime + 0.5));
   mAttackFactor = 1.0 / mAttackInverseFactor;
   mDecayFactor = exp(log(mThreshold) / (mCurRate * mDecayTime + 0.5));
 
   if (mRatio > 1)
      mCompression = 1.0 - 1.0 / mRatio;
   else
      mCompression = 0.0;
 
   mLastLevel = mThreshold;
 
   mCircleSize = 100;
   mCircle.reinit(mCircleSize, true);
   mCirclePos = 0;
   mRMSSum = 0.0;
 
   return true;
}

References DB_TO_LINEAR, mAttackFactor, mAttackInverseFactor, mAttackTime, mCircle, mCirclePos, mCircleSize, mCompression, EffectTwoPassSimpleMono::mCurRate, mDecayFactor, mDecayTime, mLastLevel, mNoiseCounter, mNoiseFloor, mNoiseFloorDB, mRatio, mRMSSum, mThreshold, mThresholdDB, and ArrayOf< X >::reinit().

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & LegacyCompressorBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 26 of file LegacyCompressorBase.cpp.

{
   static CapturedParameters<
      LegacyCompressorBase, Threshold, NoiseFloor,
      Ratio,       // positive number > 1.0
      AttackTime,  // seconds
      ReleaseTime, // seconds
      Normalize, UsePeak>
      parameters;
   return parameters;
}

References AttackTime, LegacyCompressorBase(), NoiseFloor, Normalize, Ratio, ReleaseTime, Threshold, and UsePeak.

Referenced by LegacyCompressorBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPass2()

bool LegacyCompressorBase::ProcessPass2	(	float *	buffer,
		size_t	len
	)

overrideprotected

Definition at line 192 of file LegacyCompressorBase.cpp.

{
   if (mMax != 0)
   {
      for (size_t i = 0; i < len; i++)
         buffer[i] /= mMax;
   }
 
   return true;
}

References mMax.

◆ TwoBufferProcessPass1()

bool LegacyCompressorBase::TwoBufferProcessPass1	(	float *	buffer1,
		size_t	len1,
		float *	buffer2,
		size_t	len2
	)

overrideprotectedvirtual

Override this method to actually process audio with access to 2 sequential buffers at a time

Either buffer1 or buffer2 may be modified as needed This allows implementation of processing with delays The default just calls the one-buffer-at-a-time method

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 144 of file LegacyCompressorBase.cpp.

{
   // If buffers are bigger than allocated, then abort
   // (this should never happen, but if it does, we don't want to crash)
   if ((len1 > mFollowLen) || (len2 > mFollowLen))
      return false;
 
   // This makes sure that the initial value is well-chosen
   // buffer1 == NULL on the first and only the first call
   if (buffer1 == NULL)
   {
      // Initialize the mLastLevel to the peak level in the first buffer
      // This avoids problems with large spike events near the beginning of the
      // track
      mLastLevel = mThreshold;
      for (size_t i = 0; i < len2; i++)
      {
         if (mLastLevel < fabs(buffer2[i]))
            mLastLevel = fabs(buffer2[i]);
      }
   }
 
   // buffer2 is NULL on the last and only the last call
   if (buffer2 != NULL)
   {
      Follow(buffer2, mFollow2.get(), len2, mFollow1.get(), len1);
   }
 
   if (buffer1 != NULL)
   {
      for (size_t i = 0; i < len1; i++)
      {
         buffer1[i] = DoCompression(buffer1[i], mFollow1[i]);
      }
   }
 
#if 0
   // Copy the envelope over the track data (for debug purposes)
   memcpy(buffer1, mFollow1, len1*sizeof(float));
#endif
 
   // Rotate the buffer pointers
   mFollow1.swap(mFollow2);
 
   return true;
}

References DoCompression(), Follow(), mFollow1, mFollow2, mFollowLen, mLastLevel, and mThreshold.

Here is the call graph for this function:

Member Data Documentation

◆ AttackTime

constexpr EffectParameter LegacyCompressorBase::AttackTime

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mAttackTime, L"AttackTime", 0.2, 0.1, 5.0, 100
   }

Definition at line 107 of file LegacyCompressorBase.h.

Referenced by Parameters(), EffectLegacyCompressor::PopulateOrExchange(), and EffectLegacyCompressor::TransferDataToWindow().

◆ mAttackFactor

double LegacyCompressorBase::mAttackFactor

protected

Definition at line 77 of file LegacyCompressorBase.h.

Referenced by Follow(), and NewTrackPass1().

◆ mAttackInverseFactor

double LegacyCompressorBase::mAttackInverseFactor

protected

Definition at line 78 of file LegacyCompressorBase.h.

Referenced by Follow(), and NewTrackPass1().

◆ mAttackTime

double LegacyCompressorBase::mAttackTime

protected

Definition at line 69 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), NewTrackPass1(), EffectLegacyCompressor::TransferDataToWindow(), and EffectLegacyCompressor::UpdateUI().

◆ mCircle

Doubles LegacyCompressorBase::mCircle

protected

Definition at line 67 of file LegacyCompressorBase.h.

Referenced by AvgCircle(), FreshenCircle(), and NewTrackPass1().

◆ mCirclePos

size_t LegacyCompressorBase::mCirclePos

protected

Definition at line 66 of file LegacyCompressorBase.h.

Referenced by AvgCircle(), and NewTrackPass1().

◆ mCircleSize

size_t LegacyCompressorBase::mCircleSize

protected

Definition at line 65 of file LegacyCompressorBase.h.

Referenced by AvgCircle(), FreshenCircle(), and NewTrackPass1().

◆ mCompression

double LegacyCompressorBase::mCompression

protected

Definition at line 81 of file LegacyCompressorBase.h.

Referenced by DoCompression(), LegacyCompressorBase(), and NewTrackPass1().

◆ mDecayFactor

double LegacyCompressorBase::mDecayFactor

protected

Definition at line 79 of file LegacyCompressorBase.h.

Referenced by Follow(), and NewTrackPass1().

◆ mDecayTime

double LegacyCompressorBase::mDecayTime

protected

Definition at line 76 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), NewTrackPass1(), EffectLegacyCompressor::TransferDataToWindow(), and EffectLegacyCompressor::UpdateUI().

◆ mFollow1

Floats LegacyCompressorBase::mFollow1

protected

Definition at line 86 of file LegacyCompressorBase.h.

Referenced by InitPass1(), and TwoBufferProcessPass1().

◆ mFollow2

Floats LegacyCompressorBase::mFollow2

protected

Definition at line 86 of file LegacyCompressorBase.h.

Referenced by InitPass1(), and TwoBufferProcessPass1().

◆ mFollowLen

size_t LegacyCompressorBase::mFollowLen

protected

Definition at line 87 of file LegacyCompressorBase.h.

Referenced by InitPass1(), LegacyCompressorBase(), and TwoBufferProcessPass1().

◆ mGain

double LegacyCompressorBase::mGain

protected

Definition at line 84 of file LegacyCompressorBase.h.

◆ mLastLevel

double LegacyCompressorBase::mLastLevel

protected

Definition at line 85 of file LegacyCompressorBase.h.

Referenced by Follow(), NewTrackPass1(), and TwoBufferProcessPass1().

◆ mMax

double LegacyCompressorBase::mMax

protected

Definition at line 89 of file LegacyCompressorBase.h.

Referenced by DoCompression(), InitPass1(), and ProcessPass2().

◆ mNoiseCounter

int LegacyCompressorBase::mNoiseCounter

protected

Definition at line 83 of file LegacyCompressorBase.h.

Referenced by Follow(), and NewTrackPass1().

◆ mNoiseFloor

double LegacyCompressorBase::mNoiseFloor

protected

Definition at line 82 of file LegacyCompressorBase.h.

Referenced by Follow(), LegacyCompressorBase(), and NewTrackPass1().

◆ mNoiseFloorDB

double LegacyCompressorBase::mNoiseFloorDB

protected

Definition at line 71 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), NewTrackPass1(), EffectLegacyCompressor::PopulateOrExchange(), EffectLegacyCompressor::TransferDataToWindow(), and EffectLegacyCompressor::UpdateUI().

◆ mNormalize

bool LegacyCompressorBase::mNormalize

protected

Definition at line 73 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), InitPass1(), InitPass2(), and EffectLegacyCompressor::TransferDataToWindow().

◆ mRatio

double LegacyCompressorBase::mRatio

protected

Definition at line 72 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), NewTrackPass1(), EffectLegacyCompressor::PopulateOrExchange(), EffectLegacyCompressor::TransferDataToWindow(), and EffectLegacyCompressor::UpdateUI().

◆ mRMSSum

double LegacyCompressorBase::mRMSSum

protected

Definition at line 64 of file LegacyCompressorBase.h.

Referenced by AvgCircle(), FreshenCircle(), and NewTrackPass1().

◆ mThreshold

double LegacyCompressorBase::mThreshold

protected

Definition at line 80 of file LegacyCompressorBase.h.

Referenced by DoCompression(), Follow(), LegacyCompressorBase(), NewTrackPass1(), and TwoBufferProcessPass1().

◆ mThresholdDB

double LegacyCompressorBase::mThresholdDB

protected

Definition at line 70 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), NewTrackPass1(), EffectLegacyCompressor::PopulateOrExchange(), EffectLegacyCompressor::TransferDataToWindow(), and EffectLegacyCompressor::UpdateUI().

◆ mUsePeak

bool LegacyCompressorBase::mUsePeak

protected

Definition at line 74 of file LegacyCompressorBase.h.

Referenced by DoCompression(), EffectLegacyCompressor::DoTransferDataFromWindow(), Follow(), and EffectLegacyCompressor::TransferDataToWindow().

◆ NoiseFloor

constexpr EffectParameter LegacyCompressorBase::NoiseFloor

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mNoiseFloorDB,
      L"NoiseFloor",
      -40.0,
      -80.0,
      -20.0,
      0.2
   }

Definition at line 96 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), Parameters(), EffectLegacyCompressor::PopulateOrExchange(), and EffectLegacyCompressor::TransferDataToWindow().

◆ Normalize

constexpr EffectParameter LegacyCompressorBase::Normalize

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mNormalize, L"Normalize", true, false, true, 1
   }

Definition at line 113 of file LegacyCompressorBase.h.

Referenced by Parameters(), and EffectLegacyCompressor::PopulateOrExchange().

◆ Ratio

constexpr EffectParameter LegacyCompressorBase::Ratio

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mRatio, L"Ratio", 2.0, 1.1, 10.0, 10
   }

Definition at line 104 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), Parameters(), EffectLegacyCompressor::PopulateOrExchange(), and EffectLegacyCompressor::TransferDataToWindow().

◆ ReleaseTime

constexpr EffectParameter LegacyCompressorBase::ReleaseTime

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mDecayTime, L"ReleaseTime", 1.0, 1.0, 30.0, 10
   }

Definition at line 110 of file LegacyCompressorBase.h.

Referenced by EffectLegacyCompressor::DoTransferDataFromWindow(), Parameters(), EffectLegacyCompressor::PopulateOrExchange(), and EffectLegacyCompressor::TransferDataToWindow().

◆ Symbol

const ComponentInterfaceSymbol LegacyCompressorBase::Symbol

static

Initial value:

{ XO(

"Legacy Compressor") }

Definition at line 28 of file LegacyCompressorBase.h.

Referenced by GetSymbol().

◆ Threshold

constexpr EffectParameter LegacyCompressorBase::Threshold

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mThresholdDB, L"Threshold", -12.0, -60.0, -1.0, 1
   }

Definition at line 93 of file LegacyCompressorBase.h.

Referenced by Parameters(), and EffectLegacyCompressor::PopulateOrExchange().

◆ UsePeak

constexpr EffectParameter LegacyCompressorBase::UsePeak

staticconstexprprotected

Initial value:

{
      &LegacyCompressorBase::mUsePeak, L"UsePeak", false, false, true, 1
   }

Definition at line 116 of file LegacyCompressorBase.h.

Referenced by Parameters(), and EffectLegacyCompressor::PopulateOrExchange().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LegacyCompressorBase()

◆ ~LegacyCompressorBase()

Member Function Documentation

◆ AvgCircle()

◆ DoCompression()

◆ FetchParameters()

◆ Follow()

◆ FreshenCircle()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ InitPass1()

◆ InitPass2()

◆ ManualPage()

◆ NewTrackPass1()

◆ Parameters()

◆ ProcessPass2()

◆ TwoBufferProcessPass1()

Member Data Documentation

◆ AttackTime

◆ mAttackFactor

◆ mAttackInverseFactor

◆ mAttackTime

◆ mCircle

◆ mCirclePos

◆ mCircleSize

◆ mCompression

◆ mDecayFactor

◆ mDecayTime

◆ mFollow1

◆ mFollow2

◆ mFollowLen

◆ mGain

◆ mLastLevel

◆ mMax

◆ mNoiseCounter

◆ mNoiseFloor

◆ mNoiseFloorDB

◆ mNormalize

◆ mRatio

◆ mRMSSum

◆ mThreshold

◆ mThresholdDB

◆ mUsePeak

◆ NoiseFloor

◆ Normalize

◆ Ratio

◆ ReleaseTime

◆ Symbol

◆ Threshold

◆ UsePeak