Locates clipping and inserts labels when found. More...

#include <FindClippingBase.h>

Inheritance diagram for FindClippingBase:

Collaboration diagram for FindClippingBase:

Public Member Functions
	FindClippingBase ()

virtual	~FindClippingBase ()

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

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 FindClippingBase *	FetchParameters (FindClippingBase &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("Find Clipping") }

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
int	mStart

int	mStop

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static constexpr EffectParameter	Start

static constexpr EffectParameter	Stop

Private Member Functions
bool	ProcessOne (LabelTrack &lt, int count, const WaveChannel &wt, sampleCount start, sampleCount len)

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

Locates clipping and inserts labels when found.

Definition at line 19 of file FindClippingBase.h.

Constructor & Destructor Documentation

◆ FindClippingBase()

FindClippingBase::FindClippingBase ( )

Definition at line 31 of file FindClippingBase.cpp.

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

References Parameters(), and EffectParameterMethods::Reset().

Here is the call graph for this function:

◆ ~FindClippingBase()

FindClippingBase::~FindClippingBase ( )

virtual

Definition at line 36 of file FindClippingBase.cpp.

37{

38}

Member Function Documentation

◆ FetchParameters()

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

inlinestatic

Definition at line 23 of file FindClippingBase.h.

   {
      return &e;
   }

◆ GetDescription()

TranslatableString FindClippingBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 47 of file FindClippingBase.cpp.

{
   return XO("Creates labels where clipping is detected");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol FindClippingBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 42 of file FindClippingBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType FindClippingBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 59 of file FindClippingBase.cpp.

{
   return EffectTypeAnalyze;
}

References EffectTypeAnalyze.

Referenced by Process().

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID FindClippingBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 52 of file FindClippingBase.cpp.

{
   return L"Find_Clipping";
}

◆ Parameters()

const EffectParameterMethods & FindClippingBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 23 of file FindClippingBase.cpp.

{
   static CapturedParameters<FindClippingBase, Start, Stop> parameters;
   return parameters;
}

Referenced by FindClippingBase().

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 66 of file FindClippingBase.cpp.

{
   std::shared_ptr<AddedAnalysisTrack> addedTrack;
   std::optional<ModifiedAnalysisTrack> modifiedTrack;
   const wxString name { _("Clipping") };
 
   auto clt = *inputTracks()->Any<const LabelTrack>().find_if(
      [&](const Track* track) { return track->GetName() == name; });
 
   LabelTrack* lt {};
   if (!clt)
      addedTrack = (AddAnalysisTrack(*this, name)), lt = addedTrack->get();
   else
      modifiedTrack.emplace(ModifyAnalysisTrack(*this, *clt, name)),
         lt = modifiedTrack->get();
 
   int count = 0;
 
   // JC: Only process selected tracks.
   // PRL:  Compute the strech into temporary tracks.  Don't commit the stretch.
   EffectOutputTracks temp { *mTracks, GetType(), { { mT0, mT1 } } };
   for (auto t : temp.Get().Selected<const WaveTrack>())
   {
      double trackStart = t->GetStartTime();
      double trackEnd = t->GetEndTime();
      double t0 = std::max(trackStart, mT0);
      double t1 = std::min(trackEnd, mT1);
      if (t1 > t0)
      {
         auto start = t->TimeToLongSamples(t0);
         auto end = t->TimeToLongSamples(t1);
         auto len = end - start;
 
         for (const auto pChannel : t->Channels())
            if (!ProcessOne(*lt, count++, *pChannel, start, len))
               return false;
      }
   }
 
   // No cancellation, so commit the addition of the track.
   if (addedTrack)
      addedTrack->Commit();
   if (modifiedTrack)
      modifiedTrack->Commit();
   return true;
}

References _, AddAnalysisTrack(), TrackList::Any(), details::end(), Track::GetName(), GetType(), EffectBase::inputTracks(), min(), ModifyAnalysisTrack(), EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, name, and ProcessOne().

Here is the call graph for this function:

◆ ProcessOne()

bool FindClippingBase::ProcessOne	(	LabelTrack &	lt,
		int	count,
		const WaveChannel &	wt,
		sampleCount	start,
		sampleCount	len
	)

private

i18n-hint: Two numbers are substituted; the second is the size of a set, the first is the size of a subset, and not understood as an ordinal (i.e., not meaning "first", or "second", etc.)

Definition at line 113 of file FindClippingBase.cpp.

{
   bool bGoodResult = true;
   size_t blockSize = (mStart * 1000);
 
   if (len < mStart)
      return true;
 
   Floats buffer;
   try
   {
      // mStart should be positive.
      // if we are throwing bad_alloc and mStart is negative, find out why.
      if (mStart < 0 || (int)blockSize < mStart)
         // overflow
         throw std::bad_alloc {};
      buffer.reinit(blockSize);
   }
   catch (const std::bad_alloc&)
   {
      BasicUI::ShowMessageBox(XO("Requested value exceeds memory capacity."));
      return false;
   }
 
   float* ptr = buffer.get();
 
   decltype(len) s = 0, startrun = 0, stoprun = 0, samps = 0;
   decltype(blockSize) block = 0;
   double startTime = -1.0;
 
   while (s < len)
   {
      if (block == 0)
      {
         if (TrackProgress(count, s.as_double() / len.as_double()))
         {
            bGoodResult = false;
            break;
         }
         block = limitSampleBufferSize(blockSize, len - s);
         wt.GetFloats(buffer.get(), start + s, block);
         ptr = buffer.get();
      }
 
      float v = fabs(*ptr++);
      if (v >= MAX_AUDIO)
      {
         if (startrun == 0)
         {
            startTime = wt.LongSamplesToTime(start + s);
            samps = 0;
         }
         else
            stoprun = 0;
         startrun++;
         samps++;
      }
      else
      {
         if (startrun >= mStart)
         {
            stoprun++;
            samps++;
            if (stoprun >= mStop)
            {
               lt.AddLabel(
                  SelectedRegion(
                     startTime, wt.LongSamplesToTime(start + s - mStop)),
                  XC("%lld of %lld", "find clipping")
                     .Format(
                        startrun.as_long_long(), (samps - mStop).as_long_long())
                     .Translation());
               startrun = 0;
               stoprun = 0;
               samps = 0;
            }
         }
         else
            startrun = 0;
      }
      s++;
      block--;
   }
   return bGoodResult;
}

References LabelTrack::AddLabel(), sampleCount::as_double(), WaveChannel::GetFloats(), limitSampleBufferSize(), WideSampleSequence::LongSamplesToTime(), MAX_AUDIO, mStart, mStop, ArrayOf< X >::reinit(), BasicUI::ShowMessageBox(), Effect::TrackProgress(), XC, and XO().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mStart

int FindClippingBase::mStart

protected

Using int rather than sampleCount because values are only ever small numbers

Definition at line 54 of file FindClippingBase.h.

Referenced by EffectFindClipping::DoPopulateOrExchange(), and ProcessOne().

◆ mStop

int FindClippingBase::mStop

protected

Using int rather than sampleCount because values are only ever small numbers

Definition at line 56 of file FindClippingBase.h.

Referenced by EffectFindClipping::DoPopulateOrExchange(), and ProcessOne().

◆ Start

constexpr EffectParameter FindClippingBase::Start

staticconstexprprotected

Initial value:

{
      &FindClippingBase::mStart, L"Duty Cycle Start", 3, 1, INT_MAX, 1
   }

Definition at line 62 of file FindClippingBase.h.

Referenced by EffectFindClipping::DoPopulateOrExchange().

◆ Stop

constexpr EffectParameter FindClippingBase::Stop

staticconstexprprotected

Initial value:

{
      &FindClippingBase::mStop, L"Duty Cycle End", 3, 1, INT_MAX, 1
   }

Definition at line 65 of file FindClippingBase.h.

Referenced by EffectFindClipping::DoPopulateOrExchange().

◆ Symbol

const ComponentInterfaceSymbol FindClippingBase::Symbol { XO("Find Clipping") }

static

Definition at line 27 of file FindClippingBase.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 Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FindClippingBase()

◆ ~FindClippingBase()

Member Function Documentation

◆ FetchParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ Parameters()

◆ Process()

◆ ProcessOne()

Member Data Documentation

◆ mStart

◆ mStop

◆ Start

◆ Stop

◆ Symbol