Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
EffectScienFilter Class Referencefinal

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

#include <ScienFilter.h>

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

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< EffectEditorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
 Add controls to effect panel; always succeeds. More...
 
bool TransferDataToWindow (const EffectSettings &settings) override
 
bool TransferDataFromWindow (EffectSettings &settings) override
 
- Public Member Functions inherited from StatefulPerTrackEffect
 ~StatefulPerTrackEffect () override
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
size_t SetBlockSize (size_t maxBlockSize) override
 
size_t GetBlockSize () const override
 
bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr) override
 
bool ProcessFinalize () noexcept override
 
virtual size_t ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen)=0
 Called for destructive effect computation. More...
 
- Public Member Functions inherited from StatefulEffectBase
virtual bool Init ()
 
virtual bool Process (EffectInstance &instance, EffectSettings &settings)=0
 
virtual bool RealtimeInitialize (EffectSettings &settings, double sampleRate)
 
virtual bool RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)
 
virtual bool RealtimeSuspend ()
 
virtual bool RealtimeResume ()
 
virtual bool RealtimeProcessStart (MessagePackage &package)
 settings are possibly changed, since last call, by an asynchronous dialog More...
 
virtual size_t RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
 
virtual bool RealtimeProcessEnd (EffectSettings &settings) noexcept
 settings can be updated to let a dialog change appearance at idle More...
 
virtual bool RealtimeFinalize (EffectSettings &settings) noexcept
 
virtual size_t SetBlockSize (size_t maxBlockSize)
 
virtual size_t GetBlockSize () const
 
virtual unsigned GetAudioInCount () const
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const
 How many output buffers to allocate at once. More...
 
virtual sampleCount GetLatency () const
 
virtual bool NeedsDither () const
 
virtual bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)
 
virtual bool ProcessFinalize () noexcept
 
- Public Member Functions inherited from PerTrackEffect
 ~PerTrackEffect () override
 
- Public Member Functions inherited from Effect
 Effect ()
 
virtual ~Effect ()
 
PluginPath GetPath () const override
 
bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
 
bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
 
ComponentInterfaceSymbol GetSymbol () const override
 
VendorSymbol GetVendor () const override
 
wxString GetVersion () const override
 
TranslatableString GetDescription () const override
 
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 ReplaceProcessedTracks (const bool bGoodResult)
 
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 EffectScienFilterFetchParameters (EffectScienFilter &e, EffectSettings &)
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
static void IncEffectCounter ()
 
- 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("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 EffectParameterMethodsParameters () const override
 

Private Attributes

wxWeakRef< wxWindow > mUIParent {}
 
float mCutoff
 
float mRipple
 
float mStopbandRipple
 
int mFilterType
 
int mFilterSubtype
 
int mOrder
 
int mOrderIndex
 
ArrayOf< BiquadmpBiquad
 
double mdBMax
 
double mdBMin
 
bool mEditingBatchParams
 
double mLoFreq
 
double mNyquist
 
EffectScienFilterPanelmPanel
 
wxSlider * mdBMinSlider
 
wxSlider * mdBMaxSlider
 
wxStaticText * mRippleCtlP
 
wxTextCtrl * mRippleCtl
 
wxStaticText * mRippleCtlU
 
wxTextCtrl * mCutoffCtl
 
wxStaticText * mStopbandRippleCtlP
 
wxTextCtrl * mStopbandRippleCtl
 
wxStaticText * mStopbandRippleCtlU
 
wxChoice * mFilterTypeCtl
 
wxChoice * mFilterSubTypeCtl
 
wxChoice * mFilterOrderCtl
 
RulerPanelmdBRuler
 
RulerPanelmfreqRuler
 

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
TrackListmTracks {}
 
int mNumTracks {}
 
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
double mT0 {}
 
double mT1 {}
 
bool mIsPreview { false }
 
- Protected Member Functions inherited from PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
- 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)
 
TrackAddToOutputTracks (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 TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from EffectBase
std::shared_ptr< TrackListmOutputTracks
 
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

Enumerator
kLowPass 
kHighPass 
nSubTypes 

Definition at line 137 of file ScienFilter.h.

◆ kTypes

Enumerator
kButterworth 
kChebyshevTypeI 
kChebyshevTypeII 
nTypes 

Definition at line 145 of file ScienFilter.h.

Constructor & Destructor Documentation

◆ EffectScienFilter()

EffectScienFilter::EffectScienFilter ( )

Definition at line 146 of file ScienFilter.cpp.

147{
148 Parameters().Reset(*this);
150
151 mOrderIndex = mOrder - 1;
152
153 mdBMin = -30.0;
154 mdBMax = 30.0;
155
156 mLoFreq = 20; // Lowest frequency to display in response graph
157 mNyquist = 44100.0 / 2.0; // only used during initialization, updated when effect is used
158}
void SetLinearEffectFlag(bool linearEffectFlag)
Definition: EffectBase.cpp:211
virtual void Reset(Effect &effect) const =0
const EffectParameterMethods & Parameters() const override

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.

523{
524 switch (mFilterType)
525 {
526 case kButterworth:
528 break;
529 case kChebyshevTypeI:
531 break;
532 case kChebyshevTypeII:
534 break;
535 }
536}
ArrayOf< Biquad > mpBiquad
Definition: ScienFilter.h:102
static ArrayOf< Biquad > CalcButterworthFilter(int order, double fn, double fc, int type)
Definition: Biquad.cpp:64
static ArrayOf< Biquad > CalcChebyshevType2Filter(int order, double fn, double fc, double ripple, int type)
Definition: Biquad.cpp:228
static ArrayOf< Biquad > CalcChebyshevType1Filter(int order, double fn, double fc, double ripple, int type)
Definition: Biquad.cpp:146

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.

680{
681 bool ripple;
682 bool stop;
683
684 if (FilterType == kButterworth) // Butterworth
685 {
686 ripple = false;
687 stop = false;
688 }
689 else if (FilterType == kChebyshevTypeI) // Chebyshev Type1
690 {
691 ripple = true;
692 stop = false;
693 }
694 else // Chebyshev Type2
695 {
696 ripple = false;
697 stop = true;
698 }
699
700 mRippleCtlP->Enable(ripple);
701 mRippleCtl->Enable(ripple);
702 mRippleCtlU->Enable(ripple);
703 mStopbandRippleCtlP->Enable(stop);
704 mStopbandRippleCtl->Enable(stop);
705 mStopbandRippleCtlU->Enable(stop);
706}
wxStaticText * mRippleCtlU
Definition: ScienFilter.h:117
wxTextCtrl * mRippleCtl
Definition: ScienFilter.h:116
wxStaticText * mStopbandRippleCtlP
Definition: ScienFilter.h:121
wxTextCtrl * mStopbandRippleCtl
Definition: ScienFilter.h:122
wxStaticText * mRippleCtlP
Definition: ScienFilter.h:115
wxStaticText * mStopbandRippleCtlU
Definition: ScienFilter.h:123

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.

539{
540 float Magn;
541 if (Freq >= mNyquist)
542 Freq = mNyquist - 1; // prevent tan(PI/2)
543 float FreqWarped = tan (PI * Freq/(2*mNyquist));
544 if (mCutoff >= mNyquist)
545 mCutoff = mNyquist - 1;
546 float CutoffWarped = tan (PI * mCutoff/(2*mNyquist));
547 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
548
549 switch (mFilterType)
550 {
551 case kButterworth: // Butterworth
552 default:
553 switch (mFilterSubtype)
554 {
555 case kLowPass: // lowpass
556 default:
557 if (FreqWarped/CutoffWarped > fOverflowThresh) // prevent pow() overflow
558 Magn = 0;
559 else
560 Magn = sqrt (1 / (1 + pow (FreqWarped/CutoffWarped, 2*mOrder)));
561 break;
562 case kHighPass: // highpass
563 if (FreqWarped/CutoffWarped > fOverflowThresh)
564 Magn = 1;
565 else
566 Magn = sqrt (pow (FreqWarped/CutoffWarped, 2*mOrder) / (1 + pow (FreqWarped/CutoffWarped, 2*mOrder)));
567 break;
568 }
569 break;
570
571 case kChebyshevTypeI: // Chebyshev Type 1
572 double eps; eps = sqrt(pow (10.0, wxMax(0.001, mRipple)/10.0) - 1);
573 double chebyPolyVal;
574 switch (mFilterSubtype)
575 {
576 case 0: // lowpass
577 default:
578 chebyPolyVal = Biquad::ChebyPoly(mOrder, FreqWarped/CutoffWarped);
579 Magn = sqrt (1 / (1 + square(eps) * square(chebyPolyVal)));
580 break;
581 case 1:
582 chebyPolyVal = Biquad::ChebyPoly(mOrder, CutoffWarped/FreqWarped);
583 Magn = sqrt (1 / (1 + square(eps) * square(chebyPolyVal)));
584 break;
585 }
586 break;
587
588 case kChebyshevTypeII: // Chebyshev Type 2
589 eps = 1 / sqrt(pow (10.0, wxMax(0.001, mStopbandRipple)/10.0) - 1);
590 switch (mFilterSubtype)
591 {
592 case kLowPass: // lowpass
593 default:
594 chebyPolyVal = Biquad::ChebyPoly(mOrder, CutoffWarped/FreqWarped);
595 Magn = sqrt (1 / (1 + 1 / (square(eps) * square(chebyPolyVal))));
596 break;
597 case kHighPass:
598 chebyPolyVal = Biquad::ChebyPoly(mOrder, FreqWarped/CutoffWarped);
599 Magn = sqrt (1 / (1 + 1 / (square(eps) * square(chebyPolyVal))));
600 break;
601 }
602 break;
603 }
604
605 return Magn;
606}
#define square(a)
Definition: ScienFilter.cpp:72
#define PI
Definition: ScienFilter.cpp:68
__finl float_x4 __vecc sqrt(const float_x4 &a)
static double ChebyPoly(int Order, double NormFreq)
Definition: Biquad.cpp:329

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.

191{
192 return 1;
193}

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

196{
197 return 1;
198}

◆ GetDescription()

TranslatableString EffectScienFilter::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 171 of file ScienFilter.cpp.

172{
173 /* i18n-hint: "infinite impulse response" */
174 return XO("Performs IIR filtering that emulates analog filters");
175}
XO("Cut/Copy/Paste")

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.

167{
168 return Symbol;
169}
static const ComponentInterfaceSymbol Symbol
Definition: ScienFilter.h:40

References Symbol.

◆ GetType()

EffectType EffectScienFilter::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 185 of file ScienFilter.cpp.

186{
187 return EffectTypeProcess;
188}
@ 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.

224{
225 int selcount = 0;
226 double rate = 0.0;
227
228 auto trackRange = inputTracks()->Selected< const WaveTrack >();
229
230 {
231 auto t = *trackRange.begin();
232 mNyquist =
233 (t
234 ? t->GetRate()
235 : mProjectRate)
236 / 2.0;
237 }
238
239 for (auto t : trackRange)
240 {
241 if (selcount == 0)
242 {
243 rate = t->GetRate();
244 }
245 else
246 {
247 if (t->GetRate() != rate)
248 {
250 XO(
251"To apply a filter, all selected tracks must have the same sample rate.") );
252 return false;
253 }
254 }
255 selcount++;
256 }
257
258 return true;
259}
const TrackList * inputTracks() const
Definition: EffectBase.h:94
double mProjectRate
Definition: EffectBase.h:115
static int DoMessageBox(const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
auto Selected() -> TrackIterRange< TrackType >
Definition: Track.h:1330
A Track that contains audio waveform data.
Definition: WaveTrack.h:51

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.

178{
179 return L"Classic_Filters";
180}

◆ OnCutoff()

void EffectScienFilter::OnCutoff ( wxCommandEvent &  evt)
private

Definition at line 628 of file ScienFilter.cpp.

629{
631 mUIParent, mUIParent->TransferDataFromWindow()))
632 {
633 return;
634 }
635
636 mPanel->Refresh(false);
637}
static bool EnableApply(wxWindow *parent, bool enable=true)
Enable or disable the Apply button of the dialog that contains parent.
EffectScienFilterPanel * mPanel
Definition: ScienFilter.h:111
wxWeakRef< wxWindow > mUIParent
Definition: ScienFilter.h:93

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.

623{
624 mFilterSubtype = mFilterSubTypeCtl->GetSelection();
625 mPanel->Refresh(false);
626}
wxChoice * mFilterSubTypeCtl
Definition: ScienFilter.h:126

References mFilterSubtype, mFilterSubTypeCtl, and mPanel.

◆ OnFilterType()

void EffectScienFilter::OnFilterType ( wxCommandEvent &  evt)
private

Definition at line 615 of file ScienFilter.cpp.

616{
617 mFilterType = mFilterTypeCtl->GetSelection();
619 mPanel->Refresh(false);
620}
void EnableDisableRippleCtl(int FilterType)
wxChoice * mFilterTypeCtl
Definition: ScienFilter.h:125

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.

609{
610 mOrderIndex = mFilterOrderCtl->GetSelection();
611 mOrder = mOrderIndex + 1; // 0..n-1 -> 1..n
612 mPanel->Refresh(false);
613}
wxChoice * mFilterOrderCtl
Definition: ScienFilter.h:127

References mFilterOrderCtl, mOrder, mOrderIndex, and mPanel.

◆ OnRipple()

void EffectScienFilter::OnRipple ( wxCommandEvent &  evt)
private

Definition at line 639 of file ScienFilter.cpp.

640{
642 mUIParent, mUIParent->TransferDataFromWindow()))
643 {
644 return;
645 }
646
647 mPanel->Refresh(false);
648}

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.

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

References mUIParent.

◆ OnSlider()

void EffectScienFilter::OnSlider ( wxCommandEvent &  evt)
private

◆ OnSliderDBMAX()

void EffectScienFilter::OnSliderDBMAX ( wxCommandEvent &  evt)
private

Definition at line 666 of file ScienFilter.cpp.

667{
669}
bool 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.

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.

651{
653 mUIParent, mUIParent->TransferDataFromWindow()))
654 {
655 return;
656 }
657
658 mPanel->Refresh(false);
659}

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.

105{
108 > parameters{
110 bool updating){
111 if (updating) {
112 e.mOrderIndex = e.mOrder - 1;
113 e.CalcFilter();
114 }
115 return true;
116 },
117 };
118 return parameters;
119}
Generates EffectParameterMethods overrides from variadic template arguments.
An Effect that applies 'classical' IIR filters.
Definition: ScienFilter.h:36
static constexpr EffectParameter Stopband
Definition: ScienFilter.h:166
static constexpr EffectParameter Cutoff
Definition: ScienFilter.h:162
static constexpr EnumParameter Subtype
Definition: ScienFilter.h:158
static constexpr EnumParameter Type
Definition: ScienFilter.h:156
static constexpr EffectParameter Passband
Definition: ScienFilter.h:164
static constexpr EffectParameter Order
Definition: ScienFilter.h:160
Externalized state of a plug-in.

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.

264{
265 mUIParent = S.GetParent();
266 S.AddSpace(5);
267 S.SetSizerProportion(1);
268 S.StartMultiColumn(3, wxEXPAND);
269 {
270 S.SetStretchyCol(1);
271 S.SetStretchyRow(0);
272
273 // -------------------------------------------------------------------
274 // ROW 1: Freq response panel and sliders for vertical scale
275 // -------------------------------------------------------------------
276
277 S.StartVerticalLay();
278 {
280 S.GetParent(), wxID_ANY, wxVERTICAL,
281 wxSize{ 100, 100 }, // Ruler can't handle small sizes
282 RulerPanel::Range{ 30.0, -120.0 },
284 XO("dB"),
286 .LabelEdges(true)
287 );
288
289 S.SetBorder(1);
290 S.AddSpace(1, 1);
291 S.Prop(1)
292 .Position(wxALIGN_RIGHT | wxTOP)
293 .AddWindow(mdBRuler);
294 S.AddSpace(1, 1);
295 }
296 S.EndVerticalLay();
297
299 S.GetParent(), wxID_ANY,
300 this, mLoFreq, mNyquist
301 );
302
303 S.SetBorder(5);
304 S.Prop(1)
305 .Position(wxEXPAND | wxRIGHT)
306 .MinSize( { -1, -1 } )
307 .AddWindow(mPanel);
308
309 S.StartVerticalLay();
310 {
311 S.AddVariableText(XO("+ dB"), false, wxCENTER);
313 .Name(XO("Max dB"))
314 .Style(wxSL_VERTICAL | wxSL_INVERSE)
315 .AddSlider( {}, 10, 20, 0);
316#if wxUSE_ACCESSIBILITY
317 mdBMaxSlider->SetAccessible(safenew SliderAx(mdBMaxSlider, XO("%d dB")));
318#endif
320 .Name(XO("Min dB"))
321 .Style(wxSL_VERTICAL | wxSL_INVERSE)
322 .AddSlider( {}, -10, -10, -120);
323#if wxUSE_ACCESSIBILITY
324 mdBMinSlider->SetAccessible(safenew SliderAx(mdBMinSlider, XO("%d dB")));
325#endif
326
327 S.AddVariableText(XO("- dB"), false, wxCENTER);
328 }
329 S.EndVerticalLay();
330
331 // -------------------------------------------------------------------
332 // ROW 2: Frequency ruler
333 // -------------------------------------------------------------------
334
335 S.AddSpace(1, 1);
336
338 S.GetParent(), wxID_ANY, wxHORIZONTAL,
339 wxSize{ 100, 100 }, // Ruler can't handle small sizes
340 RulerPanel::Range{ mLoFreq, mNyquist },
342 {},
344 .Log(true)
345 .Flip(true)
346 .LabelEdges(true)
347 );
348
349 S.Prop(1)
350 .Position(wxEXPAND | wxALIGN_LEFT | wxRIGHT)
351 .AddWindow(mfreqRuler);
352
353 S.AddSpace(1, 1);
354
355 // -------------------------------------------------------------------
356 // ROW 3 and 4: Type, Order, Ripple, Subtype, Cutoff
357 // -------------------------------------------------------------------
358
359 S.AddSpace(1, 1);
360 S.SetSizerProportion(0);
361 S.StartMultiColumn(8, wxALIGN_CENTER);
362 {
363 wxASSERT(nTypes == WXSIZEOF(kTypeStrings));
364
366 .Focus()
367 .Validator<wxGenericValidator>(&mFilterType)
368 .MinSize( { -1, -1 } )
369 .AddChoice(XXO("&Filter Type:"),
371 );
372
374 .Validator<wxGenericValidator>(&mOrderIndex)
375 .MinSize( { -1, -1 } )
376 /*i18n-hint: 'Order' means the complexity of the filter, and is a number between 1 and 10.*/
377 .AddChoice(XXO("O&rder:"),
378 []{
379 TranslatableStrings orders;
380 for (int i = 1; i <= 10; i++)
381 orders.emplace_back( Verbatim("%d").Format( i ) );
382 return orders;
383 }()
384 );
385 S.AddSpace(1, 1);
386
387 mRippleCtlP = S.AddVariableText( XO("&Passband Ripple:"),
388 false, wxALL | wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
390 .Name(XO("Passband Ripple (dB)"))
391 .Validator<FloatingPointValidator<float>>(
392 1, &mRipple, NumValidatorStyle::DEFAULT,
394 .AddTextBox( {}, L"", 10);
395 mRippleCtlU = S.AddVariableText(XO("dB"),
396 false, wxALL | wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
397
399 .Validator<wxGenericValidator>(&mFilterSubtype)
400 .MinSize( { -1, -1 } )
401 .AddChoice(XXO("&Subtype:"),
403 );
404
406 .Name(XO("Cutoff (Hz)"))
407 .Validator<FloatingPointValidator<float>>(
408 1, &mCutoff, NumValidatorStyle::DEFAULT,
409 Cutoff.min, mNyquist - 1)
410 .AddTextBox(XXO("C&utoff:"), L"", 10);
411 S.AddUnits(XO("Hz"));
412
414 S.AddVariableText(XO("Minimum S&topband Attenuation:"),
415 false, wxALL | wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
417 .Name(XO("Minimum S&topband Attenuation (dB)"))
418 .Validator<FloatingPointValidator<float>>(
419 1, &mStopbandRipple, NumValidatorStyle::DEFAULT,
421 .AddTextBox( {}, L"", 10);
423 S.AddVariableText(XO("dB"),
424 false, wxALL | wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
425 }
426 S.EndMultiColumn();
427 S.AddSpace(1, 1);
428 }
429 S.EndMultiColumn();
430
431 return nullptr;
432}
XXO("&Cut/Copy/Paste Toolbar")
#define safenew
Definition: MemoryX.h:10
@ ID_Cutoff
Definition: ScienFilter.cpp:83
@ ID_SubType
Definition: ScienFilter.cpp:80
@ ID_dBMax
Definition: ScienFilter.cpp:77
@ ID_Ripple
Definition: ScienFilter.cpp:82
@ ID_StopbandRipple
Definition: ScienFilter.cpp:84
@ ID_Order
Definition: ScienFilter.cpp:81
@ ID_Type
Definition: ScienFilter.cpp:79
@ ID_dBMin
Definition: ScienFilter.cpp:78
TranslatableStrings Msgids(const EnumValueSymbol strings[], size_t nStrings)
Convenience function often useful when adding choice controls.
#define S(N)
Definition: ToChars.cpp:64
TranslatableString Verbatim(wxString str)
Require calls to the one-argument constructor to go through this distinct global function name.
std::vector< TranslatableString > TranslatableStrings
static const EnumValueSymbol kSubTypeStrings[nSubTypes]
Definition: ScienFilter.h:143
friend class EffectScienFilterPanel
Definition: ScienFilter.h:135
static const EnumValueSymbol kTypeStrings[nTypes]
Definition: ScienFilter.h:152
wxTextCtrl * mCutoffCtl
Definition: ScienFilter.h:119
wxSlider * mdBMaxSlider
Definition: ScienFilter.h:113
RulerPanel * mdBRuler
Definition: ScienFilter.h:129
RulerPanel * mfreqRuler
Definition: ScienFilter.h:130
wxSlider * mdBMinSlider
Definition: ScienFilter.h:112
static const IntFormat & Instance()
Definition: IntFormat.cpp:14
static const LinearDBFormat & Instance()
RulerPanel class allows you to work with a Ruler like any other wxWindow.
Definition: RulerPanel.h:19
std::pair< double, double > Range
Definition: RulerPanel.h:23
TranslatableString & Format(Args &&...args) &
Capture variadic format arguments (by copy) when there is no plural.
A Validator is an object which checks whether a wxVariant satisfies a certain criterion....
Definition: Validators.h:53
const Type min
Minimum value.
const Type max
Maximum value.
Options & LabelEdges(bool l)
Definition: RulerPanel.h:41
Options & Flip(bool f)
Definition: RulerPanel.h:38
Options & Log(bool l)
Definition: RulerPanel.h:35

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.

210{
211 const float *ibuf = inBlock[0];
212 for (int iPair = 0; iPair < (mOrder + 1) / 2; iPair++)
213 {
214 mpBiquad[iPair].Process(ibuf, outBlock[0], blockLen);
215 ibuf = outBlock[0];
216 }
217
218 return blockLen;
219}

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

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

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.

458{
459 if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
460 {
461 return false;
462 }
463
464 mOrder = mOrderIndex + 1;
465
466 CalcFilter();
467
468 return true;
469}

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.

438{
439 mOrderIndex = mOrder - 1;
440
441 if (!mUIParent->TransferDataToWindow())
442 {
443 return false;
444 }
445
446 mdBMinSlider->SetValue((int) mdBMin);
447 mdBMin = 0.0; // force refresh in TransferGraphLimitsFromWindow()
448
449 mdBMaxSlider->SetValue((int) mdBMax);
450 mdBMax = 0.0; // force refresh in TransferGraphLimitsFromWindow()
451
453
455}

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.

477{
478 // Read the sliders and send to the panel
479 wxString tip;
480
481 bool rr = false;
482 int dB = mdBMinSlider->GetValue();
483 if (dB != mdBMin) {
484 rr = true;
485 mdBMin = dB;
486 tip.Printf(_("%d dB"), (int)mdBMin);
487 mdBMinSlider->SetToolTip(tip);
488 }
489
490 dB = mdBMaxSlider->GetValue();
491 if (dB != mdBMax) {
492 rr = true;
493 mdBMax = dB;
494 tip.Printf(_("%d dB"),(int)mdBMax);
495 mdBMaxSlider->SetToolTip(tip);
496 }
497
498 if (rr) {
500 }
501
502 // Refresh ruler if values have changed
503 if (rr) {
504 int w1, w2, h;
505 mdBRuler->ruler.GetMaxSize(&w1, &h);
507 mdBRuler->ruler.GetMaxSize(&w2, &h);
508 if( w1 != w2 ) // Reduces flicker
509 {
510 mdBRuler->SetSize(wxSize(w2,h));
511 mUIParent->Layout();
512 mfreqRuler->Refresh(false);
513 }
514 mdBRuler->Refresh(false);
515 }
516
517 mPanel->Refresh(false);
518
519 return true;
520}
#define _(s)
Definition: Internat.h:73
void SetDbRange(double min, double max)
void GetMaxSize(wxCoord *width, wxCoord *height)
Definition: Ruler.cpp:613
void SetRange(double min, double max)
Definition: Ruler.cpp:151
Ruler ruler
Definition: RulerPanel.h:79

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

◆ mdBMin

double EffectScienFilter::mdBMin
private

Definition at line 105 of file ScienFilter.h.

Referenced by TransferDataToWindow(), and TransferGraphLimitsFromWindow().

◆ mdBMinSlider

wxSlider* EffectScienFilter::mdBMinSlider
private

◆ mdBRuler

RulerPanel* EffectScienFilter::mdBRuler
private

◆ 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

◆ mFilterTypeCtl

wxChoice* EffectScienFilter::mFilterTypeCtl
private

Definition at line 125 of file ScienFilter.h.

Referenced by OnFilterType(), and PopulateOrExchange().

◆ mfreqRuler

RulerPanel* EffectScienFilter::mfreqRuler
private

◆ 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

◆ mOrderIndex

int EffectScienFilter::mOrderIndex
private

◆ mPanel

EffectScienFilterPanel* EffectScienFilter::mPanel
private

◆ 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

◆ Order

constexpr EffectParameter EffectScienFilter::Order
staticconstexprprivate
Initial value:
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:
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:
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:

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:

Definition at line 156 of file ScienFilter.h.

Referenced by Parameters().


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