Audacity 3.2.0
Classes | 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]

Classes

struct  Instance
 

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
 
std::any BeginPreview (const EffectSettings &settings) override
 Called when Preview() starts, to allow temporary effect state changes. More...
 
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
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from StatefulPerTrackEffect
 ~StatefulPerTrackEffect () override
 
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
 
bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr) override
 
bool ProcessFinalize () noexcept override
 
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 ()
 
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 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
 
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 NumericFormatID 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, InstanceFinder finder={})
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
bool IsLinearEffect () const
 
bool PreviewsFullSelection () const
 
void SetTracks (TrackList *pTracks)
 
virtual std::any BeginPreview (const EffectSettings &settings)
 Called when Preview() starts, to allow temporary effect state changes. More...
 
bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void CountWaveTracks ()
 
- 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 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 (EffectBase &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 EffectAmplifyFetchParameters (EffectAmplify &e, EffectSettings &)
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
- Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointerFindInstance (EffectPlugin &plugin)
 
static InstanceFinder DefaultInstanceFinder (EffectPlugin &plugin)
 
- 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("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

wxWeakRef< wxWindow > mUIParent {}
 
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 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
std::shared_ptr< TrackListmTracks {}
 
int mNumTracks {}
 
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
double mT0 {}
 
double mT1 {}
 
bool mIsPreview { false }
 
- Protected Member Functions inherited from PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
std::shared_ptr< EffectOutputTracksMakeOutputTracks ()
 
void DestroyOutputTracks () const
 
- 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, sampleCount *start, sampleCount *len)
 
- Protected Member Functions inherited from EffectBase
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from EffectBase
double mF0 {}
 
double mF1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 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 101 of file Amplify.cpp.

102{
103 mAmp = Amp.def;
104 // Ratio.def == DB_TO_LINEAR(Amp.def)
105 Parameters().Reset(*this);
106 mRatioClip = 0.0;
107 mPeak = 0.0;
108
110}
double mRatioClip
Definition: Amplify.h:90
static constexpr EffectParameter Amp
Definition: Amplify.h:107
double mPeak
Definition: Amplify.h:87
const EffectParameterMethods & Parameters() const override
Definition: Amplify.cpp:53
double mAmp
Definition: Amplify.h:91
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:210
virtual void Reset(Effect &effect) const =0
const Type def
Default value.

References Amp, EffectParameter< Structure, Member, Type, Value >::def, mAmp, mPeak, mRatioClip, Parameters(), EffectParameterMethods::Reset(), and EffectBase::SetLinearEffectFlag().

Referenced by Parameters().

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

◆ ~EffectAmplify()

EffectAmplify::~EffectAmplify ( )
virtual

Definition at line 112 of file Amplify.cpp.

113{
114}

Member Function Documentation

◆ BeginPreview()

std::any EffectAmplify::BeginPreview ( const EffectSettings settings)
overridevirtual

Called when Preview() starts, to allow temporary effect state changes.

default returns a null

Returns
will undo its effects in its destructor before Preview() finishes

Reimplemented from EffectBase.

Definition at line 212 of file Amplify.cpp.

213{
214 return { std::pair{
216 } };
217}
double mRatio
Definition: Amplify.h:89

References mPeak, and mRatio.

◆ CheckClip()

void EffectAmplify::CheckClip ( )
private

Definition at line 360 of file Amplify.cpp.

361{
363 mClip->GetValue() || (mPeak > 0.0 && mRatio <= mRatioClip));
364}
wxWeakRef< wxWindow > mUIParent
Definition: Amplify.h:85
wxCheckBox * mClip
Definition: Amplify.h:98
static bool EnableApply(wxWindow *parent, bool enable=true)
Enable or disable the Apply button of the dialog that contains parent.

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

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 303 of file Amplify.cpp.

304{
305 // limit range of gain
306 double dBInit = LINEAR_TO_DB(mRatio);
307 double dB = std::clamp<double>(dBInit, Amp.min, Amp.max);
308 if (dB != dBInit)
309 mRatio = DB_TO_LINEAR(dB);
310
313}
#define LINEAR_TO_DB(x)
Definition: MemoryX.h:339
#define DB_TO_LINEAR(x)
Definition: MemoryX.h:338
double mNewPeak
Definition: Amplify.h:92
const Type min
Minimum value.
const Type max
Maximum value.

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 169 of file Amplify.cpp.

170{
171 Init();
172
173 mRatioClip = 0.0;
174 if (mPeak > 0.0)
175 {
176 mRatio = 1.0 / mPeak;
178 }
179 else
180 {
181 mRatio = 1.0;
182 }
183 mCanClip = false;
184
185 ClampRatio();
186 return { nullptr };
187}
void ClampRatio()
Definition: Amplify.cpp:303
bool mCanClip
Definition: Amplify.h:93
bool Init() override
Definition: Amplify.cpp:191

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 141 of file Amplify.cpp.

142{
143 return 1;
144}

◆ 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 146 of file Amplify.cpp.

147{
148 return 1;
149}

◆ GetDescription()

TranslatableString EffectAmplify::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 123 of file Amplify.cpp.

124{
125 // Note: This is useful only after ratio has been set.
126 return XO("Increases or decreases the volume of the audio you have selected");
127}
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectAmplify::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 118 of file Amplify.cpp.

119{
120 return Symbol;
121}
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 136 of file Amplify.cpp.

137{
138 return EffectTypeProcess;
139}
@ EffectTypeProcess

References EffectTypeProcess.

◆ Init()

bool EffectAmplify::Init ( )
overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 191 of file Amplify.cpp.

192{
193 auto range = inputTracks()->Selected<const WaveTrack>();
194 bool hasPitchOrSpeed = any_of(begin(range), end(range), [this](auto* pTrack) {
195 return TimeStretching::HasPitchOrSpeed(*pTrack, mT0, mT1);
196 });
197 if (hasPitchOrSpeed)
198 range = MakeOutputTracks()->Get().Selected<const WaveTrack>();
199 mPeak = 0.0;
200 for (auto t : range) {
201 for (const auto pChannel : t->Channels()) {
202 auto pair =
203 WaveChannelUtilities::GetMinMax(*pChannel, mT0, mT1); // may throw
204 const float min = pair.first, max = pair.second;
205 const float newpeak = std::max(fabs(min), fabs(max));
206 mPeak = std::max<double>(mPeak, newpeak);
207 }
208 }
209 return true;
210}
int min(int a, int b)
double mT1
Definition: EffectBase.h:114
const TrackList * inputTracks() const
Definition: EffectBase.h:91
double mT0
Definition: EffectBase.h:113
std::shared_ptr< EffectOutputTracks > MakeOutputTracks()
auto Selected() -> TrackIterRange< TrackType >
Definition: Track.h:967
A Track that contains audio waveform data.
Definition: WaveTrack.h:203
WAVE_TRACK_API bool HasPitchOrSpeed(const WaveTrack &track, double t0, double t1)
WAVE_TRACK_API std::pair< float, float > GetMinMax(const WaveChannel &channel, double t0, double t1, bool mayThrow=true)
const char * end(const char *str) noexcept
Definition: StringUtils.h:106
const char * begin(const char *str) noexcept
Definition: StringUtils.h:101

References details::begin(), details::end(), WaveChannelUtilities::GetMinMax(), TimeStretching::HasPitchOrSpeed(), EffectBase::inputTracks(), PerTrackEffect::MakeOutputTracks(), min(), mPeak, EffectBase::mT0, EffectBase::mT1, and TrackList::Selected().

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 163 of file Amplify.cpp.

164{
165 // To do: externalize state so const_cast isn't needed
166 return const_cast<EffectAmplify&>(*this).DoLoadFactoryDefaults(settings);
167}
static Settings & settings()
Definition: TrackInfo.cpp:47
An Effect that makes a sound louder or softer.
Definition: Amplify.h:28
OptionalMessage DoLoadFactoryDefaults(EffectSettings &settings)
Definition: Amplify.cpp:169

References DoLoadFactoryDefaults(), and settings().

Here is the call graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > EffectAmplify::MakeInstance ( ) const
overridevirtual

Make an object maintaining short-term state of an Effect.

One effect may have multiple instances extant simultaneously. Instances have state, may be implemented in foreign code, and are temporary, whereas EffectSettings represents persistent effect state that can be saved and reloaded from files.

Parameters
settingsmay be assumed to have a lifetime enclosing the instance's
Postcondition
true (no promises that the result isn't null)

Implements EffectInstanceFactory.

Definition at line 351 of file Amplify.cpp.

352{
353 // Cheat with const_cast to return an object that calls through to
354 // non-const methods of a stateful effect.
355 return std::make_shared<Instance>(const_cast<EffectAmplify&>(*this));
356}

◆ ManualPage()

ManualPageID EffectAmplify::ManualPage ( ) const
overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 129 of file Amplify.cpp.

130{
131 return L"Amplify";
132}

◆ OnAmpSlider()

void EffectAmplify::OnAmpSlider ( wxCommandEvent &  evt)
private

Definition at line 409 of file Amplify.cpp.

410{
411 double dB = evt.GetInt() / Amp.scale;
412 mRatio = DB_TO_LINEAR(std::clamp<double>(dB, Amp.min, Amp.max));
413
414 double dB2 = (evt.GetInt() - 1) / Amp.scale;
415 double ratio2 = DB_TO_LINEAR(std::clamp<double>(dB2, Amp.min, Amp.max));
416
417 if (!mClip->GetValue() && mRatio * mPeak > 1.0 && ratio2 * mPeak < 1.0)
418 {
419 mRatio = 1.0 / mPeak;
420 }
421
423 mAmpT->GetValidator()->TransferToWindow();
424
426 mNewPeakT->GetValidator()->TransferToWindow();
427
428 CheckClip();
429}
wxTextCtrl * mNewPeakT
Definition: Amplify.h:97
wxTextCtrl * mAmpT
Definition: Amplify.h:96
void CheckClip()
Definition: Amplify.cpp:360
const Type scale
Scaling factor, for slider control.

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 366 of file Amplify.cpp.

367{
368 if (!mAmpT->GetValidator()->TransferFromWindow())
369 {
371 return;
372 }
373
374 mRatio = DB_TO_LINEAR(std::clamp<double>(mAmp * Amp.scale, Amp.min * Amp.scale, Amp.max * Amp.scale) / Amp.scale);
375
376 mAmpS->SetValue((int) (LINEAR_TO_DB(mRatio) * Amp.scale + 0.5));
377
379 mNewPeakT->GetValidator()->TransferToWindow();
380
381 CheckClip();
382}
wxSlider * mAmpS
Definition: Amplify.h:95

References Amp, CheckClip(), DB_TO_LINEAR, EffectEditor::EnableApply(), LINEAR_TO_DB, mAmp, mAmpS, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, mUIParent, 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 431 of file Amplify.cpp.

432{
433 CheckClip();
434}

References CheckClip().

Here is the call graph for this function:

◆ OnPeakText()

void EffectAmplify::OnPeakText ( wxCommandEvent &  evt)
private

Definition at line 384 of file Amplify.cpp.

385{
386 if (!mNewPeakT->GetValidator()->TransferFromWindow())
387 {
389 return;
390 }
391
392 if (mNewPeak == 0.0)
394 else
396
397 double ampInit = LINEAR_TO_DB(mRatio);
398 mAmp = std::clamp<double>(ampInit, Amp.min, Amp.max);
399 if (mAmp != ampInit)
401
402 mAmpT->GetValidator()->TransferToWindow();
403
404 mAmpS->SetValue((int) (mAmp * Amp.scale + 0.5f));
405
406 CheckClip();
407}

References Amp, CheckClip(), DB_TO_LINEAR, EffectEditor::EnableApply(), LINEAR_TO_DB, mAmp, mAmpS, mAmpT, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mNewPeak, mNewPeakT, mPeak, mRatio, mRatioClip, mUIParent, 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 53 of file Amplify.cpp.

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

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

Referenced by EffectAmplify().

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

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > 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 PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 219 of file Amplify.cpp.

222{
223 mUIParent = S.GetParent();
224
225 enum{ precision = 3 }; // allow (a generous) 3 decimal places for Amplification (dB)
226
227 bool batch = IsBatchProcessing();
228 if ( batch )
229 {
230 mCanClip = true;
231 mPeak = 1.0;
232 }
233 else
234 {
235 if (mPeak > 0.0)
236 {
237 mRatio = 1.0 / mPeak;
239 }
240 else
241 {
242 mRatio = 1.0;
243 }
244 }
245
246 // At this point mNewPeak is still uninitialized; this will initialize it
247 ClampRatio();
248
249 S.AddSpace(0, 5);
250
251 S.StartVerticalLay(0);
252 {
253 // Amplitude
254 S.StartMultiColumn(2, wxCENTER);
255 {
256 mAmpT = S.Id(ID_Amp)
257 .Validator<FloatingPointValidator<double>>(
258 precision, &mAmp, NumValidatorStyle::ONE_TRAILING_ZERO, Amp.min, Amp.max )
259 .AddTextBox(XXO("&Amplification (dB):"), L"", 12);
260 }
261 S.EndMultiColumn();
262
263 // Amplitude
264 S.StartHorizontalLay(wxEXPAND);
265 {
266 mAmpS = S.Id(ID_Amp)
267 .Style(wxSL_HORIZONTAL)
268 .Name(XO("Amplification dB"))
269 .AddSlider( {}, 0, Amp.max * Amp.scale, Amp.min * Amp.scale);
270 }
271 S.EndHorizontalLay();
272
273 // Peak
274 S.StartMultiColumn(2, wxCENTER);
275 {
276 mNewPeakT = S.Id(ID_Peak)
277 .Validator<FloatingPointValidator<double>>(
278 // One extra decimal place so that rounding is visible to user
279 // (see: bug 958)
280 precision + 1,
281 &mNewPeak, NumValidatorStyle::ONE_TRAILING_ZERO,
282 // min and max need same precision as what we're validating (bug 963)
283 RoundValue( precision + 1, Amp.min + LINEAR_TO_DB(mPeak) ),
284 RoundValue( precision + 1, Amp.max + LINEAR_TO_DB(mPeak) ) )
285 .AddTextBox(XXO("&New Peak Amplitude (dB):"), L"", 12);
286 }
287 S.EndMultiColumn();
288
289 // Clipping
290 S.StartHorizontalLay(wxCENTER);
291 {
292
293 mClip = S.Id(ID_Clip).Disable( batch )
294 .AddCheckBox(XXO("Allo&w clipping"), false);
295 }
296 S.EndHorizontalLay();
297 }
298 S.EndVerticalLay();
299
300 return nullptr;
301}
@ ID_Clip
Definition: Amplify.cpp:50
@ ID_Peak
Definition: Amplify.cpp:49
@ ID_Amp
Definition: Amplify.cpp:48
XXO("&Cut/Copy/Paste Toolbar")
#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, mUIParent, S, EffectParameter< Structure, Member, Type, Value >::scale, XO(), and XXO().

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 151 of file Amplify.cpp.

153{
154 for (decltype(blockLen) i = 0; i < blockLen; i++)
155 {
156 outBlock[0][i] = inBlock[0][i] * mRatio;
157 }
158
159 return blockLen;
160}

References mRatio.

◆ TransferDataFromWindow()

bool EffectAmplify::TransferDataFromWindow ( EffectSettings settings)
overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 330 of file Amplify.cpp.

331{
332 if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
333 {
334 return false;
335 }
336
337 mRatio = DB_TO_LINEAR(std::clamp<double>(mAmp * Amp.scale, Amp.min * Amp.scale, Amp.max * Amp.scale) / Amp.scale);
338
339 mCanClip = mClip->GetValue();
340
341 if (!mCanClip && mRatio * mPeak > 1.0)
342 {
343 mRatio = 1.0 / mPeak;
344 }
345
346 ClampRatio();
347
348 return true;
349}

References Amp, ClampRatio(), DB_TO_LINEAR, mAmp, EffectParameter< Structure, Member, Type, Value >::max, mCanClip, mClip, EffectParameter< Structure, Member, Type, Value >::min, mPeak, mRatio, 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; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 315 of file Amplify.cpp.

316{
317 mAmpT->GetValidator()->TransferToWindow();
318
319 mAmpS->SetValue((int) (mAmp * Amp.scale + 0.5f));
320
321 mNewPeakT->GetValidator()->TransferToWindow();
322
323 mClip->SetValue(mCanClip);
324
325 CheckClip();
326
327 return true;
328}

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 107 of file Amplify.h.

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

◆ Clipping

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

Definition at line 109 of file Amplify.h.

Referenced by Parameters().

◆ mAmp

double EffectAmplify::mAmp = 0.0
private

◆ mAmpS

wxSlider* EffectAmplify::mAmpS
private

Definition at line 95 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 92 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

◆ mUIParent

wxWeakRef<wxWindow> EffectAmplify::mUIParent {}
private

◆ Ratio

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

Definition at line 104 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: