Audacity  3.0.3
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 "Effect.h"
20 
21 class EffectFindClipping final : public Effect
22 {
23 public:
25 
27  virtual ~EffectFindClipping();
28 
29  // ComponentInterface implementation
30 
33  ManualPageID ManualPage() override;
34 
35  // EffectDefinitionInterface implementation
36 
37  EffectType GetType() override;
38 
39  // EffectClientInterface implementation
40 
41  bool DefineParams( ShuttleParams & S ) override;
42  bool GetAutomationParameters(CommandParameters & parms) override;
43  bool SetAutomationParameters(CommandParameters & parms) override;
44 
45  // Effect implementation
46 
47  bool Process() override;
48  void PopulateOrExchange(ShuttleGui & S) override;
49  bool TransferDataToWindow() override;
50  bool TransferDataFromWindow() override;
51 
52 private:
53  // EffectFindCliping implementation
54 
55  bool ProcessOne(LabelTrack *lt, int count, const WaveTrack * wt,
56  sampleCount start, sampleCount len);
57 
58 private:
59  int mStart;
60  int mStop;
61 };
62 
63 #endif // __AUDACITY_EFFECT_FINDCLIPPING__
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
CommandParameters
CommandParameters, derived from wxFileConfig, is essentially doing the same things as the Shuttle cla...
Definition: EffectAutomationParameters.h:67
EffectFindClipping::ManualPage
ManualPageID ManualPage() override
Definition: FindClipping.cpp:71
EffectFindClipping::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: FindClipping.cpp:61
WaveTrack
A Track that contains audio waveform data.
Definition: WaveTrack.h:69
EffectFindClipping::TransferDataFromWindow
bool TransferDataFromWindow() override
Definition: FindClipping.cpp:266
Effect.h
Effect
Base class for many of the effects in Audacity.
Definition: Effect.h:72
EffectFindClipping::ProcessOne
bool ProcessOne(LabelTrack *lt, int count, const WaveTrack *wt, sampleCount start, sampleCount len)
Definition: FindClipping.cpp:157
EffectFindClipping::SetAutomationParameters
bool SetAutomationParameters(CommandParameters &parms) override
Definition: FindClipping.cpp:98
ShuttleParams
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:62
LabelTrack
A LabelTrack is a Track that holds labels (LabelStruct).
Definition: LabelTrack.h:88
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
EffectFindClipping::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: FindClipping.cpp:84
EffectFindClipping::TransferDataToWindow
bool TransferDataToWindow() override
Definition: FindClipping.cpp:258
EffectFindClipping::EffectFindClipping
EffectFindClipping()
Definition: FindClipping.cpp:49
EffectFindClipping::GetType
EffectType GetType() override
Definition: FindClipping.cpp:78
EffectFindClipping::mStop
int mStop
Using int rather than sampleCount because values are only ever small numbers.
Definition: FindClipping.h:60
EffectFindClipping::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: FindClipping.h:24
EffectFindClipping::Process
bool Process() override
Definition: FindClipping.cpp:111
TaggedIdentifier< ManualPageIDTag >
sampleCount
Positions or offsets within audio files need a wide type.
Definition: SampleCount.h:18
EffectFindClipping
Locates clipping and inserts labels when found.
Definition: FindClipping.h:22
EffectFindClipping::~EffectFindClipping
virtual ~EffectFindClipping()
Definition: FindClipping.cpp:55
EffectType
EffectType
Definition: EffectInterface.h:55
EffectFindClipping::GetAutomationParameters
bool GetAutomationParameters(CommandParameters &parms) override
Definition: FindClipping.cpp:90
EffectFindClipping::mStart
int mStart
Using int rather than sampleCount because values are only ever small numbers.
Definition: FindClipping.h:59
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631
EffectFindClipping::GetDescription
TranslatableString GetDescription() override
Definition: FindClipping.cpp:66
EffectFindClipping::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: FindClipping.cpp:243