1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-27 14:09:33 +02:00
audacity/src/effects/AutoDuck.h
James Crook 1c988b4e3a 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-02-24 14:20:22 -05:00

142 lines
3.5 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
AutoDuck.h
Markus Meyer
**********************************************************************/
#ifndef __AUDACITY_EFFECT_AUTODUCK__
#define __AUDACITY_EFFECT_AUTODUCK__
#include <wx/bitmap.h>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <wx/textctrl.h>
#include <wx/window.h>
#include "Effect.h"
#include "../widgets/wxPanelWrapper.h"
class EffectAutoDuckPanel;
class ShuttleGui;
#define AUTO_DUCK_PANEL_NUM_CONTROL_POINTS 5
#define AUTODUCK_PLUGIN_SYMBOL XO("Auto Duck")
class EffectAutoDuck final : public Effect
{
public:
EffectAutoDuck();
virtual ~EffectAutoDuck();
// IdentInterface implementation
wxString GetSymbol() override;
wxString GetDescription() override;
wxString ManualPage() override;
// EffectDefinitionInterface implementation
EffectType GetType() override;
// EffectClientInterface implementation
bool DefineParams( ShuttleParams & S ) override;
bool GetAutomationParameters(CommandAutomationParameters & parms) override;
bool SetAutomationParameters(CommandAutomationParameters & parms) override;
// Effect implementation
bool Startup() override;
bool Init() override;
void End() override;
bool Process() override;
void PopulateOrExchange(ShuttleGui & S) override;
bool TransferDataToWindow() override;
bool TransferDataFromWindow() override;
private:
// EffectAutoDuck implementation
bool ApplyDuckFade(int trackNumber, WaveTrack *t, double t0, double t1);
void OnValueChanged(wxCommandEvent & evt);
private:
double mDuckAmountDb;
double mInnerFadeDownLen;
double mInnerFadeUpLen;
double mOuterFadeDownLen;
double mOuterFadeUpLen;
double mThresholdDb;
double mMaximumPause;
const WaveTrack *mControlTrack;
wxTextCtrl *mDuckAmountDbBox;
wxTextCtrl *mInnerFadeDownLenBox;
wxTextCtrl *mInnerFadeUpLenBox;
wxTextCtrl *mOuterFadeDownLenBox;
wxTextCtrl *mOuterFadeUpLenBox;
wxTextCtrl *mThresholdDbBox;
wxTextCtrl *mMaximumPauseBox;
EffectAutoDuckPanel *mPanel;
DECLARE_EVENT_TABLE()
friend class EffectAutoDuckPanel;
};
class EffectAutoDuckPanel final : public wxPanelWrapper
{
public:
EffectAutoDuckPanel(
wxWindow *parent, wxWindowID winid, EffectAutoDuck *effect);
virtual ~EffectAutoDuckPanel();
private:
enum EControlPoint
{
innerFadeDown = 0,
outerFadeDown,
innerFadeUp,
outerFadeUp,
duckAmount,
none = 99,
};
bool AcceptsFocus() const override { return false; }
// So that wxPanel is not included in Tab traversal - see wxWidgets bug 15581
bool AcceptsFocusFromKeyboard() const override { return false; }
void OnPaint(wxPaintEvent & evt);
void OnMouseCaptureChanged(wxMouseCaptureChangedEvent & evt);
void OnMouseCaptureLost(wxMouseCaptureLostEvent & evt);
void OnLeftDown(wxMouseEvent & evt);
void OnLeftUp(wxMouseEvent & evt);
void OnMotion(wxMouseEvent & evt);
void ResetControlPoints();
EControlPoint GetNearestControlPoint(const wxPoint & pt);
private:
wxWindow *mParent;
EffectAutoDuck *mEffect;
std::unique_ptr<wxBitmap> mBackgroundBitmap;
EControlPoint mCurrentControlPoint;
wxPoint mControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS];
wxPoint mMoveStartControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS];
wxPoint mMouseDownPoint;
bool mControlPointMoveActivated;
DECLARE_EVENT_TABLE()
};
#endif