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
 Actually do the effect here. More...
 
std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
 Add controls to effect panel; always succeeds. More...
 
- Public Member Functions inherited from StatefulEffect
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 ()
 Call once to set up state for whole list of tracks to be processed. More...
 
virtual bool Process (EffectInstance &instance, EffectSettings &settings)=0
 Actually do the effect here. More...
 
virtual bool RealtimeInitialize (EffectSettings &settings, double sampleRate)
 
virtual bool RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate)
 
virtual bool RealtimeSuspend ()
 
virtual bool RealtimeResume ()
 
virtual bool RealtimeProcessStart (EffectSettings &settings)
 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
 
- 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...
 
bool LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 Change settings to a user-named preset. More...
 
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...
 
bool LoadFactoryPreset (int id, EffectSettings &settings) const override
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
 
bool LoadFactoryDefaults (EffectSettings &settings) const override
 Change settings back to "factory default". More...
 
unsigned GetAudioInCount () const override
 How many input buffers to allocate at once. More...
 
unsigned GetAudioOutCount () const override
 How many output buffers to allocate at once. More...
 
virtual const EffectParameterMethodsParameters () const
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override
 
std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
 Adds controls to a panel that is given as the parent window of S More...
 
bool IsGraphicalUI () override
 
bool ValidateUI (EffectSettings &) override
 
bool CloseUI () override
 
bool CanExportPresets () override
 
void ExportPresets (const EffectSettings &settings) const override
 
void ImportPresets (EffectSettings &settings) override
 
bool HasOptions () override
 
void ShowOptions () override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatSymbol GetSelectionFormat ()
 
int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
 Usually applies factory to self and given access. More...
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
bool LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
bool TransferDataToWindow (const EffectSettings &settings) override
 Update controls for the settings. More...
 
bool TransferDataFromWindow (EffectSettings &settings) override
 Update the given settings from controls. More...
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings)
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
int MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
 
bool EnableApply (bool enable=true)
 
wxWindow * GetUIParent ()
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
- Public Member Functions inherited from EffectUIClientInterface
virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual bool CanExportPresets ()=0
 
virtual void ExportPresets (const EffectSettings &settings) const =0
 
virtual void ImportPresets (EffectSettings &settings)=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=0
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual const EffectSettingsManagerGetDefinition () const =0
 
virtual int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
 Usually applies factory to self and given access. More...
 
virtual void Preview (EffectSettingsAccess &access, bool dryOnly)=0
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual bool 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, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 Unfortunately complicated dual-use function. More...
 
virtual bool TransferDataToWindow (const EffectSettings &settings)=0
 Update controls for the settings. More...
 
virtual bool TransferDataFromWindow (EffectSettings &settings)=0
 Update the given settings from controls. More...
 
- 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...
 
virtual unsigned GetAudioInCount () const =0
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const =0
 How many output buffers to allocate at once. More...
 
virtual int GetMidiInCount () const
 Function that has not yet found a use. More...
 
virtual int GetMidiOutCount () const
 Function that has not yet found a use. 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...
 
- 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 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 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

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 Effect
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , Since_3_2 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Protected Member Functions inherited from Effect
bool EnablePreview (bool enable=true)
 
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...
 
virtual std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
 Add controls to effect panel; always succeeds. 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)
 
std::shared_ptr< AddedAnalysisTrackAddAnalysisTrack (const wxString &name=wxString())
 
ModifiedAnalysisTrack ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())
 
TrackAddToOutputTracks (const std::shared_ptr< Track > &t)
 
- Protected Member Functions inherited from EffectBase
void Preview (EffectSettingsAccess &access, bool dryOnly) override
 
bool DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
 Unfortunately complicated dual-use function. 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
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=0
 
- Protected Attributes inherited from Effect
wxWeakRef< wxDialog > mHostUIDialog
 This smart pointer tracks the lifetime of the dialog. More...
 
wxWindow * mUIParent {}
 
- Protected Attributes inherited from EffectBase
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
std::shared_ptr< TrackListmOutputTracks
 
double mT0 {}
 
double mT1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 
- Protected Attributes inherited from EffectUIClientInterface
friend EffectUIValidator
 
friend DefaultEffectUIValidator
 
- 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 27 of file ClickRemoval.h.

Constructor & Destructor Documentation

◆ EffectClickRemoval()

EffectClickRemoval::EffectClickRemoval ( )

Definition at line 70 of file ClickRemoval.cpp.

71{
72 Parameters().Reset(*this);
73
75
76 windowSize = 8192;
77 sep = 2049;
78}
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:218
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 80 of file ClickRemoval.cpp.

81{
82}

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 110 of file ClickRemoval.cpp.

111{
112 return ((mClickWidth == 0) || (mThresholdLevel == 0));
113}

References mClickWidth, and mThresholdLevel.

◆ FetchParameters()

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

Definition at line 31 of file ClickRemoval.h.

31{ return &e; }

◆ GetDescription()

TranslatableString EffectClickRemoval::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 91 of file ClickRemoval.cpp.

92{
93 return XO("Click Removal is designed to remove clicks on audio tracks");
94}
#define XO(s)
Definition: Internat.h:31

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectClickRemoval::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 86 of file ClickRemoval.cpp.

87{
88 return Symbol;
89}
static const ComponentInterfaceSymbol Symbol
Definition: ClickRemoval.h:32

References Symbol.

◆ GetType()

EffectType EffectClickRemoval::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 103 of file ClickRemoval.cpp.

104{
105 return EffectTypeProcess;
106}
@ 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 96 of file ClickRemoval.cpp.

97{
98 return L"Click_Removal";
99}

◆ OnThreshSlider()

void EffectClickRemoval::OnThreshSlider ( wxCommandEvent &  evt)
private

Definition at line 339 of file ClickRemoval.cpp.

340{
341 mThreshS->GetValidator()->TransferFromWindow();
342 mThreshT->GetValidator()->TransferToWindow();
343}
wxTextCtrl * mThreshT
Definition: ClickRemoval.h:78
wxSlider * mThreshS
Definition: ClickRemoval.h:76

References mThreshS, and mThreshT.

◆ OnThreshText()

void EffectClickRemoval::OnThreshText ( wxCommandEvent &  evt)
private

Definition at line 327 of file ClickRemoval.cpp.

328{
329 mThreshT->GetValidator()->TransferFromWindow();
330 mThreshS->GetValidator()->TransferToWindow();
331}

References mThreshS, and mThreshT.

◆ OnWidthSlider()

void EffectClickRemoval::OnWidthSlider ( wxCommandEvent &  evt)
private

Definition at line 333 of file ClickRemoval.cpp.

334{
335 mWidthS->GetValidator()->TransferFromWindow();
336 mWidthT->GetValidator()->TransferToWindow();
337}
wxTextCtrl * mWidthT
Definition: ClickRemoval.h:77
wxSlider * mWidthS
Definition: ClickRemoval.h:75

References mWidthS, and mWidthT.

◆ OnWidthText()

void EffectClickRemoval::OnWidthText ( wxCommandEvent &  evt)
private

Definition at line 321 of file ClickRemoval.cpp.

322{
323 mWidthT->GetValidator()->TransferFromWindow();
324 mWidthS->GetValidator()->TransferToWindow();
325}

References mWidthS, and mWidthT.

◆ Parameters()

const EffectParameterMethods & EffectClickRemoval::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 50 of file ClickRemoval.cpp.

51{
54 > parameters;
55 return parameters;
56}
Generates EffectParameterMethods overrides from variadic template arguments.
static constexpr EffectParameter Width
Definition: ClickRemoval.h:85
static constexpr EffectParameter Threshold
Definition: ClickRemoval.h:83

References EffectClickRemoval(), Threshold, and Width.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectClickRemoval::PopulateOrExchange ( ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access 
)
overridevirtual

Add controls to effect panel; always succeeds.

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

Reimplemented from Effect.

Definition at line 276 of file ClickRemoval.cpp.

278{
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}
@ ID_Width
@ ID_Thresh
#define XXO(s)
Definition: Internat.h:44
#define S(N)
Definition: ToChars.cpp:64
const Type min
Minimum value.
Definition: Shuttle.h:30
const Type max
Maximum value.
Definition: Shuttle.h:31

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

◆ Process()

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

Actually do the effect here.

Returns
success

Implements StatefulEffectBase.

Definition at line 115 of file ClickRemoval.cpp.

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

References Effect::CopyInputTracks(), PackedArray::end(), mbDidSomething, Effect::MessageBox(), 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 151 of file ClickRemoval.cpp.

152{
153 if (len <= windowSize / 2)
154 {
156 XO("Selection must be larger than %d samples.")
157 .Format(windowSize / 2),
158 wxOK | wxICON_ERROR );
159 return false;
160 }
161
162 auto idealBlockLen = track->GetMaxBlockSize() * 4;
163 if (idealBlockLen % windowSize != 0)
164 idealBlockLen += (windowSize - (idealBlockLen % windowSize));
165
166 bool bResult = true;
167 decltype(len) s = 0;
168 Floats buffer{ idealBlockLen };
169 Floats datawindow{ windowSize };
170 while ((len - s) > windowSize / 2)
171 {
172 auto block = limitSampleBufferSize( idealBlockLen, len - s );
173
174 track->GetFloats(buffer.get(), start + s, block);
175
176 for (decltype(block) i = 0; i + windowSize / 2 < block; i += windowSize / 2)
177 {
178 auto wcopy = std::min( windowSize, block - i );
179
180 for(decltype(wcopy) j = 0; j < wcopy; j++)
181 datawindow[j] = buffer[i+j];
182 for(auto j = wcopy; j < windowSize; j++)
183 datawindow[j] = 0;
184
185 mbDidSomething |= RemoveClicks(windowSize, datawindow.get());
186
187 for(decltype(wcopy) j = 0; j < wcopy; j++)
188 buffer[i+j] = datawindow[j];
189 }
190
191 if (mbDidSomething) // RemoveClicks() actually did something.
192 track->Set((samplePtr) buffer.get(), floatSample, start + s, block);
193
194 s += block;
195
196 if (TrackProgress(count, s.as_double() /
197 len.as_double())) {
198 bResult = false;
199 break;
200 }
201 }
202
203 return bResult;
204}
int min(int a, int b)
size_t limitSampleBufferSize(size_t bufferSize, sampleCount limit)
Definition: SampleCount.cpp:23
@ floatSample
Definition: SampleFormat.h:34
char * samplePtr
Definition: SampleFormat.h:49
bool RemoveClicks(size_t len, float *buffer)
bool TrackProgress(int whichTrack, double frac, const TranslatableString &={}) const
Definition: Effect.cpp:693
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:67
size_t GetMaxBlockSize() const override
This returns a nonnegative number of samples meant to size a memory buffer.
Definition: WaveTrack.cpp:1806
void Set(constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len)
Definition: WaveTrack.cpp:2195
double as_double() const
Definition: SampleCount.h:45

References sampleCount::as_double(), floatSample, SampleTrack::GetFloats(), WaveTrack::GetMaxBlockSize(), limitSampleBufferSize(), mbDidSomething, Effect::MessageBox(), 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 206 of file ClickRemoval.cpp.

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

References mClickWidth, mThresholdLevel, and sep.

Referenced by ProcessOne().

Here is the caller graph for this function:

Member Data Documentation

◆ mbDidSomething

bool EffectClickRemoval::mbDidSomething
private

Definition at line 69 of file ClickRemoval.h.

Referenced by Process(), and ProcessOne().

◆ mClickWidth

int EffectClickRemoval::mClickWidth
private

Definition at line 72 of file ClickRemoval.h.

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

◆ mEnvelope

Envelope* EffectClickRemoval::mEnvelope
private

Definition at line 67 of file ClickRemoval.h.

◆ mThresholdLevel

int EffectClickRemoval::mThresholdLevel
private

Definition at line 71 of file ClickRemoval.h.

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

◆ mThreshS

wxSlider* EffectClickRemoval::mThreshS
private

Definition at line 76 of file ClickRemoval.h.

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

◆ mThreshT

wxTextCtrl* EffectClickRemoval::mThreshT
private

Definition at line 78 of file ClickRemoval.h.

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

◆ mWidthS

wxSlider* EffectClickRemoval::mWidthS
private

Definition at line 75 of file ClickRemoval.h.

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

◆ mWidthT

wxTextCtrl* EffectClickRemoval::mWidthT
private

Definition at line 77 of file ClickRemoval.h.

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

◆ sep

int EffectClickRemoval::sep
private

Definition at line 73 of file ClickRemoval.h.

Referenced by RemoveClicks().

◆ Symbol

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

Definition at line 32 of file ClickRemoval.h.

Referenced by GetSymbol().

◆ Threshold

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

Definition at line 83 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 85 of file ClickRemoval.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ windowSize

size_t EffectClickRemoval::windowSize
private

Definition at line 70 of file ClickRemoval.h.

Referenced by ProcessOne().


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