Truncate Silence automatically reduces the length of passages where the volume is below a set threshold level. More...

#include <TruncSilenceBase.h>

Inheritance diagram for TruncSilenceBase:

Collaboration diagram for TruncSilenceBase:

Public Member Functions
	TruncSilenceBase ()

virtual	~TruncSilenceBase ()

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	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override

bool	Analyze (RegionList &silenceList, RegionList &trackSilences, const WaveTrack &wt, sampleCount silentFrame, sampleCount index, int whichTrack, double inputLength=nullptr, double minInputLength=nullptr) const

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

bool	NeedsDither () const 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 TruncSilenceBase *	FetchParameters (TruncSilenceBase &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

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 Types
enum	kActions { kTruncate , kCompress , nActions }

Protected Member Functions
void	Intersect (RegionList &dest, const RegionList &src)

bool	ProcessIndependently ()

bool	ProcessAll ()

bool	FindSilences (RegionList &silences, const TrackIterRange< const WaveTrack > &range)

bool	DoRemoval (const RegionList &silences, const TrackIterRange< Track > &range, unsigned iGroup, unsigned nGroups, double &totalCutLen)

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	mThresholdDB {}

int	mActionIndex

double	mInitialAllowedSilence

double	mTruncLongestAllowedSilence

double	mSilenceCompressPercent

bool	mbIndependent

size_t	mBlendFrameCount

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static const EnumValueSymbol	kActionStrings [nActions]

static constexpr EffectParameter	Threshold

static constexpr EnumParameter	ActIndex

static constexpr EffectParameter	Minimum

static constexpr EffectParameter	Truncate

static constexpr EffectParameter	Compress

static constexpr EffectParameter	Independent

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

Truncate Silence automatically reduces the length of passages where the volume is below a set threshold level.

Definition at line 24 of file TruncSilenceBase.h.

Member Enumeration Documentation

◆ kActions

enum TruncSilenceBase::kActions

protected

Enumerator
kTruncate
kCompress
nActions

Definition at line 93 of file TruncSilenceBase.h.

   {
      kTruncate,
      kCompress,
      nActions
   };

Constructor & Destructor Documentation

◆ TruncSilenceBase()

TruncSilenceBase::TruncSilenceBase ( )

Definition at line 94 of file TruncSilenceBase.cpp.

{
   Parameters().Reset(*this);
 
   SetLinearEffectFlag(false);
 
   // This used to be changeable via the audacity.cfg/registry.  Doubtful that
   // was ever done.
   //
   // Original comment:
   //
   //   mBlendFrameCount only retrieved from prefs ... not using dialog
   //   Only way to change (for windows) is thru registry
   //   The values should be figured dynamically ... too many frames could be
   //   invalid
   mBlendFrameCount = DEF_BlendFrameCount;
}

References DEF_BlendFrameCount, mBlendFrameCount, 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:

◆ ~TruncSilenceBase()

TruncSilenceBase::~TruncSilenceBase ( )

virtual

Definition at line 112 of file TruncSilenceBase.cpp.

113{

114}

Member Function Documentation

◆ Analyze()

bool TruncSilenceBase::Analyze	(	RegionList &	silenceList,
		RegionList &	trackSilences,
		const WaveTrack &	wt,
		sampleCount *	silentFrame,
		sampleCount *	index,
		int	whichTrack,
		double *	inputLength = `nullptr`,
		double *	minInputLength = `nullptr`
	)		const

Definition at line 509 of file TruncSilenceBase.cpp.

{
   const auto rate = wt.GetRate();
 
   // Smallest silent region to detect in frames
   auto minSilenceFrames =
      sampleCount(std::max(mInitialAllowedSilence, DEF_MinTruncMs) * rate);
 
   double truncDbSilenceThreshold = DB_TO_LINEAR(mThresholdDB);
   auto blockLen = wt.GetMaxBlockSize();
   auto start = wt.TimeToLongSamples(mT0);
   auto end = wt.TimeToLongSamples(mT1);
   sampleCount outLength = 0;
 
   double previewLength;
   gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &previewLength, 6.0);
   // Minimum required length in samples.
   const sampleCount previewLen(previewLength * rate);
 
   // Keep position in overall silences list for optimization
   RegionList::iterator rit(silenceList.begin());
 
   // Allocate buffers
   Floats buffers[] { Floats { blockLen }, Floats { blockLen } };
 
   // Loop through current track
   while (*index < end)
   {
      if (
         inputLength &&
         ((outLength >= previewLen) ||
          (*index - start > wt.TimeToLongSamples(*minInputLength))))
      {
         *inputLength = std::min<double>(*inputLength, *minInputLength);
         if (outLength >= previewLen)
         {
            *minInputLength = *inputLength;
         }
         return true;
      }
 
      if (!inputLength)
      {
         // Show progress dialog, test for cancellation
         bool cancelled = TotalProgress(
            detectFrac *
            (whichTrack +
             (*index - start).as_double() / (end - start).as_double()) /
            (double)GetNumWaveTracks());
         if (cancelled)
            return false;
      }
 
      // Optimization: if not in a silent region skip ahead to the next one
 
      double curTime = wt.LongSamplesToTime(*index);
      for (; rit != silenceList.end(); ++rit)
      {
         // Find the first silent region ending after current time
         if (rit->end >= curTime)
         {
            break;
         }
      }
 
      if (rit == silenceList.end())
      {
         // No more regions -- no need to process the rest of the track
         if (inputLength)
         {
            // Add available samples up to previewLength.
            auto remainingTrackSamples =
               wt.TimeToLongSamples(wt.GetEndTime()) - *index;
            auto requiredTrackSamples = previewLen - outLength;
            outLength += (remainingTrackSamples > requiredTrackSamples) ?
                            requiredTrackSamples :
                            remainingTrackSamples;
         }
 
         break;
      }
      else if (rit->start > curTime)
      {
         // End current silent region, skip ahead
         if (*silentFrame >= minSilenceFrames)
         {
            trackSilences.push_back(Region(
               wt.LongSamplesToTime(*index - *silentFrame),
               wt.LongSamplesToTime(*index)));
         }
         *silentFrame = 0;
         auto newIndex = wt.TimeToLongSamples(rit->start);
         if (inputLength)
         {
            auto requiredTrackSamples = previewLen - outLength;
            // Add non-silent sample to outLength
            outLength += ((newIndex - *index) > requiredTrackSamples) ?
                            requiredTrackSamples :
                            newIndex - *index;
         }
 
         *index = newIndex;
      }
      // End of optimization
 
      // Limit size of current block if we've reached the end
      auto count = limitSampleBufferSize(blockLen, end - *index);
 
      // Fill buffers
      size_t iChannel = 0;
      for (const auto pChannel : wt.Channels())
         pChannel->GetFloats(buffers[iChannel++].get(), *index, count);
 
      // Look for silenceList in current block
      for (decltype(count) i = 0; i < count; ++i)
      {
         if (
            inputLength &&
            ((outLength >= previewLen) ||
             (outLength > wt.TimeToLongSamples(*minInputLength))))
         {
            *inputLength =
               wt.LongSamplesToTime(*index + i) - wt.LongSamplesToTime(start);
            break;
         }
 
         const bool silent =
            std::all_of(buffers, buffers + iChannel, [&](const Floats& buffer) {
               return fabs(buffer[i]) < truncDbSilenceThreshold;
            });
         if (silent)
            (*silentFrame)++;
         else
         {
            sampleCount allowed = 0;
            if (*silentFrame >= minSilenceFrames)
            {
               if (inputLength)
               {
                  switch (mActionIndex)
                  {
                  case kTruncate:
                     outLength +=
                        wt.TimeToLongSamples(mTruncLongestAllowedSilence);
                     break;
                  case kCompress:
                     allowed = wt.TimeToLongSamples(mInitialAllowedSilence);
                     outLength += sampleCount(
                        allowed.as_double() +
                        (*silentFrame - allowed).as_double() *
                           mSilenceCompressPercent / 100.0);
                     break;
                     // default: // Not currently used.
                  }
               }
 
               // Record the silent region
               trackSilences.push_back(Region(
                  wt.LongSamplesToTime(*index + i - *silentFrame),
                  wt.LongSamplesToTime(*index + i)));
            }
            else if (inputLength)
            { // included as part of non-silence
               outLength += *silentFrame;
            }
            *silentFrame = 0;
            if (inputLength)
            {
               ++outLength; // Add non-silent sample to outLength
            }
         }
      }
      // Next block
      *index += count;
   }
 
   if (inputLength)
   {
      *inputLength = std::min<double>(*inputLength, *minInputLength);
      if (outLength >= previewLen)
      {
         *minInputLength = *inputLength;
      }
   }
 
   return true;
}

References sampleCount::as_double(), WaveTrack::Channels(), DB_TO_LINEAR, DEF_MinTruncMs, detectFrac, details::end(), WaveTrack::GetEndTime(), WaveTrack::GetMaxBlockSize(), Effect::GetNumWaveTracks(), WaveTrack::GetRate(), gPrefs, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, kCompress, kTruncate, limitSampleBufferSize(), WideSampleSequence::LongSamplesToTime(), mActionIndex, mInitialAllowedSilence, mSilenceCompressPercent, EffectBase::mT0, EffectBase::mT1, mThresholdDB, mTruncLongestAllowedSilence, audacity::BasicSettings::Read(), WideSampleSequence::TimeToLongSamples(), Effect::TotalProgress(), and wxT().

Referenced by CalcPreviewInputLength(), and FindSilences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalcPreviewInputLength()

double TruncSilenceBase::CalcPreviewInputLength	(	const EffectSettings &	settings,
		double	previewLength
	)		const

overridevirtual

Implements EffectBase.

Definition at line 186 of file TruncSilenceBase.cpp.

{
   double inputLength = mT1 - mT0;
   double minInputLength = inputLength;
 
   // Master list of silent regions
   RegionList silences;
 
   // Start with the whole selection silent
   silences.push_back(Region(mT0, mT1));
 
   int whichTrack = 0;
 
   for (auto wt : inputTracks()->Selected<const WaveTrack>())
   {
      RegionList trackSilences;
 
      auto index = wt->TimeToLongSamples(mT0);
      sampleCount silentFrame = 0; // length of the current silence
 
      Analyze(
         silences, trackSilences, *wt, &silentFrame, &index, whichTrack,
         &inputLength, &minInputLength);
 
      whichTrack += wt->NChannels();
   }
   return inputLength;
}

References Analyze(), EffectBase::inputTracks(), EffectBase::mT0, and EffectBase::mT1.

Here is the call graph for this function:

◆ DoRemoval()

bool TruncSilenceBase::DoRemoval	(	const RegionList &	silences,
		const TrackIterRange< Track > &	range,
		unsigned	iGroup,
		unsigned	nGroups,
		double &	totalCutLen
	)

protected

Definition at line 363 of file TruncSilenceBase.cpp.

{
   //
   // Now remove the silent regions from all selected / sync-lock selected
   // tracks.
   //
 
   // Loop over detected regions in reverse (so cuts don't change time values
   // down the line)
   int whichReg = 0;
   RegionList::const_reverse_iterator rit;
   for (rit = silences.rbegin(); rit != silences.rend(); ++rit)
   {
      const Region& region = *rit;
      const Region* const r = &region;
 
      // Progress dialog and cancellation. Do additional cleanup before return.
      const double frac =
         detectFrac + (1 - detectFrac) *
                         (iGroup + whichReg / double(silences.size())) /
                         nGroups;
      if (TotalProgress(frac))
         return false;
 
      // Intersection may create regions smaller than allowed; ignore them.
      // Allow one nanosecond extra for consistent results with exact
      // milliseconds of allowed silence.
      if ((r->end - r->start) < (mInitialAllowedSilence - 0.000000001))
         continue;
 
      // Find NEW silence length as requested
      double inLength = r->end - r->start;
      double outLength;
 
      switch (mActionIndex)
      {
      case kTruncate:
         outLength = std::min(mTruncLongestAllowedSilence, inLength);
         break;
      case kCompress:
         outLength =
            mInitialAllowedSilence + (inLength - mInitialAllowedSilence) *
                                        mSilenceCompressPercent / 100.0;
         break;
      default: // Not currently used.
         outLength = std::min(
            mInitialAllowedSilence + (inLength - mInitialAllowedSilence) *
                                        mSilenceCompressPercent / 100.0,
            mTruncLongestAllowedSilence);
      }
 
      const double cutLen = std::max(0.0, inLength - outLength);
      // Don't waste time cutting nothing.
      if (cutLen == 0.0)
         continue;
 
      totalCutLen += cutLen;
 
      bool success = true;
      double cutStart = (r->start + r->end - cutLen) / 2;
      double cutEnd = cutStart + cutLen;
      (range + &SyncLock::IsSelectedOrSyncLockSelectedP -
       [&](const Track* pTrack) {
          return
             // Don't waste time past the end of a track
             pTrack->GetEndTime() < r->start;
       })
         .VisitWhile(
            success,
            [&](WaveTrack& wt) {
               // In WaveTracks, clear with a cross-fade
               auto blendFrames = mBlendFrameCount;
               // Round start/end times to frame boundaries
               cutStart = wt.SnapToSample(cutStart);
               cutEnd = wt.SnapToSample(cutEnd);
 
               // Make sure the cross-fade does not affect non-silent frames
               if (wt.LongSamplesToTime(blendFrames) > inLength)
               {
                  // Result is not more than blendFrames:
                  blendFrames = wt.TimeToLongSamples(inLength).as_size_t();
               }
 
               // Perform cross-fade in memory
               struct Buffers
               {
                  Buffers(size_t size)
                      : buf1 { size }
                      , buf2 { size }
                  {
                  }
                  Floats buf1, buf2;
               };
               Buffers buffers[2] { blendFrames, blendFrames };
               auto t1 = wt.TimeToLongSamples(cutStart) - blendFrames / 2;
               auto t2 = wt.TimeToLongSamples(cutEnd) - blendFrames / 2;
 
               size_t iChannel = 0;
               for (const auto pChannel : wt.Channels())
               {
                  auto& buffer = buffers[iChannel];
                  pChannel->GetFloats(buffer.buf1.get(), t1, blendFrames);
                  pChannel->GetFloats(buffer.buf2.get(), t2, blendFrames);
 
                  for (decltype(blendFrames) i = 0; i < blendFrames; ++i)
                  {
                     buffer.buf1[i] = ((blendFrames - i) * buffer.buf1[i] +
                                       i * buffer.buf2[i]) /
                                      (double)blendFrames;
                  }
                  ++iChannel;
               }
 
               wt.Clear(cutStart, cutEnd);
 
               iChannel = 0;
               for (const auto pChannel : wt.Channels())
               {
                  // Write cross-faded data
                  auto& buffer = buffers[iChannel];
                  success =
                     success &&
                     pChannel->SetFloats(
                        buffer.buf1.get(), t1, blendFrames,
                        // This effect mostly shifts samples to remove silences,
                        // and does only a little bit of floating point
                        // calculations to cross-fade the splices, over a 100
                        // sample interval by default. Don't dither.
                        narrowestSampleFormat);
                  ++iChannel;
               }
            },
            [&](Track& t) {
               // Non-wave tracks: just do a sync-lock adjust
               t.SyncLockAdjust(cutEnd, cutStart);
            });
      if (!success)
         return false;
      ++whichReg;
   }
 
   return true;
}

References sampleCount::as_size_t(), WaveTrack::Channels(), WaveTrack::Clear(), detectFrac, WaveTrack::Region::end, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, SyncLock::IsSelectedOrSyncLockSelectedP(), kCompress, kTruncate, WideSampleSequence::LongSamplesToTime(), mActionIndex, mBlendFrameCount, min(), mInitialAllowedSilence, mSilenceCompressPercent, mTruncLongestAllowedSilence, narrowestSampleFormat, size, WideSampleSequence::SnapToSample(), WaveTrack::Region::start, WideSampleSequence::TimeToLongSamples(), and Effect::TotalProgress().

Referenced by ProcessAll(), and ProcessIndependently().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 28 of file TruncSilenceBase.h.

   {
      return &e;
   }

◆ FindSilences()

bool TruncSilenceBase::FindSilences	(	RegionList &	silences,
		const TrackIterRange< const WaveTrack > &	range
	)

protected

Definition at line 317 of file TruncSilenceBase.cpp.

{
   // Start with the whole selection silent
   silences.push_back(Region(mT0, mT1));
 
   // Remove non-silent regions in each track
   int whichTrack = 0;
   for (auto wt : range)
   {
      // Smallest silent region to detect in frames
      auto minSilenceFrames = sampleCount(
         std::max(mInitialAllowedSilence, DEF_MinTruncMs) * wt->GetRate());
 
      //
      // Scan the track for silences
      //
      RegionList trackSilences;
 
      auto index = wt->TimeToLongSamples(mT0);
      sampleCount silentFrame = 0;
 
      // Detect silences
      bool cancelled = !(Analyze(
         silences, trackSilences, *wt, &silentFrame, &index, whichTrack));
 
      // Buffer has been freed, so we're OK to return if cancelled
      if (cancelled)
         return false;
 
      if (silentFrame >= minSilenceFrames)
      {
         // Track ended in silence -- record region
         trackSilences.push_back(Region(
            wt->LongSamplesToTime(index - silentFrame),
            wt->LongSamplesToTime(index)));
      }
 
      // Intersect with the overall silent region list
      Intersect(silences, trackSilences);
      whichTrack++;
   }
 
   return true;
}

References Analyze(), DEF_MinTruncMs, Intersect(), mInitialAllowedSilence, EffectBase::mT0, and EffectBase::mT1.

Referenced by ProcessAll(), and ProcessIndependently().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString TruncSilenceBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 123 of file TruncSilenceBase.cpp.

{
   return XO(
      "Automatically reduces the length of passages where the volume is below a specified level");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol TruncSilenceBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 118 of file TruncSilenceBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType TruncSilenceBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 136 of file TruncSilenceBase.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Referenced by ProcessAll(), and ProcessIndependently().

Here is the caller graph for this function:

◆ Intersect()

void TruncSilenceBase::Intersect	(	RegionList &	dest,
		const RegionList &	src
	)

protected

Definition at line 703 of file TruncSilenceBase.cpp.

{
   RegionList::iterator destIter;
   destIter = dest.begin();
   // Any time we reach the end of the dest list we're finished
   if (destIter == dest.end())
      return;
   RegionList::iterator curDest = destIter;
 
   // Operation: find non-silent regions in src, remove them from dest.
   double nsStart = curDest->start;
   double nsEnd;
   bool lastRun = false; // must run the loop one extra time
 
   RegionList::const_iterator srcIter = src.begin();
 
   // This logic, causing the loop to run once after end of src, must occur
   // each time srcIter is updated
   if (srcIter == src.end())
   {
      lastRun = true;
   }
 
   while (srcIter != src.end() || lastRun)
   {
      // Don't use curSrc unless lastRun is false!
      RegionList::const_iterator curSrc;
 
      if (lastRun)
      {
         // The last non-silent region extends as far as possible
         nsEnd = std::numeric_limits<double>::max();
      }
      else
      {
         curSrc = srcIter;
         nsEnd = curSrc->start;
      }
 
      if (nsEnd > nsStart)
      {
         // Increment through dest until we have a region that could be affected
         while (curDest->end <= nsStart)
         {
            ++destIter;
            if (destIter == dest.end())
            {
               return;
            }
            curDest = destIter;
         }
 
         // Check for splitting dest region in two
         if (nsStart > curDest->start && nsEnd < curDest->end)
         {
            // The second region
            Region r(nsEnd, curDest->end);
 
            // The first region
            curDest->end = nsStart;
 
            // Insert second region after first
            RegionList::iterator nextIt(destIter);
            ++nextIt;
 
            // This should just read: destIter = dest.insert(nextIt, r); but we
            // work around two two wxList::insert() bugs. First, in some
            // versions it returns the wrong value. Second, in some versions,
            // it crashes when you insert at list end.
            if (nextIt == dest.end())
               dest.push_back(r);
            else
               dest.insert(nextIt, r);
            ++destIter; // (now points at the newly-inserted region)
 
            curDest = destIter;
         }
 
         // Check for truncating the end of dest region
         if (
            nsStart > curDest->start && nsStart < curDest->end &&
            nsEnd >= curDest->end)
         {
            curDest->end = nsStart;
 
            ++destIter;
            if (destIter == dest.end())
            {
               return;
            }
            curDest = destIter;
         }
 
         // Check for all dest regions that need to be removed completely
         while (nsStart <= curDest->start && nsEnd >= curDest->end)
         {
            destIter = dest.erase(destIter);
            if (destIter == dest.end())
            {
               return;
            }
            curDest = destIter;
         }
 
         // Check for truncating the beginning of dest region
         if (
            nsStart <= curDest->start && nsEnd > curDest->start &&
            nsEnd < curDest->end)
         {
            curDest->start = nsEnd;
         }
      }
 
      if (lastRun)
      {
         // done
         lastRun = false;
      }
      else
      {
         // Next non-silent region starts at the end of this silent region
         nsStart = curSrc->end;
         ++srcIter;
         if (srcIter == src.end())
         {
            lastRun = true;
         }
      }
   }
}

References details::end().

Referenced by FindSilences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadSettings()

bool TruncSilenceBase::LoadSettings	(	const CommandParameters &	parms,
		EffectSettings &	settings
	)		const

overridevirtual

Restore settings from keys and values.

Returns: true on success

Implements EffectSettingsManager.

Definition at line 141 of file TruncSilenceBase.cpp.

{
   Effect::LoadSettings(parms, settings);
 
   // A bit of special treatment for two parameters
 
   // This control migrated from a choice to a text box in version 2.3.0
   double myThreshold {};
   bool newParams = [&] {
      double temp;
      if (!parms.ReadAndVerify(
             Threshold.key, &temp, Threshold.def, Threshold.min, Threshold.max))
         return false;
      myThreshold = temp;
      return true;
   }();
 
   if (!newParams)
   {
      int temp;
      // Use legacy param:
      if (!parms.ReadAndVerify(
             L"Db", &temp, 0, Enums::DbChoices, Enums::NumDbChoices))
         return false;
      myThreshold = enumToDB(temp);
   }
 
   {
      int temp;
      if (!parms.ReadAndVerify(
             ActIndex.key, &temp, ActIndex.def, kActionStrings, nActions,
             kObsoleteActions, nObsoleteActions))
         return false;
 
      // TODO:  fix this when settings are really externalized
      const_cast<int&>(mActionIndex) = temp;
   }
   // TODO:  fix this when settings are really externalized
   const_cast<double&>(mThresholdDB) = myThreshold;
   return true;
}

References ActIndex, Enums::DbChoices, EffectParameter< Structure, Member, Type, Value >::def, enumToDB(), kActionStrings, EffectParameter< Structure, Member, Type, Value >::key, kObsoleteActions, Effect::LoadSettings(), mActionIndex, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mThresholdDB, nActions, nObsoleteActions, Enums::NumDbChoices, CommandParameters::ReadAndVerify(), settings(), and Threshold.

Here is the call graph for this function:

◆ ManualPage()

ManualPageID TruncSilenceBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 129 of file TruncSilenceBase.cpp.

{
   return L"Truncate_Silence";
}

◆ NeedsDither()

bool TruncSilenceBase::NeedsDither ( ) const

overridevirtual

Reimplemented from StatefulEffectBase.

Definition at line 852 of file TruncSilenceBase.cpp.

{
   return false;
}

◆ Parameters()

const EffectParameterMethods & TruncSilenceBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 73 of file TruncSilenceBase.cpp.

{
   static CapturedParameters<
      TruncSilenceBase, Threshold, ActIndex, Minimum, Truncate, Compress,
      Independent>
      parameters;
   return parameters;
}

References ActIndex, Compress, Independent, Minimum, Threshold, Truncate, and TruncSilenceBase().

Referenced by TruncSilenceBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 216 of file TruncSilenceBase.cpp.

{
   const bool success = mbIndependent ? ProcessIndependently() : ProcessAll();
 
   return success;
}

References mbIndependent, ProcessAll(), and ProcessIndependently().

Here is the call graph for this function:

◆ ProcessAll()

bool TruncSilenceBase::ProcessAll ( )

protected

Definition at line 291 of file TruncSilenceBase.cpp.

{
   // Copy tracks
   EffectOutputTracks outputs {
      *mTracks, GetType(), { { mT0, mT1 } }, true, true
   };
 
   // Master list of silent regions.
   // This list should always be kept in order.
   RegionList silences;
 
   if (FindSilences(silences, outputs.Get().Selected<const WaveTrack>()))
   {
      auto trackRange = outputs.Get().Any();
      double totalCutLen = 0.0;
      if (DoRemoval(silences, trackRange, 0, 1, totalCutLen))
      {
         mT1 -= totalCutLen;
         outputs.Commit();
         return true;
      }
   }
 
   return false;
}

References DoRemoval(), FindSilences(), GetType(), EffectBase::mT0, EffectBase::mT1, and EffectBase::mTracks.

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessIndependently()

bool TruncSilenceBase::ProcessIndependently ( )

protected

Definition at line 223 of file TruncSilenceBase.cpp.

{
   unsigned nGroups = 0;
 
   const bool syncLock = SyncLockState::Get(*FindProject()).IsSyncLocked();
 
   // Check if it's permissible
   {
      for (auto track : inputTracks()->Selected<const WaveTrack>())
      {
         if (syncLock)
         {
            auto otherTracks =
               SyncLock::Group(*track).Filter<const WaveTrack>() +
               &Track::IsSelected -
               [&](const Track* pTrack) { return pTrack == track; };
            if (otherTracks)
            {
               BasicUI::ShowMessageBox(XO(
                  "When truncating independently, there may only be one selected audio track in each Sync-Locked Track Group."));
               return false;
            }
         }
 
         ++nGroups;
      }
   }
 
   if (nGroups == 0)
      // nothing to do
      return true;
 
   // Now do the work
 
   // Copy tracks
   EffectOutputTracks outputs {
      *mTracks, GetType(), { { mT0, mT1 } }, true, true
   };
   double newT1 = 0.0;
 
   {
      unsigned iGroup = 0;
      for (auto track : outputs.Get().Selected<WaveTrack>())
      {
         RegionList silences;
         if (!FindSilences(
                silences, TrackList::SingletonRange(&as_const(*track))))
            return false;
         // Treat tracks in the sync lock group only
         Track *groupFirst, *groupLast;
         auto range = syncLock ? SyncLock::Group(*track) :
                                 TrackList::SingletonRange<Track>(track);
         double totalCutLen = 0.0;
         if (!DoRemoval(silences, range, iGroup, nGroups, totalCutLen))
            return false;
         newT1 = std::max(newT1, mT1 - totalCutLen);
 
         ++iGroup;
      }
   }
 
   mT1 = newT1;
 
   outputs.Commit();
 
   return true;
}

References DoRemoval(), EffectBase::FindProject(), FindSilences(), SyncLockState::Get(), GetType(), SyncLock::Group(), EffectBase::inputTracks(), Track::IsSelected(), SyncLockState::IsSyncLocked(), EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, BasicUI::ShowMessageBox(), TrackList::SingletonRange(), and XO().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ActIndex

constexpr EnumParameter TruncSilenceBase::ActIndex

staticconstexprprotected

Initial value:

{ &TruncSilenceBase::mActionIndex,
                                             L"Action",
                                             (int)kTruncate,
                                             0,
                                             nActions - 1,
                                             1,
                                             kActionStrings,
                                             nActions }

Definition at line 105 of file TruncSilenceBase.h.

Referenced by LoadSettings(), and Parameters().

◆ Compress

constexpr EffectParameter TruncSilenceBase::Compress

staticconstexprprotected

Initial value:

{
      &TruncSilenceBase::mSilenceCompressPercent,
      L"Compress",
      50.0,
      0.0,
      99.9,
      1
   }

Definition at line 129 of file TruncSilenceBase.h.

Referenced by Parameters().

◆ Independent

constexpr EffectParameter TruncSilenceBase::Independent

staticconstexprprotected

Initial value:

{
      &TruncSilenceBase::mbIndependent, L"Independent", false, false, true, 1
   }

Definition at line 137 of file TruncSilenceBase.h.

Referenced by Parameters().

◆ kActionStrings

const EnumValueSymbol TruncSilenceBase::kActionStrings

staticprotected

Initial value:

= {
   { XO("Truncate Detected Silence") }, { XO("Compress Excess Silence") }
}

Definition at line 100 of file TruncSilenceBase.h.

Referenced by LoadSettings().

◆ mActionIndex

int TruncSilenceBase::mActionIndex

protected

Definition at line 83 of file TruncSilenceBase.h.

Referenced by Analyze(), DoRemoval(), LoadSettings(), and EffectTruncSilence::UpdateUI().

◆ mbIndependent

bool TruncSilenceBase::mbIndependent

protected

Definition at line 87 of file TruncSilenceBase.h.

Referenced by Process(), and EffectTruncSilence::TransferDataFromWindow().

◆ mBlendFrameCount

size_t TruncSilenceBase::mBlendFrameCount

protected

Definition at line 89 of file TruncSilenceBase.h.

Referenced by DoRemoval(), and TruncSilenceBase().

◆ Minimum

constexpr EffectParameter TruncSilenceBase::Minimum

staticconstexprprotected

Initial value:

{
      &TruncSilenceBase::mInitialAllowedSilence,
      L"Minimum",
      0.5,
      0.001,
      10000.0,
      1
   }

Definition at line 113 of file TruncSilenceBase.h.

Referenced by Parameters().

◆ mInitialAllowedSilence

double TruncSilenceBase::mInitialAllowedSilence

protected

Definition at line 84 of file TruncSilenceBase.h.

Referenced by Analyze(), DoRemoval(), and FindSilences().

◆ mSilenceCompressPercent

double TruncSilenceBase::mSilenceCompressPercent

protected

Definition at line 86 of file TruncSilenceBase.h.

Referenced by Analyze(), and DoRemoval().

◆ mThresholdDB

double TruncSilenceBase::mThresholdDB {}

protected

Definition at line 82 of file TruncSilenceBase.h.

Referenced by Analyze(), and LoadSettings().

◆ mTruncLongestAllowedSilence

double TruncSilenceBase::mTruncLongestAllowedSilence

protected

Definition at line 85 of file TruncSilenceBase.h.

Referenced by Analyze(), and DoRemoval().

◆ Symbol

const ComponentInterfaceSymbol TruncSilenceBase::Symbol

static

Initial value:

{ XO(

"Truncate Silence") }

Definition at line 32 of file TruncSilenceBase.h.

Referenced by GetSymbol().

◆ Threshold

constexpr EffectParameter TruncSilenceBase::Threshold

staticconstexprprotected

Initial value:

{
      &TruncSilenceBase::mThresholdDB, L"Threshold", -20.0, -80.0, -20.0, 1
   }

Definition at line 102 of file TruncSilenceBase.h.

Referenced by LoadSettings(), and Parameters().

◆ Truncate

constexpr EffectParameter TruncSilenceBase::Truncate

staticconstexprprotected

Initial value:

{
      &TruncSilenceBase::mTruncLongestAllowedSilence,
      L"Truncate",
      0.5,
      0.0,
      10000.0,
      1
   }

Definition at line 121 of file TruncSilenceBase.h.

Referenced by Parameters().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kActions

Constructor & Destructor Documentation

◆ TruncSilenceBase()

◆ ~TruncSilenceBase()

Member Function Documentation

◆ Analyze()

◆ CalcPreviewInputLength()

◆ DoRemoval()

◆ FetchParameters()

◆ FindSilences()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ Intersect()

◆ LoadSettings()

◆ ManualPage()

◆ NeedsDither()

◆ Parameters()

◆ Process()

◆ ProcessAll()

◆ ProcessIndependently()

Member Data Documentation

◆ ActIndex

◆ Compress

◆ Independent

◆ kActionStrings

◆ mActionIndex

◆ mbIndependent

◆ mBlendFrameCount

◆ Minimum

◆ mInitialAllowedSilence

◆ mSilenceCompressPercent

◆ mThresholdDB

◆ mTruncLongestAllowedSilence

◆ Symbol

◆ Threshold

◆ Truncate