2013-10-02 10:32:41 +00:00
|
|
|
/**********************************************************************
|
|
|
|
|
2013-10-02 16:00:34 +00:00
|
|
|
Audacity: A Digital Audio Editor
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2013-10-02 16:00:34 +00:00
|
|
|
EffectScienFilter.h
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2013-10-02 16:00:34 +00:00
|
|
|
Norm C
|
|
|
|
Mitch Golden
|
|
|
|
Vaughan Johnson (Preview)
|
2013-10-02 10:32:41 +00:00
|
|
|
|
|
|
|
***********************************************************************/
|
|
|
|
|
|
|
|
#ifndef __AUDACITY_EFFECT_SCIENFILTER__
|
|
|
|
#define __AUDACITY_EFFECT_SCIENFILTER__
|
|
|
|
|
2019-03-23 18:28:37 +00:00
|
|
|
#include <wx/setup.h> // for wxUSE_* macros
|
|
|
|
|
2013-10-02 10:32:41 +00:00
|
|
|
#include "Biquad.h"
|
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
#include "Effect.h"
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2018-11-14 19:10:04 +00:00
|
|
|
class wxBitmap;
|
2018-11-14 16:07:06 +00:00
|
|
|
class wxChoice;
|
2018-11-11 21:18:23 +00:00
|
|
|
class wxSlider;
|
2018-11-11 21:41:45 +00:00
|
|
|
class wxStaticText;
|
2015-06-18 14:24:36 +00:00
|
|
|
class wxTextCtrl;
|
2018-10-23 20:36:02 +00:00
|
|
|
class RulerPanel;
|
2015-06-18 14:24:36 +00:00
|
|
|
class ShuttleGui;
|
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
class EffectScienFilterPanel;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2016-02-24 06:06:39 +00:00
|
|
|
class EffectScienFilter final : public Effect
|
2015-04-17 03:53:42 +00:00
|
|
|
{
|
2013-10-02 10:32:41 +00:00
|
|
|
public:
|
2019-01-17 22:33:49 +00:00
|
|
|
static const ComponentInterfaceSymbol Symbol;
|
|
|
|
|
2013-10-02 10:32:41 +00:00
|
|
|
EffectScienFilter();
|
|
|
|
virtual ~EffectScienFilter();
|
|
|
|
|
2018-11-02 15:31:44 +00:00
|
|
|
// ComponentInterface implementation
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2018-11-02 15:31:44 +00:00
|
|
|
ComponentInterfaceSymbol GetSymbol() override;
|
2019-12-08 18:53:48 +00:00
|
|
|
TranslatableString GetDescription() override;
|
2021-06-06 16:18:35 +00:00
|
|
|
ManualPageID ManualPage() override;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
Automation: AudacityCommand
This is a squash of 50 commits.
This merges the capabilities of BatchCommands and Effects using a new
AudacityCommand class. AudacityCommand provides one function to specify the
parameters, and then we leverage that one function in automation, whether by chains,
mod-script-pipe or (future) Nyquist.
- Now have AudacityCommand which is using the same mechanism as Effect
- Has configurable parameters
- Has data-entry GUI (built using shuttle GUI)
- Registers with PluginManager.
- Menu commands now provided in chains, and to python batch.
- Tested with Zoom Toggle.
- ShuttleParams now can set, get, set defaults, validate and specify
the parameters.
- Bugfix: Don't overwrite values with defaults first time out.
- Add DefineParams function for all built-in effects.
- Extend CommandContext to carry output channels for results.
We abuse EffectsManager. It handles both Effects and
AudacityCommands now. In time an Effect should become a special case of
AudacityCommand and we'll split and rename the EffectManager class.
- Don't use 'default' as a parameter name.
- Massive renaming for CommandDefinitionInterface
- EffectIdentInterface becomes EffectDefinitionInterface
- EffectAutomationParameters becomes CommandAutomationParameters
- PluginType is now a bit field.
This way we can search for related types at the same time.
- Most old batch commands made into AudacityCommands.
The ones that weren't are for a reason. They are used by mod-script-pipe
to carry commands and responses across from a non-GUI thread to the GUI
thread.
- Major tidy up of ScreenshotCommand
- Reworking of SelectCommand
- GetPreferenceCommand and SetPreferenceCommand
- GetTrackInfo and SetTrackInfo
- GetInfoCommand
- Help, Open, Save, Import and Export commands.
- Removed obsolete commands ExecMenu, GetProjectInfo and SetProjectInfo
which are now better handled by other commands.
- JSONify "GetInfo: Commands" output, i.e. commas in the right places.
- General work on better Doxygen.
- Lyrics -> LyricsPanel
- Meter -> MeterPanel
- Updated Linux makefile.
- Scripting commands added into Extra menu.
- Distinct names for previously duplicated find-clipping parameters.
- Fixed longstanding error with erroneous status field number which
previously caused an ASSERT in debug.
- Sensible formatting of numbers in Chains, 0.1 not 0.1000000000137
2018-01-14 18:51:41 +00:00
|
|
|
// EffectDefinitionInterface implementation
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
EffectType GetType() override;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// EffectClientInterface implementation
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2016-09-02 19:53:09 +00:00
|
|
|
unsigned GetAudioInCount() override;
|
|
|
|
unsigned GetAudioOutCount() override;
|
2016-02-24 06:06:47 +00:00
|
|
|
bool ProcessInitialize(sampleCount totalLen, ChannelNames chanMap = NULL) override;
|
2016-09-06 13:19:27 +00:00
|
|
|
size_t ProcessBlock(float **inBlock, float **outBlock, size_t blockLen) override;
|
Automation: AudacityCommand
This is a squash of 50 commits.
This merges the capabilities of BatchCommands and Effects using a new
AudacityCommand class. AudacityCommand provides one function to specify the
parameters, and then we leverage that one function in automation, whether by chains,
mod-script-pipe or (future) Nyquist.
- Now have AudacityCommand which is using the same mechanism as Effect
- Has configurable parameters
- Has data-entry GUI (built using shuttle GUI)
- Registers with PluginManager.
- Menu commands now provided in chains, and to python batch.
- Tested with Zoom Toggle.
- ShuttleParams now can set, get, set defaults, validate and specify
the parameters.
- Bugfix: Don't overwrite values with defaults first time out.
- Add DefineParams function for all built-in effects.
- Extend CommandContext to carry output channels for results.
We abuse EffectsManager. It handles both Effects and
AudacityCommands now. In time an Effect should become a special case of
AudacityCommand and we'll split and rename the EffectManager class.
- Don't use 'default' as a parameter name.
- Massive renaming for CommandDefinitionInterface
- EffectIdentInterface becomes EffectDefinitionInterface
- EffectAutomationParameters becomes CommandAutomationParameters
- PluginType is now a bit field.
This way we can search for related types at the same time.
- Most old batch commands made into AudacityCommands.
The ones that weren't are for a reason. They are used by mod-script-pipe
to carry commands and responses across from a non-GUI thread to the GUI
thread.
- Major tidy up of ScreenshotCommand
- Reworking of SelectCommand
- GetPreferenceCommand and SetPreferenceCommand
- GetTrackInfo and SetTrackInfo
- GetInfoCommand
- Help, Open, Save, Import and Export commands.
- Removed obsolete commands ExecMenu, GetProjectInfo and SetProjectInfo
which are now better handled by other commands.
- JSONify "GetInfo: Commands" output, i.e. commas in the right places.
- General work on better Doxygen.
- Lyrics -> LyricsPanel
- Meter -> MeterPanel
- Updated Linux makefile.
- Scripting commands added into Extra menu.
- Distinct names for previously duplicated find-clipping parameters.
- Fixed longstanding error with erroneous status field number which
previously caused an ASSERT in debug.
- Sensible formatting of numbers in Chains, 0.1 not 0.1000000000137
2018-01-14 18:51:41 +00:00
|
|
|
bool DefineParams( ShuttleParams & S ) override;
|
2018-02-21 14:24:25 +00:00
|
|
|
bool GetAutomationParameters(CommandParameters & parms) override;
|
|
|
|
bool SetAutomationParameters(CommandParameters & parms) override;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// Effect implementation
|
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
bool Startup() override;
|
|
|
|
bool Init() override;
|
|
|
|
void PopulateOrExchange(ShuttleGui & S) override;
|
|
|
|
bool TransferDataToWindow() override;
|
|
|
|
bool TransferDataFromWindow() override;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
|
|
|
private:
|
2015-04-17 03:53:42 +00:00
|
|
|
// EffectScienFilter implementation
|
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
bool TransferGraphLimitsFromWindow();
|
2018-08-04 20:45:20 +00:00
|
|
|
void CalcFilter();
|
2015-04-17 03:53:42 +00:00
|
|
|
float FilterMagnAtFreq(float Freq);
|
|
|
|
void EnableDisableRippleCtl (int FilterType);
|
|
|
|
|
|
|
|
void OnSize( wxSizeEvent & evt );
|
|
|
|
void OnSlider( wxCommandEvent & evt );
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnOrder( wxCommandEvent & evt );
|
|
|
|
void OnCutoff( wxCommandEvent & evt );
|
|
|
|
void OnRipple( wxCommandEvent & evt );
|
|
|
|
void OnStopbandRipple( wxCommandEvent & evt );
|
|
|
|
void OnFilterType( wxCommandEvent & evt );
|
|
|
|
void OnFilterSubtype( wxCommandEvent & evt );
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnSliderDBMAX( wxCommandEvent & evt );
|
|
|
|
void OnSliderDBMIN( wxCommandEvent & evt );
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
private:
|
2013-10-02 10:32:41 +00:00
|
|
|
float mCutoff;
|
|
|
|
float mRipple;
|
|
|
|
float mStopbandRipple;
|
|
|
|
int mFilterType; // Butterworth etc.
|
|
|
|
int mFilterSubtype; // lowpass, highpass
|
2015-04-17 03:53:42 +00:00
|
|
|
int mOrder;
|
|
|
|
int mOrderIndex;
|
2018-07-24 15:08:47 +00:00
|
|
|
ArrayOf<Biquad> mpBiquad;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
|
|
|
double mdBMax;
|
|
|
|
double mdBMin;
|
|
|
|
bool mEditingBatchParams;
|
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
double mLoFreq;
|
|
|
|
double mNyquist;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
EffectScienFilterPanel *mPanel;
|
|
|
|
wxSlider *mdBMinSlider;
|
|
|
|
wxSlider *mdBMaxSlider;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
wxStaticText *mRippleCtlP;
|
|
|
|
wxTextCtrl *mRippleCtl;
|
|
|
|
wxStaticText *mRippleCtlU;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
wxTextCtrl *mCutoffCtl;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
wxStaticText *mStopbandRippleCtlP;
|
|
|
|
wxTextCtrl *mStopbandRippleCtl;
|
|
|
|
wxStaticText *mStopbandRippleCtlU;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
wxChoice *mFilterTypeCtl;
|
|
|
|
wxChoice *mFilterSubTypeCtl;
|
|
|
|
wxChoice *mFilterOrderCtl;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
RulerPanel *mdBRuler;
|
|
|
|
RulerPanel *mfreqRuler;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2016-09-18 14:26:29 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
friend class EffectScienFilterPanel;
|
2013-10-02 10:32:41 +00:00
|
|
|
};
|
|
|
|
|
2016-06-25 18:18:23 +00:00
|
|
|
class EffectScienFilterPanel final : public wxPanelWrapper
|
2013-10-02 10:32:41 +00:00
|
|
|
{
|
|
|
|
public:
|
2017-10-20 16:06:29 +00:00
|
|
|
EffectScienFilterPanel(
|
2017-11-03 13:13:06 +00:00
|
|
|
wxWindow *parent, wxWindowID winid,
|
|
|
|
EffectScienFilter *effect, double lo, double hi);
|
2015-04-17 03:53:42 +00:00
|
|
|
virtual ~EffectScienFilterPanel();
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// We don't need or want to accept focus.
|
|
|
|
bool AcceptsFocus() const;
|
2015-11-26 15:21:48 +00:00
|
|
|
// So that wxPanel is not included in Tab traversal - see wxWidgets bug 15581
|
|
|
|
bool AcceptsFocusFromKeyboard() const;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void SetFreqRange(double lo, double hi);
|
|
|
|
void SetDbRange(double min, double max);
|
2013-10-02 10:32:41 +00:00
|
|
|
|
|
|
|
private:
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnPaint(wxPaintEvent & evt);
|
|
|
|
void OnSize(wxSizeEvent & evt);
|
|
|
|
|
2013-10-02 10:32:41 +00:00
|
|
|
private:
|
2015-04-17 03:53:42 +00:00
|
|
|
EffectScienFilter *mEffect;
|
|
|
|
wxWindow *mParent;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
|
|
|
double mLoFreq;
|
2015-04-17 03:53:42 +00:00
|
|
|
double mHiFreq;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
double mDbMin;
|
|
|
|
double mDbMax;
|
2014-01-03 00:58:30 +00:00
|
|
|
|
2016-08-04 11:33:22 +00:00
|
|
|
std::unique_ptr<wxBitmap> mBitmap;
|
2015-04-17 03:53:42 +00:00
|
|
|
wxRect mEnvRect;
|
|
|
|
int mWidth;
|
|
|
|
int mHeight;
|
|
|
|
|
|
|
|
friend class EffectScienFilter;
|
2013-10-02 10:32:41 +00:00
|
|
|
|
2016-09-18 14:26:29 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
2013-10-02 10:32:41 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|