#include <ChangeSpeed.h>

Inheritance diagram for EffectChangeSpeed:

Collaboration diagram for EffectChangeSpeed:

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

bool	TransferDataToWindow (const EffectSettings &settings) override

bool	TransferDataFromWindow (EffectSettings &settings) override

Public Member Functions inherited from ChangeSpeedBase
	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

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

Private Member Functions
void	OnText_PercentChange (wxCommandEvent &evt)

void	OnText_Multiplier (wxCommandEvent &evt)

void	OnSlider_PercentChange (wxCommandEvent &evt)

void	OnChoice_Vinyl (wxCommandEvent &evt)

void	OnTimeCtrl_ToLength (wxCommandEvent &evt)

void	OnTimeCtrlUpdate (wxCommandEvent &evt)

void	Update_Text_PercentChange ()

void	Update_Text_Multiplier ()

void	Update_Slider_PercentChange ()

void	Update_Vinyl ()

void	Update_TimeCtrl_ToLength ()

void	UpdateUI ()

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}

wxTextCtrl *	mpTextCtrl_PercentChange

wxTextCtrl *	mpTextCtrl_Multiplier

wxSlider *	mpSlider_PercentChange

wxChoice *	mpChoice_FromVinyl

wxChoice *	mpChoice_ToVinyl

NumericTextCtrl *	mpFromLengthCtrl

NumericTextCtrl *	mpToLengthCtrl

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 }

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

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 ChangeSpeedBase
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 inherited from ChangeSpeedBase
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 inherited from ChangeSpeedBase
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 inherited from ChangeSpeedBase
static constexpr EffectParameter	Percentage

Detailed Description

Definition at line 27 of file ChangeSpeed.h.

Member Function Documentation

◆ OnChoice_Vinyl()

void EffectChangeSpeed::OnChoice_Vinyl ( wxCommandEvent & evt )

private

Definition at line 297 of file ChangeSpeed.cpp.

{
   // Treat mpChoice_FromVinyl and mpChoice_ToVinyl as one control since we need
   // both to calculate Percent Change.
   mFromVinyl = mpChoice_FromVinyl->GetSelection();
   mToVinyl = mpChoice_ToVinyl->GetSelection();
   // Use this as the 'preferred' choice.
   if (mFromVinyl != kVinyl_NA) {
      SetConfig(GetDefinition(), PluginSettings::Private,
         CurrentSettingsGroup(), wxT("VinylChoice"), mFromVinyl);
   }
 
   // If mFromVinyl & mToVinyl are set, then there's a NEW percent change.
   if ((mFromVinyl != kVinyl_NA) && (mToVinyl != kVinyl_NA))
   {
      double fromRPM;
      double toRPM;
      switch (mFromVinyl) {
      default:
      case kVinyl_33AndAThird:   fromRPM = 33.0 + (1.0 / 3.0); break;
      case kVinyl_45:            fromRPM = 45.0; break;
      case kVinyl_78:            fromRPM = 78; break;
      }
      switch (mToVinyl) {
      default:
      case kVinyl_33AndAThird:   toRPM = 33.0 + (1.0 / 3.0); break;
      case kVinyl_45:            toRPM = 45.0; break;
      case kVinyl_78:            toRPM = 78; break;
      }
      m_PercentChange = ((toRPM * 100.0) / fromRPM) - 100.0;
      UpdateUI();
 
      mbLoopDetect = true;
      Update_Text_PercentChange();
      Update_Text_Multiplier();
      Update_Slider_PercentChange();
      Update_TimeCtrl_ToLength();
   }
   mbLoopDetect = false;
}

References CurrentSettingsGroup(), Effect::GetDefinition(), kVinyl_33AndAThird, kVinyl_45, kVinyl_78, kVinyl_NA, ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mbLoopDetect, ChangeSpeedBase::mFromVinyl, mpChoice_FromVinyl, mpChoice_ToVinyl, ChangeSpeedBase::mToVinyl, PluginSettings::Private, PluginSettings::SetConfig(), Update_Slider_PercentChange(), Update_Text_Multiplier(), Update_Text_PercentChange(), Update_TimeCtrl_ToLength(), UpdateUI(), and wxT().

Here is the call graph for this function:

◆ OnSlider_PercentChange()

void EffectChangeSpeed::OnSlider_PercentChange ( wxCommandEvent & evt )

private

Definition at line 278 of file ChangeSpeed.cpp.

{
   if (mbLoopDetect)
      return;
 
   m_PercentChange = (double)(mpSlider_PercentChange->GetValue());
   // Warp positive values to actually go up faster & further than negatives.
   if (m_PercentChange > 0.0)
      m_PercentChange = pow(m_PercentChange, kSliderWarp);
   UpdateUI();
 
   mbLoopDetect = true;
   Update_Text_PercentChange();
   Update_Text_Multiplier();
   Update_Vinyl();
   Update_TimeCtrl_ToLength();
   mbLoopDetect = false;
}

References kSliderWarp, ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mbLoopDetect, mpSlider_PercentChange, Update_Text_Multiplier(), Update_Text_PercentChange(), Update_TimeCtrl_ToLength(), Update_Vinyl(), and UpdateUI().

Here is the call graph for this function:

◆ OnText_Multiplier()

void EffectChangeSpeed::OnText_Multiplier ( wxCommandEvent & evt )

private

Definition at line 261 of file ChangeSpeed.cpp.

{
   if (mbLoopDetect)
      return;
 
   mpTextCtrl_Multiplier->GetValidator()->TransferFromWindow();
   m_PercentChange = 100 * (mMultiplier - 1);
   UpdateUI();
 
   mbLoopDetect = true;
   Update_Text_PercentChange();
   Update_Slider_PercentChange();
   Update_Vinyl();
   Update_TimeCtrl_ToLength();
   mbLoopDetect = false;
}

References ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mbLoopDetect, ChangeSpeedBase::mMultiplier, mpTextCtrl_Multiplier, Update_Slider_PercentChange(), Update_Text_PercentChange(), Update_TimeCtrl_ToLength(), Update_Vinyl(), and UpdateUI().

Here is the call graph for this function:

◆ OnText_PercentChange()

void EffectChangeSpeed::OnText_PercentChange ( wxCommandEvent & evt )

private

Definition at line 245 of file ChangeSpeed.cpp.

{
   if (mbLoopDetect)
      return;
 
   mpTextCtrl_PercentChange->GetValidator()->TransferFromWindow();
   UpdateUI();
 
   mbLoopDetect = true;
   Update_Text_Multiplier();
   Update_Slider_PercentChange();
   Update_Vinyl();
   Update_TimeCtrl_ToLength();
   mbLoopDetect = false;
}

References ChangeSpeedBase::mbLoopDetect, mpTextCtrl_PercentChange, Update_Slider_PercentChange(), Update_Text_Multiplier(), Update_TimeCtrl_ToLength(), Update_Vinyl(), and UpdateUI().

Here is the call graph for this function:

◆ OnTimeCtrl_ToLength()

void EffectChangeSpeed::OnTimeCtrl_ToLength ( wxCommandEvent & evt )

private

Definition at line 338 of file ChangeSpeed.cpp.

{
   if (mbLoopDetect)
      return;
 
   mToLength = mpToLengthCtrl->GetValue();
   // Division by (double) 0.0 is not an error and we want to show "infinite" in
   // text controls, so take care that we handle infinite values when they occur.
   m_PercentChange = ((mFromLength * 100.0) / mToLength) - 100.0;
   UpdateUI();
 
   mbLoopDetect = true;
 
   Update_Text_PercentChange();
   Update_Text_Multiplier();
   Update_Slider_PercentChange();
   Update_Vinyl();
 
   mbLoopDetect = false;
}

References NumericConverter::GetValue(), ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mbLoopDetect, ChangeSpeedBase::mFromLength, mpToLengthCtrl, ChangeSpeedBase::mToLength, Update_Slider_PercentChange(), Update_Text_Multiplier(), Update_Text_PercentChange(), Update_Vinyl(), and UpdateUI().

Here is the call graph for this function:

◆ OnTimeCtrlUpdate()

void EffectChangeSpeed::OnTimeCtrlUpdate ( wxCommandEvent & evt )

private

Definition at line 359 of file ChangeSpeed.cpp.

{
   mFormat = NumericConverterFormats::Lookup(
      FormatterContext::SampleRateContext(mProjectRate),
      NumericConverterType_TIME(), evt.GetString()).Internal();
 
   mpFromLengthCtrl->SetFormatName(mFormat);
   // Update From/To Length controls (precision has changed).
   mpToLengthCtrl->SetValue(mToLength);
   mpFromLengthCtrl->SetValue(mFromLength);
}

References ComponentInterfaceSymbol::Internal(), NumericConverterFormats::Lookup(), ChangeSpeedBase::mFormat, ChangeSpeedBase::mFromLength, mpFromLengthCtrl, EffectBase::mProjectRate, mpToLengthCtrl, ChangeSpeedBase::mToLength, NumericConverterType_TIME(), FormatterContext::SampleRateContext(), NumericTextCtrl::SetFormatName(), and NumericTextCtrl::SetValue().

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectChangeSpeed::PopulateOrExchange	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)

overridevirtual

Add controls to effect panel; always succeeds.

Returns: if not null, then return it from PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 64 of file ChangeSpeed.cpp.

{
   mUIParent = S.GetParent();
 
   {
      wxString formatId;
      GetConfig(GetDefinition(), PluginSettings::Private,
         CurrentSettingsGroup(),
         wxT("TimeFormat"), formatId, mFormat.GET());
      mFormat = NumericConverterFormats::Lookup(
         FormatterContext::SampleRateContext(mProjectRate),
         NumericConverterType_TIME(), formatId).Internal();
   }
   GetConfig(GetDefinition(), PluginSettings::Private,
      CurrentSettingsGroup(),
      wxT("VinylChoice"), mFromVinyl, mFromVinyl);
 
   S.SetBorder(5);
 
   S.StartVerticalLay(0);
   {
      // Speed multiplier and percent change controls.
      S.StartMultiColumn(4, wxCENTER);
      {
         mpTextCtrl_Multiplier = S.Id(ID_Multiplier)
            .Validator<FloatingPointValidator<double>>(
               3, &mMultiplier,
               NumValidatorStyle::THREE_TRAILING_ZEROES,
               Percentage.min / 100.0, ((Percentage.max / 100.0) + 1) )
            .AddTextBox(XXO("&Speed Multiplier:"), L"", 12);
 
         mpTextCtrl_PercentChange = S.Id(ID_PercentChange)
            .Validator<FloatingPointValidator<double>>(
               3, &m_PercentChange,
               NumValidatorStyle::THREE_TRAILING_ZEROES,
               Percentage.min, Percentage.max )
            .AddTextBox(XXO("Percent C&hange:"), L"", 12);
      }
      S.EndMultiColumn();
 
      // Percent change slider.
      S.StartHorizontalLay(wxEXPAND);
      {
         mpSlider_PercentChange = S.Id(ID_PercentChange)
            .Name(XO("Percent Change"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {}, 0, (int)kSliderMax, (int)Percentage.min);
      }
      S.EndHorizontalLay();
 
      // Vinyl rpm controls.
      S.StartMultiColumn(5, wxCENTER);
      {
         /* i18n-hint: "rpm" is an English abbreviation meaning "revolutions per minute".
            "vinyl" refers to old-fashioned phonograph records */
         S.AddUnits(XO("Standard Vinyl rpm:"));
 
         mpChoice_FromVinyl = S.Id(ID_FromVinyl)
            /* i18n-hint: changing speed of audio "from" one value "to" another
             "rpm" means "revolutions per minute" as on a vinyl record turntable
             */
            .Name(XO("From rpm"))
            .MinSize( { 100, -1 } )
            /* i18n-hint: changing speed of audio "from" one value "to" another */
            .AddChoice(XXC("&from", "change speed"), kVinylStrings);
 
         mpChoice_ToVinyl = S.Id(ID_ToVinyl)
            /* i18n-hint: changing speed of audio "from" one value "to" another
             "rpm" means "revolutions per minute" as on a vinyl record turntable
             */
            .Name(XO("To rpm"))
            .MinSize( { 100, -1 } )
            /* i18n-hint: changing speed of audio "from" one value "to" another */
            .AddChoice(XXC("&to", "change speed"), kVinylStrings);
      }
      S.EndMultiColumn();
 
      // From/To time controls.
      S.StartStatic(XO("Selection Length"), 0);
      {
         S.StartMultiColumn(2, wxALIGN_LEFT);
         {
            S.AddPrompt(XXO("C&urrent Length:"));
 
            mpFromLengthCtrl = safenew
                  NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                                 S.GetParent(), wxID_ANY,
                                 NumericConverterType_TIME(),
                                 mFormat,
                                 mFromLength,
                                 NumericTextCtrl::Options{}
                                  .ReadOnly(true)
                                  .MenuEnabled(false));
 
            S.ToolTip(XO("Current length of selection."))
               /* i18n-hint: changing speed of audio "from" one value "to" another */
               .Name(XC("from", "change speed"))
               .Position(wxALIGN_LEFT)
               .AddWindow(mpFromLengthCtrl);
 
            S.AddPrompt(XXO("&New Length:"));
 
            mpToLengthCtrl = safenew
                  NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                                 S.GetParent(), ID_ToLength,
                                 NumericConverterType_TIME(),
                                 mFormat,
                                 mToLength);
 
            /* i18n-hint: changing speed of audio "from" one value "to" another */
            S.Name(XC("to", "change speed"))
               .Position(wxALIGN_LEFT)
               .AddWindow(mpToLengthCtrl);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndVerticalLay();
   return nullptr;
}

References CurrentSettingsGroup(), PluginSettings::GetConfig(), ID_FromVinyl, ID_Multiplier, ID_PercentChange, ID_ToLength, ID_ToVinyl, ComponentInterfaceSymbol::Internal(), kSliderMax, kVinylStrings, NumericConverterFormats::Lookup(), NumericConverterType_TIME(), PluginSettings::Private, NumericTextCtrl::Options::ReadOnly(), S, safenew, FormatterContext::SampleRateContext(), wxT(), XC, XO(), XXC, and XXO().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool EffectChangeSpeed::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 224 of file ChangeSpeed.cpp.

{
   // mUIParent->TransferDataFromWindow() loses some precision, so save and restore it.
   double exactPercent = m_PercentChange;
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
   m_PercentChange = exactPercent;
 
   // TODO: just visit these effect settings the default way
   SetConfig(GetDefinition(), PluginSettings::Private,
      CurrentSettingsGroup(), wxT("TimeFormat"), mFormat.GET());
   SetConfig(GetDefinition(), PluginSettings::Private,
      CurrentSettingsGroup(), wxT("VinylChoice"), mFromVinyl);
 
   return true;
}

References CurrentSettingsGroup(), Identifier::GET(), Effect::GetDefinition(), ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mFormat, ChangeSpeedBase::mFromVinyl, mUIParent, PluginSettings::Private, PluginSettings::SetConfig(), and wxT().

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectChangeSpeed::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 188 of file ChangeSpeed.cpp.

{
   mbLoopDetect = true;
 
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   if (mFromVinyl == kVinyl_NA)
   {
      mFromVinyl = kVinyl_33AndAThird;
   }
 
   Update_Text_PercentChange();
   Update_Text_Multiplier();
   Update_Slider_PercentChange();
   Update_TimeCtrl_ToLength();
 
   // Set from/to Vinyl controls - mFromVinyl must be set first.
   mpChoice_FromVinyl->SetSelection(mFromVinyl);
   // Then update to get correct mToVinyl.
   Update_Vinyl();
   // Then update ToVinyl control.
   mpChoice_ToVinyl->SetSelection(mToVinyl);
 
   // Set From Length control.
   // Set the format first so we can get sample accuracy.
   mpFromLengthCtrl->SetFormatName(mFormat);
   mpFromLengthCtrl->SetValue(mFromLength);
 
   mbLoopDetect = false;
 
   return true;
}

References kVinyl_33AndAThird, kVinyl_NA, ChangeSpeedBase::mbLoopDetect, ChangeSpeedBase::mFormat, ChangeSpeedBase::mFromLength, ChangeSpeedBase::mFromVinyl, mpChoice_FromVinyl, mpChoice_ToVinyl, mpFromLengthCtrl, ChangeSpeedBase::mToVinyl, mUIParent, NumericTextCtrl::SetFormatName(), NumericTextCtrl::SetValue(), Update_Slider_PercentChange(), Update_Text_Multiplier(), Update_Text_PercentChange(), Update_TimeCtrl_ToLength(), and Update_Vinyl().

Here is the call graph for this function:

◆ Update_Slider_PercentChange()

void EffectChangeSpeed::Update_Slider_PercentChange ( )

private

Definition at line 386 of file ChangeSpeed.cpp.

{
   auto unwarped = std::min<double>(m_PercentChange, Percentage.max);
   if (unwarped > 0.0)
      // Un-warp values above zero to actually go up to kSliderMax.
      unwarped = pow(m_PercentChange, (1.0 / kSliderWarp));
 
   // Caution: m_PercentChange could be infinite.
   int unwarpedi = (int)(unwarped + 0.5);
   unwarpedi = std::min<int>(unwarpedi, (int)kSliderMax);
 
   mpSlider_PercentChange->SetValue(unwarpedi);
}

References kSliderMax, kSliderWarp, ChangeSpeedBase::m_PercentChange, EffectParameter< Structure, Member, Type, Value >::max, mpSlider_PercentChange, and ChangeSpeedBase::Percentage.

Referenced by OnChoice_Vinyl(), OnText_Multiplier(), OnText_PercentChange(), OnTimeCtrl_ToLength(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ Update_Text_Multiplier()

void EffectChangeSpeed::Update_Text_Multiplier ( )

private

Definition at line 379 of file ChangeSpeed.cpp.

{
   mMultiplier =  1 + (m_PercentChange) / 100.0;
   mpTextCtrl_Multiplier->GetValidator()->TransferToWindow();
}

References ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mMultiplier, and mpTextCtrl_Multiplier.

Referenced by OnChoice_Vinyl(), OnSlider_PercentChange(), OnText_PercentChange(), OnTimeCtrl_ToLength(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ Update_Text_PercentChange()

void EffectChangeSpeed::Update_Text_PercentChange ( )

private

Definition at line 373 of file ChangeSpeed.cpp.

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

References mpTextCtrl_PercentChange.

Referenced by OnChoice_Vinyl(), OnSlider_PercentChange(), OnText_Multiplier(), OnTimeCtrl_ToLength(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ Update_TimeCtrl_ToLength()

void EffectChangeSpeed::Update_TimeCtrl_ToLength ( )

private

Definition at line 455 of file ChangeSpeed.cpp.

{
   mToLength = (mFromLength * 100.0) / (100.0 + m_PercentChange);
 
   // Set the format first so we can get sample accuracy.
   mpToLengthCtrl->SetFormatName(mFormat);
   // Negative times do not make sense.
   // 359999 = 99h:59m:59s which is a little less disturbing than overflow characters
   // though it may still look a bit strange with some formats.
   mToLength = std::clamp<double>(mToLength, 0.0, 359999.0);
   mpToLengthCtrl->SetValue(mToLength);
}

References ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mFormat, ChangeSpeedBase::mFromLength, mpToLengthCtrl, ChangeSpeedBase::mToLength, NumericTextCtrl::SetFormatName(), and NumericTextCtrl::SetValue().

Referenced by OnChoice_Vinyl(), OnSlider_PercentChange(), OnText_Multiplier(), OnText_PercentChange(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Update_Vinyl()

void EffectChangeSpeed::Update_Vinyl ( )

private

Definition at line 401 of file ChangeSpeed.cpp.

{
   // Match Vinyl rpm when within 0.01% of a standard ratio.
   // Ratios calculated as: ((toRPM / fromRPM) - 1) * 100 * 100
 
   // Caution: m_PercentChange could be infinite
   int ratio = (int)((m_PercentChange * 100) + 0.5);
 
   switch (ratio)
   {
      case 0: // toRPM is the same as fromRPM
         if (mFromVinyl != kVinyl_NA) {
            mpChoice_ToVinyl->SetSelection(mpChoice_FromVinyl->GetSelection());
         } else {
            // Use the last saved option.
            GetConfig(GetDefinition(), PluginSettings::Private,
               CurrentSettingsGroup(), wxT("VinylChoice"), mFromVinyl, 0);
            mpChoice_FromVinyl->SetSelection(mFromVinyl);
            mpChoice_ToVinyl->SetSelection(mFromVinyl);
         }
         break;
      case 3500:
         mpChoice_FromVinyl->SetSelection(kVinyl_33AndAThird);
         mpChoice_ToVinyl->SetSelection(kVinyl_45);
         break;
      case 13400:
         mpChoice_FromVinyl->SetSelection(kVinyl_33AndAThird);
         mpChoice_ToVinyl->SetSelection(kVinyl_78);
         break;
      case -2593:
         mpChoice_FromVinyl->SetSelection(kVinyl_45);
         mpChoice_ToVinyl->SetSelection(kVinyl_33AndAThird);
         break;
      case 7333:
         mpChoice_FromVinyl->SetSelection(kVinyl_45);
         mpChoice_ToVinyl->SetSelection(kVinyl_78);
         break;
      case -5727:
         mpChoice_FromVinyl->SetSelection(kVinyl_78);
         mpChoice_ToVinyl->SetSelection(kVinyl_33AndAThird);
         break;
      case -4231:
         mpChoice_FromVinyl->SetSelection(kVinyl_78);
         mpChoice_ToVinyl->SetSelection(kVinyl_45);
         break;
      default:
         mpChoice_ToVinyl->SetSelection(kVinyl_NA);
   }
   // and update variables.
   mFromVinyl = mpChoice_FromVinyl->GetSelection();
   mToVinyl = mpChoice_ToVinyl->GetSelection();
}

References CurrentSettingsGroup(), PluginSettings::GetConfig(), Effect::GetDefinition(), kVinyl_33AndAThird, kVinyl_45, kVinyl_78, kVinyl_NA, ChangeSpeedBase::m_PercentChange, ChangeSpeedBase::mFromVinyl, mpChoice_FromVinyl, mpChoice_ToVinyl, ChangeSpeedBase::mToVinyl, PluginSettings::Private, and wxT().

Referenced by OnSlider_PercentChange(), OnText_Multiplier(), OnText_PercentChange(), OnTimeCtrl_ToLength(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateUI()

void EffectChangeSpeed::UpdateUI ( )

private

Definition at line 469 of file ChangeSpeed.cpp.

{
   EffectEditor::EnableApply(mUIParent,
      m_PercentChange >= Percentage.min && m_PercentChange <= Percentage.max);
}

References EffectEditor::EnableApply(), ChangeSpeedBase::m_PercentChange, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mUIParent, and ChangeSpeedBase::Percentage.

Referenced by OnChoice_Vinyl(), OnSlider_PercentChange(), OnText_Multiplier(), OnText_PercentChange(), and OnTimeCtrl_ToLength().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mpChoice_FromVinyl

wxChoice* EffectChangeSpeed::mpChoice_FromVinyl

private

Definition at line 65 of file ChangeSpeed.h.

Referenced by OnChoice_Vinyl(), TransferDataToWindow(), and Update_Vinyl().

◆ mpChoice_ToVinyl

wxChoice* EffectChangeSpeed::mpChoice_ToVinyl

private

Definition at line 66 of file ChangeSpeed.h.

Referenced by OnChoice_Vinyl(), TransferDataToWindow(), and Update_Vinyl().

◆ mpFromLengthCtrl

NumericTextCtrl* EffectChangeSpeed::mpFromLengthCtrl

private

Definition at line 67 of file ChangeSpeed.h.

Referenced by OnTimeCtrlUpdate(), and TransferDataToWindow().

◆ mpSlider_PercentChange

wxSlider* EffectChangeSpeed::mpSlider_PercentChange

private

Definition at line 64 of file ChangeSpeed.h.

Referenced by OnSlider_PercentChange(), and Update_Slider_PercentChange().

◆ mpTextCtrl_Multiplier

wxTextCtrl* EffectChangeSpeed::mpTextCtrl_Multiplier

private

Definition at line 63 of file ChangeSpeed.h.

Referenced by OnText_Multiplier(), and Update_Text_Multiplier().

◆ mpTextCtrl_PercentChange

wxTextCtrl* EffectChangeSpeed::mpTextCtrl_PercentChange

private

Definition at line 62 of file ChangeSpeed.h.

Referenced by OnText_PercentChange(), and Update_Text_PercentChange().

◆ mpToLengthCtrl

NumericTextCtrl* EffectChangeSpeed::mpToLengthCtrl

private

Definition at line 68 of file ChangeSpeed.h.

Referenced by OnTimeCtrl_ToLength(), OnTimeCtrlUpdate(), and Update_TimeCtrl_ToLength().

◆ mUIParent

wxWeakRef<wxWindow> EffectChangeSpeed::mUIParent {}

private

Definition at line 59 of file ChangeSpeed.h.

Referenced by TransferDataFromWindow(), TransferDataToWindow(), and UpdateUI().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnChoice_Vinyl()

◆ OnSlider_PercentChange()

◆ OnText_Multiplier()

◆ OnText_PercentChange()

◆ OnTimeCtrl_ToLength()

◆ OnTimeCtrlUpdate()

◆ PopulateOrExchange()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ Update_Slider_PercentChange()

◆ Update_Text_Multiplier()

◆ Update_Text_PercentChange()

◆ Update_TimeCtrl_ToLength()

◆ Update_Vinyl()

◆ UpdateUI()

Member Data Documentation

◆ mpChoice_FromVinyl

◆ mpChoice_ToVinyl

◆ mpFromLengthCtrl

◆ mpSlider_PercentChange

◆ mpTextCtrl_Multiplier

◆ mpTextCtrl_PercentChange

◆ mpToLengthCtrl

◆ mUIParent