25#include <wx/dcclient.h>
26#include <wx/dcmemory.h>
32#include "../ShuttleGui.h"
34#include "../widgets/valnum.h"
36#include "../WaveTrack.h"
37#include "../widgets/AudacityMessageBox.h"
86 Parameters().Reset(*
this);
88 SetLinearEffectFlag(
true);
108 return XO(
"Reduces (ducks) the volume of one or more tracks whenever the volume of a specified \"control\" track reaches a particular level");
129 bool lastWasSelectedWaveTrack =
false;
130 const WaveTrack *controlTrackCandidate = NULL;
134 if (lastWasSelectedWaveTrack && !t->GetSelected()) {
136 controlTrackCandidate = track_cast<const WaveTrack *>(t);
139 lastWasSelectedWaveTrack =
false;
141 if (t->GetSelected()) {
142 bool ok = t->TypeSwitch<
bool>(
144 lastWasSelectedWaveTrack =
true;
152 XO(
"You selected a track which does not contain audio. AutoDuck can only process audio tracks."),
162 if (!controlTrackCandidate)
168 XO(
"Auto Duck needs a control track which must be placed below the selected track(s)."),
201 auto minSamplesPause =
213 std::vector<AutoDuckRegion> regions;
214 bool inDuckRegion =
false;
221 double duckRegionStart = 0;
232 for (
auto i = pos; i < pos + len; i++)
234 rmsSum -= rmsWindow[rmsPos];
236 auto index = ( i - pos ).as_size_t();
237 rmsWindow[rmsPos] = buf[ index ] * buf[ index ];
238 rmsSum += rmsWindow[rmsPos];
241 bool thresholdExceeded = rmsSum > threshold;
243 if (thresholdExceeded)
258 if (!thresholdExceeded && inDuckRegion)
263 curSamplesPause += 1;
265 if (curSamplesPause >= minSamplesPause)
268 double duckRegionEnd =
275 inDuckRegion =
false;
283 (pos - start).as_double() /
284 (
end - start).as_double() /
296 double duckRegionEnd =
312 for (
size_t i = 0; i < regions.size(); i++)
337 S.StartVerticalLay(
true);
346 S.StartMultiColumn(6, wxCENTER);
351 .NameSuffix(
XO(
"db"))
352 .AddTextBox(
XXO(
"Duck &amount:"), wxT(
""), 10);
353 S.AddUnits(
XO(
"dB"));
358 .NameSuffix(
XO(
"seconds"))
359 .AddTextBox(
XXO(
"Ma&ximum pause:"), wxT(
""), 10);
360 S.AddUnits(
XO(
"seconds"));
365 .NameSuffix(
XO(
"seconds"))
366 .AddTextBox(
XXO(
"Outer fade &down length:"), wxT(
""), 10);
367 S.AddUnits(
XO(
"seconds"));
372 .NameSuffix(
XO(
"seconds"))
373 .AddTextBox(
XXO(
"Outer fade &up length:"), wxT(
""), 10);
374 S.AddUnits(
XO(
"seconds"));
379 .NameSuffix(
XO(
"seconds"))
380 .AddTextBox(
XXO(
"Inner fade d&own length:"), wxT(
""), 10);
381 S.AddUnits(
XO(
"seconds"));
386 .NameSuffix(
XO(
"seconds"))
387 .AddTextBox(
XXO(
"Inner &fade up length:"), wxT(
""), 10);
388 S.AddUnits(
XO(
"seconds"));
392 S.StartMultiColumn(3, wxCENTER);
395 2, &
mThresholdDb, NumValidatorStyle::NO_TRAILING_ZEROES,
397 .NameSuffix(
XO(
"db"))
398 .AddTextBox(
XXO(
"&Threshold:"), wxT(
""), 10);
399 S.AddUnits(
XO(
"dB"));
424 double t0,
double t1)
436 if (fadeDownSamples < 1)
441 if (fadeUpSamples < 1)
444 float fadeDownStep =
mDuckAmountDb / fadeDownSamples.as_double();
445 float fadeUpStep =
mDuckAmountDb / fadeUpSamples.as_double();
453 for (
auto i = pos; i < pos + len; i++)
455 float gainDown = fadeDownStep * (i - start).as_float();
456 float gainUp = fadeUpStep * (
end - i).as_float();
459 if (gainDown > gainUp)
475 float fractionFinished = (curTime -
mT0) / (
mT1 -
mT0);
496#define CONTROL_POINT_REGION 10
497#define CONTROL_POINT_MIN_MOVE 5
499#define TEXT_DISTANCE 15
501#define FADE_DOWN_START 150
502#define FADE_UP_START 450
503#define DUCK_AMOUNT_START 50
506#define DUCK_AMOUNT_SCALE 8
508static int GetDistance(
const wxPoint& first,
const wxPoint& second)
510 int distanceX = abs(first.x - second.x);
511 int distanceY = abs(first.y - second.y);
512 if (distanceX > distanceY)
529:
wxPanelWrapper(parent, winid, wxDefaultPosition, wxSize(600, 300))
533 mCurrentControlPoint =
none;
534 mBackgroundBitmap = NULL;
536 ResetControlPoints();
547 mControlPoints[innerFadeDown] = wxPoint(-100,-100);
548 mControlPoints[innerFadeUp] = wxPoint(-100,-100);
549 mControlPoints[outerFadeDown] = wxPoint(-100,-100);
550 mControlPoints[outerFadeUp] = wxPoint(-100,-100);
551 mControlPoints[duckAmount] = wxPoint(-100,-100);
556 int clientWidth, clientHeight;
557 GetSize(&clientWidth, &clientHeight);
559 if (!mBackgroundBitmap || mBackgroundBitmap->GetWidth() != clientWidth ||
560 mBackgroundBitmap->GetHeight() != clientHeight)
562 mBackgroundBitmap = std::make_unique<wxBitmap>(clientWidth, clientHeight,24);
566 dc.SelectObject(*mBackgroundBitmap);
568 dc.SetBrush(*wxWHITE_BRUSH);
569 dc.SetPen(*wxBLACK_PEN);
570 dc.DrawRectangle(0, 0, clientWidth, clientHeight);
572 dc.SetFont(wxFont(10, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL,
573 wxFONTWEIGHT_NORMAL));
574 dc.SetTextForeground(*wxBLACK);
575 dc.SetTextBackground(*wxWHITE);
577 double duckAmountDb = 0;
578 double innerFadeDownLen = 0;
579 double innerFadeUpLen = 0;
580 double outerFadeDownLen = 0;
581 double outerFadeUpLen = 0;
582 mEffect->mDuckAmountDbBox->GetValue().ToDouble(&duckAmountDb);
583 mEffect->mInnerFadeDownLenBox->GetValue().ToDouble(&innerFadeDownLen);
584 mEffect->mInnerFadeUpLenBox->GetValue().ToDouble(&innerFadeUpLen);
585 mEffect->mOuterFadeDownLenBox->GetValue().ToDouble(&outerFadeDownLen);
586 mEffect->mOuterFadeUpLenBox->GetValue().ToDouble(&outerFadeUpLen);
595 wxString message =
_(
"Preview not available");
596 int textWidth = 0, textHeight = 0;
597 dc.GetTextExtent(message, &textWidth, &textHeight);
598 dc.DrawText(message, (clientWidth - textWidth) / 2,
599 (clientHeight - textHeight) / 2);
601 ResetControlPoints();
605 dc.SetBrush(*wxTRANSPARENT_BRUSH);
606 dc.SetPen(wxPen(
theTheme.
Colour(clrGraphLines), 3, wxPENSTYLE_SOLID));
627 points[5].x = clientWidth - 10;
632 dc.SetPen(wxPen(*wxBLACK, 1, wxPENSTYLE_DOT));
638 dc.SetBrush(*wxWHITE_BRUSH);
640 mControlPoints[outerFadeDown] = points[1];
641 mControlPoints[innerFadeDown] = points[2];
642 mControlPoints[innerFadeUp] = points[3];
643 mControlPoints[outerFadeUp] = points[4];
644 mControlPoints[duckAmount] = wxPoint(
645 (points[2].x + points[3].x) / 2, points[2].y);
653 if (cp == innerFadeDown)
655 value = innerFadeDownLen;
658 else if (cp == innerFadeUp)
660 value = innerFadeUpLen;
663 else if (cp == outerFadeDown)
665 value = outerFadeDownLen;
667 }
else if (cp == outerFadeUp)
669 value = outerFadeUpLen;
674 value = duckAmountDb;
679 valueStr += wxT(
" ");
681 if (cp == duckAmount)
688 int textWidth = 0, textHeight = 0;
689 GetTextExtent(valueStr, &textWidth, &textHeight);
691 int textPosX = mControlPoints[i].x - textWidth / 2;
692 int textPosY = mControlPoints[i].y;
694 if (cp == duckAmount || cp == outerFadeDown || cp == outerFadeUp)
699 dc.DrawText(valueStr, textPosX, textPosY);
701 dc.DrawEllipse(mControlPoints[i].x - 3,
702 mControlPoints[i].y - 3, 6, 6);
707 wxPaintDC paintDC(
this);
708 paintDC.Blit(0, 0, clientWidth, clientHeight, &dc, 0, 0);
711 dc.SetPen(wxNullPen);
712 dc.SetBrush(wxNullBrush);
713 dc.SetFont(wxNullFont);
714 dc.SelectObject(wxNullBitmap);
718 wxMouseCaptureChangedEvent & WXUNUSED(evt))
720 SetCursor(wxNullCursor);
721 mCurrentControlPoint =
none;
725 wxMouseCaptureLostEvent & WXUNUSED(evt))
727 mCurrentControlPoint =
none;
746 if (dist[i] < dist[curMinimum])
757 EControlPoint nearest = GetNearestControlPoint(evt.GetPosition());
762 mMouseDownPoint = evt.GetPosition();
764 mCurrentControlPoint = nearest;
765 mControlPointMoveActivated =
false;
768 mMoveStartControlPoints[i] = mControlPoints[i];
777 if (mCurrentControlPoint !=
none)
779 mCurrentControlPoint =
none;
786 switch (GetNearestControlPoint(evt.GetPosition()))
789 SetCursor(wxNullCursor);
795 SetCursor(wxCursor(wxCURSOR_SIZEWE));
798 SetCursor(wxCursor(wxCURSOR_SIZENS));
802 if (mCurrentControlPoint !=
none)
804 if (!mControlPointMoveActivated)
808 if (mCurrentControlPoint == duckAmount)
809 dist = abs(evt.GetY() - mMouseDownPoint.y);
811 dist = abs(evt.GetX() - mMouseDownPoint.x);
814 mControlPointMoveActivated =
true;
817 if (mControlPointMoveActivated)
821 switch (mCurrentControlPoint)
846 mEffect->DoTransferDataToWindow();
static const size_t kBufSize
#define CONTROL_POINT_REGION
static const size_t kRMSWindowSize
static int GetDistance(const wxPoint &first, const wxPoint &second)
#define DUCK_AMOUNT_SCALE
#define DUCK_AMOUNT_START
#define CONTROL_POINT_MIN_MOVE
#define AUTO_DUCK_PANEL_NUM_CONTROL_POINTS
size_t limitSampleBufferSize(size_t bufferSize, sampleCount limit)
static void Line(wxDC &dc, wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
static void Lines(wxDC &dc, size_t nPoints, const wxPoint points[])
Generates EffectParameterMethods overrides from variadic template arguments.
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
EControlPoint GetNearestControlPoint(const wxPoint &pt)
void OnMotion(wxMouseEvent &evt)
void OnLeftDown(wxMouseEvent &evt)
void OnMouseCaptureChanged(wxMouseCaptureChangedEvent &evt)
void OnLeftUp(wxMouseEvent &evt)
void ResetControlPoints()
void OnPaint(wxPaintEvent &evt)
void OnMouseCaptureLost(wxMouseCaptureLostEvent &evt)
Implements the Auto Ducking effect.
static constexpr EffectParameter InnerFadeDownLen
wxTextCtrl * mInnerFadeUpLenBox
ComponentInterfaceSymbol GetSymbol() const override
static constexpr EffectParameter InnerFadeUpLen
wxTextCtrl * mInnerFadeDownLenBox
static constexpr EffectParameter OuterFadeDownLen
wxTextCtrl * mOuterFadeDownLenBox
bool Init() override
Call once to set up state for whole list of tracks to be processed.
const WaveTrack * mControlTrack
bool ApplyDuckFade(int trackNum, WaveTrack *t, double t0, double t1)
static constexpr EffectParameter MaximumPause
bool DoTransferDataToWindow()
wxTextCtrl * mThresholdDbBox
static constexpr EffectParameter ThresholdDb
std::unique_ptr< EffectUIValidator > PopulateOrExchange(ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
Add controls to effect panel; always succeeds.
const EffectParameterMethods & Parameters() const override
bool TransferDataToWindow(const EffectSettings &settings) override
Update controls for the settings.
virtual ~EffectAutoDuck()
void OnValueChanged(wxCommandEvent &evt)
static constexpr EffectParameter DuckAmountDb
EffectType GetType() const override
Type determines how it behaves.
static constexpr EffectParameter OuterFadeUpLen
bool Process(EffectInstance &instance, EffectSettings &settings) override
Actually do the effect here.
wxTextCtrl * mMaximumPauseBox
ManualPageID ManualPage() const override
Name of a page in the Audacity alpha manual, default is empty.
static const ComponentInterfaceSymbol Symbol
TranslatableString GetDescription() const override
wxTextCtrl * mOuterFadeUpLenBox
wxTextCtrl * mDuckAmountDbBox
std::shared_ptr< TrackList > mOutputTracks
const TrackList * inputTracks() const
void ReplaceProcessedTracks(const bool bGoodResult)
void CopyInputTracks(bool allSyncLockSelected=false)
int MessageBox(const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
bool TotalProgress(double frac, const TranslatableString &={}) const
int GetNumWaveTracks() const
Performs effect computation.
Interface for manipulations of an Effect's settings.
static wxString ToDisplayString(double numberToConvert, int digitsAfterDecimalPoint=-1)
Convert a number to a string, uses the user's locale's decimal separator.
bool GetFloats(float *buffer, sampleCount start, size_t len, fillFormat fill=fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
Retrieve samples from a track in floating-point format, regardless of the storage format.
double LongSamplesToTime(sampleCount pos) const
Convert correctly between a number of samples and an (absolute) time in seconds.
sampleCount TimeToLongSamples(double t0) const
Convert correctly between an (absolute) time in seconds and a number of samples.
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
wxColour & Colour(int iIndex)
Abstract base class for an object holding data associated with points on a time axis.
Holds a msgid for the translation catalog; may also bind format arguments.
A Track that contains audio waveform data.
void Set(constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len)
Positions or offsets within audio files need a wide type.
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
BuiltinEffectsModule::Registration< EffectAutoDuck > reg
a struct that holds a start and end time.
AutoDuckRegion(double t0, double t1)
const Type min
Minimum value.
const Type max
Maximum value.
Externalized state of a plug-in.