2010-01-23 19:44:49 +00:00
|
|
|
/**********************************************************************
|
|
|
|
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
|
|
|
|
Wahwah
|
|
|
|
|
|
|
|
Effect programming:
|
2013-06-21 22:23:47 +00:00
|
|
|
Nasca Octavian Paul (Paul Nasca)
|
2010-01-23 19:44:49 +00:00
|
|
|
|
|
|
|
UI programming:
|
|
|
|
Dominic Mazzoni (with the help of wxDesigner)
|
|
|
|
Vaughan Johnson (Preview)
|
|
|
|
|
|
|
|
**********************************************************************/
|
|
|
|
|
|
|
|
#ifndef __AUDACITY_EFFECT_WAHWAH__
|
|
|
|
#define __AUDACITY_EFFECT_WAHWAH__
|
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
#include "Effect.h"
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2018-11-11 21:18:23 +00:00
|
|
|
class wxSlider;
|
2018-11-11 21:11:18 +00:00
|
|
|
class wxTextCtrl;
|
2015-06-18 14:24:36 +00:00
|
|
|
class ShuttleGui;
|
|
|
|
|
2015-08-01 12:03:02 +00:00
|
|
|
class EffectWahwahState
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
float samplerate;
|
|
|
|
double depth;
|
|
|
|
double freqofs;
|
|
|
|
double phase;
|
2015-08-03 19:07:17 +00:00
|
|
|
double outgain;
|
2015-08-01 12:03:02 +00:00
|
|
|
double lfoskip;
|
|
|
|
unsigned long skipcount;
|
|
|
|
double xn1, xn2, yn1, yn2;
|
|
|
|
double b0, b1, b2, a0, a1, a2;
|
|
|
|
};
|
|
|
|
|
2016-02-24 06:06:39 +00:00
|
|
|
class EffectWahwah final : public Effect
|
2015-04-17 03:53:42 +00:00
|
|
|
{
|
|
|
|
public:
|
2019-01-17 22:33:49 +00:00
|
|
|
static const ComponentInterfaceSymbol Symbol;
|
|
|
|
|
2010-01-23 19:44:49 +00:00
|
|
|
EffectWahwah();
|
2015-04-17 03:53:42 +00:00
|
|
|
virtual ~EffectWahwah();
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2018-11-02 15:31:44 +00:00
|
|
|
// ComponentInterface implementation
|
2014-06-03 20:30:19 +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;
|
2010-01-23 19:44:49 +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
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
EffectType GetType() override;
|
|
|
|
bool SupportsRealtime() override;
|
2014-06-03 20:30:19 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// EffectClientInterface implementation
|
2010-01-23 19:44:49 +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;
|
2016-02-24 06:06:47 +00:00
|
|
|
bool RealtimeInitialize() override;
|
2016-09-02 19:53:09 +00:00
|
|
|
bool RealtimeAddProcessor(unsigned numChannels, float sampleRate) override;
|
2016-02-24 06:06:47 +00:00
|
|
|
bool RealtimeFinalize() override;
|
2016-09-06 13:19:27 +00:00
|
|
|
size_t RealtimeProcess(int group,
|
2015-08-01 12:03:02 +00:00
|
|
|
float **inbuf,
|
|
|
|
float **outbuf,
|
2016-09-06 13:19:27 +00:00
|
|
|
size_t numSamples) 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;
|
2014-06-03 20:30:19 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// Effect implementation
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
void PopulateOrExchange(ShuttleGui & S) override;
|
|
|
|
bool TransferDataToWindow() override;
|
|
|
|
bool TransferDataFromWindow() override;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
private:
|
|
|
|
// EffectWahwah implementation
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-08-01 12:03:02 +00:00
|
|
|
void InstanceInit(EffectWahwahState & data, float sampleRate);
|
2016-09-06 13:19:27 +00:00
|
|
|
size_t InstanceProcess(EffectWahwahState & data, float **inBlock, float **outBlock, size_t blockLen);
|
2015-08-01 12:03:02 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnFreqSlider(wxCommandEvent & evt);
|
|
|
|
void OnPhaseSlider(wxCommandEvent & evt);
|
|
|
|
void OnDepthSlider(wxCommandEvent & evt);
|
|
|
|
void OnResonanceSlider(wxCommandEvent & evt);
|
|
|
|
void OnFreqOffSlider(wxCommandEvent & evt);
|
2015-08-03 19:07:17 +00:00
|
|
|
void OnGainSlider(wxCommandEvent & evt);
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnFreqText(wxCommandEvent & evt);
|
|
|
|
void OnPhaseText(wxCommandEvent & evt);
|
|
|
|
void OnDepthText(wxCommandEvent & evt);
|
|
|
|
void OnResonanceText(wxCommandEvent & evt);
|
|
|
|
void OnFreqOffText(wxCommandEvent & evt);
|
2015-08-03 19:07:17 +00:00
|
|
|
void OnGainText(wxCommandEvent & evt);
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
private:
|
2015-08-01 12:03:02 +00:00
|
|
|
EffectWahwahState mMaster;
|
2018-02-02 18:24:53 +00:00
|
|
|
std::vector<EffectWahwahState> mSlaves;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-08-01 12:03:02 +00:00
|
|
|
/* Parameters:
|
2015-04-17 03:53:42 +00:00
|
|
|
mFreq - LFO frequency
|
|
|
|
mPhase - LFO startphase in RADIANS - useful for stereo WahWah
|
|
|
|
mDepth - Wah depth
|
|
|
|
mRes - Resonance
|
|
|
|
mFreqOfs - Wah frequency offset
|
2015-08-03 19:07:17 +00:00
|
|
|
mOutGain - output gain
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
!!!!!!!!!!!!! IMPORTANT!!!!!!!!! :
|
|
|
|
mDepth and mFreqOfs should be from 0(min) to 1(max) !
|
|
|
|
mRes should be greater than 0 ! */
|
|
|
|
|
|
|
|
double mFreq;
|
|
|
|
double mPhase;
|
|
|
|
int mDepth;
|
|
|
|
double mRes;
|
|
|
|
int mFreqOfs;
|
2015-08-03 19:07:17 +00:00
|
|
|
double mOutGain;
|
2015-04-17 03:53:42 +00:00
|
|
|
|
|
|
|
wxTextCtrl *mFreqT;
|
|
|
|
wxTextCtrl *mPhaseT;
|
|
|
|
wxTextCtrl *mDepthT;
|
|
|
|
wxTextCtrl *mResT;
|
|
|
|
wxTextCtrl *mFreqOfsT;
|
2015-08-03 19:07:17 +00:00
|
|
|
wxTextCtrl *mOutGainT;
|
2015-04-17 03:53:42 +00:00
|
|
|
|
|
|
|
wxSlider *mFreqS;
|
|
|
|
wxSlider *mPhaseS;
|
|
|
|
wxSlider *mDepthS;
|
|
|
|
wxSlider *mResS;
|
|
|
|
wxSlider *mFreqOfsS;
|
2015-08-03 19:07:17 +00:00
|
|
|
wxSlider *mOutGainS;
|
2015-04-17 03:53:42 +00:00
|
|
|
|
2016-09-18 14:26:29 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
2010-01-23 19:44:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|