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
EffectClickRemoval Class Referencefinal

An Effect for removing clicks. More...

#include <ClickRemoval.h>

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

Public Member Functions

 EffectClickRemoval ()
 
virtual ~EffectClickRemoval ()
 
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 CheckWhetherSkipEffect (const EffectSettings &settings) const override
 After Init(), tell whether Process() should be skipped. 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
 
- 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 EffectClickRemovalFetchParameters (EffectClickRemoval &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("Click Removal") }
 
- 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

bool ProcessOne (int count, WaveTrack *track, sampleCount start, sampleCount len)
 
bool RemoveClicks (size_t len, float *buffer)
 
void OnWidthText (wxCommandEvent &evt)
 
void OnThreshText (wxCommandEvent &evt)
 
void OnWidthSlider (wxCommandEvent &evt)
 
void OnThreshSlider (wxCommandEvent &evt)
 
const EffectParameterMethodsParameters () const override
 

Private Attributes

wxWeakRef< wxWindow > mUIParent {}
 
EnvelopemEnvelope
 
bool mbDidSomething
 
size_t windowSize
 
int mThresholdLevel
 
int mClickWidth
 
int sep
 
wxSlider * mWidthS
 
wxSlider * mThreshS
 
wxTextCtrl * mWidthT
 
wxTextCtrl * mThreshT
 

Static Private Attributes

static constexpr EffectParameter Threshold
 
static constexpr EffectParameter Width
 

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 for removing clicks.

Clicks are identified as small regions of high amplitude compared to the surrounding chunk of sound. Anything sufficiently tall compared to a large (2048 sample) window around it, and sufficiently narrow, is considered to be a click.

The structure was largely stolen from Domonic Mazzoni's NoiseRemoval module, and reworked for the NEW effect.

This file is intended to become part of Audacity. You may modify and/or distribute it under the same terms as Audacity itself.

Definition at line 28 of file ClickRemoval.h.

Constructor & Destructor Documentation

◆ EffectClickRemoval()

EffectClickRemoval::EffectClickRemoval ( )

Definition at line 68 of file ClickRemoval.cpp.

69{
70 Parameters().Reset(*this);
71
73
74 windowSize = 8192;
75 sep = 2049;
76}
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:214
const EffectParameterMethods & Parameters() const override
virtual void Reset(Effect &effect) const =0

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectClickRemoval()

EffectClickRemoval::~EffectClickRemoval ( )
virtual

Definition at line 78 of file ClickRemoval.cpp.

79{
80}

Member Function Documentation

◆ CheckWhetherSkipEffect()

bool EffectClickRemoval::CheckWhetherSkipEffect ( const EffectSettings settings) const
overridevirtual

After Init(), tell whether Process() should be skipped.

Implements EffectBase.

Definition at line 108 of file ClickRemoval.cpp.

109{
110 return ((mClickWidth == 0) || (mThresholdLevel == 0));
111}

References mClickWidth, and mThresholdLevel.

◆ FetchParameters()

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

Definition at line 32 of file ClickRemoval.h.

32{ return &e; }

◆ GetDescription()

TranslatableString EffectClickRemoval::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 89 of file ClickRemoval.cpp.

90{
91 return XO("Click Removal is designed to remove clicks on audio tracks");
92}
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectClickRemoval::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 84 of file ClickRemoval.cpp.

85{
86 return Symbol;
87}
static const ComponentInterfaceSymbol Symbol
Definition: ClickRemoval.h:33

References Symbol.

◆ GetType()

EffectType EffectClickRemoval::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 101 of file ClickRemoval.cpp.

102{
103 return EffectTypeProcess;
104}
@ EffectTypeProcess

References EffectTypeProcess.

◆ ManualPage()

ManualPageID EffectClickRemoval::ManualPage ( ) const
overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 94 of file ClickRemoval.cpp.

95{
96 return L"Click_Removal";
97}

◆ OnThreshSlider()

void EffectClickRemoval::OnThreshSlider ( wxCommandEvent &  evt)
private

Definition at line 359 of file ClickRemoval.cpp.

360{
361 mThreshS->GetValidator()->TransferFromWindow();
362 mThreshT->GetValidator()->TransferToWindow();
363}
wxTextCtrl * mThreshT
Definition: ClickRemoval.h:83
wxSlider * mThreshS
Definition: ClickRemoval.h:81

References mThreshS, and mThreshT.

◆ OnThreshText()

void EffectClickRemoval::OnThreshText ( wxCommandEvent &  evt)
private

Definition at line 347 of file ClickRemoval.cpp.

348{
349 mThreshT->GetValidator()->TransferFromWindow();
350 mThreshS->GetValidator()->TransferToWindow();
351}

References mThreshS, and mThreshT.

◆ OnWidthSlider()

void EffectClickRemoval::OnWidthSlider ( wxCommandEvent &  evt)
private

Definition at line 353 of file ClickRemoval.cpp.

354{
355 mWidthS->GetValidator()->TransferFromWindow();
356 mWidthT->GetValidator()->TransferToWindow();
357}
wxTextCtrl * mWidthT
Definition: ClickRemoval.h:82
wxSlider * mWidthS
Definition: ClickRemoval.h:80

References mWidthS, and mWidthT.

◆ OnWidthText()

void EffectClickRemoval::OnWidthText ( wxCommandEvent &  evt)
private

Definition at line 341 of file ClickRemoval.cpp.

342{
343 mWidthT->GetValidator()->TransferFromWindow();
344 mWidthS->GetValidator()->TransferToWindow();
345}

References mWidthS, and mWidthT.

◆ Parameters()

const EffectParameterMethods & EffectClickRemoval::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 48 of file ClickRemoval.cpp.

49{
52 > parameters;
53 return parameters;
54}
Generates EffectParameterMethods overrides from variadic template arguments.
static constexpr EffectParameter Width
Definition: ClickRemoval.h:90
static constexpr EffectParameter Threshold
Definition: ClickRemoval.h:88

References EffectClickRemoval(), Threshold, and Width.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectClickRemoval::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 274 of file ClickRemoval.cpp.

277{
278 mUIParent = S.GetParent();
279 S.AddSpace(0, 5);
280 S.SetBorder(10);
281
282 S.StartMultiColumn(3, wxEXPAND);
283 S.SetStretchyCol(2);
284 {
285 // Threshold
286 mThreshT = S.Id(ID_Thresh)
287 .Validator<IntegerValidator<int>>(
288 &mThresholdLevel, NumValidatorStyle::DEFAULT,
290 .AddTextBox(XXO("&Threshold (lower is more sensitive):"),
291 wxT(""),
292 10);
293
294 mThreshS = S.Id(ID_Thresh)
295 .Name(XO("Threshold"))
296 .Style(wxSL_HORIZONTAL)
297 .Validator<wxGenericValidator>(&mThresholdLevel)
298 .MinSize( { 150, -1 } )
299 .AddSlider( {}, mThresholdLevel, Threshold.max, Threshold.min);
300
301 // Click width
302 mWidthT = S.Id(ID_Width)
303 .Validator<IntegerValidator<int>>(
304 &mClickWidth, NumValidatorStyle::DEFAULT, Width.min, Width.max)
305 .AddTextBox(XXO("Max &Spike Width (higher is more sensitive):"),
306 wxT(""),
307 10);
308
309 mWidthS = S.Id(ID_Width)
310 .Name(XO("Max Spike Width"))
311 .Style(wxSL_HORIZONTAL)
312 .Validator<wxGenericValidator>(&mClickWidth)
313 .MinSize( { 150, -1 } )
314 .AddSlider( {}, mClickWidth, Width.max, Width.min);
315 }
316 S.EndMultiColumn();
317
318 return nullptr;
319}
wxT("CloseDown"))
@ ID_Width
@ ID_Thresh
XXO("&Cut/Copy/Paste Toolbar")
#define S(N)
Definition: ToChars.cpp:64
wxWeakRef< wxWindow > mUIParent
Definition: ClickRemoval.h:70
const Type min
Minimum value.
const Type max
Maximum value.

References ID_Thresh, ID_Width, EffectParameter< Structure, Member, Type, Value >::max, mClickWidth, EffectParameter< Structure, Member, Type, Value >::min, mThresholdLevel, mThreshS, mThreshT, mUIParent, mWidthS, mWidthT, S, Threshold, Width, wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ Process()

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

Implements StatefulEffectBase.

Definition at line 113 of file ClickRemoval.cpp.

114{
115 this->CopyInputTracks(); // Set up mOutputTracks.
116 bool bGoodResult = true;
117 mbDidSomething = false;
118
119 int count = 0;
120 for( auto track : mOutputTracks->Selected< WaveTrack >() ) {
121 double trackStart = track->GetStartTime();
122 double trackEnd = track->GetEndTime();
123 double t0 = mT0 < trackStart? trackStart: mT0;
124 double t1 = mT1 > trackEnd? trackEnd: mT1;
125
126 if (t1 > t0) {
127 auto start = track->TimeToLongSamples(t0);
128 auto end = track->TimeToLongSamples(t1);
129 auto len = end - start;
130
131 if (!ProcessOne(count, track, start, len))
132 {
133 bGoodResult = false;
134 break;
135 }
136 }
137
138 count++;
139 }
140 if (bGoodResult && !mbDidSomething) // Processing successful, but ineffective.
142 XO("Algorithm not effective on this audio. Nothing changed."),
143 wxOK | wxICON_ERROR );
144
145 this->ReplaceProcessedTracks(bGoodResult && mbDidSomething);
146 return bGoodResult && mbDidSomething;
147}
double mT1
Definition: EffectBase.h:113
std::shared_ptr< TrackList > mOutputTracks
Definition: EffectBase.h:111
double mT0
Definition: EffectBase.h:112
void ReplaceProcessedTracks(const bool bGoodResult)
Definition: EffectBase.cpp:232
bool ProcessOne(int count, WaveTrack *track, sampleCount start, sampleCount len)
void CopyInputTracks(bool allSyncLockSelected=false)
Definition: Effect.cpp:396
static int DoMessageBox(const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
A Track that contains audio waveform data.
Definition: WaveTrack.h:51
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:159

References Effect::CopyInputTracks(), EffectUIServices::DoMessageBox(), PackedArray::end(), mbDidSomething, EffectBase::mOutputTracks, EffectBase::mT0, EffectBase::mT1, ProcessOne(), EffectBase::ReplaceProcessedTracks(), and XO().

Here is the call graph for this function:

◆ ProcessOne()

bool EffectClickRemoval::ProcessOne ( int  count,
WaveTrack track,
sampleCount  start,
sampleCount  len 
)
private

Definition at line 149 of file ClickRemoval.cpp.

150{
151 if (len <= windowSize / 2)
152 {
154 XO("Selection must be larger than %d samples.")
155 .Format(windowSize / 2),
156 wxOK | wxICON_ERROR );
157 return false;
158 }
159
160 auto idealBlockLen = track->GetMaxBlockSize() * 4;
161 if (idealBlockLen % windowSize != 0)
162 idealBlockLen += (windowSize - (idealBlockLen % windowSize));
163
164 bool bResult = true;
165 decltype(len) s = 0;
166 Floats buffer{ idealBlockLen };
167 Floats datawindow{ windowSize };
168 while ((len - s) > windowSize / 2)
169 {
170 auto block = limitSampleBufferSize( idealBlockLen, len - s );
171
172 track->GetFloats(buffer.get(), start + s, block);
173
174 for (decltype(block) i = 0; i + windowSize / 2 < block; i += windowSize / 2)
175 {
176 auto wcopy = std::min( windowSize, block - i );
177
178 for(decltype(wcopy) j = 0; j < wcopy; j++)
179 datawindow[j] = buffer[i+j];
180 for(auto j = wcopy; j < windowSize; j++)
181 datawindow[j] = 0;
182
183 mbDidSomething |= RemoveClicks(windowSize, datawindow.get());
184
185 for(decltype(wcopy) j = 0; j < wcopy; j++)
186 buffer[i+j] = datawindow[j];
187 }
188
189 if (mbDidSomething) // RemoveClicks() actually did something.
190 track->Set((samplePtr) buffer.get(), floatSample, start + s, block);
191
192 s += block;
193
194 if (TrackProgress(count, s.as_double() /
195 len.as_double())) {
196 bResult = false;
197 break;
198 }
199 }
200
201 return bResult;
202}
int min(int a, int b)
size_t limitSampleBufferSize(size_t bufferSize, sampleCount limit)
Definition: SampleCount.cpp:22
char * samplePtr
Definition: SampleFormat.h:55
bool RemoveClicks(size_t len, float *buffer)
bool TrackProgress(int whichTrack, double frac, const TranslatableString &={}) const
Definition: Effect.cpp:346
Abstract base class used in importing a file.
bool GetFloats(float *buffer, sampleCount start, size_t len, fillFormat fill=fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
Retrieve samples from a track in floating-point format, regardless of the storage format.
Definition: SampleTrack.h:82
size_t GetMaxBlockSize() const override
This returns a nonnegative number of samples meant to size a memory buffer.
Definition: WaveTrack.cpp:1611
void Set(constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len, sampleFormat effectiveFormat=widestSampleFormat)
Definition: WaveTrack.cpp:2002
double as_double() const
Definition: SampleCount.h:46

References sampleCount::as_double(), EffectUIServices::DoMessageBox(), floatSample, SampleTrack::GetFloats(), WaveTrack::GetMaxBlockSize(), limitSampleBufferSize(), mbDidSomething, min(), RemoveClicks(), WaveTrack::Set(), Effect::TrackProgress(), windowSize, and XO().

Referenced by Process().

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

◆ RemoveClicks()

bool EffectClickRemoval::RemoveClicks ( size_t  len,
float *  buffer 
)
private

Definition at line 204 of file ClickRemoval.cpp.

205{
206 bool bResult = false; // This effect usually does nothing.
207 size_t i;
208 size_t j;
209 int left = 0;
210
211 float msw;
212 int ww;
213 int s2 = sep/2;
214 Floats ms_seq{ len };
215 Floats b2{ len };
216
217 for( i=0; i<len; i++)
218 b2[i] = buffer[i]*buffer[i];
219
220 /* Shortcut for rms - multiple passes through b2, accumulating
221 * as we go.
222 */
223 for(i=0;i<len;i++)
224 ms_seq[i]=b2[i];
225
226 for(i=1; (int)i < sep; i *= 2) {
227 for(j=0;j<len-i; j++)
228 ms_seq[j] += ms_seq[j+i];
229 }
230
231 /* Cheat by truncating sep to next-lower power of two... */
232 sep = i;
233
234 for( i=0; i<len-sep; i++ ) {
235 ms_seq[i] /= sep;
236 }
237 /* ww runs from about 4 to mClickWidth. wrc is the reciprocal;
238 * chosen so that integer roundoff doesn't clobber us.
239 */
240 int wrc;
241 for(wrc=mClickWidth/4; wrc>=1; wrc /= 2) {
242 ww = mClickWidth/wrc;
243
244 for( i=0; i<len-sep; i++ ){
245 msw = 0;
246 for( j=0; (int)j<ww; j++) {
247 msw += b2[i+s2+j];
248 }
249 msw /= ww;
250
251 if(msw >= mThresholdLevel * ms_seq[i]/10) {
252 if( left == 0 ) {
253 left = i+s2;
254 }
255 } else {
256 if(left != 0 && ((int)i-left+s2) <= ww*2) {
257 float lv = buffer[left];
258 float rv = buffer[i+ww+s2];
259 for(j=left; j<i+ww+s2; j++) {
260 bResult = true;
261 buffer[j]= (rv*(j-left) + lv*(i+ww+s2-j))/(float)(i+ww+s2-left);
262 b2[j] = buffer[j]*buffer[j];
263 }
264 left=0;
265 } else if(left != 0) {
266 left = 0;
267 }
268 }
269 }
270 }
271 return bResult;
272}

References mClickWidth, mThresholdLevel, and sep.

Referenced by ProcessOne().

Here is the caller graph for this function:

◆ TransferDataFromWindow()

bool EffectClickRemoval::TransferDataFromWindow ( EffectSettings settings)
overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 331 of file ClickRemoval.cpp.

332{
333 if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
334 {
335 return false;
336 }
337
338 return true;
339}

References mUIParent.

◆ TransferDataToWindow()

bool EffectClickRemoval::TransferDataToWindow ( const EffectSettings settings)
overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 321 of file ClickRemoval.cpp.

322{
323 if (!mUIParent->TransferDataToWindow())
324 {
325 return false;
326 }
327
328 return true;
329}

References mUIParent.

Member Data Documentation

◆ mbDidSomething

bool EffectClickRemoval::mbDidSomething
private

Definition at line 74 of file ClickRemoval.h.

Referenced by Process(), and ProcessOne().

◆ mClickWidth

int EffectClickRemoval::mClickWidth
private

Definition at line 77 of file ClickRemoval.h.

Referenced by CheckWhetherSkipEffect(), PopulateOrExchange(), and RemoveClicks().

◆ mEnvelope

Envelope* EffectClickRemoval::mEnvelope
private

Definition at line 72 of file ClickRemoval.h.

◆ mThresholdLevel

int EffectClickRemoval::mThresholdLevel
private

Definition at line 76 of file ClickRemoval.h.

Referenced by CheckWhetherSkipEffect(), PopulateOrExchange(), and RemoveClicks().

◆ mThreshS

wxSlider* EffectClickRemoval::mThreshS
private

Definition at line 81 of file ClickRemoval.h.

Referenced by OnThreshSlider(), OnThreshText(), and PopulateOrExchange().

◆ mThreshT

wxTextCtrl* EffectClickRemoval::mThreshT
private

Definition at line 83 of file ClickRemoval.h.

Referenced by OnThreshSlider(), OnThreshText(), and PopulateOrExchange().

◆ mUIParent

wxWeakRef<wxWindow> EffectClickRemoval::mUIParent {}
private

Definition at line 70 of file ClickRemoval.h.

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

◆ mWidthS

wxSlider* EffectClickRemoval::mWidthS
private

Definition at line 80 of file ClickRemoval.h.

Referenced by OnWidthSlider(), OnWidthText(), and PopulateOrExchange().

◆ mWidthT

wxTextCtrl* EffectClickRemoval::mWidthT
private

Definition at line 82 of file ClickRemoval.h.

Referenced by OnWidthSlider(), OnWidthText(), and PopulateOrExchange().

◆ sep

int EffectClickRemoval::sep
private

Definition at line 78 of file ClickRemoval.h.

Referenced by RemoveClicks().

◆ Symbol

const ComponentInterfaceSymbol EffectClickRemoval::Symbol { XO("Click Removal") }
static

Definition at line 33 of file ClickRemoval.h.

Referenced by GetSymbol().

◆ Threshold

constexpr EffectParameter EffectClickRemoval::Threshold
staticconstexprprivate
Initial value:
L"Threshold", 200, 0, 900, 1 }

Definition at line 88 of file ClickRemoval.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Width

constexpr EffectParameter EffectClickRemoval::Width
staticconstexprprivate
Initial value:
L"Width", 20, 0, 40, 1 }

Definition at line 90 of file ClickRemoval.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ windowSize

size_t EffectClickRemoval::windowSize
private

Definition at line 75 of file ClickRemoval.h.

Referenced by ProcessOne().


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