|  | Audacity 3.2.0
    | 
An TimeScaleBase does high quality sliding time scaling/pitch shifting. More...
#include <TimeScaleBase.h>
| Public Member Functions | |
| TimeScaleBase () | |
| virtual | ~TimeScaleBase () | 
| 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... | |
| std::any | BeginPreview (const EffectSettings &settings) override | 
| Called when Preview() starts, to allow temporary effect state changes.  More... | |
| bool | Process (EffectInstance &instance, EffectSettings &settings) override | 
| double | CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override | 
|  Public Member Functions inherited from SBSMSBase | |
| 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 | 
| Static Public Member Functions | |
| static TimeScaleBase * | FetchParameters (TimeScaleBase &e, EffectSettings &) | 
|  Static Public Member Functions inherited from SBSMSBase | |
| 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 Attributes | |
| static const ComponentInterfaceSymbol | Symbol | 
|  Static Public Attributes inherited from EffectPlugin | |
| static const wxString | kUserPresetIdent = wxT("User Preset:") | 
| static const wxString | kFactoryPresetIdent = wxT("Factory Preset:") | 
| static const wxString | kCurrentSettingsIdent = wxT("<Current Settings>") | 
| static const wxString | kFactoryDefaultsIdent = wxT("<Factory Defaults>") | 
| Protected Member Functions | |
| const EffectParameterMethods & | Parameters () const override | 
| 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 previewLengthMore... | |
| 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 | 
| Static Protected Member Functions | |
| static double | PercentChangeToRatio (double percentChange) | 
| static double | HalfStepsToPercentChange (double halfSteps) | 
| static double | PercentChangeToHalfSteps (double percentChange) | 
| Protected 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 | 
|  Protected Attributes inherited from SBSMSBase | |
| TranslatableString | mProxyEffectName { XO("SBSMS Time / Pitch Stretch") } | 
|  Protected Attributes inherited from EffectBase | |
| double | mF0 {} | 
| double | mF1 {} | 
| wxArrayString | mPresetNames | 
| unsigned | mUIFlags { 0 } | 
| Static Protected Attributes | |
| static constexpr EffectParameter | RatePercentStart | 
| static constexpr EffectParameter | RatePercentEnd | 
| static constexpr EffectParameter | HalfStepsStart | 
| static constexpr EffectParameter | HalfStepsEnd | 
| static constexpr EffectParameter | PitchPercentStart | 
| static constexpr EffectParameter | PitchPercentEnd | 
| Additional Inherited Members | |
|  Public Types inherited from StatefulEffectBase | |
| using | MessagePackage = EffectInstance::MessagePackage | 
|  Public Types inherited from EffectPlugin | |
| using | EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess > | 
| using | InstancePointer = std::shared_ptr< EffectInstanceEx > | 
| using | InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) > | 
|  Public Types inherited from EffectDefinitionInterface | |
| enum class | RealtimeSince : unsigned { Never , After_3_1 , Always } | 
| In which versions of Audacity was an effect realtime capable?  More... | |
|  Public Attributes inherited from EffectBase | |
| std::shared_ptr< TrackList > | mTracks {} | 
| int | mNumTracks {} | 
| BasicUI::ProgressDialog * | mProgress {} | 
| double | mProjectRate {} | 
| WaveTrackFactory * | mFactory {} | 
| double | mT0 {} | 
| double | mT1 {} | 
| bool | mIsPreview { false } | 
An TimeScaleBase does high quality sliding time scaling/pitch shifting.
Definition at line 17 of file TimeScaleBase.h.
| TimeScaleBase::TimeScaleBase | ( | ) | 
Definition at line 38 of file TimeScaleBase.cpp.
References bPreview, Parameters(), previewSelectedDuration, EffectParameterMethods::Reset(), EffectBase::SetLinearEffectFlag(), slideTypePitch, and slideTypeRate.
Referenced by Parameters().
| 
 | virtual | 
Definition at line 50 of file TimeScaleBase.cpp.
| 
 | overridevirtual | 
Called when Preview() starts, to allow temporary effect state changes.
default returns a null
Reimplemented from EffectBase.
Definition at line 99 of file TimeScaleBase.cpp.
References bPreview, previewSelectedDuration, and settings().
| 
 | overridevirtual | 
Implements EffectBase.
Definition at line 80 of file TimeScaleBase.cpp.
References SBSMSBase::getInvertedStretchedTime(), m_RatePercentChangeEnd, m_RatePercentChangeStart, PercentChangeToRatio(), settings(), and slideTypeRate.
| 
 | inlinestatic | 
Definition at line 21 of file TimeScaleBase.h.
| 
 | overridevirtual | 
Implements ComponentInterface.
Definition at line 61 of file TimeScaleBase.cpp.
References XO().
| 
 | overridevirtual | 
Reimplemented from SBSMSBase.
Definition at line 56 of file TimeScaleBase.cpp.
References Symbol.
| 
 | overridevirtual | 
Type determines how it behaves.
Reimplemented from SBSMSBase.
Definition at line 73 of file TimeScaleBase.cpp.
References EffectTypeProcess.
| 
 | staticprotected | 
Definition at line 130 of file TimeScaleBase.cpp.
Referenced by EffectTimeScale::OnText_PitchHalfStepsEnd(), and EffectTimeScale::OnText_PitchHalfStepsStart().
| 
 | overridevirtual | 
Name of a page in the Audacity alpha manual, default is empty.
Reimplemented from EffectDefinitionInterface.
Definition at line 66 of file TimeScaleBase.cpp.
| 
 | overrideprotectedvirtual | 
Reimplemented from Effect.
Definition at line 22 of file TimeScaleBase.cpp.
References HalfStepsEnd, HalfStepsStart, PitchPercentEnd, PitchPercentStart, RatePercentEnd, RatePercentStart, and TimeScaleBase().
Referenced by TimeScaleBase().
| 
 | staticprotected | 
Definition at line 135 of file TimeScaleBase.cpp.
References PercentChangeToRatio().
Referenced by EffectTimeScale::OnText_PitchPercentChangeEnd(), and EffectTimeScale::OnText_PitchPercentChangeStart().
| 
 | staticprotected | 
Definition at line 125 of file TimeScaleBase.cpp.
Referenced by CalcPreviewInputLength(), PercentChangeToHalfSteps(), and Process().
| 
 | overridevirtual | 
Reimplemented from SBSMSBase.
Definition at line 105 of file TimeScaleBase.cpp.
References bPreview, SBSMSBase::getRate(), m_PitchPercentChangeEnd, m_PitchPercentChangeStart, m_RatePercentChangeEnd, m_RatePercentChangeStart, EffectBase::mT0, EffectBase::mT1, PercentChangeToRatio(), previewSelectedDuration, SBSMSBase::Process(), SBSMSBase::setParameters(), settings(), slideTypePitch, and slideTypeRate.
| 
 | protected | 
Definition at line 54 of file TimeScaleBase.h.
Referenced by BeginPreview(), Process(), and TimeScaleBase().
| 
 | staticconstexprprotected | 
Definition at line 91 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | staticconstexprprotected | 
Definition at line 83 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | protected | 
Definition at line 61 of file TimeScaleBase.h.
Referenced by EffectTimeScale::OnText_PitchHalfStepsEnd(), and EffectTimeScale::OnText_PitchPercentChangeEnd().
| 
 | protected | 
Definition at line 60 of file TimeScaleBase.h.
Referenced by EffectTimeScale::OnText_PitchHalfStepsStart(), and EffectTimeScale::OnText_PitchPercentChangeStart().
| 
 | protected | 
Definition at line 63 of file TimeScaleBase.h.
Referenced by EffectTimeScale::OnText_PitchHalfStepsEnd(), EffectTimeScale::OnText_PitchPercentChangeEnd(), and Process().
| 
 | protected | 
Definition at line 62 of file TimeScaleBase.h.
Referenced by EffectTimeScale::OnText_PitchHalfStepsStart(), EffectTimeScale::OnText_PitchPercentChangeStart(), and Process().
| 
 | protected | 
Definition at line 59 of file TimeScaleBase.h.
Referenced by CalcPreviewInputLength(), EffectTimeScale::OnSlider_RatePercentChangeEnd(), Process(), and EffectTimeScale::Update_Slider_RatePercentChangeEnd().
| 
 | protected | 
Definition at line 58 of file TimeScaleBase.h.
Referenced by CalcPreviewInputLength(), EffectTimeScale::OnSlider_RatePercentChangeStart(), Process(), and EffectTimeScale::Update_Slider_RatePercentChangeStart().
| 
 | staticconstexprprotected | 
Definition at line 107 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | staticconstexprprotected | 
Definition at line 99 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | protected | 
Definition at line 55 of file TimeScaleBase.h.
Referenced by BeginPreview(), Process(), and TimeScaleBase().
| 
 | staticconstexprprotected | 
Definition at line 75 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | staticconstexprprotected | 
Definition at line 67 of file TimeScaleBase.h.
Referenced by Parameters().
| 
 | protected | 
Definition at line 57 of file TimeScaleBase.h.
Referenced by Process(), and TimeScaleBase().
| 
 | protected | 
Definition at line 56 of file TimeScaleBase.h.
Referenced by CalcPreviewInputLength(), Process(), and TimeScaleBase().
| 
 | static | 
Definition at line 25 of file TimeScaleBase.h.
Referenced by GetSymbol().