#include <SBSMSEffect.h>

Inheritance diagram for EffectSBSMS:

Collaboration diagram for EffectSBSMS:

Public Member Functions
bool	Process (EffectInstance &instance, EffectSettings &settings) override

void	setParameters (double rateStart, double rateEnd, double pitchStart, double pitchEnd, SlideType rateSlideType, SlideType pitchSlideType, bool bLinkRatePitch, bool bRateReferenceInput, bool bPitchReferenceInput)

void	setParameters (double tempoRatio, double pitchRatio)

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

Public Member Functions inherited from StatefulEffectUIServices
	~StatefulEffectUIServices () override

std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...

virtual std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)

virtual bool	TransferDataFromWindow (EffectSettings &settings)

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

virtual int	ShowHostInterface (EffectBase &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

Static Public Member Functions
static double	getInvertedStretchedTime (double rateStart, double rateEnd, SlideType slideType, double outputTime)

static double	getRate (double rateStart, double rateEnd, SlideType slideType, double t)

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 Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Protected Member Functions
ComponentInterfaceSymbol	GetSymbol () 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
TranslatableString	mProxyEffectName { XO("SBSMS Time / Pitch Stretch") }

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Private Member Functions
EffectType	GetType () const override
	Type determines how it behaves. More...

bool	ProcessLabelTrack (LabelTrack *track)

void	Finalize (WaveTrack &orig, const WaveTrack &out, const TimeWarper &warper)

Private Attributes
double	rateStart

double	rateEnd

double	pitchStart

double	pitchEnd

bool	bLinkRatePitch

bool	bRateReferenceInput

bool	bPitchReferenceInput

SlideType	rateSlideType

SlideType	pitchSlideType

int	mCurTrackNum

float	mTotalStretch

Friends
class	EffectChangeTempo

class	EffectChangePitch

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 Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

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 }

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>")

Detailed Description

Definition at line 30 of file SBSMSEffect.h.

Member Function Documentation

◆ Finalize()

void EffectSBSMS::Finalize	(	WaveTrack &	orig,
		const WaveTrack &	out,
		const TimeWarper &	warper
	)

private

Precondition: orig.NChannels() == out.NChannels()

Definition at line 427 of file SBSMSEffect.cpp.

{
   assert(orig.NChannels() == out.NChannels());
   // Silenced samples will be inserted in gaps between clips, so capture where these
   // gaps are for later deletion
   std::vector<std::pair<double, double>> gaps;
   double last = mT0;
   auto clips = orig.SortedIntervalArray();
   auto front = clips.front();
   auto back = clips.back();
   for (auto &clip : clips) {
      auto st = clip->GetPlayStartTime();
      auto et = clip->GetPlayEndTime();
 
      if (st >= mT0 || et < mT1) {
         if (mT0 < st && clip == front) {
            gaps.push_back(std::make_pair(mT0, st));
         }
         else if (last < st && mT0 <= last ) {
            gaps.push_back(std::make_pair(last, st));
         }
 
         if (et < mT1 && clip == back) {
            gaps.push_back(std::make_pair(et, mT1));
         }
      }
      last = et;
   }
 
   // Take the output track and insert it in place of the original sample data
   orig.ClearAndPaste(mT0, mT1, out, true, true, &warper);
 
   // Finally, recreate the gaps
   for (auto gap : gaps) {
      const auto st = orig.SnapToSample(gap.first);
      const auto et = orig.SnapToSample(gap.second);
      if (st >= mT0 && et <= mT1 && st != et)
         orig.SplitDelete(warper.Warp(st), warper.Warp(et));
   }
}

References WaveTrack::ClearAndPaste(), gap, EffectBase::mT0, EffectBase::mT1, WaveTrack::NChannels(), WideSampleSequence::SnapToSample(), WaveTrack::SortedIntervalArray(), WaveTrack::SplitDelete(), and TimeWarper::Warp().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInvertedStretchedTime()

double EffectSBSMS::getInvertedStretchedTime	(	double	rateStart,
		double	rateEnd,
		SlideType	slideType,
		double	outputTime
	)

static

Definition at line 214 of file SBSMSEffect.cpp.

{
   Slide slide(slideType,rateStart,rateEnd,0);
   return slide.getInverseStretchedTime(outputTime);
}

References rateEnd, and rateStart.

Referenced by EffectTimeScale::CalcPreviewInputLength().

Here is the caller graph for this function:

◆ getRate()

double EffectSBSMS::getRate	(	double	rateStart,
		double	rateEnd,
		SlideType	slideType,
		double	t
	)

static

Definition at line 220 of file SBSMSEffect.cpp.

{
   Slide slide(slideType,rateStart,rateEnd,0);
   return slide.getRate(t);
}

References rateEnd, and rateStart.

Referenced by EffectTimeScale::Process().

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectSBSMS::GetSymbol ( ) const

inlineoverrideprotectedvirtual

Implements ComponentInterface.

Reimplemented in EffectTimeScale.

Definition at line 48 of file SBSMSEffect.h.

48{ return mProxyEffectName; }

EffectSBSMS::mProxyEffectName

TranslatableString mProxyEffectName

Definition: SBSMSEffect.h:44

References mProxyEffectName.

◆ GetType()

EffectType EffectSBSMS::GetType ( ) const

overrideprivatevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Reimplemented in EffectTimeScale.

Definition at line 198 of file SBSMSEffect.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Referenced by Process().

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Reimplemented in EffectTimeScale.

Definition at line 226 of file SBSMSEffect.cpp.

{
   bool bGoodResult = true;
 
   //Iterate over each track
   //all needed because this effect needs to introduce silence in the group tracks to keep sync
   EffectOutputTracks outputs { *mTracks, GetType(), { { mT0, mT1 } }, true };
   mCurTrackNum = 0;
 
   double maxDuration = 0.0;
 
   Slide rateSlide(rateSlideType,rateStart,rateEnd);
   Slide pitchSlide(pitchSlideType,pitchStart,pitchEnd);
   mTotalStretch = rateSlide.getTotalStretch();
 
   outputs.Get().Any().VisitWhile(bGoodResult,
      [&](auto &&fallthrough){ return [&](LabelTrack &lt) {
         if (!(lt.GetSelected() || SyncLock::IsSyncLockSelected(lt)))
            return fallthrough();
         if (!ProcessLabelTrack(&lt))
            bGoodResult = false;
      }; },
      [&](auto &&fallthrough){ return [&](WaveTrack &track) {
         if (!track.GetSelected())
            return fallthrough();
 
         // Process only if the right marker is to the right of the left marker
         if (mT1 > mT0) {
            const auto start = track.TimeToLongSamples(mT0);
            const auto end = track.TimeToLongSamples(mT1);
 
            // TODO: more-than-two-channels
            auto channels = track.Channels();
            const auto leftTrack = (*channels.begin()).get();
            const auto rightTrack = (channels.size() > 1)
               ? (* ++ channels.first).get()
               : nullptr;
            if (rightTrack)
               mCurTrackNum++; // Increment for rightTrack, too.
 
            // SBSMS has a fixed sample rate - we just convert to its sample
            // rate and then convert back
            const float srTrack = track.GetRate();
            const float srProcess = bLinkRatePitch ? srTrack : 44100.0;
 
            // the resampler needs a callback to supply its samples
            ResampleBuf rb;
            const auto maxBlockSize = track.GetMaxBlockSize();
            rb.blockSize = maxBlockSize;
            rb.buf.reinit(rb.blockSize, true);
            rb.leftTrack = leftTrack;
            rb.rightTrack = rightTrack ? rightTrack : leftTrack;
            rb.leftBuffer.reinit(maxBlockSize, true);
            rb.rightBuffer.reinit(maxBlockSize, true);
 
            // Samples in selection
            const auto samplesIn = end - start;
 
            // Samples for SBSMS to process after resampling
            const auto samplesToProcess = static_cast<sampleCount>(
               samplesIn.as_float() * (srProcess/srTrack));
 
            SlideType outSlideType;
            SBSMSResampleCB outResampleCB;
 
            if (bLinkRatePitch) {
              rb.bPitch = true;
              outSlideType = rateSlideType;
              outResampleCB = resampleCB;
              rb.offset = start;
              rb.end = end;
               // Third party library has its own type alias, check it
               static_assert(sizeof(sampleCount::type) <=
                 sizeof(_sbsms_::SampleCountType),
"Type _sbsms_::SampleCountType is too narrow to hold a sampleCount");
              rb.iface = std::make_unique<SBSMSInterfaceSliding>(
                  &rateSlide, &pitchSlide, bPitchReferenceInput,
                  static_cast<_sbsms_::SampleCountType>(
                     samplesToProcess.as_long_long()),
                  0, nullptr);
            }
            else {
               rb.bPitch = false;
               outSlideType =
                  (srProcess == srTrack ? SlideIdentity : SlideConstant);
               outResampleCB = postResampleCB;
               rb.ratio = srProcess/srTrack;
               rb.quality = std::make_unique<SBSMSQuality>(&SBSMSQualityStandard);
               rb.resampler = std::make_unique<Resampler>(resampleCB, &rb,
                  srProcess == srTrack ? SlideIdentity : SlideConstant);
               rb.sbsms = std::make_unique<SBSMS>(
                  rightTrack ? 2 : 1, rb.quality.get(), true);
               rb.SBSMSBlockSize = rb.sbsms->getInputFrameSize();
               rb.SBSMSBuf.reinit(static_cast<size_t>(rb.SBSMSBlockSize), true);
               rb.offset = start;
               rb.end = end;
               rb.iface = std::make_unique<SBSMSEffectInterface>(
                  rb.resampler.get(), &rateSlide, &pitchSlide,
                  bPitchReferenceInput,
                  static_cast<_sbsms_::SampleCountType>(
                     samplesToProcess.as_long_long()),
                  0,
                  rb.quality.get());
            }
 
            Resampler resampler(outResampleCB, &rb, outSlideType);
 
            audio outBuf[SBSMSOutBlockSize];
            float outBufLeft[2 * SBSMSOutBlockSize];
            float outBufRight[2 * SBSMSOutBlockSize];
 
            // Samples in output after SBSMS
            const sampleCount samplesToOutput = rb.iface->getSamplesToOutput();
 
            // Samples in output after resampling back
            const auto samplesOut = static_cast<sampleCount>(
               samplesToOutput.as_float() * (srTrack / srProcess));
 
            // Duration in track time
            const double duration = (mT1 - mT0) * mTotalStretch;
 
            if (duration > maxDuration)
               maxDuration = duration;
 
            const auto warper = createTimeWarper(
               mT0, mT1, maxDuration, rateStart, rateEnd, rateSlideType);
 
            WaveTrack::Holder outputTrack = track.EmptyCopy();
            auto iter = outputTrack->Channels().begin();
            rb.outputTrack = outputTrack.get();
            rb.outputLeftChannel = (*iter++).get();
            if (rightTrack)
               rb.outputRightChannel = (*iter).get();
 
            long pos = 0;
            long outputCount = -1;
 
            // process
            while (pos < samplesOut && outputCount) {
               const auto frames =
                  limitSampleBufferSize(SBSMSOutBlockSize, samplesOut - pos);
 
               outputCount = resampler.read(outBuf, frames);
               for (int i = 0; i < outputCount; ++i) {
                  outBufLeft[i] = outBuf[i][0];
                  if (rightTrack)
                     outBufRight[i] = outBuf[i][1];
               }
               pos += outputCount;
               rb.outputLeftChannel->Append(
                  (samplePtr)outBufLeft, floatSample, outputCount);
               if (rightTrack)
                  rb.outputRightChannel->Append(
                     (samplePtr)outBufRight, floatSample, outputCount);
 
               double frac = static_cast<double>(pos) / samplesOut.as_double();
               int nWhichTrack = mCurTrackNum;
               if (rightTrack) {
                  nWhichTrack = 2 * (mCurTrackNum / 2);
                  if (frac < 0.5)
                     // Show twice as far for each track,
                     // because we're doing 2 at once.
                     frac *= 2.0;
                  else {
                     nWhichTrack++;
                     frac -= 0.5;
                     // Show twice as far for each track,
                     // because we're doing 2 at once.
                     frac *= 2.0;
                  }
               }
               if (TrackProgress(nWhichTrack, frac)) {
                  bGoodResult = false;
                  return;
               }
            }
 
            {
               auto pException = rb.mpException;
               rb.mpException = {};
               if (pException)
                  std::rethrow_exception(pException);
            }
 
            rb.outputTrack->Flush();
            Finalize(track, *outputTrack, *warper);
         }
         mCurTrackNum++;
      }; },
      [&](Track &t) {
         if (SyncLock::IsSyncLockSelected(t))
            t.SyncLockAdjust(mT1, mT0 + (mT1 - mT0) * mTotalStretch);
      }
   );
 
   if (bGoodResult)
      outputs.Commit();
 
   return bGoodResult;
}

References WaveChannel::Append(), sampleCount::as_float(), audio, bLinkRatePitch, ResampleBuf::blockSize, ResampleBuf::bPitch, bPitchReferenceInput, ResampleBuf::buf, createTimeWarper(), details::end(), ResampleBuf::end, Finalize(), floatSample, WaveTrack::Flush(), GetType(), ResampleBuf::iface, SyncLock::IsSyncLockSelected(), ResampleBuf::leftBuffer, ResampleBuf::leftTrack, limitSampleBufferSize(), anonymous_namespace{StaffPadTimeAndPitch.cpp}::maxBlockSize, mCurTrackNum, ResampleBuf::mpException, EffectBase::mT0, EffectBase::mT1, mTotalStretch, EffectBase::mTracks, ResampleBuf::offset, ResampleBuf::outputLeftChannel, ResampleBuf::outputRightChannel, ResampleBuf::outputTrack, pitchEnd, pitchSlideType, pitchStart, postResampleCB(), ProcessLabelTrack(), ResampleBuf::quality, rateEnd, rateSlideType, rateStart, ResampleBuf::ratio, ArrayOf< X >::reinit(), resampleCB(), ResampleBuf::resampler, ResampleBuf::rightBuffer, ResampleBuf::rightTrack, ResampleBuf::sbsms, ResampleBuf::SBSMSBlockSize, ResampleBuf::SBSMSBuf, SBSMSOutBlockSize, and Effect::TrackProgress().

Referenced by EffectTimeScale::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessLabelTrack()

bool EffectSBSMS::ProcessLabelTrack ( LabelTrack * track )

private

Definition at line 205 of file SBSMSEffect.cpp.

{
   auto warper1 = createTimeWarper(
      mT0, mT1, (mT1 - mT0) * mTotalStretch, rateStart, rateEnd, rateSlideType);
   RegionTimeWarper warper{ mT0, mT1, std::move(warper1) };
   lt->WarpLabels(warper);
   return true;
}

References createTimeWarper(), EffectBase::mT0, EffectBase::mT1, mTotalStretch, rateEnd, rateSlideType, rateStart, and LabelTrack::WarpLabels().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParameters() [1/2]

void EffectSBSMS::setParameters	(	double	rateStart,
		double	rateEnd,
		double	pitchStart,
		double	pitchEnd,
		SlideType	rateSlideType,
		SlideType	pitchSlideType,
		bool	bLinkRatePitch,
		bool	bRateReferenceInput,
		bool	bPitchReferenceInput
	)

Definition at line 149 of file SBSMSEffect.cpp.

{
   this->rateStart = rateStartIn;
   this->rateEnd = rateEndIn;
   this->pitchStart = pitchStartIn;
   this->pitchEnd = pitchEndIn;
   this->bLinkRatePitch = bLinkRatePitchIn;
   this->rateSlideType = rateSlideTypeIn;
   this->pitchSlideType = pitchSlideTypeIn;
   this->bRateReferenceInput = bRateReferenceInputIn;
   this->bPitchReferenceInput = bPitchReferenceInputIn;
}

References bLinkRatePitch, bPitchReferenceInput, bRateReferenceInput, pitchEnd, pitchSlideType, pitchStart, rateEnd, rateSlideType, and rateStart.

Referenced by EffectTimeScale::Process(), and setParameters().

Here is the caller graph for this function:

◆ setParameters() [2/2]

void EffectSBSMS::setParameters	(	double	tempoRatio,
		double	pitchRatio
	)

Definition at line 164 of file SBSMSEffect.cpp.

{
   setParameters(tempoRatio, tempoRatio, pitchRatio, pitchRatio,
                 SlideConstant, SlideConstant, false, false, false);
}

References setParameters().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ EffectChangePitch

friend class EffectChangePitch

friend

Definition at line 68 of file SBSMSEffect.h.

◆ EffectChangeTempo

friend class EffectChangeTempo

friend

Definition at line 67 of file SBSMSEffect.h.

Member Data Documentation

◆ bLinkRatePitch

bool EffectSBSMS::bLinkRatePitch

private

Definition at line 61 of file SBSMSEffect.h.

Referenced by Process(), and setParameters().

◆ bPitchReferenceInput

bool EffectSBSMS::bPitchReferenceInput

private

Definition at line 61 of file SBSMSEffect.h.

Referenced by Process(), and setParameters().

◆ bRateReferenceInput

bool EffectSBSMS::bRateReferenceInput

private

Definition at line 61 of file SBSMSEffect.h.

Referenced by setParameters().

◆ mCurTrackNum

int EffectSBSMS::mCurTrackNum

private

Definition at line 64 of file SBSMSEffect.h.

Referenced by Process().

◆ mProxyEffectName

TranslatableString EffectSBSMS::mProxyEffectName { XO("SBSMS Time / Pitch Stretch") }

protected

Definition at line 44 of file SBSMSEffect.h.

Referenced by GetSymbol().

◆ mTotalStretch

float EffectSBSMS::mTotalStretch

private

Definition at line 65 of file SBSMSEffect.h.

Referenced by Process(), and ProcessLabelTrack().

◆ pitchEnd

double EffectSBSMS::pitchEnd

private

Definition at line 60 of file SBSMSEffect.h.

Referenced by Process(), and setParameters().

◆ pitchSlideType

SlideType EffectSBSMS::pitchSlideType

private

Definition at line 63 of file SBSMSEffect.h.

Referenced by Process(), and setParameters().

◆ pitchStart

double EffectSBSMS::pitchStart

private

Definition at line 60 of file SBSMSEffect.h.

Referenced by Process(), and setParameters().

◆ rateEnd

double EffectSBSMS::rateEnd

private

Definition at line 60 of file SBSMSEffect.h.

Referenced by getInvertedStretchedTime(), getRate(), Process(), ProcessLabelTrack(), and setParameters().

◆ rateSlideType

SlideType EffectSBSMS::rateSlideType

private

Definition at line 62 of file SBSMSEffect.h.

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

◆ rateStart

double EffectSBSMS::rateStart

private

Definition at line 60 of file SBSMSEffect.h.

Referenced by getInvertedStretchedTime(), getRate(), Process(), ProcessLabelTrack(), and setParameters().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Finalize()

◆ getInvertedStretchedTime()

◆ getRate()

◆ GetSymbol()

◆ GetType()

◆ Process()

◆ ProcessLabelTrack()

◆ setParameters() [1/2]

◆ setParameters() [2/2]

Friends And Related Function Documentation

◆ EffectChangePitch

◆ EffectChangeTempo

Member Data Documentation

◆ bLinkRatePitch

◆ bPitchReferenceInput

◆ bRateReferenceInput

◆ mCurTrackNum

◆ mProxyEffectName

◆ mTotalStretch

◆ pitchEnd

◆ pitchSlideType

◆ pitchStart

◆ rateEnd

◆ rateSlideType

◆ rateStart