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

An Effect that makes a sound louder or softer. More...

#include <Amplify.h>

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

Public Member Functions

 EffectAmplify ()
 
virtual ~EffectAmplify ()
 
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...
 
OptionalMessage LoadFactoryDefaults (EffectSettings &settings) const override
 
OptionalMessage DoLoadFactoryDefaults (EffectSettings &settings)
 
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...
 
size_t ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen) override
 Called for destructive effect computation. More...
 
bool Init () override
 Call once to set up state for whole list of tracks to be processed. More...
 
void Preview (EffectSettingsAccess &access, bool dryOnly) override
 
std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
 Add controls to effect panel; always succeeds. More...
 
bool TransferDataToWindow (const EffectSettings &settings) override
 Update controls for the settings. More...
 
bool TransferDataFromWindow (EffectSettings &settings) override
 Update the given settings from controls. More...
 
- Public Member Functions inherited from StatefulPerTrackEffect
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
size_t SetBlockSize (size_t maxBlockSize) override
 
size_t GetBlockSize () const override
 
virtual bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)
 
virtual bool ProcessFinalize () noexcept
 
virtual size_t ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen)=0
 Called for destructive effect computation. 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, 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
 
- Public Member Functions inherited from PerTrackEffect
 ~PerTrackEffect () override
 
- 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
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override
 
EffectUIClientInterfaceGetEffectUIClientInterface () override
 Returns the EffectUIClientInterface instance for this effect. More...
 
std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) 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
 
OptionalMessage 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
 
OptionalMessage 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
 
void SetTracks (TrackList *pTracks)
 
- Public Member Functions inherited from EffectUIClientInterface
virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)=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 OptionalMessage ImportPresets (EffectSettings &settings)=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=0
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=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 EffectUIClientInterfaceGetEffectUIClientInterface ()=0
 Returns the EffectUIClientInterface instance for this effect. More...
 
virtual void Preview (EffectSettingsAccess &access, bool dryOnly)=0
 
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, 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...
 
- 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
 

Static Public Member Functions

static EffectAmplifyFetchParameters (EffectAmplify &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("Amplify") }
 
- 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 ClampRatio ()
 
void OnAmpText (wxCommandEvent &evt)
 
void OnPeakText (wxCommandEvent &evt)
 
void OnAmpSlider (wxCommandEvent &evt)
 
void OnClipCheckBox (wxCommandEvent &evt)
 
void CheckClip ()
 
const EffectParameterMethodsParameters () const override
 

Private Attributes

double mPeak = 1.0
 
double mRatio = 1.0
 
double mRatioClip = 1.0
 
double mAmp = 0.0
 
double mNewPeak = 1.0
 
bool mCanClip = true
 
wxSlider * mAmpS
 
wxTextCtrl * mAmpT
 
wxTextCtrl * mNewPeakT
 
wxCheckBox * mClip
 

Static Private Attributes

static constexpr EffectParameter Ratio
 
static constexpr EffectParameter Amp
 
static constexpr EffectParameter Clipping
 

Additional Inherited Members

- Public Types inherited from StatefulEffectBase
using MessagePackage = EffectInstance::MessagePackage
 
- 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 PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
- 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, const EffectOutputs *pOutputs)
 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
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- 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 }
 
- Static Protected Attributes inherited from EffectBase
static int nEffectsDone = 0
 

Detailed Description

An Effect that makes a sound louder or softer.

This rewritten class supports a smart Amplify effect - it calculates the maximum amount of gain that can be applied to all tracks without causing clipping and selects this as the default parameter.

Definition at line 27 of file Amplify.h.

Constructor & Destructor Documentation

◆ EffectAmplify()

EffectAmplify::EffectAmplify ( )

Definition at line 92 of file Amplify.cpp.

93{
94 mAmp = Amp.def;
95 // Ratio.def == DB_TO_LINEAR(Amp.def)
96 Parameters().Reset(*this);
97 mRatioClip = 0.0;
98 mPeak = 0.0;
99
101}
double mRatioClip
Definition: Amplify.h:81
static constexpr EffectParameter Amp
Definition: Amplify.h:98
double mPeak
Definition: Amplify.h:78
const EffectParameterMethods & Parameters() const override
Definition: Amplify.cpp:50
double mAmp
Definition: Amplify.h:82
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:222
virtual void Reset(Effect &effect) const =0
const Type def
Default value.
Definition: Shuttle.h:29

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectAmplify()

EffectAmplify::~EffectAmplify ( )
virtual

Definition at line 103 of file Amplify.cpp.

104{
105}

Member Function Documentation

◆ CheckClip()

void EffectAmplify::CheckClip ( )
private

Definition at line 341 of file Amplify.cpp.

342{
343 EnableApply(mClip->GetValue() || (mPeak > 0.0 && mRatio <= mRatioClip));
344}
wxCheckBox * mClip
Definition: Amplify.h:89
double mRatio
Definition: Amplify.h:80
bool EnableApply(bool enable=true)
Definition: Effect.cpp:612

References Effect::EnableApply(), mClip, mPeak, mRatio, and mRatioClip.

Referenced by OnAmpSlider(), OnAmpText(), OnClipCheckBox(), OnPeakText(), and TransferDataToWindow().

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

◆ ClampRatio()

void EffectAmplify::ClampRatio ( )
private

Definition at line 291 of file Amplify.cpp.

292{
293 // limit range of gain
294 double dBInit = LINEAR_TO_DB(mRatio);
295 double dB = std::clamp<double>(dBInit, Amp.min, Amp.max);
296 if (dB != dBInit)
297 mRatio = DB_TO_LINEAR(dB);
298
301}
#define LINEAR_TO_DB(x)
Definition: MemoryX.h:544
#define DB_TO_LINEAR(x)
Definition: MemoryX.h:543
double mNewPeak
Definition: Amplify.h:83
const Type min
Minimum value.
Definition: Shuttle.h:30
const Type max
Maximum value.
Definition: Shuttle.h:31

References Amp, DB_TO_LINEAR, LINEAR_TO_DB, mAmp, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mPeak, and mRatio.

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

Here is the caller graph for this function:

◆ DoLoadFactoryDefaults()

OptionalMessage EffectAmplify::DoLoadFactoryDefaults ( EffectSettings settings)

Definition at line 160 of file Amplify.cpp.

161{
162 Init();
163
164 mRatioClip = 0.0;
165 if (mPeak > 0.0)
166 {
167 mRatio = 1.0 / mPeak;
169 }
170 else
171 {
172 mRatio = 1.0;
173 }
174 mCanClip = false;
175
176 ClampRatio();
177 return { nullptr };
178}
void ClampRatio()
Definition: Amplify.cpp:291
bool mCanClip
Definition: Amplify.h:84
bool Init() override
Call once to set up state for whole list of tracks to be processed.
Definition: Amplify.cpp:182

References ClampRatio(), Init(), mCanClip, mPeak, mRatio, and mRatioClip.

Referenced by LoadFactoryDefaults().

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

◆ FetchParameters()

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

Definition at line 31 of file Amplify.h.

31{ return &e; }

◆ GetAudioInCount()

unsigned EffectAmplify::GetAudioInCount ( ) const
overridevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize Default implementation returns 0

Reimplemented from StatefulEffectBase.

Definition at line 132 of file Amplify.cpp.

133{
134 return 1;
135}

◆ GetAudioOutCount()

unsigned EffectAmplify::GetAudioOutCount ( ) const
overridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize Default implementation returns 0

Reimplemented from StatefulEffectBase.

Definition at line 137 of file Amplify.cpp.

138{
139 return 1;
140}

◆ GetDescription()

TranslatableString EffectAmplify::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 114 of file Amplify.cpp.

115{
116 // Note: This is useful only after ratio has been set.
117 return XO("Increases or decreases the volume of the audio you have selected");
118}
#define XO(s)
Definition: Internat.h:31

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectAmplify::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 109 of file Amplify.cpp.

110{
111 return Symbol;
112}
static const ComponentInterfaceSymbol Symbol
Definition: Amplify.h:32

References Symbol.

◆ GetType()

EffectType EffectAmplify::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 127 of file Amplify.cpp.

128{
129 return EffectTypeProcess;
130}
@ EffectTypeProcess

References EffectTypeProcess.

◆ Init()

bool EffectAmplify::Init ( )
overridevirtual

Call once to set up state for whole list of tracks to be processed.

Returns
success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 182 of file Amplify.cpp.

183{
184 mPeak = 0.0;
185
186 for (auto t : inputTracks()->Selected< const WaveTrack >())
187 {
188 auto pair = t->GetMinMax(mT0, mT1); // may throw
189 const float min = pair.first, max = pair.second;
190 float newpeak = (fabs(min) > fabs(max) ? fabs(min) : fabs(max));
191
192 if (newpeak > mPeak)
193 {
194 mPeak = newpeak;
195 }
196 }
197
198 return true;
199}
int min(int a, int b)
double mT1
Definition: EffectBase.h:109
const TrackList * inputTracks() const
Definition: EffectBase.h:104
double mT0
Definition: EffectBase.h:108

References EffectBase::inputTracks(), min(), mPeak, EffectBase::mT0, and EffectBase::mT1.

Referenced by DoLoadFactoryDefaults().

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

◆ LoadFactoryDefaults()

OptionalMessage EffectAmplify::LoadFactoryDefaults ( EffectSettings settings) const
overridevirtual

Change settings back to "factory default"

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 154 of file Amplify.cpp.

155{
156 // To do: externalize state so const_cast isn't needed
157 return const_cast<EffectAmplify&>(*this).DoLoadFactoryDefaults(settings);
158}
static Settings & settings()
Definition: TrackInfo.cpp:87
An Effect that makes a sound louder or softer.
Definition: Amplify.h:28
OptionalMessage DoLoadFactoryDefaults(EffectSettings &settings)
Definition: Amplify.cpp:160

References DoLoadFactoryDefaults(), and settings().

Here is the call graph for this function:

◆ ManualPage()

ManualPageID EffectAmplify::ManualPage ( ) const
overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 120 of file Amplify.cpp.

121{
122 return L"Amplify";
123}

◆ OnAmpSlider()

void EffectAmplify::OnAmpSlider ( wxCommandEvent &  evt)
private

Definition at line 389 of file Amplify.cpp.

390{
391 double dB = evt.GetInt() / Amp.scale;
392 mRatio = DB_TO_LINEAR(std::clamp<double>(dB, Amp.min, Amp.max));
393
394 double dB2 = (evt.GetInt() - 1) / Amp.scale;
395 double ratio2 = DB_TO_LINEAR(std::clamp<double>(dB2, Amp.min, Amp.max));
396
397 if (!mClip->GetValue() && mRatio * mPeak > 1.0 && ratio2 * mPeak < 1.0)
398 {
399 mRatio = 1.0 / mPeak;
400 }
401
403 mAmpT->GetValidator()->TransferToWindow();
404
406 mNewPeakT->GetValidator()->TransferToWindow();
407
408 CheckClip();
409}
wxTextCtrl * mNewPeakT
Definition: Amplify.h:88
wxTextCtrl * mAmpT
Definition: Amplify.h:87
void CheckClip()
Definition: Amplify.cpp:341
const Type scale
Scaling factor, for slider control.
Definition: Shuttle.h:32

References Amp, CheckClip(), DB_TO_LINEAR, LINEAR_TO_DB, mAmp, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, mClip, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnAmpText()

void EffectAmplify::OnAmpText ( wxCommandEvent &  evt)
private

Definition at line 346 of file Amplify.cpp.

347{
348 if (!mAmpT->GetValidator()->TransferFromWindow())
349 {
350 EnableApply(false);
351 return;
352 }
353
354 mRatio = DB_TO_LINEAR(std::clamp<double>(mAmp * Amp.scale, Amp.min * Amp.scale, Amp.max * Amp.scale) / Amp.scale);
355
356 mAmpS->SetValue((int) (LINEAR_TO_DB(mRatio) * Amp.scale + 0.5));
357
359 mNewPeakT->GetValidator()->TransferToWindow();
360
361 CheckClip();
362}
wxSlider * mAmpS
Definition: Amplify.h:86

References Amp, CheckClip(), DB_TO_LINEAR, Effect::EnableApply(), LINEAR_TO_DB, mAmp, mAmpS, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnClipCheckBox()

void EffectAmplify::OnClipCheckBox ( wxCommandEvent &  evt)
private

Definition at line 411 of file Amplify.cpp.

412{
413 CheckClip();
414}

References CheckClip().

Here is the call graph for this function:

◆ OnPeakText()

void EffectAmplify::OnPeakText ( wxCommandEvent &  evt)
private

Definition at line 364 of file Amplify.cpp.

365{
366 if (!mNewPeakT->GetValidator()->TransferFromWindow())
367 {
368 EnableApply(false);
369 return;
370 }
371
372 if (mNewPeak == 0.0)
374 else
376
377 double ampInit = LINEAR_TO_DB(mRatio);
378 mAmp = std::clamp<double>(ampInit, Amp.min, Amp.max);
379 if (mAmp != ampInit)
381
382 mAmpT->GetValidator()->TransferToWindow();
383
384 mAmpS->SetValue((int) (mAmp * Amp.scale + 0.5f));
385
386 CheckClip();
387}

References Amp, CheckClip(), DB_TO_LINEAR, Effect::EnableApply(), LINEAR_TO_DB, mAmp, mAmpS, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, mRatioClip, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectAmplify::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 50 of file Amplify.cpp.

51{
53 // Interactive case
55 > parameters;
56
58 Ratio
59 > batchParameters{
60 // If invoking Amplify from a macro, mCanClip is not a parameter
61 // but is always true
62 [](EffectAmplify &, EffectSettings &, EffectAmplify &e, bool) {
63 e.mCanClip = true;
64 return true;
65 },
66 };
67
68 // Parameters differ depending on batch mode. Option to disable clipping
69 // is interactive only.
71 return batchParameters;
72 else
73 return parameters;
74}
Generates EffectParameterMethods overrides from variadic template arguments.
static constexpr EffectParameter Ratio
Definition: Amplify.h:95
static constexpr EffectParameter Clipping
Definition: Amplify.h:100
bool IsBatchProcessing() const override
Definition: Effect.cpp:559
Externalized state of a plug-in.

References Clipping, EffectAmplify(), Effect::IsBatchProcessing(), and Ratio.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectAmplify::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 Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

Reimplemented from Effect.

Definition at line 209 of file Amplify.cpp.

212{
213 enum{ precision = 3 }; // allow (a generous) 3 decimal places for Amplification (dB)
214
215 bool batch = IsBatchProcessing();
216 if ( batch )
217 {
218 mCanClip = true;
219 mPeak = 1.0;
220 }
221 else
222 {
223 if (mPeak > 0.0)
224 {
225 mRatio = 1.0 / mPeak;
227 }
228 else
229 {
230 mRatio = 1.0;
231 }
232 }
233
234 // At this point mNewPeak is still uninitialized; this will initialize it
235 ClampRatio();
236
237 S.AddSpace(0, 5);
238
239 S.StartVerticalLay(0);
240 {
241 // Amplitude
242 S.StartMultiColumn(2, wxCENTER);
243 {
244 mAmpT = S.Id(ID_Amp)
245 .Validator<FloatingPointValidator<double>>(
246 precision, &mAmp, NumValidatorStyle::ONE_TRAILING_ZERO, Amp.min, Amp.max )
247 .AddTextBox(XXO("&Amplification (dB):"), L"", 12);
248 }
249 S.EndMultiColumn();
250
251 // Amplitude
252 S.StartHorizontalLay(wxEXPAND);
253 {
254 mAmpS = S.Id(ID_Amp)
255 .Style(wxSL_HORIZONTAL)
256 .Name(XO("Amplification dB"))
257 .AddSlider( {}, 0, Amp.max * Amp.scale, Amp.min * Amp.scale);
258 }
259 S.EndHorizontalLay();
260
261 // Peak
262 S.StartMultiColumn(2, wxCENTER);
263 {
264 mNewPeakT = S.Id(ID_Peak)
265 .Validator<FloatingPointValidator<double>>(
266 // One extra decimal place so that rounding is visible to user
267 // (see: bug 958)
268 precision + 1,
269 &mNewPeak, NumValidatorStyle::ONE_TRAILING_ZERO,
270 // min and max need same precision as what we're validating (bug 963)
271 RoundValue( precision + 1, Amp.min + LINEAR_TO_DB(mPeak) ),
272 RoundValue( precision + 1, Amp.max + LINEAR_TO_DB(mPeak) ) )
273 .AddTextBox(XXO("&New Peak Amplitude (dB):"), L"", 12);
274 }
275 S.EndMultiColumn();
276
277 // Clipping
278 S.StartHorizontalLay(wxCENTER);
279 {
280
281 mClip = S.Id(ID_Clip).Disable( batch )
282 .AddCheckBox(XXO("Allo&w clipping"), false);
283 }
284 S.EndHorizontalLay();
285 }
286 S.EndVerticalLay();
287
288 return nullptr;
289}
@ ID_Clip
Definition: Amplify.cpp:47
@ ID_Peak
Definition: Amplify.cpp:46
@ ID_Amp
Definition: Amplify.cpp:45
#define XXO(s)
Definition: Internat.h:44
#define S(N)
Definition: ToChars.cpp:64

References Amp, ClampRatio(), ID_Amp, ID_Clip, ID_Peak, Effect::IsBatchProcessing(), LINEAR_TO_DB, mAmp, mAmpS, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, mCanClip, mClip, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, mRatioClip, S, EffectParameter< Structure, Member, Type, Value >::scale, XO, and XXO.

Here is the call graph for this function:

◆ Preview()

void EffectAmplify::Preview ( EffectSettingsAccess access,
bool  dryOnly 
)
overridevirtual

Implements EffectPlugin.

Definition at line 201 of file Amplify.cpp.

202{
203 auto cleanup1 = valueRestorer( mRatio );
204 auto cleanup2 = valueRestorer( mPeak );
205
206 Effect::Preview(access, dryOnly);
207}
ValueRestorer< T > valueRestorer(T &var)
inline functions provide convenient parameter type deduction
Definition: MemoryX.h:234
void Preview(EffectSettingsAccess &access, bool dryOnly) override
Definition: EffectBase.cpp:332

References mPeak, mRatio, EffectBase::Preview(), and valueRestorer().

Here is the call graph for this function:

◆ ProcessBlock()

size_t EffectAmplify::ProcessBlock ( EffectSettings settings,
const float *const *  inBlock,
float *const *  outBlock,
size_t  blockLen 
)
overridevirtual

Called for destructive effect computation.

Implements StatefulPerTrackEffect.

Definition at line 142 of file Amplify.cpp.

144{
145 for (decltype(blockLen) i = 0; i < blockLen; i++)
146 {
147 outBlock[0][i] = inBlock[0][i] * mRatio;
148 }
149
150 return blockLen;
151}

References mRatio.

◆ TransferDataFromWindow()

bool EffectAmplify::TransferDataFromWindow ( EffectSettings settings)
overridevirtual

Update the given settings from controls.

Implements EffectPlugin.

Definition at line 318 of file Amplify.cpp.

319{
320 if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
321 {
322 return false;
323 }
324
325 mRatio = DB_TO_LINEAR(std::clamp<double>(mAmp * Amp.scale, Amp.min * Amp.scale, Amp.max * Amp.scale) / Amp.scale);
326
327 mCanClip = mClip->GetValue();
328
329 if (!mCanClip && mRatio * mPeak > 1.0)
330 {
331 mRatio = 1.0 / mPeak;
332 }
333
334 ClampRatio();
335
336 return true;
337}
wxWindow * mUIParent
Definition: Effect.h:307

References Amp, ClampRatio(), DB_TO_LINEAR, mAmp, EffectParameter< Structure, Member, Type, Value >::max, mCanClip, mClip, EffectParameter< Structure, Member, Type, Value >::min, mPeak, mRatio, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectAmplify::TransferDataToWindow ( const EffectSettings settings)
overridevirtual

Update controls for the settings.

Implements EffectPlugin.

Definition at line 303 of file Amplify.cpp.

304{
305 mAmpT->GetValidator()->TransferToWindow();
306
307 mAmpS->SetValue((int) (mAmp * Amp.scale + 0.5f));
308
309 mNewPeakT->GetValidator()->TransferToWindow();
310
311 mClip->SetValue(mCanClip);
312
313 CheckClip();
314
315 return true;
316}

References Amp, CheckClip(), mAmp, mAmpS, mAmpT, mCanClip, mClip, mNewPeakT, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

Member Data Documentation

◆ Amp

constexpr EffectParameter EffectAmplify::Amp
staticconstexprprivate
Initial value:
L"", -0.91515f, -50.0f, 50.0f, 10.0f }

Definition at line 98 of file Amplify.h.

Referenced by ClampRatio(), OnAmpSlider(), OnAmpText(), OnPeakText(), PopulateOrExchange(), TransferDataFromWindow(), and TransferDataToWindow().

◆ Clipping

constexpr EffectParameter EffectAmplify::Clipping
staticconstexprprivate
Initial value:
L"AllowClipping", false, false, true, 1 }

Definition at line 100 of file Amplify.h.

Referenced by Parameters().

◆ mAmp

double EffectAmplify::mAmp = 0.0
private

◆ mAmpS

wxSlider* EffectAmplify::mAmpS
private

Definition at line 86 of file Amplify.h.

Referenced by OnAmpText(), OnPeakText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mAmpT

wxTextCtrl* EffectAmplify::mAmpT
private

◆ mCanClip

bool EffectAmplify::mCanClip = true
private

◆ mClip

wxCheckBox* EffectAmplify::mClip
private

◆ mNewPeak

double EffectAmplify::mNewPeak = 1.0
private

Definition at line 83 of file Amplify.h.

Referenced by ClampRatio(), OnAmpSlider(), OnAmpText(), OnPeakText(), and PopulateOrExchange().

◆ mNewPeakT

wxTextCtrl* EffectAmplify::mNewPeakT
private

◆ mPeak

double EffectAmplify::mPeak = 1.0
private

◆ mRatio

double EffectAmplify::mRatio = 1.0
private

◆ mRatioClip

double EffectAmplify::mRatioClip = 1.0
private

Definition at line 81 of file Amplify.h.

Referenced by CheckClip(), DoLoadFactoryDefaults(), OnPeakText(), and PopulateOrExchange().

◆ Ratio

constexpr EffectParameter EffectAmplify::Ratio
staticconstexprprivate
Initial value:
L"Ratio", 0.9f, 0.003162f, 316.227766f, 1.0f }

Definition at line 95 of file Amplify.h.

Referenced by Parameters().

◆ Symbol

const ComponentInterfaceSymbol EffectAmplify::Symbol { XO("Amplify") }
static

Definition at line 32 of file Amplify.h.

Referenced by GetSymbol().


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