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

#include <Equalization.h>

Inheritance diagram for EffectEqualization:

Collaboration diagram for EffectEqualization:

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< EffectEditor >	PopulateOrExchange (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< EffectInstance >	MakeInstance () 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 EffectParameterMethods &	Parameters () const

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () 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)
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

void	SetTracks (TrackList *pTracks)

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (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 EffectSettingsManager &	GetDefinition () const =0

virtual void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
	Calculate temporary tracks of limited length with effect applied and play. More...

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< EffectInstance >	MakeInstance () 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< EffectOutputs >	MakeOutputs () 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< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...

virtual std::unique_ptr< EffectEditor >	PopulateOrExchange (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 (EffectPlugin &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< EffectEditor >	PopulateUI (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 EqualizationParameters *	FetchParameters (EffectEqualization &e, EffectSettings &)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (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 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 (int count, WaveTrack *t, sampleCount start, sampleCount len)

const EffectParameterMethods &	Parameters () const override

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}

EqualizationFilter	mParameters

EqualizationCurvesList	mCurvesList { mParameters }

const int	mOptions

EqualizationUI	mUI { *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
TrackList *	mTracks {}

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, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

Protected Member Functions inherited from EffectBase
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
	Calculate temporary tracks of limited length with effect applied and play. 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 TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 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 20 of file Equalization.h.

Constructor & Destructor Documentation

◆ EffectEqualization()

EffectEqualization::EffectEqualization ( int Options = kEqLegacy )

Definition at line 93 of file Equalization.cpp.

   : mParameters{ GetDefinition() }
   , mOptions{ Options }
{
   auto &hiFreq = mParameters.mHiFreq;
   auto &curves = mCurvesList.mCurves;
 
   Parameters().Reset(*this);
 
   SetLinearEffectFlag(true);
 
   // Load the EQ curves
   EQCurveReader{ curves, GetName(), mOptions }.LoadCurves();
 
   // Note: initial curve is set in TransferDataToWindow
 
   //double loLog = log10(mLoFreq);
   //double stepLog = (log10(hiFreq) - loLog)/((double)NUM_PTS-1.);
 
   // We expect these Hi and Lo frequencies to be overridden by Init().
   // Don't use inputTracks().  See bug 2321.
#if 0
   auto trackList = inputTracks();
   const auto t = trackList
      ? *trackList->Any< const WaveTrack >().first
      : nullptr
   ;
   hiFreq =
      (t
         ? t->GetRate()
         : mProjectRate)
      / 2.0;
#endif
   hiFreq = mProjectRate / 2.0;
}

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 130 of file Equalization.cpp.

131{

132}

Member Function Documentation

◆ DoLoadFactoryDefaults()

OptionalMessage EffectEqualization::DoLoadFactoryDefaults ( EffectSettings & settings )

Definition at line 227 of file Equalization.cpp.

{
   mParameters.LoadDefaults(mOptions);
   return Effect::LoadFactoryDefaults(settings);
}

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 24 of file Equalization.h.

25 { return &e.mParameters; }

References mParameters.

◆ GetDescription()

TranslatableString EffectEqualization::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 145 of file Equalization.cpp.

{
   return XO("Adjusts the volume levels of particular frequencies");
}

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 261 of file Equalization.cpp.

{
   RegistryPaths names;
 
   for (size_t i = 0; i < WXSIZEOF(FactoryPresets); i++)
   {
      if ((mOptions == kEqOptionGraphic) && (FactoryPresets[i].bForBoth == false))
         continue;
      names.push_back(FactoryPresets[i].name.Translation());
   }
 
   return names;
}

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 136 of file Equalization.cpp.

{
   if( mOptions == kEqOptionGraphic )
      return EffectEqualizationGraphic::Symbol;
   if( mOptions == kEqOptionCurve )
      return EffectEqualizationCurve::Symbol;
   return EffectEqualization::Symbol;
}

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 162 of file Equalization.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ Init()

bool EffectEqualization::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 312 of file Equalization.cpp.

{
   constexpr auto loFreqI = EqualizationFilter::loFreqI;
 
   const auto &lin = mParameters.mLin;
   const auto &curveName = mParameters.mCurveName;
   auto &loFreq = mParameters.mLoFreq;
   auto &hiFreq = mParameters.mHiFreq;
 
   int selcount = 0;
   double rate = 0.0;
 
   if (const auto project = FindProject()) {
      auto trackRange = TrackList::Get(*project).Selected<const WaveTrack>();
      if (trackRange) {
         rate = (*(trackRange.first++)) -> GetRate();
         ++selcount;
 
         for (auto track : trackRange) {
            if (track->GetRate() != rate) {
               EffectUIServices::DoMessageBox(*this,
                  XO(
   "To apply Equalization, all selected tracks must have the same sample rate.") );
               return(false);
            }
            ++selcount;
         }
      }
   }
   else
      // Editing macro parameters, use this default
      rate = 44100.0;
 
   hiFreq = rate / 2.0;
   // Unlikely, but better than crashing.
   if (hiFreq <= loFreqI) {
      EffectUIServices::DoMessageBox(*this,
         XO("Track sample rate is too low for this effect."),
         wxOK | wxCENTRE,
         XO("Effect Unavailable") );
      return(false);
   }
 
   loFreq = loFreqI;
 
   mUI.Init();
   mUI.setCurve(curveName);
 
   mParameters.CalcFilter();
 
   return(true);
}

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, 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 218 of file Equalization.cpp.

{
   // To do: externalize state so const_cast isn't needed
   if (!const_cast<EffectEqualization&>(*this).DoLoadFactoryDefaults(settings))
      return {};
   return { nullptr };
}

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 276 of file Equalization.cpp.

{
   int index = -1;
   for (size_t i = 0; i < WXSIZEOF(FactoryPresets); i++)
   {
      if ((mOptions == kEqOptionGraphic) && (FactoryPresets[i].bForBoth == false))
         continue;
      if (id-- == 0) {
         index = i;
         break;
      }
   }
   if (index < 0)
      return {};
 
   // mParams = 
   wxString params = FactoryPresets[index].values;
 
   CommandParameters eap(params);
   ShuttleSetAutomation S;
   S.SetForWriting( &eap );
   // To do: externalize state so const_cast isn't needed
   if (!const_cast<EffectEqualization*>(this)->VisitSettings(S, settings))
      return {};
   return { nullptr };
}

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 150 of file Equalization.cpp.

{
   // Bug 2509: Must use _ and not space in names.
   if( mOptions == kEqOptionGraphic )
      return L"Graphic_EQ";
   if( mOptions == kEqOptionCurve )
      return L"Filter_Curve_EQ";
   return L"Equalization";
}

References kEqOptionCurve, kEqOptionGraphic, and mOptions.

◆ Parameters()

const EffectParameterMethods & EffectEqualization::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 45 of file Equalization.cpp.

{
   static CapturedParameters<EffectEqualization,
      EqualizationParameters::FilterLength,
      // CurveName,
      EqualizationParameters::InterpLin,
      // Pretty sure the interpolation name shouldn't have been interpreted when
      // specified in chains, but must keep it that way for compatibility.
      EqualizationParameters::InterpMeth
   > parameters {
      [](EffectEqualization &effect, EffectSettings &,
         EqualizationParameters &params, bool updating
      ){
         constexpr auto nInterpolations =
            EqualizationParameters::nInterpolations;
         if (updating) {
            if (params.mInterp >= nInterpolations)
               params.mInterp -= nInterpolations;
         }
         return true;
      }
   };
   return parameters;
}

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 397 of file Equalization.cpp.

{
   mUIParent = S.GetParent();
   return mUI.PopulateOrExchange(S, instance, access, 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 365 of file Equalization.cpp.

{
   this->CopyInputTracks(); // Set up mOutputTracks.
   mParameters.CalcFilter();
   bool bGoodResult = true;
 
   int count = 0;
   for( auto track : mOutputTracks->Selected< WaveTrack >() ) {
      double trackStart = track->GetStartTime();
      double trackEnd = track->GetEndTime();
      double t0 = mT0 < trackStart? trackStart: mT0;
      double t1 = mT1 > trackEnd? trackEnd: mT1;
 
      if (t1 > t0) {
         auto start = track->TimeToLongSamples(t0);
         auto end = track->TimeToLongSamples(t1);
         auto len = end - start;
 
         if (!ProcessOne(count, track, start, len))
         {
            bGoodResult = false;
            break;
         }
      }
 
      count++;
   }
 
   this->ReplaceProcessedTracks(bGoodResult);
   return bGoodResult;
}

References EqualizationFilter::CalcFilter(), Effect::CopyInputTracks(), PackedArray::end(), EffectBase::mOutputTracks, mParameters, EffectBase::mT0, EffectBase::mT1, ProcessOne(), and EffectBase::ReplaceProcessedTracks().

Here is the call graph for this function:

◆ ProcessOne()

bool EffectEqualization::ProcessOne	(	int	count,
		WaveTrack *	t,
		sampleCount	start,
		sampleCount	len
	)

private

Definition at line 452 of file Equalization.cpp.

{
   constexpr auto windowSize = EqualizationFilter::windowSize;
 
   const auto &M = mParameters.mM;
 
   wxASSERT(M - 1 < windowSize);
   size_t L = windowSize - (M - 1);   //Process L samples at a go
   auto s = start;
   auto idealBlockLen = t->GetMaxBlockSize() * 4;
   if (idealBlockLen % L != 0)
      idealBlockLen += (L - (idealBlockLen % L));
 
   EqualizationTask task{ M, idealBlockLen, *t };
   auto &buffer = task.buffer;
   auto &window1 = task.window1;
   auto &window2 = task.window2;
   auto &thisWindow = task.thisWindow;
   auto &lastWindow = task.lastWindow;
 
   auto originalLen = len;
 
   auto &output = task.output;
   t->ConvertToSampleFormat( floatSample );
 
   TrackProgress(count, 0.);
   bool bLoopSuccess = true;
   size_t wcopy = 0;
 
   while (len != 0)
   {
      auto block = limitSampleBufferSize( idealBlockLen, len );
 
      t->GetFloats(buffer.get(), s, block);
 
      for(size_t i = 0; i < block; i += L)   //go through block in lumps of length L
      {
         wcopy = std::min <size_t> (L, block - i);
         for(size_t j = 0; j < wcopy; j++)
            thisWindow[j] = buffer[i+j];   //copy the L (or remaining) samples
         for(auto j = wcopy; j < windowSize; j++)
            thisWindow[j] = 0;   //this includes the padding
 
         mParameters.Filter(windowSize, thisWindow);
 
         // Overlap - Add
         for(size_t j = 0; (j < M - 1) && (j < wcopy); j++)
            buffer[i+j] = thisWindow[j] + lastWindow[L + j];
         for(size_t j = M - 1; j < wcopy; j++)
            buffer[i+j] = thisWindow[j];
 
         std::swap( thisWindow, lastWindow );
      }  //next i, lump of this block
 
      task.AccumulateSamples((samplePtr)buffer.get(), block);
      len -= block;
      s += block;
 
      if (TrackProgress(count, ( s - start ).as_double() /
                        originalLen.as_double()))
      {
         bLoopSuccess = false;
         break;
      }
   }
 
   if(bLoopSuccess)
   {
      // M-1 samples of 'tail' left in lastWindow, get them now
      if(wcopy < (M - 1)) {
         // Still have some overlap left to process
         // (note that lastWindow and thisWindow have been exchanged at this point
         //  so that 'thisWindow' is really the window prior to 'lastWindow')
         size_t j = 0;
         for(; j < M - 1 - wcopy; j++)
            buffer[j] = lastWindow[wcopy + j] + thisWindow[L + wcopy + j];
         // And fill in the remainder after the overlap
         for( ; j < M - 1; j++)
            buffer[j] = lastWindow[wcopy + j];
      } else {
         for(size_t j = 0; j < M - 1; j++)
            buffer[j] = lastWindow[wcopy + j];
      }
      task.AccumulateSamples((samplePtr)buffer.get(), M - 1);
      output->Flush();
   }
 
   if (bLoopSuccess)
      PasteOverPreservingClips(*t, start, originalLen, *output);
 
   return bLoopSuccess;
}

References WaveTrack::ConvertToSampleFormat(), EqualizationFilter::Filter(), floatSample, SampleTrack::GetFloats(), WaveTrack::GetMaxBlockSize(), limitSampleBufferSize(), EqualizationParameters::mM, mParameters, PasteOverPreservingClips(), anonymous_namespace{NoteTrack.cpp}::swap(), Effect::TrackProgress(), 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 408 of file Equalization.cpp.

{
   return mUI.TransferDataToWindow(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 303 of file Equalization.cpp.

{
   // Stateful effect still cheats const_cast!
   return const_cast<EffectEqualization&>(*this).mUI.ValidateUI(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 167 of file Equalization.cpp.

{
   const auto &curves = mCurvesList.mCurves;
   Effect::VisitSettings(visitor, settings);
 
   // Curve point parameters -- how many isn't known statically
   if( dynamic_cast<ShuttleGetAutomation*>(&visitor)) {
      int numPoints = curves[ 0 ].points.size();
      int point;
      for( point = 0; point < numPoints; point++ )
      {
         const wxString nameFreq = wxString::Format("f%i",point);
         const wxString nameVal = wxString::Format("v%i",point);
         visitor.Define( curves[ 0 ].points[ point ].Freq, nameFreq,
            0.0, 0.0, 0.0, 0.0 );
         visitor.Define( curves[ 0 ].points[ point ].dB, nameVal,
            0.0, 0.0, 0.0, 0.0 );
      }
   }
   return true;
}

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 190 of file Equalization.cpp.

{
   auto &curves = mCurvesList.mCurves;
   Effect::VisitSettings(visitor, settings);
 
   // Curve point parameters -- how many isn't known statically
   {
      curves[0].points.clear();
   
      for (int i = 0; i < 200; i++)
      {
         const wxString nameFreq = wxString::Format("f%i",i);
         const wxString nameVal = wxString::Format("v%i",i);
         double f = -1000.0;
         double d = 0.0;
         visitor.Define( f, nameFreq, 0.0,  -10000.0, 1000000.0, 0.0 );
         visitor.Define( d, nameVal,  0.0, -10000.0, 10000.0, 0.0 );
         if( f <= 0.0 )
            break;
         curves[0].points.push_back( EQPoint( f,d ));
      }
      mUI.setCurve( 0 );
   }
   return true;
}

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 74 of file Equalization.h.

Referenced by EffectEqualization(), and VisitSettings().

◆ mOptions

const int EffectEqualization::mOptions

private

Definition at line 75 of file Equalization.h.

Referenced by DoLoadFactoryDefaults(), EffectEqualization(), GetFactoryPresets(), GetSymbol(), LoadFactoryPreset(), and ManualPage().

◆ mParameters

EqualizationFilter EffectEqualization::mParameters

private

Definition at line 73 of file Equalization.h.

Referenced by DoLoadFactoryDefaults(), EffectEqualization(), FetchParameters(), Init(), Process(), and ProcessOne().

◆ mUI

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

private

Definition at line 76 of file Equalization.h.

Referenced by Init(), PopulateOrExchange(), TransferDataToWindow(), ValidateUI(), and VisitSettings().

◆ mUIParent

wxWeakRef<wxWindow> EffectEqualization::mUIParent {}

private

Definition at line 72 of file Equalization.h.

Referenced by PopulateOrExchange().

◆ Symbol

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

static

Definition at line 26 of file Equalization.h.

Referenced by GetSymbol().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectEqualization()

◆ ~EffectEqualization()

Member Function Documentation

◆ DoLoadFactoryDefaults()

◆ FetchParameters()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetSymbol()

◆ GetType()

◆ Init()

◆ LoadFactoryDefaults()

◆ LoadFactoryPreset()

◆ ManualPage()

◆ Parameters()

◆ PopulateOrExchange()

◆ Process()

◆ ProcessOne()

◆ TransferDataToWindow()

◆ ValidateUI()

◆ VisitSettings() [1/2]

◆ VisitSettings() [2/2]

Member Data Documentation

◆ mCurvesList

◆ mOptions

◆ mParameters

◆ mUI

◆ mUIParent

◆ Symbol