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

#include <NormalizeBase.h>

Inheritance diagram for NormalizeBase:

Collaboration diagram for NormalizeBase:

Public Member Functions
	NormalizeBase ()

virtual	~NormalizeBase ()

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	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	After Init(), tell whether Process() should be skipped. More...

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

Public Member Functions inherited from StatefulEffect
	~StatefulEffect () override

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

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()

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

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

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

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual bool	RealtimeProcessStart (MessagePackage &package)
	settings are possibly changed, since last call, by an asynchronous dialog More...

virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

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

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

virtual sampleCount	GetLatency () const

virtual bool	NeedsDither () const

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

virtual bool	ProcessFinalize () noexcept

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

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

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

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

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

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

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

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

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

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

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

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

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

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

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

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

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

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatID	GetSelectionFormat ()

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

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

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

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

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

bool	IsLinearEffect () const

bool	PreviewsFullSelection () const

void	SetTracks (TrackList *pTracks)

double	GetDefaultDuration ()

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

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

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

void	CountWaveTracks ()

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

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

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

virtual const EffectSettingsManager &	GetDefinition () const =0

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

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

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

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

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

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

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

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

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

virtual EffectSettings	MakeSettings () const

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

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

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

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

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

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

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

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

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

bool	SupportsRealtime () const

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

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

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

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

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

static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)

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

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

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
const EffectParameterMethods &	Parameters () const override

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

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

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

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

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

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

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

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
double	mPeakLevel

bool	mGain

bool	mDC

bool	mStereoInd

double	mCurT0

double	mCurT1

float	mMult

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static constexpr EffectParameter	PeakLevel

static constexpr EffectParameter	RemoveDC

static constexpr EffectParameter	ApplyVolume

static constexpr EffectParameter	StereoInd

Private Types
using	ProgressReport = std::function< bool(double fraction)>

Private Member Functions
bool	ProcessOne (WaveChannel &track, const TranslatableString &msg, double &progress, float offset)

void	ProcessData (float *buffer, size_t len, float offset)

Static Private Member Functions
static bool	AnalyseTrack (const WaveChannel &track, const ProgressReport &report, bool gain, bool dc, double curT0, double curT1, float &offset, float &extent)

static bool	AnalyseTrackData (const WaveChannel &track, const ProgressReport &report, double curT0, double curT1, float &offset)

static double	AnalyseDataDC (float *buffer, size_t len, double sum)

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

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

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

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

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

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

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

Detailed Description

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

Definition at line 18 of file NormalizeBase.h.

Member Typedef Documentation

◆ ProgressReport

using NormalizeBase::ProgressReport = std::function<bool(double fraction)>

private

Definition at line 52 of file NormalizeBase.h.

Constructor & Destructor Documentation

◆ NormalizeBase()

NormalizeBase::NormalizeBase ( )

Definition at line 28 of file NormalizeBase.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:

◆ ~NormalizeBase()

NormalizeBase::~NormalizeBase ( )

virtual

Definition at line 34 of file NormalizeBase.cpp.

35{

36}

Member Function Documentation

◆ AnalyseDataDC()

double NormalizeBase::AnalyseDataDC	(	float *	buffer,
		size_t	len,
		double	sum
	)

staticprivate

See also: AnalyseDataLoudnessDC

Definition at line 369 of file NormalizeBase.cpp.

{
   for (decltype(len) i = 0; i < len; i++)
      sum += (double)buffer[i];
   return sum;
}

Referenced by AnalyseTrackData().

Here is the caller graph for this function:

◆ AnalyseTrack()

bool NormalizeBase::AnalyseTrack	(	const WaveChannel &	track,
		const ProgressReport &	report,
		bool	gain,
		bool	dc,
		double	curT0,
		double	curT1,
		float &	offset,
		float &	extent
	)

staticprivate

Definition at line 201 of file NormalizeBase.cpp.

{
   bool result = true;
   float min, max;
   if (gain)
   {
      // set mMin, mMax.  No progress bar here as it's fast.
      auto pair =
         WaveChannelUtilities::GetMinMax(track, curT0, curT1); // may throw
      min = pair.first, max = pair.second;
 
      if (dc)
      {
         result = AnalyseTrackData(track, report, curT0, curT1, offset);
         min += offset;
         max += offset;
      }
   }
   else if (dc)
   {
      min = -1.0, max = 1.0; // sensible defaults?
      result = AnalyseTrackData(track, report, curT0, curT1, offset);
      min += offset;
      max += offset;
   }
   else
   {
      wxFAIL_MSG("Analysing Track when nothing to do!");
      min = -1.0, max = 1.0; // sensible defaults?
      offset = 0.0;
   }
   extent = fmax(fabs(min), fabs(max));
   return result;
}

References AnalyseTrackData(), WaveChannelUtilities::GetMinMax(), and min().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AnalyseTrackData()

bool NormalizeBase::AnalyseTrackData	(	const WaveChannel &	track,
		const ProgressReport &	report,
		double	curT0,
		double	curT1,
		float &	offset
	)

staticprivate

Definition at line 241 of file NormalizeBase.cpp.

{
   bool rc = true;
 
   // Transform the marker timepoints to samples
   auto start = track.TimeToLongSamples(curT0);
   auto end = track.TimeToLongSamples(curT1);
 
   // 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
   auto len = (end - start).as_double();
 
   // Initiate a processing buffer.  This buffer will (most likely)
   // be shorter than the length of the track being processed.
   Floats buffer { track.GetMaxBlockSize() };
 
   double sum = 0.0; // dc offset inits
 
   sampleCount blockSamples;
   sampleCount totalSamples = 0;
 
   // 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
      const auto block =
         limitSampleBufferSize(track.GetBestBlockSize(s), end - s);
 
      // Get the samples from the track and put them in the buffer
      track.GetFloats(
         buffer.get(), s, block, FillFormat::fillZero, true, &blockSamples);
      totalSamples += blockSamples;
 
      // Process the buffer.
      sum = AnalyseDataDC(buffer.get(), block, sum);
 
      // Increment s one blockfull of samples
      s += block;
 
      // Update the Progress meter
      if (!report((s - start).as_double() / len))
      {
         rc = false; // lda .. break, not return, so that buffer is deleted
         break;
      }
   }
   if (totalSamples > 0)
      // calculate actual offset (amount that needs to be added on)
      offset = -sum / totalSamples.as_double();
   else
      offset = 0.0;
 
   // Return true because the effect processing succeeded ... unless cancelled
   return rc;
}

References AnalyseDataDC(), sampleCount::as_double(), details::end(), fillZero, WaveChannel::GetBestBlockSize(), WaveChannel::GetFloats(), WaveChannel::GetMaxBlockSize(), limitSampleBufferSize(), and WideSampleSequence::TimeToLongSamples().

Referenced by AnalyseTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckWhetherSkipEffect()

bool NormalizeBase::CheckWhetherSkipEffect ( const EffectSettings & settings ) const

overridevirtual

After Init(), tell whether Process() should be skipped.

Implements EffectBase.

Definition at line 64 of file NormalizeBase.cpp.

{
   return ((mGain == false) && (mDC == false));
}

References mDC, and mGain.

◆ FetchParameters()

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

inlinestatic

Definition at line 22 of file NormalizeBase.h.

   {
      return &e;
   }

◆ GetDescription()

TranslatableString NormalizeBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 45 of file NormalizeBase.cpp.

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

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol NormalizeBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 40 of file NormalizeBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType NormalizeBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 57 of file NormalizeBase.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Referenced by Process().

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID NormalizeBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 50 of file NormalizeBase.cpp.

{
   return L"Normalize";
}

◆ Parameters()

const EffectParameterMethods & NormalizeBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 18 of file NormalizeBase.cpp.

{
   static CapturedParameters<
      NormalizeBase, PeakLevel, ApplyVolume, RemoveDC, StereoInd>
      parameters;
   return parameters;
}

References ApplyVolume, NormalizeBase(), PeakLevel, RemoveDC, and StereoInd.

Referenced by NormalizeBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 69 of file NormalizeBase.cpp.

{
   if (mGain == false && mDC == false)
      return true;
 
   float ratio;
   if (mGain)
   {
      // same value used for all tracks
      ratio = DB_TO_LINEAR(
         std::clamp<double>(mPeakLevel, PeakLevel.min, PeakLevel.max));
   }
   else
   {
      ratio = 1.0;
   }
 
   // Iterate over each track
   EffectOutputTracks outputs { *mTracks, GetType(), { { mT0, mT1 } } };
   bool bGoodResult = true;
   double progress = 0;
   TranslatableString topMsg;
   if (mDC && mGain)
      topMsg = XO("Removing DC offset and Normalizing...\n");
   else if (mDC && !mGain)
      topMsg = XO("Removing DC offset...\n");
   else if (!mDC && mGain)
      topMsg = XO("Normalizing without removing DC offset...\n");
   else if (!mDC && !mGain)
      topMsg = XO("Not doing anything...\n"); // shouldn't get here
 
   for (auto track : outputs.Get().Selected<WaveTrack>())
   {
      // Get start and end times from track
      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 = std::max(trackStart, mT0);
      mCurT1 = std::min(trackEnd, mT1);
 
      // Process only if the right marker is to the right of the left marker
      if (mCurT1 > mCurT0)
      {
         wxString trackName = track->GetName();
 
         std::vector<float> extents;
         float maxExtent { std::numeric_limits<float>::lowest() };
         std::vector<float> offsets;
 
         const auto channels = track->Channels();
         // mono or 'stereo tracks independently'
         const bool oneChannel = (channels.size() == 1 || mStereoInd);
         auto msg = oneChannel ?
                       topMsg + XO("Analyzing: %s").Format(trackName) :
                       topMsg +
                          // TODO: more-than-two-channels-message
                          XO("Analyzing first track of stereo pair: %s")
                             .Format(trackName);
 
         const auto progressReport = [&](double fraction) {
            return !TotalProgress(
               (progress + fraction / double(2 * GetNumWaveTracks())), msg);
         };
 
         // Analysis loop over channels collects offsets and extent
         for (auto channel : channels)
         {
            float offset = 0;
            float extent = 0;
            bGoodResult = AnalyseTrack(
               *channel, progressReport, mGain, mDC, mCurT0, mCurT1, offset,
               extent);
            if (!bGoodResult)
               goto break2;
            progress += 1.0 / double(2 * GetNumWaveTracks());
            extents.push_back(extent);
            maxExtent = std::max(maxExtent, extent);
            offsets.push_back(offset);
            // TODO: more-than-two-channels-message
            if (!oneChannel)
               msg = topMsg + XO("Analyzing second track of stereo pair: %s")
                                 .Format(trackName);
         }
 
         if (oneChannel)
         {
            if (track->NChannels() == 1)
               // really mono
               msg = topMsg + XO("Processing: %s").Format(trackName);
            else
               //'stereo tracks independently'
               // TODO: more-than-two-channels-message
               msg = topMsg + XO("Processing stereo channels independently: %s")
                                 .Format(trackName);
         }
         else
            msg = topMsg +
                  // TODO: more-than-two-channels-message
                  XO("Processing first track of stereo pair: %s")
                     .Format(trackName);
 
         // Use multiplier in the second, processing loop over channels
         auto pOffset = offsets.begin();
         auto pExtent = extents.begin();
         for (const auto channel : channels)
         {
            const auto extent = oneChannel ? *pExtent++ : maxExtent;
            if ((extent > 0) && mGain)
               mMult = ratio / extent;
            else
               mMult = 1.0;
            if (
               false ==
               (bGoodResult = ProcessOne(*channel, msg, progress, *pOffset++)))
               goto break2;
            // TODO: more-than-two-channels-message
            msg = topMsg + XO("Processing second track of stereo pair: %s")
                              .Format(trackName);
         }
      }
   }
 
break2:
 
   if (bGoodResult)
      outputs.Commit();
 
   return bGoodResult;
}

References AnalyseTrack(), DB_TO_LINEAR, Effect::GetNumWaveTracks(), GetType(), EffectParameter< Structure, Member, Type, Value >::max, mCurT0, mCurT1, mDC, mGain, EffectParameter< Structure, Member, Type, Value >::min, min(), mMult, mPeakLevel, mStereoInd, EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, PeakLevel, ProcessOne(), Effect::TotalProgress(), and XO().

Here is the call graph for this function:

◆ ProcessData()

void NormalizeBase::ProcessData	(	float *	buffer,
		size_t	len,
		float	offset
	)

private

Definition at line 376 of file NormalizeBase.cpp.

{
   for (decltype(len) i = 0; i < len; i++)
   {
      float adjFrame = (buffer[i] + offset) * mMult;
      buffer[i] = adjFrame;
   }
}

References mMult.

Referenced by ProcessOne().

Here is the caller graph for this function:

◆ ProcessOne()

bool NormalizeBase::ProcessOne	(	WaveChannel &	track,
		const TranslatableString &	msg,
		double &	progress,
		float	offset
	)

private

Definition at line 307 of file NormalizeBase.cpp.

{
   bool rc = true;
 
   // 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
   auto len = (end - start).as_double();
 
   // Initiate a processing buffer.  This buffer will (most likely)
   // be shorter than the length of the track being processed.
   Floats buffer { track.GetMaxBlockSize() };
 
   // 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
      const auto block =
         limitSampleBufferSize(track.GetBestBlockSize(s), end - s);
 
      // Get the samples from the track and put them in the buffer
      track.GetFloats(buffer.get(), s, block);
 
      // Process the buffer.
      ProcessData(buffer.get(), block, offset);
 
      // Copy the newly-changed samples back onto the track.
      if (!track.SetFloats(buffer.get(), s, block))
      {
         rc = false;
         break;
      }
 
      // Increment s one blockfull of samples
      s += block;
 
      // Update the Progress meter
      if (TotalProgress(
             progress + ((s - start).as_double() / len) /
                           double(2 * GetNumWaveTracks()),
             msg))
      {
         rc = false; // lda .. break, not return, so that buffer is deleted
         break;
      }
   }
   progress += 1.0 / double(2 * GetNumWaveTracks());
 
   // Return true because the effect processing succeeded ... unless cancelled
   return rc;
}

References details::end(), WaveChannel::GetBestBlockSize(), WaveChannel::GetFloats(), WaveChannel::GetMaxBlockSize(), Effect::GetNumWaveTracks(), limitSampleBufferSize(), mCurT0, mCurT1, ProcessData(), WaveChannel::SetFloats(), WideSampleSequence::TimeToLongSamples(), and Effect::TotalProgress().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ApplyVolume

constexpr EffectParameter NormalizeBase::ApplyVolume

staticconstexprprotected

Initial value:

{
      &NormalizeBase::mGain, L"ApplyVolume", true, false, true, 1
   }

Definition at line 80 of file NormalizeBase.h.

Referenced by Parameters().

◆ mCurT0

double NormalizeBase::mCurT0

protected

Definition at line 68 of file NormalizeBase.h.

Referenced by Process(), and ProcessOne().

◆ mCurT1

double NormalizeBase::mCurT1

protected

Definition at line 69 of file NormalizeBase.h.

Referenced by Process(), and ProcessOne().

◆ mDC

bool NormalizeBase::mDC

protected

Definition at line 65 of file NormalizeBase.h.

Referenced by CheckWhetherSkipEffect(), Process(), and EffectNormalize::UpdateUI().

◆ mGain

bool NormalizeBase::mGain

protected

Definition at line 64 of file NormalizeBase.h.

Referenced by CheckWhetherSkipEffect(), Process(), and EffectNormalize::UpdateUI().

◆ mMult

float NormalizeBase::mMult

protected

Definition at line 70 of file NormalizeBase.h.

Referenced by Process(), and ProcessData().

◆ mPeakLevel

double NormalizeBase::mPeakLevel

protected

Definition at line 63 of file NormalizeBase.h.

Referenced by Process().

◆ mStereoInd

bool NormalizeBase::mStereoInd

protected

Definition at line 66 of file NormalizeBase.h.

Referenced by Process().

◆ PeakLevel

constexpr EffectParameter NormalizeBase::PeakLevel

staticconstexprprotected

Initial value:

{
      &NormalizeBase::mPeakLevel, L"PeakLevel", -1.0, -145.0, 0.0, 1
   }

Definition at line 74 of file NormalizeBase.h.

Referenced by Parameters(), and Process().

◆ RemoveDC

constexpr EffectParameter NormalizeBase::RemoveDC

staticconstexprprotected

Initial value:

{
      &NormalizeBase::mDC, L"RemoveDcOffset", true, false, true, 1
   }

Definition at line 77 of file NormalizeBase.h.

Referenced by Parameters().

◆ StereoInd

constexpr EffectParameter NormalizeBase::StereoInd

staticconstexprprotected

Initial value:

{
      &NormalizeBase::mStereoInd, L"StereoIndependent", false, false, true, 1
   }

Definition at line 83 of file NormalizeBase.h.

Referenced by Parameters().

◆ Symbol

const ComponentInterfaceSymbol NormalizeBase::Symbol { XO("Normalize") }

static

Definition at line 26 of file NormalizeBase.h.

Referenced by GetSymbol().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ProgressReport

Constructor & Destructor Documentation

◆ NormalizeBase()

◆ ~NormalizeBase()

Member Function Documentation

◆ AnalyseDataDC()

◆ AnalyseTrack()

◆ AnalyseTrackData()

◆ CheckWhetherSkipEffect()

◆ FetchParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ Parameters()

◆ Process()

◆ ProcessData()

◆ ProcessOne()

Member Data Documentation

◆ ApplyVolume

◆ mCurT0

◆ mCurT1

◆ mDC

◆ mGain

◆ mMult

◆ mPeakLevel

◆ mStereoInd

◆ PeakLevel

◆ RemoveDC

◆ StereoInd

◆ Symbol