Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
EffectRepeat Class Referencefinal

An Effect that repeats audio several times over. More...

#include <Repeat.h>

Inheritance diagram for EffectRepeat:
[legend]
Collaboration diagram for EffectRepeat:
[legend]

Public Member Functions

 EffectRepeat ()
 
virtual ~EffectRepeat ()
 
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...
 
bool Process (EffectInstance &instance, EffectSettings &settings) override
 
std::unique_ptr< EffectEditorPopulateOrExchange (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
 
bool NeedsDither () const override
 
- Public Member Functions inherited from StatefulEffect
 ~StatefulEffect () override
 
std::shared_ptr< EffectInstanceMakeInstance () 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
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
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 EffectParameterMethodsParameters () const
 
bool CanExportPresets () const override
 Whether the effect supports export of presets to files, and importing too. More...
 
bool HasOptions () const override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatSymbol 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)
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
void SetTracks (TrackList *pTracks)
 
bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (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 EffectSettingsManagerGetDefinition () const =0
 
virtual void Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
 Calculate temporary tracks of limited length with effect applied and play. More...
 
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< EffectInstanceMakeInstance () 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< EffectOutputsMakeOutputs () 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< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
 Allows PopulateOrExchange to return null. More...
 
virtual std::unique_ptr< EffectEditorPopulateOrExchange (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 (EffectPlugin &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< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0
 
virtual OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0
 
virtual void ShowOptions (const EffectPlugin &plugin) const =0
 
virtual bool ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0
 
virtual bool CloseUI () const =0
 

Static Public Member Functions

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

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Repeat") }
 
- 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>")
 

Private Member Functions

void OnRepeatTextChange (wxCommandEvent &evt)
 
void DisplayNewTime ()
 
const EffectParameterMethodsParameters () const override
 

Private Attributes

wxWeakRef< wxWindow > mUIParent {}
 
int repeatCount
 
wxTextCtrl * mRepeatCount
 
wxStaticText * mCurrentTime
 
wxStaticText * mTotalTime
 

Static Private Attributes

static constexpr EffectParameter Count
 

Additional Inherited Members

- Public Types inherited from StatefulEffectBase
using MessagePackage = EffectInstance::MessagePackage
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
using InstancePointer = std::shared_ptr< EffectInstanceEx >
 
using InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , After_3_1 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Public Types inherited from EffectUIServices
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Attributes inherited from EffectBase
TrackListmTracks {}
 
- 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, const WaveTrack *pRight, sampleCount *start, sampleCount *len)
 
void CopyInputTracks (bool allSyncLockSelected=false)
 
TrackAddToOutputTracks (const std::shared_ptr< Track > &t)
 
- Protected Member Functions inherited from EffectBase
virtual std::any BeginPreview (const EffectSettings &settings)
 Called when Preview() starts, to allow temporary effect state changes. More...
 
void Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
 Calculate temporary tracks of limited length with effect applied and play. More...
 
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
void IncludeNotSelectedPreviewTracks (bool includeNotSelected)
 
void ReplaceProcessedTracks (const bool bGoodResult)
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from EffectBase
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
std::shared_ptr< TrackListmOutputTracks
 
double mT0 {}
 
double mT1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 
- Static Protected Attributes inherited from EffectBase
static int nEffectsDone = 0
 

Detailed Description

An Effect that repeats audio several times over.

Definition at line 23 of file Repeat.h.

Constructor & Destructor Documentation

◆ EffectRepeat()

EffectRepeat::EffectRepeat ( )

Definition at line 55 of file Repeat.cpp.

56{
57 Parameters().Reset(*this);
59}
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:214
virtual void Reset(Effect &effect) const =0
const EffectParameterMethods & Parameters() const override
Definition: Repeat.cpp:38

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectRepeat()

EffectRepeat::~EffectRepeat ( )
virtual

Definition at line 61 of file Repeat.cpp.

62{
63}

Member Function Documentation

◆ DisplayNewTime()

void EffectRepeat::DisplayNewTime ( )
private

Definition at line 230 of file Repeat.cpp.

231{
232 long l;
233 wxString str;
234 mRepeatCount->GetValue().ToLong(&l);
235
238 mT1 - mT0,
240
241 str = wxString::Format( _("Current selection length: %s"), nc.GetString() );
242
243 mCurrentTime->SetLabel(str);
244 mCurrentTime->SetName(str); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
245
246 if (l > 0) {
248 repeatCount = l;
249
250 nc.SetValue((mT1 - mT0) * (repeatCount + 1));
251 str = wxString::Format( _("New selection length: %s"), nc.GetString() );
252 }
253 else {
254 str = _("Warning: No repeats.");
256 }
257 mTotalTime->SetLabel(str);
258 mTotalTime->SetName(str); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
259}
#define str(a)
#define _(s)
Definition: Internat.h:73
double mT1
Definition: EffectBase.h:113
double mProjectRate
Definition: EffectBase.h:105
double mT0
Definition: EffectBase.h:112
static bool EnableApply(wxWindow *parent, bool enable=true)
Enable or disable the Apply button of the dialog that contains parent.
virtual NumericFormatSymbol GetSelectionFormat()
Definition: Effect.cpp:195
wxStaticText * mTotalTime
Definition: Repeat.h:66
wxWeakRef< wxWindow > mUIParent
Definition: Repeat.h:60
int repeatCount
Definition: Repeat.h:62
wxTextCtrl * mRepeatCount
Definition: Repeat.h:64
wxStaticText * mCurrentTime
Definition: Repeat.h:65
NumericConverter provides the advanced formatting control used in the selection bar of Audacity.

References _, EffectEditor::EnableApply(), Effect::GetSelectionFormat(), NumericConverter::GetString(), mCurrentTime, EffectBase::mProjectRate, mRepeatCount, EffectBase::mT0, EffectBase::mT1, mTotalTime, mUIParent, repeatCount, NumericConverter::SetValue(), str, and NumericConverter::TIME.

Referenced by OnRepeatTextChange(), and TransferDataToWindow().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FetchParameters()

static EffectRepeat * EffectRepeat::FetchParameters ( EffectRepeat e,
EffectSettings  
)
inlinestatic

Definition at line 27 of file Repeat.h.

27{ return &e; }

◆ GetDescription()

TranslatableString EffectRepeat::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 72 of file Repeat.cpp.

73{
74 return XO("Repeats the selection the specified number of times");
75}
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectRepeat::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 67 of file Repeat.cpp.

68{
69 return Symbol;
70}
static const ComponentInterfaceSymbol Symbol
Definition: Repeat.h:28

References Symbol.

◆ GetType()

EffectType EffectRepeat::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 84 of file Repeat.cpp.

85{
86 return EffectTypeProcess;
87}
@ EffectTypeProcess

References EffectTypeProcess.

◆ ManualPage()

ManualPageID EffectRepeat::ManualPage ( ) const
overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 77 of file Repeat.cpp.

78{
79 return L"Repeat";
80}

◆ NeedsDither()

bool EffectRepeat::NeedsDither ( ) const
overridevirtual

Reimplemented from StatefulEffectBase.

Definition at line 266 of file Repeat.cpp.

267{
268 return false;
269}

◆ OnRepeatTextChange()

void EffectRepeat::OnRepeatTextChange ( wxCommandEvent &  evt)
private

Definition at line 261 of file Repeat.cpp.

262{
264}
void DisplayNewTime()
Definition: Repeat.cpp:230

References DisplayNewTime().

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectRepeat::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 38 of file Repeat.cpp.

39{
41 Count
42 > parameters;
43 return parameters;
44}
Generates EffectParameterMethods overrides from variadic template arguments.
EffectRepeat()
Definition: Repeat.cpp:55
static constexpr EffectParameter Count
Definition: Repeat.h:71

References Count, and EffectRepeat().

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectRepeat::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 181 of file Repeat.cpp.

184{
185 mUIParent = S.GetParent();
186 S.StartHorizontalLay(wxCENTER, false);
187 {
188 mRepeatCount = S.Validator<IntegerValidator<int>>(
189 &repeatCount, NumValidatorStyle::DEFAULT,
190 Count.min, 2147483647 / mProjectRate )
191 .AddTextBox(XXO("&Number of repeats to add:"), L"", 12);
192 }
193 S.EndHorizontalLay();
194
195 S.StartMultiColumn(1, wxCENTER);
196 {
197 mCurrentTime = S.AddVariableText(
198 XO("Current selection length: dd:hh:mm:ss"));
199 mTotalTime = S.AddVariableText(XO("New selection length: dd:hh:mm:ss"));
200 }
201 S.EndMultiColumn();
202 return nullptr;
203}
XXO("&Cut/Copy/Paste Toolbar")
#define S(N)
Definition: ToChars.cpp:64
const Type min
Minimum value.

References Count, mCurrentTime, EffectParameter< Structure, Member, Type, Value >::min, EffectBase::mProjectRate, mRepeatCount, mTotalTime, mUIParent, repeatCount, S, XO(), and XXO().

Here is the call graph for this function:

◆ Process()

bool EffectRepeat::Process ( EffectInstance instance,
EffectSettings settings 
)
overridevirtual

Implements StatefulEffectBase.

Definition at line 91 of file Repeat.cpp.

92{
93 // Set up mOutputTracks.
94 // This effect needs all for sync-lock grouping.
95 CopyInputTracks(true);
96
97 int nTrack = 0;
98 bool bGoodResult = true;
99 double maxDestLen = 0.0; // used to change selection to generated bit
100
101 mOutputTracks->Any().VisitWhile( bGoodResult,
102 [&](LabelTrack *track)
103 {
105 {
106 if (!track->Repeat(mT0, mT1, repeatCount))
107 bGoodResult = false;
108 }
109 },
110 [&](WaveTrack *track, const Track::Fallthrough &fallthrough)
111 {
112 if (!track->GetSelected())
113 return fallthrough(); // Fall through to next lambda
114 auto start = track->TimeToLongSamples(mT0);
115 auto end = track->TimeToLongSamples(mT1);
116 auto len = end - start;
117 const double tLen = track->LongSamplesToTime(len);
118 const double tc = mT0 + tLen;
119
120 if (len <= 0)
121 return;
122
123 auto dest = std::dynamic_pointer_cast<WaveTrack>(track->Copy(mT0, mT1));
124 std::vector<wxString> clipNames;
125 for(auto clip : dest->SortedClipArray())
126 {
127 if(!clip->GetIsPlaceholder())
128 clipNames.push_back(clip->GetName());
129 }
130 auto t0 = tc;
131 for(int j=0; j<repeatCount; j++)
132 {
133 if (TrackProgress(nTrack, j / repeatCount)) // TrackProgress returns true on Cancel.
134 {
135 bGoodResult = false;
136 return;
137 }
138 track->Paste(t0, dest.get());
139 t0 += tLen;
140 }
141 if (t0 > maxDestLen)
142 maxDestLen = t0;
143
144 auto clips = track->SortedClipArray();
145 for(size_t i = 0; i < clips.size(); ++i)
146 {
147 const auto eps = 0.5 / track->GetRate();
148 //Find first pasted clip
149 if(std::abs(clips[i]->GetPlayStartTime() - tc) > eps)
150 continue;
151
152 //Fix pasted clips names
153 for(int j = 0; j < repeatCount; ++j)
154 {
155 for(size_t k = 0; k < clipNames.size(); ++k)
156 clips[i + k]->SetName(clipNames[k]);
157 i += clipNames.size();
158 }
159 break;
160 }
161
162 nTrack++;
163 },
164 [&](Track *t)
165 {
167 t->SyncLockAdjust(mT1, mT1 + (mT1 - mT0) * repeatCount);
168 }
169 );
170
171 if (bGoodResult)
172 {
173 // Select the NEW bits + original bit
174 mT1 = maxDestLen;
175 }
176
177 ReplaceProcessedTracks(bGoodResult);
178 return bGoodResult;
179}
std::shared_ptr< TrackList > mOutputTracks
Definition: EffectBase.h:111
void ReplaceProcessedTracks(const bool bGoodResult)
Definition: EffectBase.cpp:232
void CopyInputTracks(bool allSyncLockSelected=false)
Definition: Effect.cpp:396
bool TrackProgress(int whichTrack, double frac, const TranslatableString &={}) const
Definition: Effect.cpp:346
A LabelTrack is a Track that holds labels (LabelStruct).
Definition: LabelTrack.h:87
bool Repeat(double t0, double t1, int n)
Definition: LabelTrack.cpp:804
double LongSamplesToTime(sampleCount pos) const
Convert correctly between a number of samples and an (absolute) time in seconds.
Definition: SampleTrack.cpp:48
sampleCount TimeToLongSamples(double t0) const
Convert correctly between an (absolute) time in seconds and a number of samples.
Definition: SampleTrack.cpp:43
static bool IsSelectedOrSyncLockSelected(const Track *pTrack)
Definition: SyncLock.cpp:112
static bool IsSyncLockSelected(const Track *pTrack)
Definition: SyncLock.cpp:82
Abstract base class for an object holding data associated with points on a time axis.
Definition: Track.h:226
bool GetSelected() const
Definition: Track.h:470
Continuation<> Fallthrough
Type of arguments passed as optional second parameter to TypeSwitch<void>() cases.
Definition: Track.h:542
A Track that contains audio waveform data.
Definition: WaveTrack.h:51
void Paste(double t0, const Track *src) override
Definition: WaveTrack.cpp:1367
WaveClipPointers SortedClipArray()
Definition: WaveTrack.cpp:2459
double GetRate() const override
Definition: WaveTrack.cpp:360
Track::Holder Copy(double t0, double t1, bool forClipboard=true) const override
Definition: WaveTrack.cpp:585
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:159

References LabelTrack::Copy(), Effect::CopyInputTracks(), PackedArray::end(), Track::GetSelected(), SyncLock::IsSelectedOrSyncLockSelected(), SyncLock::IsSyncLockSelected(), EffectBase::mOutputTracks, EffectBase::mT0, EffectBase::mT1, LabelTrack::Paste(), LabelTrack::Repeat(), repeatCount, EffectBase::ReplaceProcessedTracks(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), and Effect::TrackProgress().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool EffectRepeat::TransferDataFromWindow ( EffectSettings settings)
overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 214 of file Repeat.cpp.

215{
216 if (!mUIParent->Validate())
217 {
218 return false;
219 }
220
221 long l;
222
223 mRepeatCount->GetValue().ToLong(&l);
224
225 repeatCount = (int) l;
226
227 return true;
228}

References mRepeatCount, mUIParent, and repeatCount.

◆ TransferDataToWindow()

bool EffectRepeat::TransferDataToWindow ( const EffectSettings settings)
overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 205 of file Repeat.cpp.

206{
207 mRepeatCount->ChangeValue(wxString::Format(wxT("%d"), repeatCount));
208
210
211 return true;
212}
wxT("CloseDown"))

References DisplayNewTime(), mRepeatCount, repeatCount, and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ Count

constexpr EffectParameter EffectRepeat::Count
staticconstexprprivate
Initial value:
L"Count",1, 1, INT_MAX, 1 }

Definition at line 71 of file Repeat.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ mCurrentTime

wxStaticText* EffectRepeat::mCurrentTime
private

Definition at line 65 of file Repeat.h.

Referenced by DisplayNewTime(), and PopulateOrExchange().

◆ mRepeatCount

wxTextCtrl* EffectRepeat::mRepeatCount
private

◆ mTotalTime

wxStaticText* EffectRepeat::mTotalTime
private

Definition at line 66 of file Repeat.h.

Referenced by DisplayNewTime(), and PopulateOrExchange().

◆ mUIParent

wxWeakRef<wxWindow> EffectRepeat::mUIParent {}
private

Definition at line 60 of file Repeat.h.

Referenced by DisplayNewTime(), PopulateOrExchange(), and TransferDataFromWindow().

◆ repeatCount

int EffectRepeat::repeatCount
private

◆ Symbol

const ComponentInterfaceSymbol EffectRepeat::Symbol { XO("Repeat") }
static

Definition at line 28 of file Repeat.h.

Referenced by GetSymbol().


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