An Effect to bring the loudness level up to a chosen level. More...

#include <Loudness.h>

Inheritance diagram for EffectLoudness:

Collaboration diagram for EffectLoudness:

Public Types
enum	kNormalizeTargets { kLoudness , kRMS , nAlgos }

Public Types inherited from StatefulEffectBase
using	MessagePackage = EffectInstance::MessagePackage

Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

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

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

Public Member Functions
	EffectLoudness ()

virtual	~EffectLoudness ()

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

bool	Process (EffectInstance &instance, EffectSettings &settings) override
	Actually do the effect here. More...

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

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

Public Member Functions inherited from StatefulEffect
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 ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

virtual bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual 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

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

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override

EffectUIClientInterface *	GetEffectUIClientInterface () override
	Returns the EffectUIClientInterface instance for this effect. More...

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

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

OptionalMessage	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
	Usually applies factory to self and given access. More...

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

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

unsigned	TestUIFlags (unsigned mask)

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

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const

bool	EnableApply (bool enable=true)

wxWindow *	GetUIParent ()

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

void	SetTracks (TrackList *pTracks)

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0

virtual bool	IsGraphicalUI ()=0

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

virtual bool	CanExportPresets ()=0

virtual void	ExportPresets (const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

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

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
	Usually applies factory to self and given access. More...

virtual EffectUIClientInterface *	GetEffectUIClientInterface ()=0
	Returns the EffectUIClientInterface instance for this effect. More...

virtual void	Preview (EffectSettingsAccess &access, bool dryOnly)=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, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
	Unfortunately complicated dual-use function. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)=0
	Update controls for the settings. More...

virtual bool	TransferDataFromWindow (EffectSettings &settings)=0
	Update the given settings from controls. More...

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 EffectLoudness *	FetchParameters (EffectLoudness &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 Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Loudness Normalization") }

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

Private Member Functions
void	AllocBuffers ()

void	FreeBuffers ()

bool	GetTrackRMS (WaveTrack *track, float &rms)

bool	ProcessOne (TrackIterRange< WaveTrack > range, bool analyse)

void	LoadBufferBlock (TrackIterRange< WaveTrack > range, sampleCount pos, size_t len)

bool	AnalyseBufferBlock ()

bool	ProcessBufferBlock ()

void	StoreBufferBlock (TrackIterRange< WaveTrack > range, sampleCount pos, size_t len)

bool	UpdateProgress ()

void	OnChoice (wxCommandEvent &evt)

void	OnUpdateUI (wxCommandEvent &evt)

void	UpdateUI ()

const EffectParameterMethods &	Parameters () const override

Private Attributes
bool	mStereoInd

double	mLUFSLevel

double	mRMSLevel

bool	mDualMono

int	mNormalizeTo

double	mCurT0

double	mCurT1

double	mProgressVal

int	mSteps

TranslatableString	mProgressMsg

double	mTrackLen

double	mCurRate

float	mMult

float	mRatio

float	mRMS [2]

std::unique_ptr< EBUR128 >	mLoudnessProcessor

wxSimplebook *	mBook

wxChoice *	mChoice

wxStaticText *	mWarning

wxCheckBox *	mStereoIndCheckBox

wxCheckBox *	mDualMonoCheckBox

Floats	mTrackBuffer [2]

size_t	mTrackBufferLen

size_t	mTrackBufferCapacity

bool	mProcStereo

Static Private Attributes
static constexpr EffectParameter	StereoInd

static constexpr EffectParameter	LUFSLevel

static constexpr EffectParameter	RMSLevel

static constexpr EffectParameter	DualMono

static constexpr EffectParameter	NormalizeTo

Additional Inherited Members
Protected Member Functions inherited from Effect
bool	EnablePreview (bool enable=true)

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

virtual std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. 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)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

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

Protected Member Functions inherited from EffectBase
void	Preview (EffectSettingsAccess &access, bool dryOnly) override

bool	DoEffect (EffectSettings &settings, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
	Unfortunately complicated dual-use function. 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

Protected Attributes inherited from Effect
wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWindow *	mUIParent {}

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 to bring the loudness level up to a chosen level.

Definition at line 31 of file Loudness.h.

Member Enumeration Documentation

◆ kNormalizeTargets

enum EffectLoudness::kNormalizeTargets

Enumerator
kLoudness
kRMS
nAlgos

Definition at line 34 of file Loudness.h.

   {
      kLoudness,
      kRMS,
      nAlgos
   };

Constructor & Destructor Documentation

◆ EffectLoudness()

EffectLoudness::EffectLoudness ( )

Definition at line 61 of file Loudness.cpp.

{
   Parameters().Reset(*this);
   SetLinearEffectFlag(false);
}

References 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:

◆ ~EffectLoudness()

EffectLoudness::~EffectLoudness ( )

virtual

Definition at line 67 of file Loudness.cpp.

68{

69}

Member Function Documentation

◆ AllocBuffers()

void EffectLoudness::AllocBuffers ( )

private

Get required buffer size for the largest whole track and allocate buffers. This reduces the amount of allocations required.

Definition at line 340 of file Loudness.cpp.

{
   mTrackBufferCapacity = 0;
   bool stereoTrackFound = false;
   double maxSampleRate = 0;
   mProcStereo = false;
 
   for(auto track : mOutputTracks->Selected<WaveTrack>() + &Track::Any)
   {
      mTrackBufferCapacity = std::max(mTrackBufferCapacity, track->GetMaxBlockSize());
      maxSampleRate = std::max(maxSampleRate, track->GetRate());
 
      // There is a stereo track
      if(track->IsLeader())
         stereoTrackFound = true;
   }
 
   // Initiate a processing buffer. This buffer will (most likely)
   // be shorter than the length of the track being processed.
   mTrackBuffer[0].reinit(mTrackBufferCapacity);
 
   if(!mStereoInd && stereoTrackFound)
      mTrackBuffer[1].reinit(mTrackBufferCapacity);
}

References Track::Any(), EffectBase::mOutputTracks, mProcStereo, mStereoInd, mTrackBuffer, mTrackBufferCapacity, and ArrayOf< X >::reinit().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AnalyseBufferBlock()

bool EffectLoudness::AnalyseBufferBlock ( )

private

Calculates sample sum (for DC) and EBU R128 weighted square sum (for loudness).

Definition at line 453 of file Loudness.cpp.

{
   for(size_t i = 0; i < mTrackBufferLen; i++)
   {
      mLoudnessProcessor->ProcessSampleFromChannel(mTrackBuffer[0][i], 0);
      if(mProcStereo)
         mLoudnessProcessor->ProcessSampleFromChannel(mTrackBuffer[1][i], 1);
      mLoudnessProcessor->NextSample();
   }
 
   if(!UpdateProgress())
      return false;
   return true;
}

References mLoudnessProcessor, mProcStereo, mTrackBuffer, mTrackBufferLen, and UpdateProgress().

Referenced by ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 42 of file Loudness.h.

42{ return &e; }

◆ FreeBuffers()

void EffectLoudness::FreeBuffers ( )

private

Definition at line 365 of file Loudness.cpp.

{
   mTrackBuffer[0].reset();
   mTrackBuffer[1].reset();
}

References mTrackBuffer.

Referenced by Process().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString EffectLoudness::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 78 of file Loudness.cpp.

{
   return XO("Sets the loudness of one or more tracks");
}

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectLoudness::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 73 of file Loudness.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetTrackRMS()

bool EffectLoudness::GetTrackRMS	(	WaveTrack *	track,
		float &	rms
	)

private

Definition at line 371 of file Loudness.cpp.

{
   // set mRMS.  No progress bar here as it's fast.
   float _rms = track->GetRMS(mCurT0, mCurT1); // may throw
   rms = _rms;
   return true;
}

References WaveTrack::GetRMS(), mCurT0, and mCurT1.

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetType()

EffectType EffectLoudness::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 90 of file Loudness.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ LoadBufferBlock()

void EffectLoudness::LoadBufferBlock	(	TrackIterRange< WaveTrack >	range,
		sampleCount	pos,
		size_t	len
	)

private

Definition at line 438 of file Loudness.cpp.

{
   // Get the samples from the track and put them in the buffer
   int idx = 0;
   for(auto channel : range)
   {
      channel->GetFloats(mTrackBuffer[idx].get(), pos, len );
      ++idx;
   }
   mTrackBufferLen = len;
}

References mTrackBuffer, and mTrackBufferLen.

Referenced by ProcessOne().

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID EffectLoudness::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 83 of file Loudness.cpp.

{
   return L"Loudness_Normalization";
}

◆ OnChoice()

void EffectLoudness::OnChoice ( wxCommandEvent & evt )

private

Definition at line 501 of file Loudness.cpp.

{
   mChoice->GetValidator()->TransferFromWindow();
   mBook->SetSelection( mNormalizeTo );
   UpdateUI();
   mDualMonoCheckBox->Enable(mNormalizeTo == kLoudness);
}

References kLoudness, mBook, mChoice, mDualMonoCheckBox, mNormalizeTo, and UpdateUI().

Referenced by TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnUpdateUI()

void EffectLoudness::OnUpdateUI ( wxCommandEvent & evt )

private

Definition at line 509 of file Loudness.cpp.

{
   UpdateUI();
}

References UpdateUI().

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectLoudness::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 42 of file Loudness.cpp.

{
   static CapturedParameters<EffectLoudness,
      StereoInd, LUFSLevel, RMSLevel, DualMono, NormalizeTo
   > parameters;
   return parameters;
}

References DualMono, EffectLoudness(), LUFSLevel, NormalizeTo, RMSLevel, and StereoInd.

Referenced by EffectLoudness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectLoudness::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 Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

Reimplemented from Effect.

Definition at line 215 of file Loudness.cpp.

{
   S.StartVerticalLay(0);
   {
      S.StartMultiColumn(2, wxALIGN_CENTER);
      {
         S.StartVerticalLay(false);
         {
            S.StartHorizontalLay(wxALIGN_LEFT, false);
            {
               S.AddVariableText(XO("&Normalize"), false,
                  wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
 
               mChoice = S
                  .Validator<wxGenericValidator>( &mNormalizeTo )
                  .AddChoice( {},
                     Msgids(kNormalizeTargetStrings, nAlgos),
                     mNormalizeTo );
               S
                  .AddVariableText(XO("t&o"), false,
                     wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
 
               // Use a notebook so we can have two controls but show only one
               // They target different variables with their validators
               mBook =
               S
                  .StartSimplebook();
               {
                  S.StartNotebookPage({});
                  {
                     S.StartHorizontalLay(wxALIGN_LEFT, false);
                     {
                        S
                           /* i18n-hint: LUFS is a particular method for measuring loudnesss */
                           .Name( XO("Loudness LUFS") )
                           .Validator<FloatingPointValidator<double>>(
                              2, &mLUFSLevel,
                              NumValidatorStyle::ONE_TRAILING_ZERO,
                              LUFSLevel.min, LUFSLevel.max )
                           .AddTextBox( {}, L"", 10);
 
                        /* i18n-hint: LUFS is a particular method for measuring loudnesss */
                        S
                           .AddVariableText(XO("LUFS"), false,
                              wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
                     }
                     S.EndHorizontalLay();
                  }
                  S.EndNotebookPage();
 
                  S.StartNotebookPage({});
                  {
                     S.StartHorizontalLay(wxALIGN_LEFT, false);
                     {
                        S
                           .Name( XO("RMS dB") )
                           .Validator<FloatingPointValidator<double>>(
                              2, &mRMSLevel,
                              NumValidatorStyle::ONE_TRAILING_ZERO,
                              RMSLevel.min, RMSLevel.max )
                           .AddTextBox( {}, L"", 10);
 
                        S
                           .AddVariableText(XO("dB"), false,
                              wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
                     }
                     S.EndHorizontalLay();
                  }
                  S.EndNotebookPage();
               }
               S.EndSimplebook();
 
               mWarning =
               S
                  .AddVariableText( {}, false,
                     wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            }
            S.EndHorizontalLay();
 
            mStereoIndCheckBox = S
               .Validator<wxGenericValidator>( &mStereoInd )
               .AddCheckBox(XXO("Normalize &stereo channels independently"),
                  mStereoInd );
 
            mDualMonoCheckBox = S
               .Validator<wxGenericValidator>( &mDualMono )
               .AddCheckBox(XXO("&Treat mono as dual-mono (recommended)"),
                  mDualMono );
         }
         S.EndVerticalLay();
      }
      S.EndMultiColumn();
   }
   S.EndVerticalLay();
   return nullptr;
}

References kNormalizeTargetStrings, LUFSLevel, EffectParameter< Structure, Member, Type, Value >::max, mBook, mChoice, mDualMono, mDualMonoCheckBox, EffectParameter< Structure, Member, Type, Value >::min, mLUFSLevel, mNormalizeTo, mRMSLevel, Msgids(), mStereoInd, mStereoIndCheckBox, mWarning, nAlgos, RMSLevel, S, XO, and XXO.

Here is the call graph for this function:

◆ Process()

bool EffectLoudness::Process	(	EffectInstance &	instance,
		EffectSettings &	settings
	)

overridevirtual

Actually do the effect here.

Returns: success

Implements StatefulEffectBase.

Definition at line 97 of file Loudness.cpp.

{
   if(mNormalizeTo == kLoudness)
      // LU use 10*log10(...) instead of 20*log10(...)
      // so multiply level by 2 and use standard DB_TO_LINEAR macro.
      mRatio = DB_TO_LINEAR(std::clamp<double>(mLUFSLevel*2, LUFSLevel.min, LUFSLevel.max));
   else // RMS
      mRatio = DB_TO_LINEAR(std::clamp<double>(mRMSLevel, RMSLevel.min, RMSLevel.max));
 
   // Iterate over each track
   this->CopyInputTracks(); // Set up mOutputTracks.
   bool bGoodResult = true;
   auto topMsg = XO("Normalizing Loudness...\n");
 
   AllocBuffers();
   mProgressVal = 0;
 
   for(auto track : mOutputTracks->Selected<WaveTrack>()
       + (mStereoInd ? &Track::Any : &Track::IsLeader))
   {
      // Get start and end times from track
      // PRL: No accounting for multiple channels ?
      double trackStart = track->GetStartTime();
      double trackEnd = track->GetEndTime();
 
      // Set the current bounds to whichever left marker is
      // greater and whichever right marker is less:
      mCurT0 = mT0 < trackStart? trackStart: mT0;
      mCurT1 = mT1 > trackEnd? trackEnd: mT1;
 
      // Get the track rate
      mCurRate = track->GetRate();
 
      wxString msg;
      auto trackName = track->GetName();
      mSteps = 2;
 
      mProgressMsg =
         topMsg + XO("Analyzing: %s").Format( trackName );
 
      auto range = mStereoInd
         ? TrackList::SingletonRange(track)
         : TrackList::Channels(track);
 
      mProcStereo = range.size() > 1;
 
      if(mNormalizeTo == kLoudness)
      {
         mLoudnessProcessor.reset(safenew EBUR128(mCurRate, range.size()));
         mLoudnessProcessor->Initialize();
         if(!ProcessOne(range, true))
         {
            // Processing failed -> abort
            bGoodResult = false;
            break;
         }
      }
      else // RMS
      {
         size_t idx = 0;
         for(auto channel : range)
         {
            if(!GetTrackRMS(channel, mRMS[idx]))
            {
               bGoodResult = false;
               return false;
            }
            ++idx;
         }
         mSteps = 1;
      }
 
      // Calculate normalization values the analysis results
      float extent;
      if(mNormalizeTo == kLoudness)
         extent = mLoudnessProcessor->IntegrativeLoudness();
      else // RMS
      {
         extent = mRMS[0];
         if(mProcStereo)
            // RMS: use average RMS, average must be calculated in quadratic domain.
            extent = sqrt((mRMS[0] * mRMS[0] + mRMS[1] * mRMS[1]) / 2.0);
      }
 
      if(extent == 0.0)
      {
         mLoudnessProcessor.reset();
         FreeBuffers();
         return false;
      }
      mMult = mRatio / extent;
 
      if(mNormalizeTo == kLoudness)
      {
         // Target half the LUFS value if mono (or independent processed stereo)
         // shall be treated as dual mono.
         if(range.size() == 1 && (mDualMono || track->GetChannel() != Track::MonoChannel))
            mMult /= 2.0;
 
         // LUFS are related to square values so the multiplier must be the root.
         mMult = sqrt(mMult);
      }
 
      mProgressMsg = topMsg + XO("Processing: %s").Format( trackName );
      if(!ProcessOne(range, false))
      {
         // Processing failed -> abort
         bGoodResult = false;
         break;
      }
   }
 
   this->ReplaceProcessedTracks(bGoodResult);
   mLoudnessProcessor.reset();
   FreeBuffers();
   return bGoodResult;
}

References AllocBuffers(), Track::Any(), TrackList::Channels(), Effect::CopyInputTracks(), DB_TO_LINEAR, FreeBuffers(), GetTrackRMS(), Track::IsLeader(), kLoudness, LUFSLevel, EffectParameter< Structure, Member, Type, Value >::max, mCurRate, mCurT0, mCurT1, mDualMono, EffectParameter< Structure, Member, Type, Value >::min, mLoudnessProcessor, mLUFSLevel, mMult, mNormalizeTo, Track::MonoChannel, EffectBase::mOutputTracks, mProcStereo, mProgressMsg, mProgressVal, mRatio, mRMS, mRMSLevel, mSteps, mStereoInd, EffectBase::mT0, EffectBase::mT1, ProcessOne(), EffectBase::ReplaceProcessedTracks(), RMSLevel, safenew, TrackList::SingletonRange(), and XO.

Here is the call graph for this function:

◆ ProcessBufferBlock()

bool EffectLoudness::ProcessBufferBlock ( )

private

Definition at line 468 of file Loudness.cpp.

{
   for(size_t i = 0; i < mTrackBufferLen; i++)
   {
      mTrackBuffer[0][i] = mTrackBuffer[0][i] * mMult;
      if(mProcStereo)
         mTrackBuffer[1][i] = mTrackBuffer[1][i] * mMult;
   }
 
   if(!UpdateProgress())
      return false;
   return true;
}

References mMult, mProcStereo, mTrackBuffer, mTrackBufferLen, and UpdateProgress().

Referenced by ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessOne()

bool EffectLoudness::ProcessOne	(	TrackIterRange< WaveTrack >	range,
		bool	analyse
	)

private

ProcessOne() takes a track, transforms it to bunch of buffer-blocks, and executes ProcessData, on it... uses mMult to normalize a track. mMult must be set before this is called In analyse mode, it executes the selected analyse operation on it... mMult does not have to be set before this is called

Definition at line 385 of file Loudness.cpp.

{
   WaveTrack* track = *range.begin();
 
   // Transform the marker timepoints to samples
   auto start = track->TimeToLongSamples(mCurT0);
   auto end   = track->TimeToLongSamples(mCurT1);
 
   // Get the length of the buffer (as double). len is
   // used simply to calculate a progress meter, so it is easier
   // to make it a double now than it is to do it later
   mTrackLen = (end - start).as_double();
 
   // Abort if the right marker is not to the right of the left marker
   if(mCurT1 <= mCurT0)
      return false;
 
   // Go through the track one buffer at a time. s counts which
   // sample the current buffer starts at.
   auto s = start;
   while(s < end)
   {
      // Get a block of samples (smaller than the size of the buffer)
      // Adjust the block size if it is the final block in the track
      auto blockLen = limitSampleBufferSize(
         track->GetBestBlockSize(s),
         mTrackBufferCapacity);
 
      const size_t remainingLen = (end - s).as_size_t();
      blockLen = blockLen > remainingLen ? remainingLen : blockLen;
      LoadBufferBlock(range, s, blockLen);
 
      // Process the buffer.
      if(analyse)
      {
         if(!AnalyseBufferBlock())
            return false;
      }
      else
      {
         if(!ProcessBufferBlock())
            return false;
         StoreBufferBlock(range, s, blockLen);
      }
 
      // Increment s one blockfull of samples
      s += blockLen;
   }
 
   // Return true because the effect processing succeeded ... unless cancelled
   return true;
}

References AnalyseBufferBlock(), IteratorRange< Iterator >::begin(), PackedArray::end(), WaveTrack::GetBestBlockSize(), limitSampleBufferSize(), LoadBufferBlock(), mCurT0, mCurT1, mTrackBufferCapacity, mTrackLen, ProcessBufferBlock(), StoreBufferBlock(), and SampleTrack::TimeToLongSamples().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StoreBufferBlock()

void EffectLoudness::StoreBufferBlock	(	TrackIterRange< WaveTrack >	range,
		sampleCount	pos,
		size_t	len
	)

private

Definition at line 482 of file Loudness.cpp.

{
   int idx = 0;
   for(auto channel : range)
   {
      // Copy the newly-changed samples back onto the track.
      channel->Set((samplePtr) mTrackBuffer[idx].get(), floatSample, pos, len);
      ++idx;
   }
}

References floatSample, and mTrackBuffer.

Referenced by ProcessOne().

Here is the caller graph for this function:

◆ TransferDataFromWindow()

bool EffectLoudness::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls.

Reimplemented from Effect.

Definition at line 327 of file Loudness.cpp.

{
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
   return true;
}

References Effect::mUIParent.

◆ TransferDataToWindow()

bool EffectLoudness::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings.

Reimplemented from Effect.

Definition at line 314 of file Loudness.cpp.

{
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   // adjust controls which depend on mchoice
   wxCommandEvent dummy;
   OnChoice(dummy);
   return true;
}

References Effect::mUIParent, and OnChoice().

Here is the call graph for this function:

◆ UpdateProgress()

bool EffectLoudness::UpdateProgress ( )

private

Definition at line 494 of file Loudness.cpp.

{
   mProgressVal += (double(1+mProcStereo) * double(mTrackBufferLen)
                 / (double(GetNumWaveTracks()) * double(mSteps) * mTrackLen));
   return !TotalProgress(mProgressVal, mProgressMsg);
}

References Effect::GetNumWaveTracks(), mProcStereo, mProgressMsg, mProgressVal, mSteps, mTrackBufferLen, mTrackLen, and Effect::TotalProgress().

Referenced by AnalyseBufferBlock(), and ProcessBufferBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateUI()

void EffectLoudness::UpdateUI ( )

private

Definition at line 514 of file Loudness.cpp.

{
   if (!mUIParent->TransferDataFromWindow())
   {
      mWarning->SetLabel(_("(Maximum 0dB)"));
      // TODO: recalculate layout here
      EnableApply(false);
      return;
   }
   mWarning->SetLabel(wxT(""));
   EnableApply(true);
}

References _, Effect::EnableApply(), Effect::mUIParent, mWarning, and wxT().

Referenced by OnChoice(), and OnUpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ DualMono

constexpr EffectParameter EffectLoudness::DualMono

staticconstexprprivate

Initial value:

{ &EffectLoudness::mDualMono,

L"DualMono", true, false, true, 1 }

Definition at line 126 of file Loudness.h.

Referenced by Parameters().

◆ LUFSLevel

constexpr EffectParameter EffectLoudness::LUFSLevel

staticconstexprprivate

Initial value:

{ &EffectLoudness::mLUFSLevel,

L"LUFSLevel", -23.0, -145.0, 0.0, 1 }

Definition at line 122 of file Loudness.h.

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

◆ mBook

wxSimplebook* EffectLoudness::mBook

private

Definition at line 106 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mChoice

wxChoice* EffectLoudness::mChoice

private

Definition at line 107 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mCurRate

double EffectLoudness::mCurRate

private

Definition at line 99 of file Loudness.h.

Referenced by Process().

◆ mCurT0

double EffectLoudness::mCurT0

private

Definition at line 93 of file Loudness.h.

Referenced by GetTrackRMS(), Process(), and ProcessOne().

◆ mCurT1

double EffectLoudness::mCurT1

private

Definition at line 94 of file Loudness.h.

Referenced by GetTrackRMS(), Process(), and ProcessOne().

◆ mDualMono

bool EffectLoudness::mDualMono

private

Definition at line 90 of file Loudness.h.

Referenced by PopulateOrExchange(), and Process().

◆ mDualMonoCheckBox

wxCheckBox* EffectLoudness::mDualMonoCheckBox

private

Definition at line 110 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mLoudnessProcessor

std::unique_ptr<EBUR128> EffectLoudness::mLoudnessProcessor

private

Definition at line 104 of file Loudness.h.

Referenced by AnalyseBufferBlock(), and Process().

◆ mLUFSLevel

double EffectLoudness::mLUFSLevel

private

Definition at line 88 of file Loudness.h.

Referenced by PopulateOrExchange(), and Process().

◆ mMult

float EffectLoudness::mMult

private

Definition at line 101 of file Loudness.h.

Referenced by Process(), and ProcessBufferBlock().

◆ mNormalizeTo

int EffectLoudness::mNormalizeTo

private

Definition at line 91 of file Loudness.h.

Referenced by OnChoice(), PopulateOrExchange(), and Process().

◆ mProcStereo

bool EffectLoudness::mProcStereo

private

Definition at line 115 of file Loudness.h.

Referenced by AllocBuffers(), AnalyseBufferBlock(), Process(), ProcessBufferBlock(), and UpdateProgress().

◆ mProgressMsg

TranslatableString EffectLoudness::mProgressMsg

private

Definition at line 97 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mProgressVal

double EffectLoudness::mProgressVal

private

Definition at line 95 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mRatio

float EffectLoudness::mRatio

private

Definition at line 102 of file Loudness.h.

Referenced by Process().

◆ mRMS

float EffectLoudness::mRMS[2]

private

Definition at line 103 of file Loudness.h.

Referenced by Process().

◆ mRMSLevel

double EffectLoudness::mRMSLevel

private

Definition at line 89 of file Loudness.h.

Referenced by PopulateOrExchange(), and Process().

◆ mSteps

int EffectLoudness::mSteps

private

Definition at line 96 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mStereoInd

bool EffectLoudness::mStereoInd

private

Definition at line 87 of file Loudness.h.

Referenced by AllocBuffers(), PopulateOrExchange(), and Process().

◆ mStereoIndCheckBox

wxCheckBox* EffectLoudness::mStereoIndCheckBox

private

Definition at line 109 of file Loudness.h.

Referenced by PopulateOrExchange().

◆ mTrackBuffer

Floats EffectLoudness::mTrackBuffer[2]

private

Definition at line 112 of file Loudness.h.

Referenced by AllocBuffers(), AnalyseBufferBlock(), FreeBuffers(), LoadBufferBlock(), ProcessBufferBlock(), and StoreBufferBlock().

◆ mTrackBufferCapacity

size_t EffectLoudness::mTrackBufferCapacity

private

Definition at line 114 of file Loudness.h.

Referenced by AllocBuffers(), and ProcessOne().

◆ mTrackBufferLen

size_t EffectLoudness::mTrackBufferLen

private

Definition at line 113 of file Loudness.h.

Referenced by AnalyseBufferBlock(), LoadBufferBlock(), ProcessBufferBlock(), and UpdateProgress().

◆ mTrackLen

double EffectLoudness::mTrackLen

private

Definition at line 98 of file Loudness.h.

Referenced by ProcessOne(), and UpdateProgress().

◆ mWarning

wxStaticText* EffectLoudness::mWarning

private

Definition at line 108 of file Loudness.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ NormalizeTo

constexpr EffectParameter EffectLoudness::NormalizeTo

staticconstexprprivate

Initial value:

{ &EffectLoudness::mNormalizeTo,

L"NormalizeTo", (int)kLoudness , 0 , nAlgos-1, 1 }

Definition at line 128 of file Loudness.h.

Referenced by Parameters().

◆ RMSLevel

constexpr EffectParameter EffectLoudness::RMSLevel

staticconstexprprivate

Initial value:

{ &EffectLoudness::mRMSLevel,

L"RMSLevel", -20.0, -145.0, 0.0, 1 }

Definition at line 124 of file Loudness.h.

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

◆ StereoInd

constexpr EffectParameter EffectLoudness::StereoInd

staticconstexprprivate

Initial value:

{ &EffectLoudness::mStereoInd,

L"StereoIndependent", false, false, true, 1 }

Definition at line 120 of file Loudness.h.

Referenced by Parameters().

◆ Symbol

const ComponentInterfaceSymbol EffectLoudness::Symbol { XO("Loudness Normalization") }

static

Definition at line 43 of file Loudness.h.

Referenced by GetSymbol().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kNormalizeTargets

Constructor & Destructor Documentation

◆ EffectLoudness()

◆ ~EffectLoudness()

Member Function Documentation

◆ AllocBuffers()

◆ AnalyseBufferBlock()

◆ FetchParameters()

◆ FreeBuffers()

◆ GetDescription()

◆ GetSymbol()

◆ GetTrackRMS()

◆ GetType()

◆ LoadBufferBlock()

◆ ManualPage()

◆ OnChoice()

◆ OnUpdateUI()

◆ Parameters()

◆ PopulateOrExchange()

◆ Process()

◆ ProcessBufferBlock()

◆ ProcessOne()

◆ StoreBufferBlock()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ UpdateProgress()

◆ UpdateUI()

Member Data Documentation

◆ DualMono

◆ LUFSLevel

◆ mBook

◆ mChoice

◆ mCurRate

◆ mCurT0

◆ mCurT1

◆ mDualMono

◆ mDualMonoCheckBox

◆ mLoudnessProcessor

◆ mLUFSLevel

◆ mMult

◆ mNormalizeTo

◆ mProcStereo

◆ mProgressMsg

◆ mProgressVal

◆ mRatio

◆ mRMS

◆ mRMSLevel

◆ mSteps

◆ mStereoInd

◆ mStereoIndCheckBox

◆ mTrackBuffer

◆ mTrackBufferCapacity

◆ mTrackBufferLen

◆ mTrackLen

◆ mWarning

◆ NormalizeTo

◆ RMSLevel

◆ StereoInd

◆ Symbol