Audacity 3.2.0
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
EffectEqualization Class Reference

An Effect that modifies volume in different frequency bands. More...

#include <Equalization.h>

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

Classes

struct  Task
 

Public Member Functions

 EffectEqualization (int Options=kEqLegacy)
 
virtual ~EffectEqualization ()
 
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...
 
bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
 
bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
OptionalMessage LoadFactoryDefaults (EffectSettings &settings) const override
 
OptionalMessage DoLoadFactoryDefaults (EffectSettings &settings)
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
OptionalMessage LoadFactoryPreset (int id, EffectSettings &settings) const override
 
bool ValidateUI (const EffectPlugin &plugin, EffectSettings &) const override
 
bool Init () override
 
bool Process (EffectInstance &instance, EffectSettings &settings) override
 
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
 
- Public Member Functions inherited from StatefulEffect
 ~StatefulEffect () override
 
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 ()
 
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 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
 
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 NumericFormatSymbol 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 EqualizationParametersFetchParameters (EffectEqualization &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("Equalization") }
 
- 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 (Task &task, int count, const WaveChannel &t, sampleCount start, sampleCount len)
 
const EffectParameterMethodsParameters () const override
 

Private Attributes

wxWeakRef< wxWindow > mUIParent {}
 
EqualizationFilter mParameters
 
EqualizationCurvesList mCurvesList { mParameters }
 
const int mOptions
 
EqualizationUI mUI { *this, *this, mUIParent, GetName(), mCurvesList, mOptions }
 

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 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 EffectBase
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 

Detailed Description

An Effect that modifies volume in different frequency bands.

Performs filtering, using an FFT to do a FIR filter. It lets the user draw an arbitrary envelope (using the same envelope editing code that is used to edit the track's amplitude envelope).

Also allows the curve to be specified with a series of 'graphic EQ' sliders.

The filter is applied using overlap/add of Hann windows.

Clone of the FFT Filter effect, no longer part of Audacity.

Definition at line 22 of file Equalization.h.

Constructor & Destructor Documentation

◆ EffectEqualization()

EffectEqualization::EffectEqualization ( int  Options = kEqLegacy)

Definition at line 94 of file Equalization.cpp.

96 , mOptions{ Options }
97{
98 auto &hiFreq = mParameters.mHiFreq;
99 auto &curves = mCurvesList.mCurves;
100
101 Parameters().Reset(*this);
102
104
105 // Load the EQ curves
106 EQCurveReader{ curves, GetName(), mOptions }.LoadCurves();
107
108 // Note: initial curve is set in TransferDataToWindow
109
110 //double loLog = log10(mLoFreq);
111 //double stepLog = (log10(hiFreq) - loLog)/((double)NUM_PTS-1.);
112
113 // We expect these Hi and Lo frequencies to be overridden by Init().
114 // Don't use inputTracks(). See bug 2321.
115#if 0
116 auto trackList = inputTracks();
117 const auto t = trackList
118 ? *trackList->Any<const WaveTrack>().first
119 : nullptr
120 ;
121 hiFreq =
122 (t
123 ? t->GetRate()
124 : mProjectRate)
125 / 2.0;
126#endif
127 hiFreq = mProjectRate / 2.0;
128}
TranslatableString GetName() const
Deserializer of curves from XML files.
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:214
const TrackList * inputTracks() const
Definition: EffectBase.h:91
double mProjectRate
Definition: EffectBase.h:112
const EffectParameterMethods & Parameters() const override
EqualizationFilter mParameters
Definition: Equalization.h:76
EqualizationCurvesList mCurvesList
Definition: Equalization.h:77
const int mOptions
Definition: Equalization.h:78
const EffectSettingsManager & GetDefinition() const override
Definition: Effect.cpp:189
virtual void Reset(Effect &effect) const =0
A Track that contains audio waveform data.
Definition: WaveTrack.h:220

References ComponentInterface::GetName(), EffectBase::inputTracks(), EqualizationCurvesList::mCurves, mCurvesList, EqualizationFilter::mHiFreq, mOptions, mParameters, EffectBase::mProjectRate, 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:

◆ ~EffectEqualization()

EffectEqualization::~EffectEqualization ( )
virtual

Definition at line 131 of file Equalization.cpp.

132{
133}

Member Function Documentation

◆ DoLoadFactoryDefaults()

OptionalMessage EffectEqualization::DoLoadFactoryDefaults ( EffectSettings settings)

Definition at line 228 of file Equalization.cpp.

229{
232}
static Settings & settings()
Definition: TrackInfo.cpp:83
OptionalMessage LoadFactoryDefaults(EffectSettings &settings) const override
Definition: Effect.cpp:172

References EqualizationParameters::LoadDefaults(), Effect::LoadFactoryDefaults(), mOptions, mParameters, and settings().

Referenced by LoadFactoryDefaults().

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

◆ FetchParameters()

static EqualizationParameters * EffectEqualization::FetchParameters ( EffectEqualization e,
EffectSettings  
)
inlinestatic

Definition at line 26 of file Equalization.h.

27 { return &e.mParameters; }

References mParameters.

◆ GetDescription()

TranslatableString EffectEqualization::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 146 of file Equalization.cpp.

147{
148 return XO("Adjusts the volume levels of particular frequencies");
149}
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetFactoryPresets()

RegistryPaths EffectEqualization::GetFactoryPresets ( ) const
overridevirtual

Report names of factory presets.

Implements EffectSettingsManager.

Definition at line 262 of file Equalization.cpp.

263{
265
266 for (size_t i = 0; i < WXSIZEOF(FactoryPresets); i++)
267 {
268 if ((mOptions == kEqOptionGraphic) && (FactoryPresets[i].bForBoth == false))
269 continue;
270 names.push_back(FactoryPresets[i].name.Translation());
271 }
272
273 return names;
274}
static const struct @23 FactoryPresets[]
const TranslatableString name
const int kEqOptionGraphic
std::vector< RegistryPath > RegistryPaths
Definition: Identifier.h:219
static TranslatableStrings names
Definition: TagsEditor.cpp:153
wxString Translation() const

References FactoryPresets, kEqOptionGraphic, mOptions, name, names, and TranslatableString::Translation().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectEqualization::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 137 of file Equalization.cpp.

138{
141 if( mOptions == kEqOptionCurve )
144}
const int kEqOptionCurve
static const ComponentInterfaceSymbol Symbol
Definition: Equalization.h:87
static const ComponentInterfaceSymbol Symbol
Definition: Equalization.h:95
static const ComponentInterfaceSymbol Symbol
Definition: Equalization.h:28

References kEqOptionCurve, kEqOptionGraphic, mOptions, Symbol, EffectEqualizationCurve::Symbol, and EffectEqualizationGraphic::Symbol.

◆ GetType()

EffectType EffectEqualization::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 163 of file Equalization.cpp.

164{
165 return EffectTypeProcess;
166}
@ EffectTypeProcess

References EffectTypeProcess.

◆ Init()

bool EffectEqualization::Init ( )
overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 313 of file Equalization.cpp.

314{
315 constexpr auto loFreqI = EqualizationFilter::loFreqI;
316
317 const auto &lin = mParameters.mLin;
318 const auto &curveName = mParameters.mCurveName;
319 auto &loFreq = mParameters.mLoFreq;
320 auto &hiFreq = mParameters.mHiFreq;
321
322 int selcount = 0;
323 double rate = 0.0;
324
325 if (const auto project = FindProject()) {
326 auto trackRange =
327 TrackList::Get(*project).Selected<const WaveTrack>();
328 if (trackRange) {
329 rate = (*(trackRange.first++)) -> GetRate();
330 ++selcount;
331
332 for (auto track : trackRange) {
333 if (track->GetRate() != rate) {
335 XO(
336 "To apply Equalization, all selected tracks must have the same sample rate.") );
337 return(false);
338 }
339 ++selcount;
340 }
341 }
342 }
343 else
344 // Editing macro parameters, use this default
345 rate = 44100.0;
346
347 hiFreq = rate / 2.0;
348 // Unlikely, but better than crashing.
349 if (hiFreq <= loFreqI) {
351 XO("Track sample rate is too low for this effect."),
352 wxOK | wxCENTRE,
353 XO("Effect Unavailable") );
354 return(false);
355 }
356
357 loFreq = loFreqI;
358
359 mUI.Init();
360 mUI.setCurve(curveName);
361
363
364 return(true);
365}
const auto project
const AudacityProject * FindProject() const
Definition: EffectBase.cpp:224
EqualizationUI mUI
Definition: Equalization.h:79
static int DoMessageBox(const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
void setCurve(int currentCurve)
static TrackList & Get(AudacityProject &project)
Definition: Track.cpp:354
auto Selected() -> TrackIterRange< TrackType >
Definition: Track.h:1108
double GetRate(const Track &track)
Definition: TimeTrack.cpp:196
static constexpr int loFreqI

References EqualizationFilter::CalcFilter(), EffectUIServices::DoMessageBox(), EffectBase::FindProject(), TrackList::Get(), anonymous_namespace{TimeTrack.cpp}::GetRate(), EqualizationUI::Init(), EqualizationFilter::loFreqI, EqualizationParameters::mCurveName, EqualizationFilter::mHiFreq, EqualizationParameters::mLin, EqualizationFilter::mLoFreq, mParameters, mUI, project, TrackList::Selected(), EqualizationUI::setCurve(), and XO().

Here is the call graph for this function:

◆ LoadFactoryDefaults()

OptionalMessage EffectEqualization::LoadFactoryDefaults ( EffectSettings settings) const
overridevirtual

Change settings back to "factory default"

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 219 of file Equalization.cpp.

220{
221 // To do: externalize state so const_cast isn't needed
222 if (!const_cast<EffectEqualization&>(*this).DoLoadFactoryDefaults(settings))
223 return {};
224 return { nullptr };
225}
An Effect that modifies volume in different frequency bands.
Definition: Equalization.h:23
OptionalMessage DoLoadFactoryDefaults(EffectSettings &settings)

References DoLoadFactoryDefaults(), and settings().

Here is the call graph for this function:

◆ LoadFactoryPreset()

OptionalMessage EffectEqualization::LoadFactoryPreset ( int  id,
EffectSettings settings 
) const
overridevirtual

Change settings to the preset whose name is GetFactoryPresets()[id]

Returns
nullopt for failure

Implements EffectSettingsManager.

Definition at line 277 of file Equalization.cpp.

278{
279 int index = -1;
280 for (size_t i = 0; i < WXSIZEOF(FactoryPresets); i++)
281 {
282 if ((mOptions == kEqOptionGraphic) && (FactoryPresets[i].bForBoth == false))
283 continue;
284 if (id-- == 0) {
285 index = i;
286 break;
287 }
288 }
289 if (index < 0)
290 return {};
291
292 // mParams =
293 wxString params = FactoryPresets[index].values;
294
297 S.SetForWriting( &eap );
298 // To do: externalize state so const_cast isn't needed
299 if (!const_cast<EffectEqualization*>(this)->VisitSettings(S, settings))
300 return {};
301 return { nullptr };
302}
EffectDistortionSettings params
Definition: Distortion.cpp:77
#define S(N)
Definition: ToChars.cpp:64
CommandParameters, derived from wxFileConfig, is essentially doing the same things as the SettingsVis...
bool VisitSettings(SettingsVisitor &visitor, EffectSettings &settings) override
SettingsVisitor that sets parameters to a value (from a string)

References FactoryPresets, kEqOptionGraphic, mOptions, params, S, settings(), and VisitSettings().

Here is the call graph for this function:

◆ ManualPage()

ManualPageID EffectEqualization::ManualPage ( ) const
overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 151 of file Equalization.cpp.

152{
153 // Bug 2509: Must use _ and not space in names.
155 return L"Graphic_EQ";
156 if( mOptions == kEqOptionCurve )
157 return L"Filter_Curve_EQ";
158 return L"Equalization";
159}

References kEqOptionCurve, kEqOptionGraphic, and mOptions.

◆ Parameters()

const EffectParameterMethods & EffectEqualization::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 46 of file Equalization.cpp.

47{
50 // CurveName,
52 // Pretty sure the interpolation name shouldn't have been interpreted when
53 // specified in chains, but must keep it that way for compatibility.
55 > parameters {
57 EqualizationParameters &params, bool updating
58 ){
59 constexpr auto nInterpolations =
61 if (updating) {
62 if (params.mInterp >= nInterpolations)
63 params.mInterp -= nInterpolations;
64 }
65 return true;
66 }
67 };
68 return parameters;
69}
Generates EffectParameterMethods overrides from variadic template arguments.
EffectEqualization(int Options=kEqLegacy)
Externalized state of a plug-in.
Parameters of the Equalization effects that persist in configuration files.
static constexpr EnumParameter InterpMeth
static constexpr EffectParameter FilterLength
static constexpr EffectParameter InterpLin

References EffectEqualization(), EqualizationParameters::FilterLength, EqualizationParameters::InterpLin, EqualizationParameters::InterpMeth, EqualizationParameters::nInterpolations, and params.

Referenced by EffectEqualization().

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

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectEqualization::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 460 of file Equalization.cpp.

463{
464 mUIParent = S.GetParent();
465 return mUI.PopulateOrExchange(S, instance, access, pOutputs);
466}
wxWeakRef< wxWindow > mUIParent
Definition: Equalization.h:75
std::unique_ptr< EffectEditor > PopulateOrExchange(ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)

References mUI, mUIParent, EqualizationUI::PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ Process()

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

Implements StatefulEffectBase.

Definition at line 404 of file Equalization.cpp.

405{
406 EffectOutputTracks outputs { *mTracks, {{ mT0, mT1 }} };
408 bool bGoodResult = true;
409
410 int count = 0;
411 for (auto track : outputs.Get().Selected<WaveTrack>()) {
412 double trackStart = track->GetStartTime();
413 double trackEnd = track->GetEndTime();
414 double t0 = mT0 < trackStart? trackStart: mT0;
415 double t1 = mT1 > trackEnd? trackEnd: mT1;
416
417 if (t1 > t0) {
418 auto start = track->TimeToLongSamples(t0);
419 auto end = track->TimeToLongSamples(t1);
420 auto len = end - start;
421 const auto data = CollectClipData(*track, start, len);
422
423 auto temp = track->WideEmptyCopy();
424 auto pTempTrack = *temp->Any<WaveTrack>().begin();
425 pTempTrack->ConvertToSampleFormat(floatSample);
426 auto iter0 = pTempTrack->Channels().begin();
427
428 for (const auto pChannel : track->Channels()) {
429 constexpr auto windowSize = EqualizationFilter::windowSize;
430 const auto &M = mParameters.mM;
431
432 wxASSERT(M - 1 < windowSize);
433 size_t L = windowSize - (M - 1); //Process L samples at a go
434 auto s = start;
435 auto idealBlockLen = pChannel->GetMaxBlockSize() * 4;
436 if (idealBlockLen % L != 0)
437 idealBlockLen += (L - (idealBlockLen % L));
438 auto pNewChannel = *iter0++;
439 Task task{ M, idealBlockLen, *pNewChannel };
440
441 bGoodResult = ProcessOne(task, count, *pChannel, start, len);
442 if (!bGoodResult)
443 goto done;
444 }
445 pTempTrack->Flush();
446 PasteOverPreservingClips(data, *track, start, len,
447 **temp->Any<WaveTrack>().begin());
448 }
449
450 count++;
451 }
452 done:
453
454 if (bGoodResult)
455 outputs.Commit();
456
457 return bGoodResult;
458}
void PasteOverPreservingClips(const ClipData &data, WaveTrack &oldTrack, sampleCount start, sampleCount len, const WaveTrack &newContents)
Substitute new contents into existing track, preserving clip boundaries.
ClipData CollectClipData(const WaveTrack &oldTrack, sampleCount start, sampleCount len)
Collect clip boundary and name information.
double mT1
Definition: EffectBase.h:116
std::shared_ptr< TrackList > mTracks
Definition: EffectBase.h:109
double mT0
Definition: EffectBase.h:115
bool ProcessOne(Task &task, int count, const WaveChannel &t, sampleCount start, sampleCount len)
Use this object to copy the input tracks to tentative outputTracks.
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:159
auto begin(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:150
static constexpr size_t windowSize

References PackedArray::begin(), EqualizationFilter::CalcFilter(), CollectClipData(), PackedArray::end(), floatSample, EqualizationParameters::mM, mParameters, EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, PasteOverPreservingClips(), ProcessOne(), and EqualizationFilter::windowSize.

Here is the call graph for this function:

◆ ProcessOne()

bool EffectEqualization::ProcessOne ( Task task,
int  count,
const WaveChannel t,
sampleCount  start,
sampleCount  len 
)
private

Definition at line 478 of file Equalization.cpp.

480{
481 constexpr auto windowSize = EqualizationFilter::windowSize;
482
483 const auto &M = mParameters.mM;
484
485 wxASSERT(M - 1 < windowSize);
486 size_t L = windowSize - (M - 1); //Process L samples at a go
487 auto s = start;
488
489 auto &buffer = task.buffer;
490 auto &window1 = task.window1;
491 auto &window2 = task.window2;
492 auto &thisWindow = task.thisWindow;
493 auto &lastWindow = task.lastWindow;
494
495 auto originalLen = len;
496
497 auto &output = task.output;
498
499 TrackProgress(count, 0.);
500 bool bLoopSuccess = true;
501 size_t wcopy = 0;
502
503 while (len != 0)
504 {
505 auto block = limitSampleBufferSize( task.idealBlockLen, len );
506
507 t.GetFloats(buffer.get(), s, block);
508
509 for(size_t i = 0; i < block; i += L) //go through block in lumps of length L
510 {
511 wcopy = std::min <size_t> (L, block - i);
512 for(size_t j = 0; j < wcopy; j++)
513 thisWindow[j] = buffer[i+j]; //copy the L (or remaining) samples
514 for(auto j = wcopy; j < windowSize; j++)
515 thisWindow[j] = 0; //this includes the padding
516
517 mParameters.Filter(windowSize, thisWindow);
518
519 // Overlap - Add
520 for(size_t j = 0; (j < M - 1) && (j < wcopy); j++)
521 buffer[i+j] = thisWindow[j] + lastWindow[L + j];
522 for(size_t j = M - 1; j < wcopy; j++)
523 buffer[i+j] = thisWindow[j];
524
525 std::swap( thisWindow, lastWindow );
526 } //next i, lump of this block
527
528 task.AccumulateSamples((samplePtr)buffer.get(), block);
529 len -= block;
530 s += block;
531
532 if (TrackProgress(count, ( s - start ).as_double() /
533 originalLen.as_double()))
534 {
535 bLoopSuccess = false;
536 break;
537 }
538 }
539
540 if (bLoopSuccess) {
541 // M-1 samples of 'tail' left in lastWindow, get them now
542 if(wcopy < (M - 1)) {
543 // Still have some overlap left to process
544 // (note that lastWindow and thisWindow have been exchanged at this point
545 // so that 'thisWindow' is really the window prior to 'lastWindow')
546 size_t j = 0;
547 for(; j < M - 1 - wcopy; j++)
548 buffer[j] = lastWindow[wcopy + j] + thisWindow[L + wcopy + j];
549 // And fill in the remainder after the overlap
550 for( ; j < M - 1; j++)
551 buffer[j] = lastWindow[wcopy + j];
552 } else {
553 for(size_t j = 0; j < M - 1; j++)
554 buffer[j] = lastWindow[wcopy + j];
555 }
556 task.AccumulateSamples((samplePtr)buffer.get(), M - 1);
557 }
558 return bLoopSuccess;
559}
size_t limitSampleBufferSize(size_t bufferSize, sampleCount limit)
Definition: SampleCount.cpp:22
char * samplePtr
Definition: SampleFormat.h:55
bool TrackProgress(int whichTrack, double frac, const TranslatableString &={}) const
Definition: Effect.cpp:349
bool GetFloats(float *buffer, sampleCount start, size_t len, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
"narrow" overload fetches from the unique channel
Definition: WaveTrack.h:152
void swap(std::unique_ptr< Alg_seq > &a, std::unique_ptr< Alg_seq > &b)
Definition: NoteTrack.cpp:770
void Filter(size_t len, float *buffer) const

References EffectEqualization::Task::AccumulateSamples(), EffectEqualization::Task::buffer, EqualizationFilter::Filter(), WaveChannel::GetFloats(), EffectEqualization::Task::idealBlockLen, EffectEqualization::Task::lastWindow, limitSampleBufferSize(), EqualizationParameters::mM, mParameters, EffectEqualization::Task::output, anonymous_namespace{NoteTrack.cpp}::swap(), EffectEqualization::Task::thisWindow, Effect::TrackProgress(), EffectEqualization::Task::window1, EffectEqualization::Task::window2, and EqualizationFilter::windowSize.

Referenced by Process().

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

◆ TransferDataToWindow()

bool EffectEqualization::TransferDataToWindow ( const EffectSettings settings)
overridevirtual

Update controls for the settings; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 471 of file Equalization.cpp.

472{
474}
bool TransferDataToWindow(const EffectSettings &settings)

References mUI, settings(), and EqualizationUI::TransferDataToWindow().

Here is the call graph for this function:

◆ ValidateUI()

bool EffectEqualization::ValidateUI ( const EffectPlugin plugin,
EffectSettings settings 
) const
overridevirtual

Reimplemented from BasicEffectUIServices.

Definition at line 304 of file Equalization.cpp.

306{
307 // Stateful effect still cheats const_cast!
308 return const_cast<EffectEqualization&>(*this).mUI.ValidateUI(settings);
309}
bool ValidateUI(EffectSettings &settings)

References mUI, settings(), and EqualizationUI::ValidateUI().

Here is the call graph for this function:

◆ VisitSettings() [1/2]

bool EffectEqualization::VisitSettings ( ConstSettingsVisitor visitor,
const EffectSettings settings 
) const
overridevirtual

Visit settings (read-only), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 168 of file Equalization.cpp.

170{
171 const auto &curves = mCurvesList.mCurves;
173
174 // Curve point parameters -- how many isn't known statically
175 if( dynamic_cast<ShuttleGetAutomation*>(&visitor)) {
176 int numPoints = curves[ 0 ].points.size();
177 int point;
178 for( point = 0; point < numPoints; point++ )
179 {
180 const wxString nameFreq = wxString::Format("f%i",point);
181 const wxString nameVal = wxString::Format("v%i",point);
182 visitor.Define( curves[ 0 ].points[ point ].Freq, nameFreq,
183 0.0, 0.0, 0.0, 0.0 );
184 visitor.Define( curves[ 0 ].points[ point ].dB, nameVal,
185 0.0, 0.0, 0.0, 0.0 );
186 }
187 }
188 return true;
189}
bool VisitSettings(SettingsVisitor &visitor, EffectSettings &settings) override
Definition: Effect.cpp:109
virtual void Define(Arg< bool > var, const wxChar *key, bool vdefault, bool vmin=false, bool vmax=false, bool vscl=false)
SettingsVisitor that gets parameter values into a string.

References SettingsVisitorBase< Const >::Define(), EqualizationCurvesList::mCurves, mCurvesList, settings(), and Effect::VisitSettings().

Here is the call graph for this function:

◆ VisitSettings() [2/2]

bool EffectEqualization::VisitSettings ( SettingsVisitor visitor,
EffectSettings settings 
)
overridevirtual

Visit settings (and maybe change them), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 191 of file Equalization.cpp.

193{
194 auto &curves = mCurvesList.mCurves;
196
197 // Curve point parameters -- how many isn't known statically
198 {
199 curves[0].points.clear();
200
201 for (int i = 0; i < 200; i++)
202 {
203 const wxString nameFreq = wxString::Format("f%i",i);
204 const wxString nameVal = wxString::Format("v%i",i);
205 double f = -1000.0;
206 double d = 0.0;
207 visitor.Define( f, nameFreq, 0.0, -10000.0, 1000000.0, 0.0 );
208 visitor.Define( d, nameVal, 0.0, -10000.0, 10000.0, 0.0 );
209 if( f <= 0.0 )
210 break;
211 curves[0].points.push_back( EQPoint( f,d ));
212 }
213 mUI.setCurve( 0 );
214 }
215 return true;
216}
One point in a curve.

References SettingsVisitorBase< Const >::Define(), EqualizationCurvesList::mCurves, mCurvesList, mUI, EqualizationUI::setCurve(), settings(), and Effect::VisitSettings().

Referenced by LoadFactoryPreset().

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

Member Data Documentation

◆ mCurvesList

EqualizationCurvesList EffectEqualization::mCurvesList { mParameters }
private

Definition at line 77 of file Equalization.h.

Referenced by EffectEqualization(), and VisitSettings().

◆ mOptions

const int EffectEqualization::mOptions
private

◆ mParameters

EqualizationFilter EffectEqualization::mParameters
private

◆ mUI

EqualizationUI EffectEqualization::mUI { *this, *this, mUIParent, GetName(), mCurvesList, mOptions }
private

◆ mUIParent

wxWeakRef<wxWindow> EffectEqualization::mUIParent {}
private

Definition at line 75 of file Equalization.h.

Referenced by PopulateOrExchange().

◆ Symbol

const ComponentInterfaceSymbol EffectEqualization::Symbol { XO("Equalization") }
static

Definition at line 28 of file Equalization.h.

Referenced by GetSymbol().


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