An Effect that affects both pitch & speed. More...

#include <ChangeSpeedBase.h>

Inheritance diagram for ChangeSpeedBase:

Collaboration diagram for ChangeSpeedBase:

Public Member Functions
	ChangeSpeedBase ()

virtual	~ChangeSpeedBase ()

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

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

OptionalMessage	DoLoadFactoryDefaults (EffectSettings &settings)

bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	After Init(), tell whether Process() should be skipped. More...

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

bool	Init () override

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 ChangeSpeedBase *	FetchParameters (ChangeSpeedBase &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 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	mCurTrackNum

double	mCurT0

double	mCurT1

double	m_PercentChange

int	mFromVinyl

double	mFactor

double	mFromLength

int	mTimeCtrlFormat

double	mMultiplier

bool	mbLoopDetect

double	mRate

int	mToVinyl

double	mToLength

NumericFormatID	mFormat

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static constexpr EffectParameter	Percentage

Private Types
using	Gap = std::pair< double, double >

using	Gaps = std::vector< Gap >

Private Member Functions
Gaps	FindGaps (const WaveTrack &track, const double curT0, const double curT1)

bool	ProcessOne (const WaveChannel &track, WaveChannel &outputTrack, sampleCount start, sampleCount end)

bool	ProcessLabelTrack (LabelTrack *t)

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 that affects both pitch & speed.

Definition at line 20 of file ChangeSpeedBase.h.

Member Typedef Documentation

◆ Gap

using ChangeSpeedBase::Gap = std::pair<double, double>

private

Definition at line 54 of file ChangeSpeedBase.h.

◆ Gaps

using ChangeSpeedBase::Gaps = std::vector<Gap>

private

Definition at line 55 of file ChangeSpeedBase.h.

Constructor & Destructor Documentation

◆ ChangeSpeedBase()

ChangeSpeedBase::ChangeSpeedBase ( )

Definition at line 25 of file ChangeSpeedBase.cpp.

{
   Parameters().Reset(*this);
 
   mFromVinyl = kVinyl_33AndAThird;
   mToVinyl = kVinyl_33AndAThird;
   mFromLength = 0.0;
   mToLength = 0.0;
   mFormat = NumericConverterFormats::DefaultSelectionFormat().Internal();
   mbLoopDetect = false;
 
   SetLinearEffectFlag(true);
}

References NumericConverterFormats::DefaultSelectionFormat(), ComponentInterfaceSymbol::Internal(), kVinyl_33AndAThird, mbLoopDetect, mFormat, mFromLength, mFromVinyl, mToLength, mToVinyl, Parameters(), EffectParameterMethods::Reset(), and EffectBase::SetLinearEffectFlag().

Here is the call graph for this function:

◆ ~ChangeSpeedBase()

ChangeSpeedBase::~ChangeSpeedBase ( )

virtual

Definition at line 39 of file ChangeSpeedBase.cpp.

40{

41}

Member Function Documentation

◆ CalcPreviewInputLength()

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

overridevirtual

Implements EffectBase.

Definition at line 83 of file ChangeSpeedBase.cpp.

{
   return previewLength * (100.0 + m_PercentChange) / 100.0;
}

References m_PercentChange.

◆ CheckWhetherSkipEffect()

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

overridevirtual

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

Implements EffectBase.

Definition at line 78 of file ChangeSpeedBase.cpp.

{
   return (m_PercentChange == 0.0);
}

References m_PercentChange.

◆ DoLoadFactoryDefaults()

OptionalMessage ChangeSpeedBase::DoLoadFactoryDefaults ( EffectSettings & settings )

Definition at line 70 of file ChangeSpeedBase.cpp.

{
   mFromVinyl = kVinyl_33AndAThird;
   mFormat = NumericConverterFormats::DefaultSelectionFormat().Internal();
 
   return Effect::LoadFactoryDefaults(settings);
}

References NumericConverterFormats::DefaultSelectionFormat(), ComponentInterfaceSymbol::Internal(), kVinyl_33AndAThird, Effect::LoadFactoryDefaults(), mFormat, mFromVinyl, and settings().

Referenced by LoadFactoryDefaults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 24 of file ChangeSpeedBase.h.

   {
      return &e;
   }

◆ FindGaps()

auto ChangeSpeedBase::FindGaps	(	const WaveTrack &	track,
		const double	curT0,
		const double	curT1
	)

private

Definition at line 97 of file ChangeSpeedBase.cpp.

{
   // Silenced samples will be inserted in gaps between clips, so capture where
   // these gaps are for later deletion
   Gaps gaps;
   const auto newGap = [&](double st, double et) {
      gaps.emplace_back(track.SnapToSample(st), track.SnapToSample(et));
   };
   double last = curT0;
   auto clips = track.SortedIntervalArray();
   auto front = clips.front();
   auto back = clips.back();
   for (auto& clip : clips)
   {
      auto st = clip->GetPlayStartTime();
      auto et = clip->GetPlayEndTime();
      if (st >= curT0 || et < curT1)
      {
         if (curT0 < st && clip == front)
            newGap(curT0, st);
         else if (last < st && curT0 <= last)
            newGap(last, st);
         if (et < curT1 && clip == back)
            newGap(et, curT1);
      }
      last = et;
   }
   return gaps;
}

Referenced by Process().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString ChangeSpeedBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 48 of file ChangeSpeedBase.cpp.

{
   return XO("Changes the speed of a track, also changing its pitch");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol ChangeSpeedBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 43 of file ChangeSpeedBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType ChangeSpeedBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 58 of file ChangeSpeedBase.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Referenced by Process().

Here is the caller graph for this function:

◆ Init()

bool ChangeSpeedBase::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 89 of file ChangeSpeedBase.cpp.

{
   // The selection might have changed since the last time ChangeSpeedBase
   // was invoked, so recalculate the Length parameters.
   mFromLength = mT1 - mT0;
   return true;
}

References mFromLength, EffectBase::mT0, and EffectBase::mT1.

◆ LoadFactoryDefaults()

OptionalMessage ChangeSpeedBase::LoadFactoryDefaults ( EffectSettings & settings ) const

overridevirtual

Change settings back to "factory default"

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 64 of file ChangeSpeedBase.cpp.

{
   // To do: externalize state so const_cast isn't needed
   return const_cast<ChangeSpeedBase&>(*this).DoLoadFactoryDefaults(settings);
}

References DoLoadFactoryDefaults(), and settings().

Here is the call graph for this function:

◆ ManualPage()

ManualPageID ChangeSpeedBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 53 of file ChangeSpeedBase.cpp.

{
   return L"Change_Speed";
}

◆ Parameters()

const EffectParameterMethods & ChangeSpeedBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 16 of file ChangeSpeedBase.cpp.

{
   static CapturedParameters<ChangeSpeedBase, Percentage> parameters;
   return parameters;
}

Referenced by ChangeSpeedBase().

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 128 of file ChangeSpeedBase.cpp.

{
   // Similar to SoundTouchBase::Process()
 
   // Iterate over each track.
   // All needed because this effect needs to introduce
   // silence in the sync-lock group tracks to keep sync
   EffectOutputTracks outputs { *mTracks, GetType(), { { mT0, mT1 } }, true };
   bool bGoodResult = true;
 
   mCurTrackNum = 0;
 
   mFactor = 100.0 / (100.0 + m_PercentChange);
 
   outputs.Get().Any().VisitWhile(
      bGoodResult,
      [&](LabelTrack& lt) {
         if (SyncLock::IsSelectedOrSyncLockSelected(lt))
         {
            if (!ProcessLabelTrack(&lt))
               bGoodResult = false;
         }
      },
      [&](auto&& fallthrough) {
         return [&](WaveTrack& outWaveTrack) {
            if (!outWaveTrack.GetSelected())
               return fallthrough();
 
            // Get start and end times from track
            mCurT0 = outWaveTrack.GetStartTime();
            mCurT1 = outWaveTrack.GetEndTime();
 
            // Set the current bounds to whichever left marker is
            // greater and whichever right marker is less:
            mCurT0 = std::max(mT0, mCurT0);
            mCurT1 = std::min(mT1, mCurT1);
 
            // Process only if the right marker is to the right of the left
            // marker
            if (mCurT1 > mCurT0)
            {
               // Transform the marker timepoints to samples
               auto start = outWaveTrack.TimeToLongSamples(mCurT0);
               auto end = outWaveTrack.TimeToLongSamples(mCurT1);
 
               const auto gaps = FindGaps(outWaveTrack, mCurT0, mCurT1);
 
               auto pNewTrack = outWaveTrack.EmptyCopy();
               auto iter = pNewTrack->Channels().begin();
               for (const auto pChannel : outWaveTrack.Channels())
               {
                  // ProcessOne() (implemented below) processes a single channel
                  if (ProcessOne(*pChannel, **iter++, start, end))
                     ++mCurTrackNum;
                  else
                  {
                     pNewTrack.reset();
                     break;
                  }
               }
               if (!pNewTrack)
               {
                  bGoodResult = false;
                  return;
               }
               pNewTrack->Flush();
 
               const double newLength = pNewTrack->GetEndTime();
               const LinearTimeWarper warper { mCurT0, mCurT0, mCurT1,
                                               mCurT0 + newLength };
 
               outWaveTrack.ClearAndPaste(
                  mCurT0, mCurT1, *pNewTrack, true, true, &warper);
 
               // Finally, recreate the gaps
               for (const auto [st, et] : gaps)
                  if (st >= mCurT0 && et <= mCurT1 && st != et)
                     outWaveTrack.SplitDelete(warper.Warp(st), warper.Warp(et));
            }
            else
               mCurTrackNum += outWaveTrack.NChannels();
         };
      },
      [&](Track& t) {
         if (SyncLock::IsSyncLockSelected(t))
            t.SyncLockAdjust(mT1, mT0 + (mT1 - mT0) * mFactor);
      });
 
   if (bGoodResult)
      outputs.Commit();
 
   // Update selection.
   mT1 = mT0 + (((mT1 - mT0) * 100.0) / (100.0 + m_PercentChange));
 
   return bGoodResult;
}

References details::end(), FindGaps(), GetType(), SyncLock::IsSelectedOrSyncLockSelected(), SyncLock::IsSyncLockSelected(), m_PercentChange, mCurT0, mCurT1, mCurTrackNum, mFactor, min(), EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, ProcessLabelTrack(), and ProcessOne().

Here is the call graph for this function:

◆ ProcessLabelTrack()

bool ChangeSpeedBase::ProcessLabelTrack ( LabelTrack * t )

private

Definition at line 227 of file ChangeSpeedBase.cpp.

{
   RegionTimeWarper warper { mT0, mT1,
                             std::make_unique<LinearTimeWarper>(
                                mT0, mT0, mT1, mT0 + (mT1 - mT0) * mFactor) };
   lt->WarpLabels(warper);
   return true;
}

References mFactor, EffectBase::mT0, EffectBase::mT1, and LabelTrack::WarpLabels().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessOne()

bool ChangeSpeedBase::ProcessOne	(	const WaveChannel &	track,
		WaveChannel &	outputTrack,
		sampleCount	start,
		sampleCount	end
	)

private

Definition at line 238 of file ChangeSpeedBase.cpp.

{
   // Get the length of the selection (as double). len is
   // used simple 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 processing buffers, most likely shorter than
   // the length of the selection being processed.
   auto inBufferSize = track.GetMaxBlockSize();
 
   Floats inBuffer { inBufferSize };
 
   // mFactor is at most 100-fold so this shouldn't overflow size_t
   auto outBufferSize = size_t(mFactor * inBufferSize + 10);
   Floats outBuffer { outBufferSize };
 
   // Set up the resampling stuff for this track.
   Resample resample(true, mFactor, mFactor); // constant rate resampling
 
   // Go through the track one buffer at a time. samplePos counts which
   // sample the current buffer starts at.
   bool bResult = true;
   auto samplePos = start;
   while (samplePos < end)
   {
      // Get a blockSize of samples (smaller than the size of the buffer)
      auto blockSize = limitSampleBufferSize(
         track.GetBestBlockSize(samplePos), end - samplePos);
 
      // Get the samples from the track and put them in the buffer
      track.GetFloats(inBuffer.get(), samplePos, blockSize);
 
      const auto results = resample.Process(
         mFactor, inBuffer.get(), blockSize, ((samplePos + blockSize) >= end),
         outBuffer.get(), outBufferSize);
      const auto outgen = results.second;
 
      if (outgen > 0)
         outputTrack.Append((samplePtr)outBuffer.get(), floatSample, outgen);
 
      // Increment samplePos
      samplePos += results.first;
 
      // Update the Progress meter
      if (TrackProgress(mCurTrackNum, (samplePos - start).as_double() / len))
      {
         bResult = false;
         break;
      }
   }
 
   return bResult;
}

References WaveChannel::Append(), details::end(), floatSample, WaveChannel::GetBestBlockSize(), WaveChannel::GetFloats(), WaveChannel::GetMaxBlockSize(), limitSampleBufferSize(), mCurTrackNum, mFactor, Resample::Process(), and Effect::TrackProgress().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_PercentChange

double ChangeSpeedBase::m_PercentChange

protected

Definition at line 72 of file ChangeSpeedBase.h.

Referenced by CalcPreviewInputLength(), CheckWhetherSkipEffect(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::OnSlider_PercentChange(), EffectChangeSpeed::OnText_Multiplier(), EffectChangeSpeed::OnTimeCtrl_ToLength(), Process(), EffectChangeSpeed::TransferDataFromWindow(), EffectChangeSpeed::Update_Slider_PercentChange(), EffectChangeSpeed::Update_Text_Multiplier(), EffectChangeSpeed::Update_TimeCtrl_ToLength(), EffectChangeSpeed::Update_Vinyl(), and EffectChangeSpeed::UpdateUI().

◆ mbLoopDetect

bool ChangeSpeedBase::mbLoopDetect

protected

Definition at line 81 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::OnSlider_PercentChange(), EffectChangeSpeed::OnText_Multiplier(), EffectChangeSpeed::OnText_PercentChange(), EffectChangeSpeed::OnTimeCtrl_ToLength(), and EffectChangeSpeed::TransferDataToWindow().

◆ mCurT0

double ChangeSpeedBase::mCurT0

protected

Definition at line 67 of file ChangeSpeedBase.h.

Referenced by Process().

◆ mCurT1

double ChangeSpeedBase::mCurT1

protected

Definition at line 68 of file ChangeSpeedBase.h.

Referenced by Process().

◆ mCurTrackNum

int ChangeSpeedBase::mCurTrackNum

protected

Definition at line 66 of file ChangeSpeedBase.h.

Referenced by Process(), and ProcessOne().

◆ mFactor

double ChangeSpeedBase::mFactor

protected

Definition at line 76 of file ChangeSpeedBase.h.

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

◆ mFormat

NumericFormatID ChangeSpeedBase::mFormat

protected

Definition at line 88 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), DoLoadFactoryDefaults(), EffectChangeSpeed::OnTimeCtrlUpdate(), EffectChangeSpeed::TransferDataFromWindow(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

◆ mFromLength

double ChangeSpeedBase::mFromLength

protected

Definition at line 77 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), Init(), EffectChangeSpeed::OnTimeCtrl_ToLength(), EffectChangeSpeed::OnTimeCtrlUpdate(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

◆ mFromVinyl

int ChangeSpeedBase::mFromVinyl

protected

Definition at line 75 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), DoLoadFactoryDefaults(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::TransferDataFromWindow(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_Vinyl().

◆ mMultiplier

double ChangeSpeedBase::mMultiplier

protected

Definition at line 79 of file ChangeSpeedBase.h.

Referenced by EffectChangeSpeed::OnText_Multiplier(), and EffectChangeSpeed::Update_Text_Multiplier().

◆ mRate

double ChangeSpeedBase::mRate

protected

Definition at line 83 of file ChangeSpeedBase.h.

◆ mTimeCtrlFormat

int ChangeSpeedBase::mTimeCtrlFormat

protected

Definition at line 78 of file ChangeSpeedBase.h.

◆ mToLength

double ChangeSpeedBase::mToLength

protected

Definition at line 87 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), EffectChangeSpeed::OnTimeCtrl_ToLength(), EffectChangeSpeed::OnTimeCtrlUpdate(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

◆ mToVinyl

int ChangeSpeedBase::mToVinyl

protected

Definition at line 86 of file ChangeSpeedBase.h.

Referenced by ChangeSpeedBase(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_Vinyl().

◆ Percentage

constexpr EffectParameter ChangeSpeedBase::Percentage

staticconstexprprotected

Initial value:

{
      &ChangeSpeedBase::m_PercentChange, L"Percentage", 0.0, -99.0, 4900.0, 1
   }

Definition at line 92 of file ChangeSpeedBase.h.

Referenced by EffectChangeSpeed::Update_Slider_PercentChange(), and EffectChangeSpeed::UpdateUI().

◆ Symbol

const ComponentInterfaceSymbol ChangeSpeedBase::Symbol

static

Initial value:

{ XO(

"Change Speed and Pitch") }

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

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Gap

◆ Gaps

Constructor & Destructor Documentation

◆ ChangeSpeedBase()

◆ ~ChangeSpeedBase()

Member Function Documentation

◆ CalcPreviewInputLength()

◆ CheckWhetherSkipEffect()

◆ DoLoadFactoryDefaults()

◆ FetchParameters()

◆ FindGaps()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ Init()

◆ LoadFactoryDefaults()

◆ ManualPage()

◆ Parameters()

◆ Process()

◆ ProcessLabelTrack()

◆ ProcessOne()

Member Data Documentation

◆ m_PercentChange

◆ mbLoopDetect

◆ mCurT0

◆ mCurT1

◆ mCurTrackNum

◆ mFactor

◆ mFormat

◆ mFromLength

◆ mFromVinyl

◆ mMultiplier

◆ mRate

◆ mTimeCtrlFormat

◆ mToLength

◆ mToVinyl

◆ Percentage

◆ Symbol