Audacity  2.2.0
FindClipping.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  FindClipping.h
6 
7  Dominic Mazzoni
8  Vaughan Johnson (dialog)
9 
10 **********************************************************************/
11 
12 #ifndef __AUDACITY_EFFECT_FINDCLIPPING__
13 #define __AUDACITY_EFFECT_FINDCLIPPING__
14 
15 class wxString;
16 
17 class LabelTrack;
18 
19 #include <wx/string.h>
20 
21 #include "Effect.h"
22 
23 #define FINDCLIPPING_PLUGIN_SYMBOL XO("Find Clipping")
24 
25 class EffectFindClipping final : public Effect
26 {
27 public:
29  virtual ~EffectFindClipping();
30 
31  // IdentInterface implementation
32 
33  wxString GetSymbol() override;
34  wxString GetDescription() override;
35  wxString ManualPage() override;
36 
37  // EffectIdentInterface implementation
38 
39  EffectType GetType() override;
40 
41  // EffectClientInterface implementation
42 
43  bool GetAutomationParameters(EffectAutomationParameters & parms) override;
44  bool SetAutomationParameters(EffectAutomationParameters & parms) override;
45 
46  // Effect implementation
47 
48  bool Process() override;
49  void PopulateOrExchange(ShuttleGui & S) override;
50  bool TransferDataToWindow() override;
51  bool TransferDataFromWindow() override;
52 
53 private:
54  // EffectFindCliping implementation
55 
56  bool ProcessOne(LabelTrack *lt, int count, const WaveTrack * wt,
57  sampleCount start, sampleCount len);
58 
59 private:
60  int mStart;
61  int mStop;
62 };
63 
64 #endif // __AUDACITY_EFFECT_FINDCLIPPING__
bool GetAutomationParameters(EffectAutomationParameters &parms) override
Definition: FindClipping.cpp:78
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI...
Definition: ShuttleGui.h:366
int mStart
Using int rather than sampleCount because values are only ever small numbers.
Definition: FindClipping.h:60
EffectType GetType() override
Definition: FindClipping.cpp:71
int mStop
Using int rather than sampleCount because values are only ever small numbers.
Definition: FindClipping.h:61
void PopulateOrExchange(ShuttleGui &S) override
Definition: FindClipping.cpp:238
Base class for many of the effects in Audacity.
Definition: Effect.h:62
A LabelTrack is a Track that holds labels (LabelStruct).
Definition: LabelTrack.h:114
virtual ~EffectFindClipping()
Definition: FindClipping.cpp:48
bool TransferDataToWindow() override
Definition: FindClipping.cpp:257
bool SetAutomationParameters(EffectAutomationParameters &parms) override
Definition: FindClipping.cpp:86
wxString GetDescription() override
Definition: FindClipping.cpp:59
A Track that contains audio waveform data.
Definition: WaveTrack.h:76
bool TransferDataFromWindow() override
Definition: FindClipping.cpp:265
bool Process() override
Definition: FindClipping.cpp:99
bool ProcessOne(LabelTrack *lt, int count, const WaveTrack *wt, sampleCount start, sampleCount len)
Definition: FindClipping.cpp:152
wxString ManualPage() override
Definition: FindClipping.cpp:64
wxString GetSymbol() override
Definition: FindClipping.cpp:54
EffectFindClipping()
Definition: FindClipping.cpp:42
Locates clipping and inserts labels when found.
Definition: FindClipping.h:25