An Effect that applies 'classical' IIR filters. More...

#include <ScienFilter.h>

Inheritance diagram for EffectScienFilter:

Collaboration diagram for EffectScienFilter:

Public Member Functions
	EffectScienFilter ()

virtual	~EffectScienFilter ()

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...

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...

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override

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::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

bool	TransferDataFromWindow (EffectSettings &settings) override

Public Member Functions inherited from StatefulPerTrackEffect
	~StatefulPerTrackEffect () override

std::shared_ptr< EffectInstance >	MakeInstance () 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

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, 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	ReplaceProcessedTracks (const bool bGoodResult)

void	CountWaveTracks ()

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 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 (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< 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 EffectScienFilter *	FetchParameters (EffectScienFilter &e, EffectSettings &)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

static void	IncEffectCounter ()

Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (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("Classic Filters") }

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 Types
enum	kSubTypes { kLowPass = Biquad::kLowPass , kHighPass = Biquad::kHighPass , nSubTypes = Biquad::nSubTypes }

enum	kTypes { kButterworth , kChebyshevTypeI , kChebyshevTypeII , nTypes }

Private Member Functions
bool	TransferGraphLimitsFromWindow ()

void	CalcFilter ()

float	FilterMagnAtFreq (float Freq)

void	EnableDisableRippleCtl (int FilterType)

void	OnSize (wxSizeEvent &evt)

void	OnSlider (wxCommandEvent &evt)

void	OnOrder (wxCommandEvent &evt)

void	OnCutoff (wxCommandEvent &evt)

void	OnRipple (wxCommandEvent &evt)

void	OnStopbandRipple (wxCommandEvent &evt)

void	OnFilterType (wxCommandEvent &evt)

void	OnFilterSubtype (wxCommandEvent &evt)

void	OnSliderDBMAX (wxCommandEvent &evt)

void	OnSliderDBMIN (wxCommandEvent &evt)

const EffectParameterMethods &	Parameters () const override

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}

float	mCutoff

float	mRipple

float	mStopbandRipple

int	mFilterType

int	mFilterSubtype

int	mOrder

int	mOrderIndex

ArrayOf< Biquad >	mpBiquad

double	mdBMax

double	mdBMin

bool	mEditingBatchParams

double	mLoFreq

double	mNyquist

EffectScienFilterPanel *	mPanel

wxSlider *	mdBMinSlider

wxSlider *	mdBMaxSlider

wxStaticText *	mRippleCtlP

wxTextCtrl *	mRippleCtl

wxStaticText *	mRippleCtlU

wxTextCtrl *	mCutoffCtl

wxStaticText *	mStopbandRippleCtlP

wxTextCtrl *	mStopbandRippleCtl

wxStaticText *	mStopbandRippleCtlU

wxChoice *	mFilterTypeCtl

wxChoice *	mFilterSubTypeCtl

wxChoice *	mFilterOrderCtl

RulerPanel *	mdBRuler

RulerPanel *	mfreqRuler

Static Private Attributes
static const EnumValueSymbol	kSubTypeStrings [nSubTypes]

static const EnumValueSymbol	kTypeStrings [nTypes]

static constexpr EnumParameter	Type

static constexpr EnumParameter	Subtype

static constexpr EffectParameter	Order

static constexpr EffectParameter	Cutoff

static constexpr EffectParameter	Passband

static constexpr EffectParameter	Stopband

Friends
class	EffectScienFilterPanel

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 {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

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

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 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 TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

Protected Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mOutputTracks

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

An Effect that applies 'classical' IIR filters.

Performs IIR filtering that emulates analog filters, specifically Butterworth, Chebyshev Type I and Type II. Highpass and lowpass filters are supported, as are filter orders from 1 to 10.

The filter is applied using biquads

Definition at line 35 of file ScienFilter.h.

Member Enumeration Documentation

◆ kSubTypes

enum EffectScienFilter::kSubTypes

private

Enumerator
kLowPass
kHighPass
nSubTypes

Definition at line 137 of file ScienFilter.h.

   {
      kLowPass  = Biquad::kLowPass,
      kHighPass = Biquad::kHighPass,
      nSubTypes = Biquad::nSubTypes
   };

◆ kTypes

enum EffectScienFilter::kTypes

private

Enumerator
kButterworth
kChebyshevTypeI
kChebyshevTypeII
nTypes

Definition at line 145 of file ScienFilter.h.

   {
      kButterworth,
      kChebyshevTypeI,
      kChebyshevTypeII,
      nTypes
   };

Constructor & Destructor Documentation

◆ EffectScienFilter()

EffectScienFilter::EffectScienFilter ( )

Definition at line 146 of file ScienFilter.cpp.

{
   Parameters().Reset(*this);
   SetLinearEffectFlag(true);
 
   mOrderIndex = mOrder - 1;
 
   mdBMin = -30.0;
   mdBMax = 30.0;
 
   mLoFreq = 20;              // Lowest frequency to display in response graph
   mNyquist = 44100.0 / 2.0;  // only used during initialization, updated when effect is used
}

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectScienFilter()

EffectScienFilter::~EffectScienFilter ( )

virtual

Definition at line 160 of file ScienFilter.cpp.

161{

162}

Member Function Documentation

◆ CalcFilter()

void EffectScienFilter::CalcFilter ( )

private

Definition at line 522 of file ScienFilter.cpp.

{
   switch (mFilterType)
   {
   case kButterworth:
      mpBiquad = Biquad::CalcButterworthFilter(mOrder, mNyquist, mCutoff, mFilterSubtype);
      break;
   case kChebyshevTypeI:
      mpBiquad = Biquad::CalcChebyshevType1Filter(mOrder, mNyquist, mCutoff, mRipple, mFilterSubtype);
      break;
   case kChebyshevTypeII:
      mpBiquad = Biquad::CalcChebyshevType2Filter(mOrder, mNyquist, mCutoff, mStopbandRipple, mFilterSubtype);
      break;
   }
}

References Biquad::CalcButterworthFilter(), Biquad::CalcChebyshevType1Filter(), Biquad::CalcChebyshevType2Filter(), kButterworth, kChebyshevTypeI, kChebyshevTypeII, mCutoff, mFilterSubtype, mFilterType, mNyquist, mOrder, mpBiquad, mRipple, and mStopbandRipple.

Referenced by TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableDisableRippleCtl()

void EffectScienFilter::EnableDisableRippleCtl ( int FilterType )

private

Definition at line 679 of file ScienFilter.cpp.

{
   bool ripple;
   bool stop;
 
   if (FilterType == kButterworth)    // Butterworth
   {
      ripple = false;
      stop = false;
   }
   else if (FilterType == kChebyshevTypeI)    // Chebyshev Type1
   {
      ripple = true;
      stop = false;
   }
   else                        // Chebyshev Type2
   {
      ripple = false;
      stop = true;
   }
 
   mRippleCtlP->Enable(ripple);
   mRippleCtl->Enable(ripple);
   mRippleCtlU->Enable(ripple);
   mStopbandRippleCtlP->Enable(stop);
   mStopbandRippleCtl->Enable(stop);
   mStopbandRippleCtlU->Enable(stop);
}

References kButterworth, kChebyshevTypeI, mRippleCtl, mRippleCtlP, mRippleCtlU, mStopbandRippleCtl, mStopbandRippleCtlP, and mStopbandRippleCtlU.

Referenced by OnFilterType(), and TransferDataToWindow().

Here is the caller graph for this function:

◆ FetchParameters()

static EffectScienFilter * EffectScienFilter::FetchParameters	(	EffectScienFilter &	e,
		EffectSettings &
	)

inlinestatic

Definition at line 39 of file ScienFilter.h.

39{ return &e; }

◆ FilterMagnAtFreq()

float EffectScienFilter::FilterMagnAtFreq ( float Freq )

private

Definition at line 538 of file ScienFilter.cpp.

{
   float Magn;
   if (Freq >= mNyquist)
      Freq = mNyquist - 1; // prevent tan(PI/2)
   float FreqWarped = tan (PI * Freq/(2*mNyquist));
   if (mCutoff >= mNyquist)
      mCutoff = mNyquist - 1;
   float CutoffWarped = tan (PI * mCutoff/(2*mNyquist));
   float fOverflowThresh = pow (10.0, 12.0 / (2*mOrder));    // once we exceed 10^12 there's not much to be gained and overflow could happen
 
   switch (mFilterType)
   {
   case kButterworth:      // Butterworth
   default:
      switch (mFilterSubtype)
      {
      case kLowPass: // lowpass
      default:
         if (FreqWarped/CutoffWarped > fOverflowThresh)  // prevent pow() overflow
            Magn = 0;
         else
            Magn = sqrt (1 / (1 + pow (FreqWarped/CutoffWarped, 2*mOrder)));
         break;
      case kHighPass:   // highpass
         if (FreqWarped/CutoffWarped > fOverflowThresh)
            Magn = 1;
         else
            Magn = sqrt (pow (FreqWarped/CutoffWarped, 2*mOrder) / (1 + pow (FreqWarped/CutoffWarped, 2*mOrder)));
         break;
      }
      break;
 
   case kChebyshevTypeI:     // Chebyshev Type 1
      double eps; eps = sqrt(pow (10.0, wxMax(0.001, mRipple)/10.0) - 1);
      double chebyPolyVal;
      switch (mFilterSubtype)
      {
      case 0:  // lowpass
      default:
         chebyPolyVal = Biquad::ChebyPoly(mOrder, FreqWarped/CutoffWarped);
         Magn = sqrt (1 / (1 + square(eps) * square(chebyPolyVal)));
         break;
      case 1:
         chebyPolyVal = Biquad::ChebyPoly(mOrder, CutoffWarped/FreqWarped);
         Magn = sqrt (1 / (1 + square(eps) * square(chebyPolyVal)));
         break;
      }
      break;
 
   case kChebyshevTypeII:     // Chebyshev Type 2
      eps = 1 / sqrt(pow (10.0, wxMax(0.001, mStopbandRipple)/10.0) - 1);
      switch (mFilterSubtype)
      {
      case kLowPass: // lowpass
      default:
         chebyPolyVal = Biquad::ChebyPoly(mOrder, CutoffWarped/FreqWarped);
         Magn = sqrt (1 / (1 + 1 / (square(eps) * square(chebyPolyVal))));
         break;
      case kHighPass:
         chebyPolyVal = Biquad::ChebyPoly(mOrder, FreqWarped/CutoffWarped);
         Magn = sqrt (1 / (1 + 1 / (square(eps) * square(chebyPolyVal))));
         break;
      }
      break;
   }
 
   return Magn;
}

References Biquad::ChebyPoly(), kButterworth, kChebyshevTypeI, kChebyshevTypeII, kHighPass, kLowPass, mCutoff, mFilterSubtype, mFilterType, mNyquist, mOrder, mRipple, mStopbandRipple, PI, staffpad::audio::simd::sqrt(), and square.

Referenced by EffectScienFilterPanel::OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioInCount()

unsigned EffectScienFilter::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 190 of file ScienFilter.cpp.

{
   return 1;
}

◆ GetAudioOutCount()

unsigned EffectScienFilter::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 195 of file ScienFilter.cpp.

{
   return 1;
}

◆ GetDescription()

TranslatableString EffectScienFilter::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 171 of file ScienFilter.cpp.

{
   /* i18n-hint: "infinite impulse response" */
   return XO("Performs IIR filtering that emulates analog filters");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectScienFilter::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 166 of file ScienFilter.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType EffectScienFilter::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 185 of file ScienFilter.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ Init()

bool EffectScienFilter::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 223 of file ScienFilter.cpp.

{
   int selcount = 0;
   double rate = 0.0;
 
   auto trackRange = inputTracks()->Selected< const WaveTrack >();
 
   {
      auto t = *trackRange.begin();
      mNyquist =
         (t
            ? t->GetRate()
            : mProjectRate)
         / 2.0;
   }
 
   for (auto t : trackRange)
   {
      if (selcount == 0)
      {
         rate = t->GetRate();
      }
      else
      {
         if (t->GetRate() != rate)
         {
            EffectUIServices::DoMessageBox(*this,
               XO(
"To apply a filter, all selected tracks must have the same sample rate.") );
            return false;
         }
      }
      selcount++;
   }
 
   return true;
}

References EffectUIServices::DoMessageBox(), EffectBase::inputTracks(), mNyquist, EffectBase::mProjectRate, TrackList::Selected(), and XO().

Here is the call graph for this function:

◆ ManualPage()

ManualPageID EffectScienFilter::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 177 of file ScienFilter.cpp.

{
   return L"Classic_Filters";
}

◆ OnCutoff()

void EffectScienFilter::OnCutoff ( wxCommandEvent & evt )

private

Definition at line 628 of file ScienFilter.cpp.

{
   if (!EffectEditor::EnableApply(
      mUIParent, mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mPanel->Refresh(false);
}

References EffectEditor::EnableApply(), mPanel, and mUIParent.

Here is the call graph for this function:

◆ OnFilterSubtype()

void EffectScienFilter::OnFilterSubtype ( wxCommandEvent & evt )

private

Definition at line 622 of file ScienFilter.cpp.

{
   mFilterSubtype = mFilterSubTypeCtl->GetSelection();
   mPanel->Refresh(false);
}

References mFilterSubtype, mFilterSubTypeCtl, and mPanel.

◆ OnFilterType()

void EffectScienFilter::OnFilterType ( wxCommandEvent & evt )

private

Definition at line 615 of file ScienFilter.cpp.

{
   mFilterType = mFilterTypeCtl->GetSelection();
   EnableDisableRippleCtl(mFilterType);
   mPanel->Refresh(false);
}

References EnableDisableRippleCtl(), mFilterType, mFilterTypeCtl, and mPanel.

Here is the call graph for this function:

◆ OnOrder()

void EffectScienFilter::OnOrder ( wxCommandEvent & evt )

private

Definition at line 608 of file ScienFilter.cpp.

{
   mOrderIndex = mFilterOrderCtl->GetSelection();
   mOrder = mOrderIndex + 1;  // 0..n-1 -> 1..n
   mPanel->Refresh(false);
}

References mFilterOrderCtl, mOrder, mOrderIndex, and mPanel.

◆ OnRipple()

void EffectScienFilter::OnRipple ( wxCommandEvent & evt )

private

Definition at line 639 of file ScienFilter.cpp.

{
   if (!EffectEditor::EnableApply(
      mUIParent, mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mPanel->Refresh(false);
}

References EffectEditor::EnableApply(), mPanel, and mUIParent.

Here is the call graph for this function:

◆ OnSize()

void EffectScienFilter::OnSize ( wxSizeEvent & evt )

private

Definition at line 671 of file ScienFilter.cpp.

{
   // On Windows the Passband and Stopband boxes do not refresh properly
   // on a resize...no idea why.
   mUIParent->Refresh();
   evt.Skip();
}

References mUIParent.

◆ OnSlider()

void EffectScienFilter::OnSlider ( wxCommandEvent & evt )

private

◆ OnSliderDBMAX()

void EffectScienFilter::OnSliderDBMAX ( wxCommandEvent & evt )

private

Definition at line 666 of file ScienFilter.cpp.

{
   TransferGraphLimitsFromWindow();
}

References TransferGraphLimitsFromWindow().

Here is the call graph for this function:

◆ OnSliderDBMIN()

void EffectScienFilter::OnSliderDBMIN ( wxCommandEvent & evt )

private

Definition at line 661 of file ScienFilter.cpp.

{
   TransferGraphLimitsFromWindow();
}

References TransferGraphLimitsFromWindow().

Here is the call graph for this function:

◆ OnStopbandRipple()

void EffectScienFilter::OnStopbandRipple ( wxCommandEvent & evt )

private

Definition at line 650 of file ScienFilter.cpp.

{
   if (!EffectEditor::EnableApply(
      mUIParent, mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mPanel->Refresh(false);
}

References EffectEditor::EnableApply(), mPanel, and mUIParent.

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectScienFilter::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 104 of file ScienFilter.cpp.

{
   static CapturedParameters<EffectScienFilter,
      Type, Subtype, Order, Cutoff, Passband, Stopband
   > parameters{
      [](EffectScienFilter &, EffectSettings &, EffectScienFilter &e,
         bool updating){
         if (updating) {
            e.mOrderIndex = e.mOrder - 1;
            e.CalcFilter();
         }
         return true;
      },
   };
   return parameters;
}

References Cutoff, EffectScienFilter(), Order, Passband, Stopband, Subtype, and Type.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectScienFilter::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 261 of file ScienFilter.cpp.

{
   mUIParent = S.GetParent();
   S.AddSpace(5);
   S.SetSizerProportion(1);
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(1);
      S.SetStretchyRow(0);
 
      // -------------------------------------------------------------------
      // ROW 1: Freq response panel and sliders for vertical scale
      // -------------------------------------------------------------------
 
      S.StartVerticalLay();
      {
         mdBRuler = safenew RulerPanel(
            S.GetParent(), wxID_ANY, wxVERTICAL,
            wxSize{ 100, 100 }, // Ruler can't handle small sizes
            RulerPanel::Range{ 30.0, -120.0 },
            LinearDBFormat::Instance(),
            XO("dB"),
            RulerPanel::Options{}
               .LabelEdges(true)
         );
 
         S.SetBorder(1);
         S.AddSpace(1, 1);
         S.Prop(1)
            .Position(wxALIGN_RIGHT | wxTOP)
            .AddWindow(mdBRuler);
         S.AddSpace(1, 1);
      }
      S.EndVerticalLay();
 
      mPanel = safenew EffectScienFilterPanel(
         S.GetParent(), wxID_ANY,
         this, mLoFreq, mNyquist
      );
 
      S.SetBorder(5);
      S.Prop(1)
         .Position(wxEXPAND | wxRIGHT)
         .MinSize( { -1, -1 } )
         .AddWindow(mPanel);
 
      S.StartVerticalLay();
      {
         S.AddVariableText(XO("+ dB"), false, wxCENTER);
         mdBMaxSlider = S.Id(ID_dBMax)
            .Name(XO("Max dB"))
            .Style(wxSL_VERTICAL | wxSL_INVERSE)
            .AddSlider( {}, 10, 20, 0);
#if wxUSE_ACCESSIBILITY
         mdBMaxSlider->SetAccessible(safenew SliderAx(mdBMaxSlider, XO("%d dB")));
#endif
         mdBMinSlider = S.Id(ID_dBMin)
            .Name(XO("Min dB"))
            .Style(wxSL_VERTICAL | wxSL_INVERSE)
            .AddSlider( {}, -10, -10, -120);
#if wxUSE_ACCESSIBILITY
         mdBMinSlider->SetAccessible(safenew SliderAx(mdBMinSlider, XO("%d dB")));
#endif
 
         S.AddVariableText(XO("- dB"), false, wxCENTER);
      }
      S.EndVerticalLay();
 
      // -------------------------------------------------------------------
      // ROW 2: Frequency ruler
      // -------------------------------------------------------------------
 
      S.AddSpace(1, 1);
 
      mfreqRuler = safenew RulerPanel(
         S.GetParent(), wxID_ANY, wxHORIZONTAL,
         wxSize{ 100, 100 }, // Ruler can't handle small sizes
         RulerPanel::Range{ mLoFreq, mNyquist },
         IntFormat::Instance(),
         {},
         RulerPanel::Options{}
            .Log(true)
            .Flip(true)
            .LabelEdges(true)
      );
 
      S.Prop(1)
         .Position(wxEXPAND | wxALIGN_LEFT | wxRIGHT)
         .AddWindow(mfreqRuler);
 
      S.AddSpace(1, 1);
 
      // -------------------------------------------------------------------
      // ROW 3 and 4: Type, Order, Ripple, Subtype, Cutoff
      // -------------------------------------------------------------------
 
      S.AddSpace(1, 1);
      S.SetSizerProportion(0);
      S.StartMultiColumn(8, wxALIGN_CENTER);
      {
         wxASSERT(nTypes == WXSIZEOF(kTypeStrings));
 
         mFilterTypeCtl = S.Id(ID_Type)
            .Focus()
            .Validator<wxGenericValidator>(&mFilterType)
            .MinSize( { -1, -1 } )
            .AddChoice(XXO("&Filter Type:"),
               Msgids(kTypeStrings, nTypes)
            );
 
         mFilterOrderCtl = S.Id(ID_Order)
            .Validator<wxGenericValidator>(&mOrderIndex)
            .MinSize( { -1, -1 } )
            /*i18n-hint: 'Order' means the complexity of the filter, and is a number between 1 and 10.*/
            .AddChoice(XXO("O&rder:"),
               []{
                  TranslatableStrings orders;
                  for (int i = 1; i <= 10; i++)
                     orders.emplace_back( Verbatim("%d").Format( i ) );
                  return orders;
               }()
            );
         S.AddSpace(1, 1);
 
         mRippleCtlP = S.AddVariableText( XO("&Passband Ripple:"),
            false, wxALL | wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mRippleCtl = S.Id(ID_Ripple)
            .Name(XO("Passband Ripple (dB)"))
            .Validator<FloatingPointValidator<float>>(
               1, &mRipple, NumValidatorStyle::DEFAULT,
               Passband.min, Passband.max)
            .AddTextBox( {}, L"", 10);
         mRippleCtlU = S.AddVariableText(XO("dB"),
            false, wxALL | wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
 
         mFilterSubTypeCtl = S.Id(ID_SubType)
            .Validator<wxGenericValidator>(&mFilterSubtype)
            .MinSize( { -1, -1 } )
            .AddChoice(XXO("&Subtype:"),
               Msgids(kSubTypeStrings, nSubTypes)
            );
 
         mCutoffCtl = S.Id(ID_Cutoff)
            .Name(XO("Cutoff (Hz)"))
            .Validator<FloatingPointValidator<float>>(
               1, &mCutoff, NumValidatorStyle::DEFAULT,
               Cutoff.min, mNyquist - 1)
            .AddTextBox(XXO("C&utoff:"), L"", 10);
         S.AddUnits(XO("Hz"));
 
         mStopbandRippleCtlP =
            S.AddVariableText(XO("Minimum S&topband Attenuation:"),
            false, wxALL | wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
         mStopbandRippleCtl = S.Id(ID_StopbandRipple)
            .Name(XO("Minimum S&topband Attenuation (dB)"))
            .Validator<FloatingPointValidator<float>>(
               1, &mStopbandRipple, NumValidatorStyle::DEFAULT,
               Stopband.min, Stopband.max)
            .AddTextBox( {}, L"", 10);
         mStopbandRippleCtlU =
            S.AddVariableText(XO("dB"),
            false, wxALL | wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
      }
      S.EndMultiColumn();
      S.AddSpace(1, 1);
   }
   S.EndMultiColumn();
 
   return nullptr;
}

References Cutoff, EffectScienFilterPanel, RulerPanel::Options::Flip(), TranslatableString::Format(), ID_Cutoff, ID_dBMax, ID_dBMin, ID_Order, ID_Ripple, ID_StopbandRipple, ID_SubType, ID_Type, IntFormat::Instance(), LinearDBFormat::Instance(), kSubTypeStrings, kTypeStrings, RulerPanel::Options::LabelEdges(), RulerPanel::Options::Log(), EffectParameter< Structure, Member, Type, Value >::max, mCutoff, mCutoffCtl, mdBMaxSlider, mdBMinSlider, mdBRuler, mFilterOrderCtl, mFilterSubtype, mFilterSubTypeCtl, mFilterType, mFilterTypeCtl, mfreqRuler, EffectParameter< Structure, Member, Type, Value >::min, mLoFreq, mNyquist, mOrderIndex, mPanel, mRipple, mRippleCtl, mRippleCtlP, mRippleCtlU, Msgids(), mStopbandRipple, mStopbandRippleCtl, mStopbandRippleCtlP, mStopbandRippleCtlU, mUIParent, nSubTypes, nTypes, Passband, S, safenew, Stopband, Verbatim(), XO(), and XXO().

Here is the call graph for this function:

◆ ProcessBlock()

size_t EffectScienFilter::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Implements StatefulPerTrackEffect.

Definition at line 208 of file ScienFilter.cpp.

{
   const float *ibuf = inBlock[0];
   for (int iPair = 0; iPair < (mOrder + 1) / 2; iPair++)
   {
      mpBiquad[iPair].Process(ibuf, outBlock[0], blockLen);
      ibuf = outBlock[0];
   }
 
   return blockLen;
}

References mOrder, and mpBiquad.

◆ ProcessInitialize()

bool EffectScienFilter::ProcessInitialize	(	EffectSettings &	settings,
		double	sampleRate,
		ChannelNames	chanMap
	)

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters

chanMap null or array terminated with ChannelNameEOL. Do not retain the pointer

Postcondition: GetAudioInCount() and GetAudioOutCount() are well defined

Reimplemented from StatefulEffectBase.

Definition at line 200 of file ScienFilter.cpp.

{
   for (int iPair = 0; iPair < (mOrder + 1) / 2; iPair++)
      mpBiquad[iPair].Reset();
   return true;
}

References mOrder, and mpBiquad.

◆ TransferDataFromWindow()

bool EffectScienFilter::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 457 of file ScienFilter.cpp.

{
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
   mOrder = mOrderIndex + 1;
 
   CalcFilter();
 
   return true;
}

References CalcFilter(), mOrder, mOrderIndex, and mUIParent.

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectScienFilter::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 437 of file ScienFilter.cpp.

{
   mOrderIndex = mOrder - 1;
 
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   mdBMinSlider->SetValue((int) mdBMin);
   mdBMin = 0.0;                     // force refresh in TransferGraphLimitsFromWindow()
 
   mdBMaxSlider->SetValue((int) mdBMax);
   mdBMax = 0.0;                    // force refresh in TransferGraphLimitsFromWindow()
 
   EnableDisableRippleCtl(mFilterType);
 
   return TransferGraphLimitsFromWindow();
}

References EnableDisableRippleCtl(), mdBMax, mdBMaxSlider, mdBMin, mdBMinSlider, mFilterType, mOrder, mOrderIndex, mUIParent, and TransferGraphLimitsFromWindow().

Here is the call graph for this function:

◆ TransferGraphLimitsFromWindow()

bool EffectScienFilter::TransferGraphLimitsFromWindow ( )

private

Definition at line 476 of file ScienFilter.cpp.

{
   // Read the sliders and send to the panel
   wxString tip;
 
   bool rr = false;
   int dB = mdBMinSlider->GetValue();
   if (dB != mdBMin) {
      rr = true;
      mdBMin = dB;
      tip.Printf(_("%d dB"), (int)mdBMin);
      mdBMinSlider->SetToolTip(tip);
   }
 
   dB = mdBMaxSlider->GetValue();
   if (dB != mdBMax) {
      rr = true;
      mdBMax = dB;
      tip.Printf(_("%d dB"),(int)mdBMax);
      mdBMaxSlider->SetToolTip(tip);
   }
 
   if (rr) {
      mPanel->SetDbRange(mdBMin, mdBMax);
   }
 
   // Refresh ruler if values have changed
   if (rr) {
      int w1, w2, h;
      mdBRuler->ruler.GetMaxSize(&w1, &h);
      mdBRuler->ruler.SetRange(mdBMax, mdBMin);
      mdBRuler->ruler.GetMaxSize(&w2, &h);
      if( w1 != w2 )   // Reduces flicker
      {
         mdBRuler->SetSize(wxSize(w2,h));
         mUIParent->Layout();
         mfreqRuler->Refresh(false);
      }
      mdBRuler->Refresh(false);
   }
 
   mPanel->Refresh(false);
 
   return true;
}

References _, Ruler::GetMaxSize(), mdBMax, mdBMaxSlider, mdBMin, mdBMinSlider, mdBRuler, mfreqRuler, mPanel, mUIParent, RulerPanel::ruler, EffectScienFilterPanel::SetDbRange(), and Ruler::SetRange().

Referenced by OnSliderDBMAX(), OnSliderDBMIN(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ EffectScienFilterPanel

friend class EffectScienFilterPanel

friend

Definition at line 135 of file ScienFilter.h.

Referenced by PopulateOrExchange().

Member Data Documentation

◆ Cutoff

constexpr EffectParameter EffectScienFilter::Cutoff

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mCutoff,

L"Cutoff", 1000.0f, 1.0, FLT_MAX, 1 }

Definition at line 162 of file ScienFilter.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ kSubTypeStrings

const EnumValueSymbol EffectScienFilter::kSubTypeStrings

staticprivate

Initial value:

=
{
   
   { XO("Lowpass") },
   { XO("Highpass") }
}

Definition at line 143 of file ScienFilter.h.

Referenced by PopulateOrExchange().

◆ kTypeStrings

const EnumValueSymbol EffectScienFilter::kTypeStrings

staticprivate

Initial value:

=
{
   
   { XO("Butterworth") },
   
   { XO("Chebyshev Type I") },
   
   { XO("Chebyshev Type II") }
}

Definition at line 152 of file ScienFilter.h.

Referenced by PopulateOrExchange().

◆ mCutoff

float EffectScienFilter::mCutoff

private

Definition at line 95 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), and PopulateOrExchange().

◆ mCutoffCtl

wxTextCtrl* EffectScienFilter::mCutoffCtl

private

Definition at line 119 of file ScienFilter.h.

Referenced by PopulateOrExchange().

◆ mdBMax

double EffectScienFilter::mdBMax

private

Definition at line 104 of file ScienFilter.h.

Referenced by TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ mdBMaxSlider

wxSlider* EffectScienFilter::mdBMaxSlider

private

Definition at line 113 of file ScienFilter.h.

Referenced by PopulateOrExchange(), TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ mdBMin

double EffectScienFilter::mdBMin

private

Definition at line 105 of file ScienFilter.h.

Referenced by TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ mdBMinSlider

wxSlider* EffectScienFilter::mdBMinSlider

private

Definition at line 112 of file ScienFilter.h.

Referenced by PopulateOrExchange(), TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ mdBRuler

RulerPanel* EffectScienFilter::mdBRuler

private

Definition at line 129 of file ScienFilter.h.

Referenced by EffectScienFilterPanel::OnPaint(), PopulateOrExchange(), and TransferGraphLimitsFromWindow().

◆ mEditingBatchParams

bool EffectScienFilter::mEditingBatchParams

private

Definition at line 106 of file ScienFilter.h.

◆ mFilterOrderCtl

wxChoice* EffectScienFilter::mFilterOrderCtl

private

Definition at line 127 of file ScienFilter.h.

Referenced by OnOrder(), and PopulateOrExchange().

◆ mFilterSubtype

int EffectScienFilter::mFilterSubtype

private

Definition at line 99 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), OnFilterSubtype(), and PopulateOrExchange().

◆ mFilterSubTypeCtl

wxChoice* EffectScienFilter::mFilterSubTypeCtl

private

Definition at line 126 of file ScienFilter.h.

Referenced by OnFilterSubtype(), and PopulateOrExchange().

◆ mFilterType

int EffectScienFilter::mFilterType

private

Definition at line 98 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), OnFilterType(), PopulateOrExchange(), and TransferDataToWindow().

◆ mFilterTypeCtl

wxChoice* EffectScienFilter::mFilterTypeCtl

private

Definition at line 125 of file ScienFilter.h.

Referenced by OnFilterType(), and PopulateOrExchange().

◆ mfreqRuler

RulerPanel* EffectScienFilter::mfreqRuler

private

Definition at line 130 of file ScienFilter.h.

Referenced by EffectScienFilterPanel::OnPaint(), PopulateOrExchange(), and TransferGraphLimitsFromWindow().

◆ mLoFreq

double EffectScienFilter::mLoFreq

private

Definition at line 108 of file ScienFilter.h.

Referenced by PopulateOrExchange().

◆ mNyquist

double EffectScienFilter::mNyquist

private

Definition at line 109 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), Init(), and PopulateOrExchange().

◆ mOrder

int EffectScienFilter::mOrder

private

Definition at line 100 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), OnOrder(), ProcessBlock(), ProcessInitialize(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mOrderIndex

int EffectScienFilter::mOrderIndex

private

Definition at line 101 of file ScienFilter.h.

Referenced by OnOrder(), PopulateOrExchange(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mPanel

EffectScienFilterPanel* EffectScienFilter::mPanel

private

Definition at line 111 of file ScienFilter.h.

Referenced by OnCutoff(), OnFilterSubtype(), OnFilterType(), OnOrder(), OnRipple(), OnStopbandRipple(), PopulateOrExchange(), and TransferGraphLimitsFromWindow().

◆ mpBiquad

ArrayOf<Biquad> EffectScienFilter::mpBiquad

private

Definition at line 102 of file ScienFilter.h.

Referenced by CalcFilter(), ProcessBlock(), and ProcessInitialize().

◆ mRipple

float EffectScienFilter::mRipple

private

Definition at line 96 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), and PopulateOrExchange().

◆ mRippleCtl

wxTextCtrl* EffectScienFilter::mRippleCtl

private

Definition at line 116 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mRippleCtlP

wxStaticText* EffectScienFilter::mRippleCtlP

private

Definition at line 115 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mRippleCtlU

wxStaticText* EffectScienFilter::mRippleCtlU

private

Definition at line 117 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mStopbandRipple

float EffectScienFilter::mStopbandRipple

private

Definition at line 97 of file ScienFilter.h.

Referenced by CalcFilter(), FilterMagnAtFreq(), and PopulateOrExchange().

◆ mStopbandRippleCtl

wxTextCtrl* EffectScienFilter::mStopbandRippleCtl

private

Definition at line 122 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mStopbandRippleCtlP

wxStaticText* EffectScienFilter::mStopbandRippleCtlP

private

Definition at line 121 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mStopbandRippleCtlU

wxStaticText* EffectScienFilter::mStopbandRippleCtlU

private

Definition at line 123 of file ScienFilter.h.

Referenced by EnableDisableRippleCtl(), and PopulateOrExchange().

◆ mUIParent

wxWeakRef<wxWindow> EffectScienFilter::mUIParent {}

private

Definition at line 93 of file ScienFilter.h.

Referenced by OnCutoff(), OnRipple(), OnSize(), OnStopbandRipple(), PopulateOrExchange(), TransferDataFromWindow(), TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ Order

constexpr EffectParameter EffectScienFilter::Order

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mOrder,

L"Order", 1, 1, 10, 1 }

Definition at line 160 of file ScienFilter.h.

Referenced by Parameters().

◆ Passband

constexpr EffectParameter EffectScienFilter::Passband

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mRipple,

L"PassbandRipple", 1.0f, 0.0, 100.0, 1 }

Definition at line 164 of file ScienFilter.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Stopband

constexpr EffectParameter EffectScienFilter::Stopband

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mStopbandRipple,

L"StopbandRipple", 30.0f, 0.0, 100.0, 1 }

Definition at line 166 of file ScienFilter.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Subtype

constexpr EnumParameter EffectScienFilter::Subtype

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mFilterSubtype,

L"FilterSubtype", kLowPass, 0, nSubTypes - 1, 1, kSubTypeStrings, nSubTypes }

Definition at line 158 of file ScienFilter.h.

Referenced by Parameters().

◆ Symbol

const ComponentInterfaceSymbol EffectScienFilter::Symbol { XO("Classic Filters") }

static

Definition at line 40 of file ScienFilter.h.

Referenced by GetSymbol().

◆ Type

constexpr EnumParameter EffectScienFilter::Type

staticconstexprprivate

Initial value:

{ &EffectScienFilter::mFilterType,

L"FilterType", kButterworth, 0, nTypes - 1, 1, kTypeStrings, nTypes }

Definition at line 156 of file ScienFilter.h.

Referenced by Parameters().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kSubTypes

◆ kTypes

Constructor & Destructor Documentation

◆ EffectScienFilter()

◆ ~EffectScienFilter()

Member Function Documentation

◆ CalcFilter()

◆ EnableDisableRippleCtl()

◆ FetchParameters()

◆ FilterMagnAtFreq()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ Init()

◆ ManualPage()

◆ OnCutoff()

◆ OnFilterSubtype()

◆ OnFilterType()

◆ OnOrder()

◆ OnRipple()

◆ OnSize()

◆ OnSlider()

◆ OnSliderDBMAX()

◆ OnSliderDBMIN()

◆ OnStopbandRipple()

◆ Parameters()

◆ PopulateOrExchange()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ TransferGraphLimitsFromWindow()

Friends And Related Function Documentation

◆ EffectScienFilterPanel

Member Data Documentation

◆ Cutoff

◆ kSubTypeStrings

◆ kTypeStrings

◆ mCutoff

◆ mCutoffCtl

◆ mdBMax

◆ mdBMaxSlider

◆ mdBMin

◆ mdBMinSlider

◆ mdBRuler

◆ mEditingBatchParams

◆ mFilterOrderCtl

◆ mFilterSubtype

◆ mFilterSubTypeCtl

◆ mFilterType

◆ mFilterTypeCtl

◆ mfreqRuler

◆ mLoFreq

◆ mNyquist

◆ mOrder

◆ mOrderIndex

◆ mPanel

◆ mpBiquad

◆ mRipple

◆ mRippleCtl

◆ mRippleCtlP

◆ mRippleCtlU

◆ mStopbandRipple

◆ mStopbandRippleCtl

◆ mStopbandRippleCtlP

◆ mStopbandRippleCtlU

◆ mUIParent