An EffectTimeScale does high quality sliding time scaling/pitch shifting. More...

#include <TimeScale.h>

Inheritance diagram for EffectTimeScale:

Collaboration diagram for EffectTimeScale:

Public Member Functions
	EffectTimeScale ()

virtual	~EffectTimeScale ()

ComponentInterfaceSymbol	GetSymbol () override

TranslatableString	GetDescription () override

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

EffectType	GetType () override
	Type determines how it behaves. More...

bool	GetAutomationParameters (CommandParameters &parms) override
	Save current settings into parms. More...

bool	SetAutomationParameters (CommandParameters &parms) override
	Change settings to those stored in parms. More...

bool	DefineParams (ShuttleParams &S) override

bool	Init () override

void	Preview (bool dryOnly) override

bool	Process () override

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

double	CalcPreviewInputLength (double previewLength) override

Public Member Functions inherited from EffectSBSMS
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 Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

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

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

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

bool	IsLegacy () override

bool	SupportsRealtime () override
	Whether the effect supports realtime previewing (while audio is playing). More...

bool	SupportsAutomation () override
	Whether the effect can be used without the UI, in a macro. More...

bool	LoadUserPreset (const RegistryPath &name) override
	Change settings to a user-named preset. More...

bool	SaveUserPreset (const RegistryPath &name) override
	Save current settings as a user-named preset. More...

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

bool	LoadFactoryPreset (int id) override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

bool	LoadFactoryDefaults () override
	Change settings back to "factory default". More...

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override
	Called for destructive, non-realtime effect computation. More...

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override
	Called for destructive, non-realtime effect computation. More...

bool	ProcessFinalize () override
	Called for destructive, non-realtime effect computation. More...

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override
	Called for destructive, non-realtime effect computation. More...

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () noexcept override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () noexcept override

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

bool	PopulateUI (ShuttleGui &S) final
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

EffectDefinitionInterface &	GetDefinition () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

unsigned	TestUIFlags (unsigned mask)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

virtual bool	Startup (EffectUIClientInterface *client)

virtual bool	GetAutomationParametersAsString (wxString &parms)

virtual bool	SetAutomationParametersFromString (const wxString &parms)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

virtual bool	Startup ()

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectProcessor
virtual	~EffectProcessor ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIHostInterface
virtual	~EffectUIHostInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { wxT("Sliding Stretch"), XO("Sliding Stretch") }

Static Public Attributes inherited from Effect
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>")

Private Member Functions
double	PercentChangeToRatio (double percentChange)

double	HalfStepsToPercentChange (double halfSteps)

double	PercentChangeToHalfSteps (double percentChange)

void	OnText_RatePercentChangeStart (wxCommandEvent &evt)

void	OnText_RatePercentChangeEnd (wxCommandEvent &evt)

void	OnText_PitchPercentChangeStart (wxCommandEvent &evt)

void	OnText_PitchPercentChangeEnd (wxCommandEvent &evt)

void	OnText_PitchHalfStepsStart (wxCommandEvent &evt)

void	OnText_PitchHalfStepsEnd (wxCommandEvent &evt)

void	OnSlider_RatePercentChangeStart (wxCommandEvent &evt)

void	OnSlider_RatePercentChangeEnd (wxCommandEvent &evt)

void	OnCheckBox_PreAnalyze (wxCommandEvent &evt)

void	Update_Text_RatePercentChangeStart ()

void	Update_Text_RatePercentChangeEnd ()

void	Update_Text_PitchPercentChangeStart ()

void	Update_Text_PitchPercentChangeEnd ()

void	Update_Text_PitchHalfStepsStart ()

void	Update_Text_PitchHalfStepsEnd ()

void	Update_Slider_RatePercentChangeStart ()

void	Update_Slider_RatePercentChangeEnd ()

Private Attributes
bool	bPreview

double	previewSelectedDuration

SlideType	slideTypeRate

SlideType	slideTypePitch

double	m_RatePercentChangeStart

double	m_RatePercentChangeEnd

double	m_PitchHalfStepsStart

double	m_PitchHalfStepsEnd

double	m_PitchPercentChangeStart

double	m_PitchPercentChangeEnd

wxTextCtrl *	m_pTextCtrl_RatePercentChangeStart

wxTextCtrl *	m_pTextCtrl_RatePercentChangeEnd

wxSlider *	m_pSlider_RatePercentChangeStart

wxSlider *	m_pSlider_RatePercentChangeEnd

wxTextCtrl *	m_pTextCtrl_PitchHalfStepsStart

wxTextCtrl *	m_pTextCtrl_PitchHalfStepsEnd

wxTextCtrl *	m_pTextCtrl_PitchPercentChangeStart

wxTextCtrl *	m_pTextCtrl_PitchPercentChangeEnd

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Static Public Member Functions inherited from EffectSBSMS
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 void	IncEffectCounter ()

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

Protected Member Functions inherited from Effect
bool	EnableApply (bool enable=true)

bool	EnablePreview (bool enable=true)

virtual bool	CheckWhetherSkipEffect ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual void	End ()

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

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

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

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

void	ReplaceProcessedTracks (const bool bGoodResult)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from EffectSBSMS
TranslatableString	mProxyEffectName { XO("SBSMS Time / Pitch Stretch") }

Protected Attributes inherited from Effect
BasicUI::ProgressDialog *	mProgress = nullptr

double	mProjectRate

double	mSampleRate

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWeakRef< wxDialog >	mUIDialog
	This weak pointer may be the same as the above, or null. More...

wxWindow *	mUIParent

unsigned	mUIFlags { 0 }

sampleCount	mSampleCnt

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

An EffectTimeScale does high quality sliding time scaling/pitch shifting.

Definition at line 24 of file TimeScale.h.

Constructor & Destructor Documentation

◆ EffectTimeScale()

EffectTimeScale::EffectTimeScale ( )

Definition at line 71 of file TimeScale.cpp.

 {
    m_RatePercentChangeStart = DEF_RatePercentStart;
    m_RatePercentChangeEnd = DEF_RatePercentEnd;
    m_PitchHalfStepsStart = DEF_HalfStepsStart;
    m_PitchHalfStepsEnd = DEF_HalfStepsEnd;
    m_PitchPercentChangeStart = DEF_PitchPercentStart;
    m_PitchPercentChangeEnd = DEF_PitchPercentEnd;
  
    slideTypeRate = SlideLinearOutputRate;
    slideTypePitch = SlideLinearOutputRate;
    bPreview = false;
    previewSelectedDuration = 0.0;
    
    SetLinearEffectFlag(true);
 }

◆ ~EffectTimeScale()

EffectTimeScale::~EffectTimeScale ( )

virtual

Definition at line 88 of file TimeScale.cpp.

89 {

90 }

Member Function Documentation

◆ CalcPreviewInputLength()

double EffectTimeScale::CalcPreviewInputLength ( double previewLength )

overridevirtual

Reimplemented from Effect.

Definition at line 165 of file TimeScale.cpp.

 {
    double inputLength = Effect::GetDuration();
    if(inputLength == 0.0) {
       return 0.0;
    } else {
       double rateStart1 = PercentChangeToRatio(m_RatePercentChangeStart);
       double rateEnd1 = PercentChangeToRatio(m_RatePercentChangeEnd);
       double tOut = previewLength/inputLength;
       double t = EffectSBSMS::getInvertedStretchedTime(rateStart1,rateEnd1,slideTypeRate,tOut);
       return t * inputLength;
    }
 }

References Effect::GetDuration(), EffectSBSMS::getInvertedStretchedTime(), m_RatePercentChangeEnd, m_RatePercentChangeStart, PercentChangeToRatio(), and slideTypeRate.

Here is the call graph for this function:

◆ DefineParams()

bool EffectTimeScale::DefineParams ( ShuttleParams & S )

override

Definition at line 117 of file TimeScale.cpp.

                                                      {
    S.SHUTTLE_PARAM( m_RatePercentChangeStart,  RatePercentStart );
    S.SHUTTLE_PARAM( m_RatePercentChangeEnd,    RatePercentEnd );
    S.SHUTTLE_PARAM( m_PitchHalfStepsStart,     HalfStepsStart );
    S.SHUTTLE_PARAM( m_PitchHalfStepsEnd,       HalfStepsEnd );
    S.SHUTTLE_PARAM( m_PitchPercentChangeStart, PitchPercentStart );
    S.SHUTTLE_PARAM( m_PitchPercentChangeEnd,   PitchPercentEnd );
    return true;
 }

References m_PitchHalfStepsEnd, m_PitchHalfStepsStart, m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_RatePercentChangeEnd, m_RatePercentChangeStart, and S.

◆ GetAutomationParameters()

bool EffectTimeScale::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Save current settings into parms.

Reimplemented from Effect.

Definition at line 127 of file TimeScale.cpp.

 {
    parms.Write(KEY_RatePercentStart, m_RatePercentChangeStart);
    parms.Write(KEY_RatePercentEnd, m_RatePercentChangeEnd);
    parms.Write(KEY_HalfStepsStart, m_PitchHalfStepsStart);
    parms.Write(KEY_HalfStepsEnd, m_PitchHalfStepsEnd);
    parms.Write(KEY_PitchPercentStart, m_PitchPercentChangeStart);
    parms.Write(KEY_PitchPercentEnd, m_PitchPercentChangeEnd);
  
    return true;
 }

References m_PitchHalfStepsEnd, m_PitchHalfStepsStart, m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_RatePercentChangeEnd, and m_RatePercentChangeStart.

◆ GetDescription()

TranslatableString EffectTimeScale::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 99 of file TimeScale.cpp.

 {
    return XO("Allows continuous changes to the tempo and/or pitch");
 }

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectTimeScale::GetSymbol ( )

overridevirtual

Reimplemented from EffectSBSMS.

Definition at line 94 of file TimeScale.cpp.

 {
    return Symbol;
 }

References Symbol.

◆ GetType()

EffectType EffectTimeScale::GetType ( )

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 111 of file TimeScale.cpp.

 {
    return EffectTypeProcess;
 }

References EffectTypeProcess.

◆ HalfStepsToPercentChange()

double EffectTimeScale::HalfStepsToPercentChange ( double halfSteps )

inlineprivate

Definition at line 340 of file TimeScale.cpp.

 {
    return 100.0 * (pow(2.0,halfSteps/12.0) - 1.0);
 }

Referenced by OnText_PitchHalfStepsEnd(), and OnText_PitchHalfStepsStart().

Here is the caller graph for this function:

◆ Init()

bool EffectTimeScale::Init ( )

overridevirtual

Reimplemented from Effect.

Definition at line 160 of file TimeScale.cpp.

 {
    return true;
 }

◆ ManualPage()

ManualPageID EffectTimeScale::ManualPage ( )

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 104 of file TimeScale.cpp.

 {
    return L"Sliding_Stretch";
 }

◆ OnCheckBox_PreAnalyze()

void EffectTimeScale::OnCheckBox_PreAnalyze ( wxCommandEvent & evt )

private

◆ OnSlider_RatePercentChangeEnd()

void EffectTimeScale::OnSlider_RatePercentChangeEnd ( wxCommandEvent & evt )

private

Definition at line 417 of file TimeScale.cpp.

 {
    m_RatePercentChangeEnd = (double) evt.GetInt();
  
    Update_Text_RatePercentChangeEnd();
 }

References m_RatePercentChangeEnd, and Update_Text_RatePercentChangeEnd().

Here is the call graph for this function:

◆ OnSlider_RatePercentChangeStart()

void EffectTimeScale::OnSlider_RatePercentChangeStart ( wxCommandEvent & evt )

private

Definition at line 410 of file TimeScale.cpp.

 {
    m_RatePercentChangeStart = (double) evt.GetInt();
  
    Update_Text_RatePercentChangeStart();
 }

References m_RatePercentChangeStart, and Update_Text_RatePercentChangeStart().

Here is the call graph for this function:

◆ OnText_PitchHalfStepsEnd()

void EffectTimeScale::OnText_PitchHalfStepsEnd ( wxCommandEvent & evt )

private

Definition at line 435 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    m_PitchPercentChangeEnd = HalfStepsToPercentChange(m_PitchHalfStepsEnd);
    Update_Text_PitchPercentChangeEnd();
 }

References Effect::EnableApply(), HalfStepsToPercentChange(), m_PitchHalfStepsEnd, m_PitchPercentChangeEnd, Effect::mUIParent, and Update_Text_PitchPercentChangeEnd().

Here is the call graph for this function:

◆ OnText_PitchHalfStepsStart()

void EffectTimeScale::OnText_PitchHalfStepsStart ( wxCommandEvent & evt )

private

Definition at line 424 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    m_PitchPercentChangeStart = HalfStepsToPercentChange(m_PitchHalfStepsStart);
    Update_Text_PitchPercentChangeStart();
 }

References Effect::EnableApply(), HalfStepsToPercentChange(), m_PitchHalfStepsStart, m_PitchPercentChangeStart, Effect::mUIParent, and Update_Text_PitchPercentChangeStart().

Here is the call graph for this function:

◆ OnText_PitchPercentChangeEnd()

void EffectTimeScale::OnText_PitchPercentChangeEnd ( wxCommandEvent & evt )

private

Definition at line 457 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    m_PitchHalfStepsEnd = PercentChangeToHalfSteps(m_PitchPercentChangeEnd);
    Update_Text_PitchHalfStepsEnd();
 }

References Effect::EnableApply(), m_PitchHalfStepsEnd, m_PitchPercentChangeEnd, Effect::mUIParent, PercentChangeToHalfSteps(), and Update_Text_PitchHalfStepsEnd().

Here is the call graph for this function:

◆ OnText_PitchPercentChangeStart()

void EffectTimeScale::OnText_PitchPercentChangeStart ( wxCommandEvent & evt )

private

Definition at line 446 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    m_PitchHalfStepsStart = PercentChangeToHalfSteps(m_PitchPercentChangeStart);
    Update_Text_PitchHalfStepsStart();
 }

References Effect::EnableApply(), m_PitchHalfStepsStart, m_PitchPercentChangeStart, Effect::mUIParent, PercentChangeToHalfSteps(), and Update_Text_PitchHalfStepsStart().

Here is the call graph for this function:

◆ OnText_RatePercentChangeEnd()

void EffectTimeScale::OnText_RatePercentChangeEnd ( wxCommandEvent & evt )

private

Definition at line 400 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    Update_Slider_RatePercentChangeEnd();
 }

References Effect::EnableApply(), Effect::mUIParent, and Update_Slider_RatePercentChangeEnd().

Here is the call graph for this function:

◆ OnText_RatePercentChangeStart()

void EffectTimeScale::OnText_RatePercentChangeStart ( wxCommandEvent & evt )

private

Definition at line 390 of file TimeScale.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    Update_Slider_RatePercentChangeStart();
 }

References Effect::EnableApply(), Effect::mUIParent, and Update_Slider_RatePercentChangeStart().

Here is the call graph for this function:

◆ PercentChangeToHalfSteps()

double EffectTimeScale::PercentChangeToHalfSteps ( double percentChange )

inlineprivate

Definition at line 345 of file TimeScale.cpp.

 {
    return 12.0 * log2(PercentChangeToRatio(percentChange));
 }

References PercentChangeToRatio().

Referenced by OnText_PitchPercentChangeEnd(), and OnText_PitchPercentChangeStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PercentChangeToRatio()

double EffectTimeScale::PercentChangeToRatio ( double percentChange )

inlineprivate

Definition at line 335 of file TimeScale.cpp.

 {
    return 1.0 + percentChange / 100.0;
 }

Referenced by CalcPreviewInputLength(), PercentChangeToHalfSteps(), and Process().

Here is the caller graph for this function:

◆ PopulateOrExchange()

void EffectTimeScale::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 203 of file TimeScale.cpp.

 {
    S.SetBorder(5);
    S.AddSpace(0, 5);
  
    S.StartMultiColumn(2, wxALIGN_CENTER);
    {
       // Rate Start
       S.StartStatic(XO("Initial Tempo Change (%)"));
       {
          S.StartMultiColumn(1, wxCENTER);
          {
             m_pTextCtrl_RatePercentChangeStart = S.Id(ID_RatePercentChangeStart)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_RatePercentChangeStart,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_RatePercentStart, MAX_RatePercentStart
                )
                .AddTextBox( {}, wxT(""), 12);
          }
          S.EndMultiColumn();
          S.StartHorizontalLay(wxEXPAND, 0);
          {
             m_pSlider_RatePercentChangeStart = S.Id(ID_RatePercentChangeStart)
                .Style(wxSL_HORIZONTAL)
                .AddSlider( {}, DEF_RatePercentStart, MAX_RatePercentStart, MIN_RatePercentStart);
          }
          S.EndHorizontalLay();
       }
       S.EndStatic();
  
       S.StartStatic(XO("Final Tempo Change (%)"));
       {
          S.StartMultiColumn(1, wxCENTER);
          {
             m_pTextCtrl_RatePercentChangeEnd = S.Id(ID_RatePercentChangeEnd)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_RatePercentChangeEnd,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_RatePercentEnd, MAX_RatePercentEnd
                )
                .AddTextBox( {}, wxT(""), 12);
          }
          S.EndMultiColumn();
          S.StartHorizontalLay(wxEXPAND, 0);
          {
             m_pSlider_RatePercentChangeEnd = S.Id(ID_RatePercentChangeEnd)
                .Style(wxSL_HORIZONTAL)
                .AddSlider( {}, DEF_RatePercentEnd, MAX_RatePercentEnd, MIN_RatePercentEnd);
          }
          S.EndHorizontalLay();
       }
       S.EndStatic();
  
       // Pitch Start
       S.StartStatic(XO("Initial Pitch Shift"));
       {
          S.StartMultiColumn(2, wxCENTER);
          {
             m_pTextCtrl_PitchHalfStepsStart = S.Id(ID_PitchHalfStepsStart)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_PitchHalfStepsStart,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_HalfStepsStart, MAX_HalfStepsStart
                )
                .AddTextBox(XXO("(&semitones) [-12 to 12]:"), wxT(""), 12);
  
  
             m_pTextCtrl_PitchPercentChangeStart = S.Id(ID_PitchPercentChangeStart)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_PitchPercentChangeStart,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_PitchPercentStart, MAX_PitchPercentStart
                )
                .AddTextBox(XXO("(%) [-50 to 100]:"), wxT(""), 12);
          }
          S.EndMultiColumn();
       }
       S.EndStatic();
  
       // Pitch End
       S.StartStatic(XO("Final Pitch Shift"));
       {
          S.StartMultiColumn(2, wxCENTER);
          {
             m_pTextCtrl_PitchHalfStepsEnd = S.Id(ID_PitchHalfStepsEnd)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_PitchHalfStepsEnd,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_HalfStepsEnd, MAX_HalfStepsEnd
                )
                .AddTextBox(XXO("(s&emitones) [-12 to 12]:"), wxT(""), 12);
  
             m_pTextCtrl_PitchPercentChangeEnd = S.Id(ID_PitchPercentChangeEnd)
                .Validator<FloatingPointValidator<double>>(
                   3, &m_PitchPercentChangeEnd,
                   NumValidatorStyle::NO_TRAILING_ZEROES,
                   MIN_PitchPercentStart, MAX_PitchPercentStart)
                .AddTextBox(XXO("(%) [-50 to 100]:"), wxT(""), 12);
          }
          S.EndMultiColumn();
       }
       S.EndStatic();
    }
    S.EndMultiColumn();
  
    return;
 }

References ID_PitchHalfStepsEnd, ID_PitchHalfStepsStart, ID_PitchPercentChangeEnd, ID_PitchPercentChangeStart, ID_RatePercentChangeEnd, ID_RatePercentChangeStart, m_PitchHalfStepsEnd, m_PitchHalfStepsStart, m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_pSlider_RatePercentChangeEnd, m_pSlider_RatePercentChangeStart, m_pTextCtrl_PitchHalfStepsEnd, m_pTextCtrl_PitchHalfStepsStart, m_pTextCtrl_PitchPercentChangeEnd, m_pTextCtrl_PitchPercentChangeStart, m_pTextCtrl_RatePercentChangeEnd, m_pTextCtrl_RatePercentChangeStart, m_RatePercentChangeEnd, m_RatePercentChangeStart, S, XO, and XXO.

◆ Preview()

void EffectTimeScale::Preview ( bool dryOnly )

overridevirtual

Reimplemented from Effect.

Definition at line 179 of file TimeScale.cpp.

 {
    previewSelectedDuration = Effect::GetDuration();
    auto cleanup = valueRestorer( bPreview, true );
    Effect::Preview(dryOnly);
 }

References bPreview, Effect::GetDuration(), Effect::Preview(), previewSelectedDuration, and valueRestorer().

Here is the call graph for this function:

◆ Process()

bool EffectTimeScale::Process ( )

overridevirtual

If Process() is not overridden, it uses ProcessInitialize(), ProcessBlock(), and ProcessFinalize() methods of EffectProcessor, and also GetLatency() to determine how many leading output samples to discard and how many extra samples to produce.

Reimplemented from EffectSBSMS.

Definition at line 186 of file TimeScale.cpp.

 {
    double pitchStart1 = PercentChangeToRatio(m_PitchPercentChangeStart);
    double pitchEnd1 = PercentChangeToRatio(m_PitchPercentChangeEnd);
    double rateStart1 = PercentChangeToRatio(m_RatePercentChangeStart);
    double rateEnd1 = PercentChangeToRatio(m_RatePercentChangeEnd);
   
    if(bPreview) {
       double t = (mT1-mT0) / previewSelectedDuration;
       rateEnd1 = EffectSBSMS::getRate(rateStart1,rateEnd1,slideTypeRate,t);
       pitchEnd1 = EffectSBSMS::getRate(pitchStart1,pitchEnd1,slideTypePitch,t);
    }
    
    EffectSBSMS::setParameters(rateStart1,rateEnd1,pitchStart1,pitchEnd1,slideTypeRate,slideTypePitch,false,false,false);
    return EffectSBSMS::Process();
 }

References bPreview, EffectSBSMS::getRate(), m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_RatePercentChangeEnd, m_RatePercentChangeStart, Effect::mT0, Effect::mT1, PercentChangeToRatio(), previewSelectedDuration, EffectSBSMS::Process(), EffectSBSMS::setParameters(), slideTypePitch, and slideTypeRate.

Here is the call graph for this function:

◆ SetAutomationParameters()

bool EffectTimeScale::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Change settings to those stored in parms.

Reimplemented from Effect.

Definition at line 139 of file TimeScale.cpp.

 {
    ReadAndVerifyDouble(RatePercentStart);
    ReadAndVerifyDouble(RatePercentEnd);
    ReadAndVerifyDouble(HalfStepsStart);
    ReadAndVerifyDouble(HalfStepsEnd);
    ReadAndVerifyDouble(PitchPercentStart);
    ReadAndVerifyDouble(PitchPercentEnd);
  
    m_RatePercentChangeStart = RatePercentStart;
    m_RatePercentChangeEnd = RatePercentEnd;
    m_PitchHalfStepsStart = HalfStepsStart;
    m_PitchHalfStepsEnd = HalfStepsEnd;
    m_PitchPercentChangeStart = PitchPercentStart;
    m_PitchPercentChangeEnd = PitchPercentEnd;
    
    return true;
 }

References m_PitchHalfStepsEnd, m_PitchHalfStepsStart, m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_RatePercentChangeEnd, m_RatePercentChangeStart, and ReadAndVerifyDouble.

◆ TransferDataFromWindow()

bool EffectTimeScale::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 325 of file TimeScale.cpp.

 {
    if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
    {
       return false;
    }
  
    return true;
 }

References Effect::mUIParent.

◆ TransferDataToWindow()

bool EffectTimeScale::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 312 of file TimeScale.cpp.

 {
    if (!mUIParent->TransferDataToWindow())
    {
       return false;
    }
  
    Update_Slider_RatePercentChangeStart();
    Update_Slider_RatePercentChangeEnd();
  
    return true;
 }

References Effect::mUIParent, Update_Slider_RatePercentChangeEnd(), and Update_Slider_RatePercentChangeStart().

Here is the call graph for this function:

◆ Update_Slider_RatePercentChangeEnd()

void EffectTimeScale::Update_Slider_RatePercentChangeEnd ( )

private

Definition at line 365 of file TimeScale.cpp.

 {
    m_pSlider_RatePercentChangeEnd->SetValue((int)(m_RatePercentChangeEnd + 0.5));
 }

References m_pSlider_RatePercentChangeEnd, and m_RatePercentChangeEnd.

Referenced by OnText_RatePercentChangeEnd(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ Update_Slider_RatePercentChangeStart()

void EffectTimeScale::Update_Slider_RatePercentChangeStart ( )

private

Definition at line 360 of file TimeScale.cpp.

 {
    m_pSlider_RatePercentChangeStart->SetValue((int)(m_RatePercentChangeStart + 0.5));
 }

References m_pSlider_RatePercentChangeStart, and m_RatePercentChangeStart.

Referenced by OnText_RatePercentChangeStart(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ Update_Text_PitchHalfStepsEnd()

void EffectTimeScale::Update_Text_PitchHalfStepsEnd ( )

private

Definition at line 375 of file TimeScale.cpp.

 {
    m_pTextCtrl_PitchHalfStepsEnd->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_PitchHalfStepsEnd.

Referenced by OnText_PitchPercentChangeEnd().

Here is the caller graph for this function:

◆ Update_Text_PitchHalfStepsStart()

void EffectTimeScale::Update_Text_PitchHalfStepsStart ( )

private

Definition at line 370 of file TimeScale.cpp.

 {
    m_pTextCtrl_PitchHalfStepsStart->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_PitchHalfStepsStart.

Referenced by OnText_PitchPercentChangeStart().

Here is the caller graph for this function:

◆ Update_Text_PitchPercentChangeEnd()

void EffectTimeScale::Update_Text_PitchPercentChangeEnd ( )

private

Definition at line 385 of file TimeScale.cpp.

 {
    m_pTextCtrl_PitchPercentChangeEnd->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_PitchPercentChangeEnd.

Referenced by OnText_PitchHalfStepsEnd().

Here is the caller graph for this function:

◆ Update_Text_PitchPercentChangeStart()

void EffectTimeScale::Update_Text_PitchPercentChangeStart ( )

private

Definition at line 380 of file TimeScale.cpp.

 {
    m_pTextCtrl_PitchPercentChangeStart->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_PitchPercentChangeStart.

Referenced by OnText_PitchHalfStepsStart().

Here is the caller graph for this function:

◆ Update_Text_RatePercentChangeEnd()

void EffectTimeScale::Update_Text_RatePercentChangeEnd ( )

private

Definition at line 355 of file TimeScale.cpp.

 {
    m_pTextCtrl_RatePercentChangeEnd->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_RatePercentChangeEnd.

Referenced by OnSlider_RatePercentChangeEnd().

Here is the caller graph for this function:

◆ Update_Text_RatePercentChangeStart()

void EffectTimeScale::Update_Text_RatePercentChangeStart ( )

private

Definition at line 350 of file TimeScale.cpp.

 {
    m_pTextCtrl_RatePercentChangeStart->GetValidator()->TransferToWindow();
 }

References m_pTextCtrl_RatePercentChangeStart.

Referenced by OnSlider_RatePercentChangeStart().

Here is the caller graph for this function:

Member Data Documentation

◆ bPreview

bool EffectTimeScale::bPreview

private

Definition at line 85 of file TimeScale.h.

Referenced by Preview(), and Process().

◆ m_PitchHalfStepsEnd

double EffectTimeScale::m_PitchHalfStepsEnd

private

Definition at line 92 of file TimeScale.h.

Referenced by DefineParams(), GetAutomationParameters(), OnText_PitchHalfStepsEnd(), OnText_PitchPercentChangeEnd(), PopulateOrExchange(), and SetAutomationParameters().

◆ m_PitchHalfStepsStart

double EffectTimeScale::m_PitchHalfStepsStart

private

Definition at line 91 of file TimeScale.h.

Referenced by DefineParams(), GetAutomationParameters(), OnText_PitchHalfStepsStart(), OnText_PitchPercentChangeStart(), PopulateOrExchange(), and SetAutomationParameters().

◆ m_PitchPercentChangeEnd

double EffectTimeScale::m_PitchPercentChangeEnd

private

Definition at line 94 of file TimeScale.h.

Referenced by DefineParams(), GetAutomationParameters(), OnText_PitchHalfStepsEnd(), OnText_PitchPercentChangeEnd(), PopulateOrExchange(), Process(), and SetAutomationParameters().

◆ m_PitchPercentChangeStart

double EffectTimeScale::m_PitchPercentChangeStart

private

Definition at line 93 of file TimeScale.h.

Referenced by DefineParams(), GetAutomationParameters(), OnText_PitchHalfStepsStart(), OnText_PitchPercentChangeStart(), PopulateOrExchange(), Process(), and SetAutomationParameters().

◆ m_pSlider_RatePercentChangeEnd

wxSlider* EffectTimeScale::m_pSlider_RatePercentChangeEnd

private

Definition at line 99 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Slider_RatePercentChangeEnd().

◆ m_pSlider_RatePercentChangeStart

wxSlider* EffectTimeScale::m_pSlider_RatePercentChangeStart

private

Definition at line 98 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Slider_RatePercentChangeStart().

◆ m_pTextCtrl_PitchHalfStepsEnd

wxTextCtrl* EffectTimeScale::m_pTextCtrl_PitchHalfStepsEnd

private

Definition at line 101 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_PitchHalfStepsEnd().

◆ m_pTextCtrl_PitchHalfStepsStart

wxTextCtrl* EffectTimeScale::m_pTextCtrl_PitchHalfStepsStart

private

Definition at line 100 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_PitchHalfStepsStart().

◆ m_pTextCtrl_PitchPercentChangeEnd

wxTextCtrl* EffectTimeScale::m_pTextCtrl_PitchPercentChangeEnd

private

Definition at line 103 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_PitchPercentChangeEnd().

◆ m_pTextCtrl_PitchPercentChangeStart

wxTextCtrl* EffectTimeScale::m_pTextCtrl_PitchPercentChangeStart

private

Definition at line 102 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_PitchPercentChangeStart().

◆ m_pTextCtrl_RatePercentChangeEnd

wxTextCtrl* EffectTimeScale::m_pTextCtrl_RatePercentChangeEnd

private

Definition at line 97 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_RatePercentChangeEnd().

◆ m_pTextCtrl_RatePercentChangeStart

wxTextCtrl* EffectTimeScale::m_pTextCtrl_RatePercentChangeStart

private

Definition at line 96 of file TimeScale.h.

Referenced by PopulateOrExchange(), and Update_Text_RatePercentChangeStart().

◆ m_RatePercentChangeEnd

double EffectTimeScale::m_RatePercentChangeEnd

private

Definition at line 90 of file TimeScale.h.

Referenced by CalcPreviewInputLength(), DefineParams(), GetAutomationParameters(), OnSlider_RatePercentChangeEnd(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Update_Slider_RatePercentChangeEnd().

◆ m_RatePercentChangeStart

double EffectTimeScale::m_RatePercentChangeStart

private

Definition at line 89 of file TimeScale.h.

Referenced by CalcPreviewInputLength(), DefineParams(), GetAutomationParameters(), OnSlider_RatePercentChangeStart(), PopulateOrExchange(), Process(), SetAutomationParameters(), and Update_Slider_RatePercentChangeStart().

◆ previewSelectedDuration

double EffectTimeScale::previewSelectedDuration

private

Definition at line 86 of file TimeScale.h.

Referenced by Preview(), and Process().

◆ slideTypePitch

SlideType EffectTimeScale::slideTypePitch

private

Definition at line 88 of file TimeScale.h.

Referenced by Process().

◆ slideTypeRate

SlideType EffectTimeScale::slideTypeRate

private

Definition at line 87 of file TimeScale.h.

Referenced by CalcPreviewInputLength(), and Process().

◆ Symbol

const ComponentInterfaceSymbol EffectTimeScale::Symbol { wxT("Sliding Stretch"), XO("Sliding Stretch") }

static

Definition at line 27 of file TimeScale.h.

Referenced by GetSymbol().

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectTimeScale()

◆ ~EffectTimeScale()

Member Function Documentation

◆ CalcPreviewInputLength()

◆ DefineParams()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ HalfStepsToPercentChange()

◆ Init()

◆ ManualPage()

◆ OnCheckBox_PreAnalyze()

◆ OnSlider_RatePercentChangeEnd()

◆ OnSlider_RatePercentChangeStart()

◆ OnText_PitchHalfStepsEnd()

◆ OnText_PitchHalfStepsStart()

◆ OnText_PitchPercentChangeEnd()

◆ OnText_PitchPercentChangeStart()

◆ OnText_RatePercentChangeEnd()

◆ OnText_RatePercentChangeStart()

◆ PercentChangeToHalfSteps()

◆ PercentChangeToRatio()

◆ PopulateOrExchange()

◆ Preview()

◆ Process()

◆ SetAutomationParameters()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ Update_Slider_RatePercentChangeEnd()

◆ Update_Slider_RatePercentChangeStart()

◆ Update_Text_PitchHalfStepsEnd()

◆ Update_Text_PitchHalfStepsStart()

◆ Update_Text_PitchPercentChangeEnd()

◆ Update_Text_PitchPercentChangeStart()

◆ Update_Text_RatePercentChangeEnd()

◆ Update_Text_RatePercentChangeStart()

Member Data Documentation

◆ bPreview

◆ m_PitchHalfStepsEnd

◆ m_PitchHalfStepsStart

◆ m_PitchPercentChangeEnd

◆ m_PitchPercentChangeStart

◆ m_pSlider_RatePercentChangeEnd

◆ m_pSlider_RatePercentChangeStart

◆ m_pTextCtrl_PitchHalfStepsEnd

◆ m_pTextCtrl_PitchHalfStepsStart

◆ m_pTextCtrl_PitchPercentChangeEnd

◆ m_pTextCtrl_PitchPercentChangeStart

◆ m_pTextCtrl_RatePercentChangeEnd

◆ m_pTextCtrl_RatePercentChangeStart

◆ m_RatePercentChangeEnd

◆ m_RatePercentChangeStart

◆ previewSelectedDuration

◆ slideTypePitch

◆ slideTypeRate

◆ Symbol