An Effect derived from EffectTwoPassSimpleMono. More...

#include <Compressor.h>

Inheritance diagram for EffectCompressor:

Collaboration diagram for EffectCompressor:

Public Member Functions
	EffectCompressor ()

virtual	~EffectCompressor ()

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

std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
	Add controls to effect panel; always succeeds. More...

bool	DoTransferDataFromWindow ()

bool	TransferDataToWindow (const EffectSettings &settings) override

bool	TransferDataFromWindow (EffectSettings &settings) override

Public Member Functions inherited from EffectTwoPassSimpleMono
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

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

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 NumericFormatSymbol	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)
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

void	SetTracks (TrackList *pTracks)

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

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 void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
	Calculate temporary tracks of limited length with effect applied and play. More...

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

Public Member Functions inherited from StatefulEffectUIServices
	~StatefulEffectUIServices () override

std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...

virtual std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)

virtual bool	TransferDataFromWindow (EffectSettings &settings)

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

virtual int	ShowHostInterface (EffectPlugin &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

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

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

static void	IncEffectCounter ()

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 Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Compressor") }

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

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

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

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

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

void	DisableSecondPass ()

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, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

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

void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
	Calculate temporary tracks of limited length with effect applied and play. More...

virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

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)

void	OnSlider (wxCommandEvent &evt)

void	UpdateUI ()

const EffectParameterMethods &	Parameters () const override

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}

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

EffectCompressorPanel *	mPanel

wxStaticText *	mThresholdLabel

wxSlider *	mThresholdSlider

wxStaticText *	mThresholdText

wxStaticText *	mNoiseFloorLabel

wxSlider *	mNoiseFloorSlider

wxStaticText *	mNoiseFloorText

wxStaticText *	mRatioLabel

wxSlider *	mRatioSlider

wxStaticText *	mRatioText

wxStaticText *	mAttackLabel

wxSlider *	mAttackSlider

wxStaticText *	mAttackText

wxStaticText *	mDecayLabel

wxSlider *	mDecaySlider

wxStaticText *	mDecayText

wxCheckBox *	mGainCheckBox

wxCheckBox *	mPeakCheckBox

Static Private 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

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 Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Public Attributes inherited from EffectBase
TrackList *	mTracks {}

Protected Attributes inherited from EffectTwoPassSimpleMono
int	mCurTrackNum

double	mCurRate

double	mCurT0

double	mCurT1

int	mCurChannel

int	mPass

bool	mSecondPassDisabled

std::shared_ptr< TrackList >	mWorkTracks

std::shared_ptr< TrackList > *	mTrackLists [2]

Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

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 28 of file Compressor.h.

Constructor & Destructor Documentation

◆ EffectCompressor()

EffectCompressor::EffectCompressor ( )

Definition at line 84 of file Compressor.cpp.

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

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectCompressor()

EffectCompressor::~EffectCompressor ( )

virtual

Definition at line 96 of file Compressor.cpp.

97{

98}

Member Function Documentation

◆ AvgCircle()

float EffectCompressor::AvgCircle ( float x )

private

Definition at line 441 of file Compressor.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, and mRMSSum.

Referenced by Follow().

Here is the caller graph for this function:

◆ DoCompression()

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

private

Definition at line 569 of file Compressor.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:

◆ DoTransferDataFromWindow()

bool EffectCompressor::DoTransferDataFromWindow ( )

Definition at line 305 of file Compressor.cpp.

{
   // To do:  eliminate this by using control validators instead
   mThresholdDB = (double) mThresholdSlider->GetValue();
   mNoiseFloorDB = (double) mNoiseFloorSlider->GetValue() / NoiseFloor.scale;
   mRatio = (double) mRatioSlider->GetValue() / Ratio.scale;
   mAttackTime = (double) mAttackSlider->GetValue() / 100.0; //AttackTime.scale;
   mDecayTime = (double) mDecaySlider->GetValue() / ReleaseTime.scale;
   mNormalize = mGainCheckBox->GetValue();
   mUsePeak = mPeakCheckBox->GetValue();
 
   return true;
}

References mAttackSlider, mAttackTime, mDecaySlider, mDecayTime, mGainCheckBox, mNoiseFloorDB, mNoiseFloorSlider, mNormalize, mPeakCheckBox, mRatio, mRatioSlider, mThresholdDB, mThresholdSlider, mUsePeak, NoiseFloor, Ratio, ReleaseTime, and EffectParameter< Structure, Member, Type, Value >::scale.

Referenced by OnSlider(), and TransferDataFromWindow().

Here is the caller graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 32 of file Compressor.h.

32{ return &e; }

◆ Follow()

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

private

Definition at line 456 of file Compressor.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 EffectCompressor::FreshenCircle ( )

private

Definition at line 432 of file Compressor.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 EffectCompressor::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 107 of file Compressor.cpp.

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

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectCompressor::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 102 of file Compressor.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType EffectCompressor::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 119 of file Compressor.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ InitPass1()

bool EffectCompressor::InitPass1 ( )

overrideprotectedvirtual

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 346 of file Compressor.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 EffectCompressor::InitPass2 ( )

overrideprotectedvirtual

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 368 of file Compressor.cpp.

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

References mNormalize.

◆ ManualPage()

ManualPageID EffectCompressor::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 112 of file Compressor.cpp.

{
   return L"Compressor";
}

◆ NewTrackPass1()

bool EffectCompressor::NewTrackPass1 ( )

overrideprotectedvirtual

Reimplemented from EffectTwoPassSimpleMono.

Definition at line 321 of file Compressor.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:

◆ OnSlider()

void EffectCompressor::OnSlider ( wxCommandEvent & evt )

private

Definition at line 587 of file Compressor.cpp.

{
   DoTransferDataFromWindow();
   UpdateUI();
}

References DoTransferDataFromWindow(), and UpdateUI().

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectCompressor::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 60 of file Compressor.cpp.

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

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

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectCompressor::PopulateOrExchange	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)

overridevirtual

Add controls to effect panel; always succeeds.

Returns: if not null, then return it from PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 160 of file Compressor.cpp.

{
   mUIParent = S.GetParent();
   S.SetBorder(5);
 
   S.StartHorizontalLay(wxEXPAND, true);
   {
      S.SetBorder(10);
      mPanel = safenew EffectCompressorPanel(S.GetParent(), wxID_ANY,
                                         mThresholdDB,
                                         mNoiseFloorDB,
                                         mRatio);
      S.Prop(true)
         .Position(wxEXPAND | wxALL)
         .MinSize( { 400, 200 } )
         .AddWindow(mPanel);
      S.SetBorder(5);
   }
   S.EndHorizontalLay();
 
   S.StartStatic( {} );
   {
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(1);
         mThresholdLabel = S.AddVariableText(XO("&Threshold:"), true,
            wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mThresholdSlider = S.Id(ID_Threshold)
            .Name(XO("Threshold"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {},
               Threshold.def * Threshold.scale,
               Threshold.max * Threshold.scale,
               Threshold.min * Threshold.scale);
         mThresholdText = S.AddVariableText(ThresholdFormat(999), true,
            wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
 
         mNoiseFloorLabel = S.AddVariableText(XO("&Noise Floor:"), true,
            wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mNoiseFloorSlider = S.Id(ID_NoiseFloor)
            .Name(XO("Noise Floor"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {},
               NoiseFloor.def * NoiseFloor.scale,
               NoiseFloor.max * NoiseFloor.scale,
               NoiseFloor.min * NoiseFloor.scale);
         mNoiseFloorText = S.AddVariableText(ThresholdFormat(999),
            true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
 
         mRatioLabel = S.AddVariableText(XO("&Ratio:"), true,
            wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mRatioSlider = S.Id(ID_Ratio)
            .Name(XO("Ratio"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {},
               Ratio.def * Ratio.scale,
               Ratio.max * Ratio.scale,
               Ratio.min * Ratio.scale);
         mRatioSlider->SetPageSize(5);
         mRatioText = S.AddVariableText(RatioTextFormat( 1, 99.9 ), true,
            wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
 
         /* i18n-hint: Particularly in percussion, sounds can be regarded as having
          * an 'attack' phase where the sound builds up and a 'decay' where the
          * sound dies away.  So this means 'onset duration'.  */
         mAttackLabel = S.AddVariableText(XO("&Attack Time:"), true,
            wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mAttackSlider = S.Id(ID_Attack)
         /* i18n-hint: Particularly in percussion, sounds can be regarded as having
          * an 'attack' phase where the sound builds up and a 'decay' where the
          * sound dies away.  So this means 'onset duration'.  */
            .Name(XO("Attack Time"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {},
               AttackTime.def * AttackTime.scale,
               AttackTime.max * AttackTime.scale,
               AttackTime.min * AttackTime.scale);
         mAttackText = S.AddVariableText(
            AttackTimeFormat(9.99),
            true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
 
         /* i18n-hint: Particularly in percussion, sounds can be regarded as having
          * an 'attack' phase where the sound builds up and a 'decay' or 'release' where the
          * sound dies away.  */
         mDecayLabel = S.AddVariableText(XO("R&elease Time:"), true,
            wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mDecaySlider = S.Id(ID_Decay)
         /* i18n-hint: Particularly in percussion, sounds can be regarded as having
          * an 'attack' phase where the sound builds up and a 'decay' or 'release' where the
          * sound dies away.  */
            .Name(XO("Release Time"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {},
               ReleaseTime.def * ReleaseTime.scale,
               ReleaseTime.max * ReleaseTime.scale,
               ReleaseTime.min * ReleaseTime.scale);
 
         mDecayText = S.AddVariableText(
            DecayTimeFormat(99.9),
            true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartHorizontalLay(wxCENTER, false);
   {
      /* i18n-hint: Make-up, i.e. correct for any reduction, rather than fabricate it.*/
      mGainCheckBox = S.AddCheckBox(XXO("Ma&ke-up gain for 0 dB after compressing"),
            Normalize.def);
      /* i18n-hint: "Compress" here means reduce variations of sound volume,
       NOT related to file-size compression; Peaks means extremes in volume */
      mPeakCheckBox = S.AddCheckBox(XXO("C&ompress based on Peaks"),
            UsePeak.def);
   }
   S.EndHorizontalLay();
   return nullptr;
}

References AttackTime, anonymous_namespace{Compressor.cpp}::AttackTimeFormat(), anonymous_namespace{Compressor.cpp}::DecayTimeFormat(), EffectParameter< Structure, Member, Type, Value >::def, ID_Attack, ID_Decay, ID_NoiseFloor, ID_Ratio, ID_Threshold, mAttackLabel, mAttackSlider, mAttackText, EffectParameter< Structure, Member, Type, Value >::max, mDecayLabel, mDecaySlider, mDecayText, mGainCheckBox, EffectParameter< Structure, Member, Type, Value >::min, mNoiseFloorDB, mNoiseFloorLabel, mNoiseFloorSlider, mNoiseFloorText, mPanel, mPeakCheckBox, mRatio, mRatioLabel, mRatioSlider, mRatioText, mThresholdDB, mThresholdLabel, mThresholdSlider, mThresholdText, mUIParent, NoiseFloor, Normalize, Ratio, anonymous_namespace{Compressor.cpp}::RatioTextFormat(), ReleaseTime, S, safenew, EffectParameter< Structure, Member, Type, Value >::scale, Threshold, anonymous_namespace{Compressor.cpp}::ThresholdFormat(), UsePeak, XO(), and XXO().

Here is the call graph for this function:

◆ ProcessPass2()

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

overrideprotected

Definition at line 421 of file Compressor.cpp.

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

References mMax.

◆ TransferDataFromWindow()

bool EffectCompressor::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 296 of file Compressor.cpp.

{
   if (!mUIParent->Validate())
   {
      return false;
   }
   return DoTransferDataFromWindow();
}

References DoTransferDataFromWindow(), and mUIParent.

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectCompressor::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 281 of file Compressor.cpp.

{
   mThresholdSlider->SetValue(lrint(mThresholdDB));
   mNoiseFloorSlider->SetValue(lrint(mNoiseFloorDB * NoiseFloor.scale));
   mRatioSlider->SetValue(lrint(mRatio * Ratio.scale));
   mAttackSlider->SetValue(lrint(mAttackTime * AttackTime.scale));
   mDecaySlider->SetValue(lrint(mDecayTime * ReleaseTime.scale));
   mGainCheckBox->SetValue(mNormalize);
   mPeakCheckBox->SetValue(mUsePeak);
 
   UpdateUI();
 
   return true;
}

References AttackTime, lrint, mAttackSlider, mAttackTime, mDecaySlider, mDecayTime, mGainCheckBox, mNoiseFloorDB, mNoiseFloorSlider, mNormalize, mPeakCheckBox, mRatio, mRatioSlider, mThresholdDB, mThresholdSlider, mUsePeak, NoiseFloor, Ratio, ReleaseTime, EffectParameter< Structure, Member, Type, Value >::scale, and UpdateUI().

Here is the call graph for this function:

◆ TwoBufferProcessPass1()

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

overrideprotected

Definition at line 378 of file Compressor.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:

◆ UpdateUI()

void EffectCompressor::UpdateUI ( )

private

Definition at line 593 of file Compressor.cpp.

{
   mThresholdLabel->SetName(wxString::Format(_("Threshold %d dB"), (int) mThresholdDB));
   mThresholdText->SetLabel(ThresholdFormat((int) mThresholdDB).Translation());
   mThresholdText->SetName(mThresholdText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mNoiseFloorLabel->SetName(wxString::Format(_("Noise Floor %d dB"), (int) mNoiseFloorDB));
   mNoiseFloorText->SetLabel(ThresholdFormat((int) mNoiseFloorDB).Translation());
   mNoiseFloorText->SetName(mNoiseFloorText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mRatioLabel->SetName(
      RatioLabelFormat(mRatioSlider->GetValue(), mRatio).Translation());
   mRatioText->SetLabel(
      RatioTextFormat(mRatioSlider->GetValue(), mRatio).Translation());
   mRatioText->SetName(mRatioText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mAttackLabel->SetName(wxString::Format(_("Attack Time %.2f secs"), mAttackTime));
   mAttackText->SetLabel(AttackTimeFormat(mAttackTime).Translation());
   mAttackText->SetName(mAttackText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mDecayLabel->SetName(wxString::Format(_("Release Time %.1f secs"), mDecayTime));
   mDecayText->SetLabel(DecayTimeFormat(mDecayTime).Translation());
   mDecayText->SetName(mDecayText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mPanel->Refresh(false);
 
   return;
}

References _, anonymous_namespace{Compressor.cpp}::AttackTimeFormat(), anonymous_namespace{Compressor.cpp}::DecayTimeFormat(), mAttackLabel, mAttackText, mAttackTime, mDecayLabel, mDecayText, mDecayTime, mNoiseFloorDB, mNoiseFloorLabel, mNoiseFloorText, mPanel, mRatio, mRatioLabel, mRatioSlider, mRatioText, mThresholdDB, mThresholdLabel, mThresholdText, anonymous_namespace{Compressor.cpp}::RatioLabelFormat(), anonymous_namespace{Compressor.cpp}::RatioTextFormat(), anonymous_namespace{Compressor.cpp}::ThresholdFormat(), and TranslatableString::Translation().

Referenced by OnSlider(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ AttackTime

constexpr EffectParameter EffectCompressor::AttackTime

staticconstexprprivate

Initial value:

{ &EffectCompressor::mAttackTime,

L"AttackTime", 0.2, 0.1, 5.0, 100 }

Definition at line 143 of file Compressor.h.

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

◆ mAttackFactor

double EffectCompressor::mAttackFactor

private

Definition at line 95 of file Compressor.h.

Referenced by Follow(), and NewTrackPass1().

◆ mAttackInverseFactor

double EffectCompressor::mAttackInverseFactor

private

Definition at line 96 of file Compressor.h.

Referenced by Follow(), and NewTrackPass1().

◆ mAttackLabel

wxStaticText* EffectCompressor::mAttackLabel

private

Definition at line 123 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mAttackSlider

wxSlider* EffectCompressor::mAttackSlider

private

Definition at line 124 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mAttackText

wxStaticText* EffectCompressor::mAttackText

private

Definition at line 125 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mAttackTime

double EffectCompressor::mAttackTime

private

Definition at line 87 of file Compressor.h.

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

◆ mCircle

Doubles EffectCompressor::mCircle

private

Definition at line 85 of file Compressor.h.

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

◆ mCirclePos

size_t EffectCompressor::mCirclePos

private

Definition at line 84 of file Compressor.h.

Referenced by AvgCircle(), and NewTrackPass1().

◆ mCircleSize

size_t EffectCompressor::mCircleSize

private

Definition at line 83 of file Compressor.h.

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

◆ mCompression

double EffectCompressor::mCompression

private

Definition at line 99 of file Compressor.h.

Referenced by DoCompression(), and NewTrackPass1().

◆ mDecayFactor

double EffectCompressor::mDecayFactor

private

Definition at line 97 of file Compressor.h.

Referenced by Follow(), and NewTrackPass1().

◆ mDecayLabel

wxStaticText* EffectCompressor::mDecayLabel

private

Definition at line 127 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mDecaySlider

wxSlider* EffectCompressor::mDecaySlider

private

Definition at line 128 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mDecayText

wxStaticText* EffectCompressor::mDecayText

private

Definition at line 129 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mDecayTime

double EffectCompressor::mDecayTime

private

Definition at line 94 of file Compressor.h.

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

◆ mFollow1

Floats EffectCompressor::mFollow1

private

Definition at line 104 of file Compressor.h.

Referenced by InitPass1(), and TwoBufferProcessPass1().

◆ mFollow2

Floats EffectCompressor::mFollow2

private

Definition at line 104 of file Compressor.h.

Referenced by InitPass1(), and TwoBufferProcessPass1().

◆ mFollowLen

size_t EffectCompressor::mFollowLen

private

Definition at line 105 of file Compressor.h.

Referenced by InitPass1(), and TwoBufferProcessPass1().

◆ mGain

double EffectCompressor::mGain

private

Definition at line 102 of file Compressor.h.

◆ mGainCheckBox

wxCheckBox* EffectCompressor::mGainCheckBox

private

Definition at line 131 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mLastLevel

double EffectCompressor::mLastLevel

private

Definition at line 103 of file Compressor.h.

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

◆ mMax

double EffectCompressor::mMax

private

Definition at line 107 of file Compressor.h.

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

◆ mNoiseCounter

int EffectCompressor::mNoiseCounter

private

Definition at line 101 of file Compressor.h.

Referenced by Follow(), and NewTrackPass1().

◆ mNoiseFloor

double EffectCompressor::mNoiseFloor

private

Definition at line 100 of file Compressor.h.

Referenced by Follow(), and NewTrackPass1().

◆ mNoiseFloorDB

double EffectCompressor::mNoiseFloorDB

private

Definition at line 89 of file Compressor.h.

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

◆ mNoiseFloorLabel

wxStaticText* EffectCompressor::mNoiseFloorLabel

private

Definition at line 115 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mNoiseFloorSlider

wxSlider* EffectCompressor::mNoiseFloorSlider

private

Definition at line 116 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mNoiseFloorText

wxStaticText* EffectCompressor::mNoiseFloorText

private

Definition at line 117 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mNormalize

bool EffectCompressor::mNormalize

private

Definition at line 91 of file Compressor.h.

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

◆ mPanel

EffectCompressorPanel* EffectCompressor::mPanel

private

Definition at line 109 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mPeakCheckBox

wxCheckBox* EffectCompressor::mPeakCheckBox

private

Definition at line 132 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mRatio

double EffectCompressor::mRatio

private

Definition at line 90 of file Compressor.h.

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

◆ mRatioLabel

wxStaticText* EffectCompressor::mRatioLabel

private

Definition at line 119 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mRatioSlider

wxSlider* EffectCompressor::mRatioSlider

private

Definition at line 120 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), TransferDataToWindow(), and UpdateUI().

◆ mRatioText

wxStaticText* EffectCompressor::mRatioText

private

Definition at line 121 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mRMSSum

double EffectCompressor::mRMSSum

private

Definition at line 82 of file Compressor.h.

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

◆ mThreshold

double EffectCompressor::mThreshold

private

Definition at line 98 of file Compressor.h.

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

◆ mThresholdDB

double EffectCompressor::mThresholdDB

private

Definition at line 88 of file Compressor.h.

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

◆ mThresholdLabel

wxStaticText* EffectCompressor::mThresholdLabel

private

Definition at line 111 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mThresholdSlider

wxSlider* EffectCompressor::mThresholdSlider

private

Definition at line 112 of file Compressor.h.

Referenced by DoTransferDataFromWindow(), PopulateOrExchange(), and TransferDataToWindow().

◆ mThresholdText

wxStaticText* EffectCompressor::mThresholdText

private

Definition at line 113 of file Compressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mUIParent

wxWeakRef<wxWindow> EffectCompressor::mUIParent {}

private

Definition at line 80 of file Compressor.h.

Referenced by PopulateOrExchange(), and TransferDataFromWindow().

◆ mUsePeak

bool EffectCompressor::mUsePeak

private

Definition at line 92 of file Compressor.h.

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

◆ NoiseFloor

constexpr EffectParameter EffectCompressor::NoiseFloor

staticconstexprprivate

Initial value:

{ &EffectCompressor::mNoiseFloorDB,

L"NoiseFloor", -40.0, -80.0, -20.0, 0.2 }

Definition at line 139 of file Compressor.h.

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

◆ Normalize

constexpr EffectParameter EffectCompressor::Normalize

staticconstexprprivate

Initial value:

{ &EffectCompressor::mNormalize,

L"Normalize", true, false, true, 1 }

Definition at line 147 of file Compressor.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Ratio

constexpr EffectParameter EffectCompressor::Ratio

staticconstexprprivate

Initial value:

{ &EffectCompressor::mRatio,

L"Ratio", 2.0, 1.1, 10.0, 10 }

Definition at line 141 of file Compressor.h.

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

◆ ReleaseTime

constexpr EffectParameter EffectCompressor::ReleaseTime

staticconstexprprivate

Initial value:

{ &EffectCompressor::mDecayTime,

L"ReleaseTime", 1.0, 1.0, 30.0, 10 }

Definition at line 145 of file Compressor.h.

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

◆ Symbol

const ComponentInterfaceSymbol EffectCompressor::Symbol { XO("Compressor") }

static

Definition at line 34 of file Compressor.h.

Referenced by GetSymbol().

◆ Threshold

constexpr EffectParameter EffectCompressor::Threshold

staticconstexprprivate

Initial value:

{ &EffectCompressor::mThresholdDB,

L"Threshold", -12.0, -60.0, -1.0, 1 }

Definition at line 137 of file Compressor.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ UsePeak

constexpr EffectParameter EffectCompressor::UsePeak

staticconstexprprivate

Initial value:

{ &EffectCompressor::mUsePeak,

L"UsePeak", false, false, true, 1 }

Definition at line 149 of file Compressor.h.

Referenced by Parameters(), and 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

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectCompressor()

◆ ~EffectCompressor()

Member Function Documentation

◆ AvgCircle()

◆ DoCompression()

◆ DoTransferDataFromWindow()

◆ FetchParameters()

◆ Follow()

◆ FreshenCircle()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ InitPass1()

◆ InitPass2()

◆ ManualPage()

◆ NewTrackPass1()

◆ OnSlider()

◆ Parameters()

◆ PopulateOrExchange()

◆ ProcessPass2()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ TwoBufferProcessPass1()

◆ UpdateUI()

Member Data Documentation

◆ AttackTime

◆ mAttackFactor

◆ mAttackInverseFactor

◆ mAttackLabel

◆ mAttackSlider

◆ mAttackText

◆ mAttackTime

◆ mCircle

◆ mCirclePos

◆ mCircleSize

◆ mCompression

◆ mDecayFactor

◆ mDecayLabel

◆ mDecaySlider

◆ mDecayText

◆ mDecayTime

◆ mFollow1

◆ mFollow2

◆ mFollowLen

◆ mGain

◆ mGainCheckBox

◆ mLastLevel

◆ mMax

◆ mNoiseCounter

◆ mNoiseFloor

◆ mNoiseFloorDB

◆ mNoiseFloorLabel

◆ mNoiseFloorSlider

◆ mNoiseFloorText

◆ mNormalize

◆ mPanel

◆ mPeakCheckBox

◆ mRatio

◆ mRatioLabel

◆ mRatioSlider

◆ mRatioText

◆ mRMSSum

◆ mThreshold

◆ mThresholdDB

◆ mThresholdLabel

◆ mThresholdSlider

◆ mThresholdText

◆ mUIParent

◆ mUsePeak

◆ NoiseFloor