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 Member Functions
	EffectLoudness ()

virtual	~EffectLoudness ()

ComponentInterfaceSymbol	GetSymbol () override

TranslatableString	GetDescription () override

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

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

bool	GetAutomationParameters (CommandParameters &parms) override
	Save current settings into parms. More...

bool	SetAutomationParameters (CommandParameters &parms) override
	Change settings to those stored in parms. More...

bool	DefineParams (ShuttleParams &S) override

bool	CheckWhetherSkipEffect () override

bool	Startup () override

bool	Process () override

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

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

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

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

bool	IsLegacy () override

bool	SupportsRealtime () override
	Whether the effect supports realtime previewing (while audio is playing). More...

bool	SupportsAutomation () override
	Whether the effect can be used without the UI, in a macro. More...

bool	LoadUserPreset (const RegistryPath &name) override
	Change settings to a user-named preset. More...

bool	SaveUserPreset (const RegistryPath &name) override
	Save current settings as a user-named preset. More...

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

bool	LoadFactoryPreset (int id) override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

bool	LoadFactoryDefaults () override
	Change settings back to "factory default". More...

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override
	Called for destructive, non-realtime effect computation. More...

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override
	Called for destructive, non-realtime effect computation. More...

bool	ProcessFinalize () override
	Called for destructive, non-realtime effect computation. More...

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override
	Called for destructive, non-realtime effect computation. More...

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () noexcept override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () noexcept override

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

bool	PopulateUI (ShuttleGui &S) final
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

EffectDefinitionInterface &	GetDefinition () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

unsigned	TestUIFlags (unsigned mask)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

virtual bool	Startup (EffectUIClientInterface *client)

virtual bool	GetAutomationParametersAsString (wxString &parms)

virtual bool	SetAutomationParametersFromString (const wxString &parms)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

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

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectProcessor
virtual	~EffectProcessor ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIHostInterface
virtual	~EffectUIHostInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

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

Static Public Attributes inherited from Effect
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 ()

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

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

Static Public Member Functions inherited from Effect
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...

Protected Member Functions inherited from Effect
bool	EnableApply (bool enable=true)

bool	EnablePreview (bool enable=true)

virtual bool	Init ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

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

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

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

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

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

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

void	ReplaceProcessedTracks (const bool bGoodResult)

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

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from Effect
BasicUI::ProgressDialog *	mProgress = nullptr

double	mProjectRate

double	mSampleRate

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWeakRef< wxDialog >	mUIDialog
	This weak pointer may be the same as the above, or null. More...

wxWindow *	mUIParent

unsigned	mUIFlags { 0 }

sampleCount	mSampleCnt

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

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

Definition at line 29 of file Loudness.h.

Constructor & Destructor Documentation

◆ EffectLoudness()

EffectLoudness::EffectLoudness ( )

Definition at line 69 of file Loudness.cpp.

 {
    mStereoInd = DEF_StereoInd;
    mLUFSLevel = DEF_LUFSLevel;
    mRMSLevel = DEF_RMSLevel;
    mDualMono = DEF_DualMono;
    mNormalizeTo = DEF_NormalizeTo;
  
    SetLinearEffectFlag(false);
 }

References mDualMono, mLUFSLevel, mNormalizeTo, mRMSLevel, mStereoInd, and Effect::SetLinearEffectFlag().

Here is the call graph for this function:

◆ ~EffectLoudness()

EffectLoudness::~EffectLoudness ( )

virtual

Definition at line 80 of file Loudness.cpp.

81 {

82 }

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 413 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(), Effect::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 526 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:

◆ CheckWhetherSkipEffect()

bool EffectLoudness::CheckWhetherSkipEffect ( )

overridevirtual

Reimplemented from Effect.

Definition at line 149 of file Loudness.cpp.

 {
    return false;
 }

◆ DefineParams()

bool EffectLoudness::DefineParams ( ShuttleParams & S )

override

Definition at line 109 of file Loudness.cpp.

 {
    S.SHUTTLE_PARAM( mStereoInd, StereoInd );
    S.SHUTTLE_PARAM( mLUFSLevel, LUFSLevel );
    S.SHUTTLE_PARAM( mRMSLevel, RMSLevel );
    S.SHUTTLE_PARAM( mDualMono, DualMono );
    S.SHUTTLE_PARAM( mNormalizeTo, NormalizeTo );
    return true;
 }

References mDualMono, mLUFSLevel, mNormalizeTo, mRMSLevel, mStereoInd, and S.

◆ FreeBuffers()

void EffectLoudness::FreeBuffers ( )

private

Definition at line 438 of file Loudness.cpp.

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

References mTrackBuffer.

Referenced by Process().

Here is the caller graph for this function:

◆ GetAutomationParameters()

bool EffectLoudness::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Save current settings into parms.

Reimplemented from Effect.

Definition at line 119 of file Loudness.cpp.

 {
    parms.Write(KEY_StereoInd, mStereoInd);
    parms.Write(KEY_LUFSLevel, mLUFSLevel);
    parms.Write(KEY_RMSLevel, mRMSLevel);
    parms.Write(KEY_DualMono, mDualMono);
    parms.Write(KEY_NormalizeTo, mNormalizeTo);
  
    return true;
 }

References mDualMono, mLUFSLevel, mNormalizeTo, mRMSLevel, and mStereoInd.

◆ GetDescription()

TranslatableString EffectLoudness::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 91 of file Loudness.cpp.

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

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectLoudness::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 86 of file Loudness.cpp.

 {
    return Symbol;
 }

References Symbol.

◆ GetTrackRMS()

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

private

Definition at line 444 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 ( )

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 103 of file Loudness.cpp.

 {
    return EffectTypeProcess;
 }

References EffectTypeProcess.

◆ LoadBufferBlock()

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

private

Definition at line 511 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 ( )

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 96 of file Loudness.cpp.

 {
    return L"Loudness_Normalization";
 }

◆ OnChoice()

void EffectLoudness::OnChoice ( wxCommandEvent & evt )

private

Definition at line 574 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 582 of file Loudness.cpp.

 {
    UpdateUI();
 }

References UpdateUI().

Here is the call graph for this function:

◆ PopulateOrExchange()

void EffectLoudness::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 291 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,
                               MIN_LUFSLevel, MAX_LUFSLevel )
                            .AddTextBox( {}, wxT(""), 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,
                               MIN_RMSLevel, MAX_RMSLevel )
                            .AddTextBox( {}, wxT(""), 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();
 }

References kNormalizeTargetStrings, mBook, mChoice, mDualMono, mDualMonoCheckBox, mLUFSLevel, mNormalizeTo, mRMSLevel, Msgids(), mStereoInd, mStereoIndCheckBox, mWarning, nAlgos, S, XO, and XXO.

Here is the call graph for this function:

◆ Process()

bool EffectLoudness::Process ( )

overridevirtual

If Process() is not overridden, it uses ProcessInitialize(), ProcessBlock(), and ProcessFinalize() methods of EffectProcessor, and also GetLatency() to determine how many leading output samples to discard and how many extra samples to produce.

Reimplemented from Effect.

Definition at line 173 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(TrapDouble(mLUFSLevel*2, MIN_LUFSLevel, MAX_LUFSLevel));
    else // RMS
       mRatio = DB_TO_LINEAR(TrapDouble(mRMSLevel, MIN_RMSLevel, MAX_RMSLevel));
  
    // 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, mCurRate, mCurT0, mCurT1, mDualMono, mLoudnessProcessor, mLUFSLevel, mMult, mNormalizeTo, Track::MonoChannel, Effect::mOutputTracks, mProcStereo, mProgressMsg, mProgressVal, mRatio, mRMS, mRMSLevel, mSteps, mStereoInd, Effect::mT0, Effect::mT1, ProcessOne(), Effect::ReplaceProcessedTracks(), safenew, TrackList::SingletonRange(), TrapDouble(), and XO.

Here is the call graph for this function:

◆ ProcessBufferBlock()

bool EffectLoudness::ProcessBufferBlock ( )

private

Definition at line 541 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 458 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(), 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:

◆ SetAutomationParameters()

bool EffectLoudness::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Change settings to those stored in parms.

Reimplemented from Effect.

Definition at line 130 of file Loudness.cpp.

 {
    ReadAndVerifyBool(StereoInd);
    ReadAndVerifyDouble(LUFSLevel);
    ReadAndVerifyDouble(RMSLevel);
    ReadAndVerifyBool(DualMono);
    ReadAndVerifyInt(NormalizeTo);
  
    mStereoInd = StereoInd;
    mLUFSLevel = LUFSLevel;
    mRMSLevel = RMSLevel;
    mDualMono = DualMono;
    mNormalizeTo = NormalizeTo;
  
    return true;
 }

References mDualMono, mLUFSLevel, mNormalizeTo, mRMSLevel, mStereoInd, ReadAndVerifyBool, ReadAndVerifyDouble, and ReadAndVerifyInt.

◆ Startup()

bool EffectLoudness::Startup ( )

overridevirtual

Reimplemented from Effect.

Definition at line 154 of file Loudness.cpp.

 {
    wxString base = wxT("/Effects/Loudness/");
    // Load the old "current" settings
    if (gPrefs->Exists(base))
    {
       mStereoInd = false;
       mDualMono = DEF_DualMono;
       mNormalizeTo = kLoudness;
       mLUFSLevel = DEF_LUFSLevel;
       mRMSLevel = DEF_RMSLevel;
  
       SaveUserPreset(GetCurrentSettingsGroup());
  
       gPrefs->Flush();
    }
    return true;
 }

References FileConfig::Flush(), Effect::GetCurrentSettingsGroup(), gPrefs, kLoudness, mDualMono, mLUFSLevel, mNormalizeTo, mRMSLevel, mStereoInd, and Effect::SaveUserPreset().

Here is the call graph for this function:

◆ StoreBufferBlock()

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

private

Definition at line 555 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 ( )

overridevirtual

Reimplemented from Effect.

Definition at line 400 of file Loudness.cpp.

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

References Effect::mUIParent.

◆ TransferDataToWindow()

bool EffectLoudness::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 387 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 567 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 ( void )

private

Definition at line 587 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, and mWarning.

Referenced by OnChoice(), and OnUpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mBook

wxSimplebook* EffectLoudness::mBook

private

Definition at line 101 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mChoice

wxChoice* EffectLoudness::mChoice

private

Definition at line 102 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mCurRate

double EffectLoudness::mCurRate

private

Definition at line 94 of file Loudness.h.

Referenced by Process().

◆ mCurT0

double EffectLoudness::mCurT0

private

Definition at line 88 of file Loudness.h.

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

◆ mCurT1

double EffectLoudness::mCurT1

private

Definition at line 89 of file Loudness.h.

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

◆ mDualMono

bool EffectLoudness::mDualMono

private

Definition at line 85 of file Loudness.h.

Referenced by DefineParams(), EffectLoudness(), GetAutomationParameters(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Startup().

◆ mDualMonoCheckBox

wxCheckBox* EffectLoudness::mDualMonoCheckBox

private

Definition at line 105 of file Loudness.h.

Referenced by OnChoice(), and PopulateOrExchange().

◆ mLoudnessProcessor

std::unique_ptr<EBUR128> EffectLoudness::mLoudnessProcessor

private

Definition at line 99 of file Loudness.h.

Referenced by AnalyseBufferBlock(), and Process().

◆ mLUFSLevel

double EffectLoudness::mLUFSLevel

private

Definition at line 83 of file Loudness.h.

Referenced by DefineParams(), EffectLoudness(), GetAutomationParameters(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Startup().

◆ mMult

float EffectLoudness::mMult

private

Definition at line 96 of file Loudness.h.

Referenced by Process(), and ProcessBufferBlock().

◆ mNormalizeTo

int EffectLoudness::mNormalizeTo

private

Definition at line 86 of file Loudness.h.

Referenced by DefineParams(), EffectLoudness(), GetAutomationParameters(), OnChoice(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Startup().

◆ mProcStereo

bool EffectLoudness::mProcStereo

private

Definition at line 110 of file Loudness.h.

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

◆ mProgressMsg

TranslatableString EffectLoudness::mProgressMsg

private

Definition at line 92 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mProgressVal

double EffectLoudness::mProgressVal

private

Definition at line 90 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mRatio

float EffectLoudness::mRatio

private

Definition at line 97 of file Loudness.h.

Referenced by Process().

◆ mRMS

float EffectLoudness::mRMS[2]

private

Definition at line 98 of file Loudness.h.

Referenced by Process().

◆ mRMSLevel

double EffectLoudness::mRMSLevel

private

Definition at line 84 of file Loudness.h.

Referenced by DefineParams(), EffectLoudness(), GetAutomationParameters(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Startup().

◆ mSteps

int EffectLoudness::mSteps

private

Definition at line 91 of file Loudness.h.

Referenced by Process(), and UpdateProgress().

◆ mStereoInd

bool EffectLoudness::mStereoInd

private

Definition at line 82 of file Loudness.h.

Referenced by AllocBuffers(), DefineParams(), EffectLoudness(), GetAutomationParameters(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Startup().

◆ mStereoIndCheckBox

wxCheckBox* EffectLoudness::mStereoIndCheckBox

private

Definition at line 104 of file Loudness.h.

Referenced by PopulateOrExchange().

◆ mTrackBuffer

Floats EffectLoudness::mTrackBuffer[2]

private

Definition at line 107 of file Loudness.h.

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

◆ mTrackBufferCapacity

size_t EffectLoudness::mTrackBufferCapacity

private

Definition at line 109 of file Loudness.h.

Referenced by AllocBuffers(), and ProcessOne().

◆ mTrackBufferLen

size_t EffectLoudness::mTrackBufferLen

private

Definition at line 108 of file Loudness.h.

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

◆ mTrackLen

double EffectLoudness::mTrackLen

private

Definition at line 93 of file Loudness.h.

Referenced by ProcessOne(), and UpdateProgress().

◆ mWarning

wxStaticText* EffectLoudness::mWarning

private

Definition at line 103 of file Loudness.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ Symbol

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

static

Definition at line 32 of file Loudness.h.

Referenced by GetSymbol().

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectLoudness()

◆ ~EffectLoudness()

Member Function Documentation

◆ AllocBuffers()

◆ AnalyseBufferBlock()

◆ CheckWhetherSkipEffect()

◆ DefineParams()

◆ FreeBuffers()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetTrackRMS()

◆ GetType()

◆ LoadBufferBlock()

◆ ManualPage()

◆ OnChoice()

◆ OnUpdateUI()

◆ PopulateOrExchange()

◆ Process()

◆ ProcessBufferBlock()

◆ ProcessOne()

◆ SetAutomationParameters()

◆ Startup()

◆ StoreBufferBlock()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ UpdateProgress()

◆ UpdateUI()

Member Data Documentation

◆ 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

◆ Symbol