Audacity 3.2.0
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
EffectAutoDuck::Panel Class Referencefinal

#include <AutoDuck.h>

Inheritance diagram for EffectAutoDuck::Panel:
[legend]
Collaboration diagram for EffectAutoDuck::Panel:
[legend]

Public Member Functions

 Panel (wxWindow *parent, wxWindowID winid, EffectAutoDuck *effect)
 
virtual ~Panel ()
 
- Public Member Functions inherited from wxPanelWrapper
 wxPanelWrapper ()
 
 wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
 
bool Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
 
void SetLabel (const TranslatableString &label)
 
void SetName (const TranslatableString &name)
 
void SetToolTip (const TranslatableString &toolTip)
 
void SetName ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
 wxTabTraversalWrapper (Args &&... args)
 
 wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
 
 wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete
 

Private Types

enum  EControlPoint {
  innerFadeDown = 0 , outerFadeDown , innerFadeUp , outerFadeUp ,
  duckAmount , none = 99
}
 

Private Member Functions

bool AcceptsFocus () const override
 
bool AcceptsFocusFromKeyboard () const override
 
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 Attributes

wxWindow * mParent
 
EffectAutoDuckmEffect
 
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
 

Detailed Description

Definition at line 107 of file AutoDuck.h.

Member Enumeration Documentation

◆ EControlPoint

Enumerator
innerFadeDown 
outerFadeDown 
innerFadeUp 
outerFadeUp 
duckAmount 
none 

Definition at line 115 of file AutoDuck.h.

Constructor & Destructor Documentation

◆ Panel()

EffectAutoDuck::Panel::Panel ( wxWindow *  parent,
wxWindowID  winid,
EffectAutoDuck effect 
)

Definition at line 562 of file AutoDuck.cpp.

564: wxPanelWrapper(parent, winid, wxDefaultPosition, wxSize(600, 300))
565{
566 mParent = parent;
567 mEffect = effect;
569 mBackgroundBitmap = NULL;
570
572}
std::unique_ptr< wxBitmap > mBackgroundBitmap
Definition: AutoDuck.h:143
wxWindow * mParent
Definition: AutoDuck.h:141
EControlPoint mCurrentControlPoint
Definition: AutoDuck.h:144
EffectAutoDuck * mEffect
Definition: AutoDuck.h:142

References none.

◆ ~Panel()

EffectAutoDuck::Panel::~Panel ( )
virtual

Definition at line 574 of file AutoDuck.cpp.

575{
576 if(HasCapture())
577 ReleaseMouse();
578}

Member Function Documentation

◆ AcceptsFocus()

bool EffectAutoDuck::Panel::AcceptsFocus ( ) const
inlineoverrideprivate

Definition at line 125 of file AutoDuck.h.

125{ return false; }

◆ AcceptsFocusFromKeyboard()

bool EffectAutoDuck::Panel::AcceptsFocusFromKeyboard ( ) const
inlineoverrideprivate

Definition at line 127 of file AutoDuck.h.

127{ return false; }

◆ GetNearestControlPoint()

EffectAutoDuck::Panel::EControlPoint EffectAutoDuck::Panel::GetNearestControlPoint ( const wxPoint &  pt)
private

Definition at line 771 of file AutoDuck.cpp.

772{
774 int i;
775
776 for (i = 0; i < AUTO_DUCK_PANEL_NUM_CONTROL_POINTS; i++)
777 dist[i] = GetDistance(pt, mControlPoints[i]);
778
779 int curMinimum = 0;
780 for (i = 0; i < AUTO_DUCK_PANEL_NUM_CONTROL_POINTS; i++)
781 if (dist[i] < dist[curMinimum])
782 curMinimum = i;
783
784 if (dist[curMinimum] <= CONTROL_POINT_REGION)
785 return (EControlPoint)curMinimum;
786 else
787 return none;
788}
#define CONTROL_POINT_REGION
Definition: AutoDuck.cpp:531
static int GetDistance(const wxPoint &first, const wxPoint &second)
Definition: AutoDuck.cpp:543
#define AUTO_DUCK_PANEL_NUM_CONTROL_POINTS
Definition: AutoDuck.h:24
wxPoint mControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS]
Definition: AutoDuck.h:145

References AUTO_DUCK_PANEL_NUM_CONTROL_POINTS, CONTROL_POINT_REGION, GetDistance(), and none.

Here is the call graph for this function:

◆ OnLeftDown()

void EffectAutoDuck::Panel::OnLeftDown ( wxMouseEvent &  evt)
private

Definition at line 790 of file AutoDuck.cpp.

791{
792 EControlPoint nearest = GetNearestControlPoint(evt.GetPosition());
793
794 if (nearest != none)
795 {
796 // this control point has been clicked
797 mMouseDownPoint = evt.GetPosition();
798
799 mCurrentControlPoint = nearest;
801
802 for (int i = 0; i < AUTO_DUCK_PANEL_NUM_CONTROL_POINTS; i++)
804
805 if( !HasCapture() )
806 CaptureMouse();
807 }
808}
EControlPoint GetNearestControlPoint(const wxPoint &pt)
Definition: AutoDuck.cpp:771
bool mControlPointMoveActivated
Definition: AutoDuck.h:148
wxPoint mMouseDownPoint
Definition: AutoDuck.h:147
wxPoint mMoveStartControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS]
Definition: AutoDuck.h:146

References AUTO_DUCK_PANEL_NUM_CONTROL_POINTS, and none.

◆ OnLeftUp()

void EffectAutoDuck::Panel::OnLeftUp ( wxMouseEvent &  evt)
private

Definition at line 810 of file AutoDuck.cpp.

811{
813 {
815 ReleaseMouse();
816 }
817}

References none.

◆ OnMotion()

void EffectAutoDuck::Panel::OnMotion ( wxMouseEvent &  evt)
private

Definition at line 819 of file AutoDuck.cpp.

820{
821 switch (GetNearestControlPoint(evt.GetPosition()))
822 {
823 case none:
824 SetCursor(wxNullCursor);
825 break;
826 case innerFadeDown:
827 case innerFadeUp:
828 case outerFadeDown:
829 case outerFadeUp:
830 SetCursor(wxCursor(wxCURSOR_SIZEWE));
831 break;
832 case duckAmount:
833 SetCursor(wxCursor(wxCURSOR_SIZENS));
834 break;
835 }
836
838 {
840 {
841 int dist;
842
844 dist = abs(evt.GetY() - mMouseDownPoint.y);
845 else
846 dist = abs(evt.GetX() - mMouseDownPoint.x);
847
848 if (dist >= CONTROL_POINT_MIN_MOVE)
850 }
851
853 {
854 float newValue;
855
856 switch (mCurrentControlPoint)
857 {
858 case outerFadeDown:
859 newValue = ((double)(FADE_DOWN_START - evt.GetX())) / FADE_SCALE;
860 mEffect->mOuterFadeDownLen = std::clamp<double>(newValue, OuterFadeDownLen.min, OuterFadeDownLen.max);
861 break;
862 case outerFadeUp:
863 newValue = ((double)(evt.GetX() - FADE_UP_START)) / FADE_SCALE;
864 mEffect->mOuterFadeUpLen = std::clamp<double>(newValue, OuterFadeUpLen.min, OuterFadeUpLen.max);
865 break;
866 case innerFadeDown:
867 newValue = ((double)(evt.GetX() - FADE_DOWN_START)) / FADE_SCALE;
868 mEffect->mInnerFadeDownLen = std::clamp<double>(newValue, InnerFadeDownLen.min, InnerFadeDownLen.max);
869 break;
870 case innerFadeUp:
871 newValue = ((double)(FADE_UP_START - evt.GetX())) / FADE_SCALE;
872 mEffect->mInnerFadeUpLen = std::clamp<double>(newValue, InnerFadeUpLen.min, InnerFadeUpLen.max);
873 break;
874 case duckAmount:
875 newValue = ((double)(DUCK_AMOUNT_START - evt.GetY())) / DUCK_AMOUNT_SCALE;
876 mEffect->mDuckAmountDb = std::clamp<double>(newValue, DuckAmountDb.min, DuckAmountDb.max);
877 break;
878 case none:
879 wxASSERT(false); // should not happen
880 }
882 Refresh(false);
883 }
884 }
885}
#define FADE_DOWN_START
Definition: AutoDuck.cpp:536
#define FADE_UP_START
Definition: AutoDuck.cpp:537
#define FADE_SCALE
Definition: AutoDuck.cpp:540
#define DUCK_AMOUNT_SCALE
Definition: AutoDuck.cpp:541
#define DUCK_AMOUNT_START
Definition: AutoDuck.cpp:538
#define CONTROL_POINT_MIN_MOVE
Definition: AutoDuck.cpp:532
static constexpr EffectParameter InnerFadeDownLen
Definition: AutoDuck.h:93
double mInnerFadeDownLen
Definition: AutoDuck.h:68
static constexpr EffectParameter InnerFadeUpLen
Definition: AutoDuck.h:95
static constexpr EffectParameter OuterFadeDownLen
Definition: AutoDuck.h:97
bool DoTransferDataToWindow()
Definition: AutoDuck.cpp:435
double mDuckAmountDb
Definition: AutoDuck.h:67
double mInnerFadeUpLen
Definition: AutoDuck.h:69
static constexpr EffectParameter DuckAmountDb
Definition: AutoDuck.h:91
double mOuterFadeDownLen
Definition: AutoDuck.h:70
static constexpr EffectParameter OuterFadeUpLen
Definition: AutoDuck.h:99
double mOuterFadeUpLen
Definition: AutoDuck.h:71
const Type min
Minimum value.
const Type max
Maximum value.

References CONTROL_POINT_MIN_MOVE, DUCK_AMOUNT_SCALE, DUCK_AMOUNT_START, EffectAutoDuck::DuckAmountDb, FADE_DOWN_START, FADE_SCALE, FADE_UP_START, EffectAutoDuck::InnerFadeDownLen, EffectAutoDuck::InnerFadeUpLen, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, none, EffectAutoDuck::OuterFadeDownLen, and EffectAutoDuck::OuterFadeUpLen.

◆ OnMouseCaptureChanged()

void EffectAutoDuck::Panel::OnMouseCaptureChanged ( wxMouseCaptureChangedEvent &  evt)
private

Definition at line 752 of file AutoDuck.cpp.

754{
755 SetCursor(wxNullCursor);
757}

References none.

◆ OnMouseCaptureLost()

void EffectAutoDuck::Panel::OnMouseCaptureLost ( wxMouseCaptureLostEvent &  evt)
private

Definition at line 759 of file AutoDuck.cpp.

761{
763
764 if (HasCapture())
765 {
766 ReleaseMouse();
767 }
768}

References none.

◆ OnPaint()

void EffectAutoDuck::Panel::OnPaint ( wxPaintEvent &  evt)
private

Definition at line 589 of file AutoDuck.cpp.

590{
591 int clientWidth, clientHeight;
592 GetSize(&clientWidth, &clientHeight);
593
594 if (!mBackgroundBitmap || mBackgroundBitmap->GetWidth() != clientWidth ||
595 mBackgroundBitmap->GetHeight() != clientHeight)
596 {
597 mBackgroundBitmap = std::make_unique<wxBitmap>(clientWidth, clientHeight,24);
598 }
599
600 wxMemoryDC dc;
601 dc.SelectObject(*mBackgroundBitmap);
602
603 dc.SetBrush(*wxWHITE_BRUSH);
604 dc.SetPen(*wxBLACK_PEN);
605 dc.DrawRectangle(0, 0, clientWidth, clientHeight);
606
607 dc.SetFont(wxFont(10, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL,
608 wxFONTWEIGHT_NORMAL));
609 dc.SetTextForeground(*wxBLACK);
610 dc.SetTextBackground(*wxWHITE);
611
612 double duckAmountDb = 0;
613 double innerFadeDownLen = 0;
614 double innerFadeUpLen = 0;
615 double outerFadeDownLen = 0;
616 double outerFadeUpLen = 0;
617 mEffect->mDuckAmountDbBox->GetValue().ToDouble(&duckAmountDb);
618 mEffect->mInnerFadeDownLenBox->GetValue().ToDouble(&innerFadeDownLen);
619 mEffect->mInnerFadeUpLenBox->GetValue().ToDouble(&innerFadeUpLen);
620 mEffect->mOuterFadeDownLenBox->GetValue().ToDouble(&outerFadeDownLen);
621 mEffect->mOuterFadeUpLenBox->GetValue().ToDouble(&outerFadeUpLen);
622
623 if (innerFadeDownLen < InnerFadeDownLen.min || innerFadeDownLen > InnerFadeDownLen.max ||
624 innerFadeUpLen < InnerFadeUpLen.min || innerFadeUpLen > InnerFadeUpLen.max ||
625 outerFadeDownLen < OuterFadeDownLen.min || outerFadeDownLen > OuterFadeDownLen.max ||
626 outerFadeUpLen < OuterFadeUpLen.min || outerFadeUpLen > OuterFadeUpLen.max ||
627 duckAmountDb < DuckAmountDb.min || duckAmountDb > DuckAmountDb.max)
628 {
629 // values are out of range, no preview available
630 wxString message = _("Preview not available");
631 int textWidth = 0, textHeight = 0;
632 dc.GetTextExtent(message, &textWidth, &textHeight);
633 dc.DrawText(message, (clientWidth - textWidth) / 2,
634 (clientHeight - textHeight) / 2);
635
637 } else
638 {
639 // draw preview
640 dc.SetBrush(*wxTRANSPARENT_BRUSH);
641 dc.SetPen(wxPen(theTheme.Colour(clrGraphLines), 3, wxPENSTYLE_SOLID));
642
643 wxPoint points[6];
644
645 points[0].x = 10;
646 points[0].y = DUCK_AMOUNT_START;
647
648 points[1].x = FADE_DOWN_START - (int)(outerFadeDownLen * FADE_SCALE);
649 points[1].y = DUCK_AMOUNT_START;
650
651 points[2].x = FADE_DOWN_START + (int)(innerFadeDownLen * FADE_SCALE);
652 points[2].y = DUCK_AMOUNT_START -
653 (int)(duckAmountDb * DUCK_AMOUNT_SCALE);
654
655 points[3].x = FADE_UP_START - (int)(innerFadeUpLen * FADE_SCALE);
656 points[3].y = DUCK_AMOUNT_START -
657 (int)(duckAmountDb * DUCK_AMOUNT_SCALE);
658
659 points[4].x = FADE_UP_START + (int)(outerFadeUpLen * FADE_SCALE);
660 points[4].y = DUCK_AMOUNT_START;
661
662 points[5].x = clientWidth - 10;
663 points[5].y = DUCK_AMOUNT_START;
664
665 AColor::Lines(dc, 6, points);
666
667 dc.SetPen(wxPen(*wxBLACK, 1, wxPENSTYLE_DOT));
668
669 AColor::Line(dc, FADE_DOWN_START, 10, FADE_DOWN_START, clientHeight - 10);
670 AColor::Line(dc, FADE_UP_START, 10, FADE_UP_START, clientHeight - 10);
671
672 dc.SetPen(AColor::envelopePen);
673 dc.SetBrush(*wxWHITE_BRUSH);
674
675 mControlPoints[outerFadeDown] = points[1];
676 mControlPoints[innerFadeDown] = points[2];
677 mControlPoints[innerFadeUp] = points[3];
678 mControlPoints[outerFadeUp] = points[4];
679 mControlPoints[duckAmount] = wxPoint(
680 (points[2].x + points[3].x) / 2, points[2].y);
681
682 for (int i = 0; i < AUTO_DUCK_PANEL_NUM_CONTROL_POINTS; i++)
683 {
685 int digits;
686 float value;
687
688 if (cp == innerFadeDown)
689 {
690 value = innerFadeDownLen;
691 digits = 2;
692 }
693 else if (cp == innerFadeUp)
694 {
695 value = innerFadeUpLen;
696 digits = 2;
697 }
698 else if (cp == outerFadeDown)
699 {
700 value = outerFadeDownLen;
701 digits = 2;
702 } else if (cp == outerFadeUp)
703 {
704 value = outerFadeUpLen;
705 digits = 2;
706 }
707 else
708 {
709 value = duckAmountDb;
710 digits = 1;
711 }
712
713 wxString valueStr = Internat::ToDisplayString(value, digits);
714 valueStr += wxT(" ");
715
716 if (cp == duckAmount)
717 /* i18n-hint: short form of 'decibels'.*/
718 valueStr += _("dB");
719 else
720 /* i18n-hint: short form of 'seconds'.*/
721 valueStr += _("s");
722
723 int textWidth = 0, textHeight = 0;
724 GetTextExtent(valueStr, &textWidth, &textHeight);
725
726 int textPosX = mControlPoints[i].x - textWidth / 2;
727 int textPosY = mControlPoints[i].y;
728
729 if (cp == duckAmount || cp == outerFadeDown || cp == outerFadeUp)
730 textPosY -= TEXT_DISTANCE + textHeight;
731 else
732 textPosY += TEXT_DISTANCE;
733
734 dc.DrawText(valueStr, textPosX, textPosY);
735
736 dc.DrawEllipse(mControlPoints[i].x - 3,
737 mControlPoints[i].y - 3, 6, 6);
738 }
739 }
740
741 // copy background buffer to paint dc
742 wxPaintDC paintDC(this);
743 paintDC.Blit(0, 0, clientWidth, clientHeight, &dc, 0, 0);
744
745 // clean up: necessary to free resources on Windows
746 dc.SetPen(wxNullPen);
747 dc.SetBrush(wxNullBrush);
748 dc.SetFont(wxNullFont);
749 dc.SelectObject(wxNullBitmap);
750}
wxT("CloseDown"))
#define TEXT_DISTANCE
Definition: AutoDuck.cpp:534
#define _(s)
Definition: Internat.h:73
THEME_API Theme theTheme
Definition: Theme.cpp:82
static void Line(wxDC &dc, wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
Definition: AColor.cpp:187
static void Lines(wxDC &dc, size_t nPoints, const wxPoint points[])
Definition: AColor.cpp:194
static wxPen envelopePen
Definition: AColor.h:115
wxTextCtrl * mInnerFadeUpLenBox
Definition: AutoDuck.h:79
wxTextCtrl * mInnerFadeDownLenBox
Definition: AutoDuck.h:78
wxTextCtrl * mOuterFadeDownLenBox
Definition: AutoDuck.h:80
wxTextCtrl * mOuterFadeUpLenBox
Definition: AutoDuck.h:81
wxTextCtrl * mDuckAmountDbBox
Definition: AutoDuck.h:77
static wxString ToDisplayString(double numberToConvert, int digitsAfterDecimalPoint=-1)
Convert a number to a string, uses the user's locale's decimal separator.
Definition: Internat.cpp:137
wxColour & Colour(int iIndex)

References _, AUTO_DUCK_PANEL_NUM_CONTROL_POINTS, ThemeBase::Colour(), DUCK_AMOUNT_SCALE, DUCK_AMOUNT_START, EffectAutoDuck::DuckAmountDb, AColor::envelopePen, FADE_DOWN_START, FADE_SCALE, FADE_UP_START, EffectAutoDuck::InnerFadeDownLen, EffectAutoDuck::InnerFadeUpLen, AColor::Line(), AColor::Lines(), EffectParameter< Structure, Member, Type, Value >::max, EffectAutoDuck::OuterFadeDownLen, EffectAutoDuck::OuterFadeUpLen, TEXT_DISTANCE, theTheme, Internat::ToDisplayString(), and wxT().

Here is the call graph for this function:

◆ ResetControlPoints()

void EffectAutoDuck::Panel::ResetControlPoints ( )
private

Definition at line 580 of file AutoDuck.cpp.

581{
582 mControlPoints[innerFadeDown] = wxPoint(-100,-100);
583 mControlPoints[innerFadeUp] = wxPoint(-100,-100);
584 mControlPoints[outerFadeDown] = wxPoint(-100,-100);
585 mControlPoints[outerFadeUp] = wxPoint(-100,-100);
586 mControlPoints[duckAmount] = wxPoint(-100,-100);
587}

Member Data Documentation

◆ mBackgroundBitmap

std::unique_ptr<wxBitmap> EffectAutoDuck::Panel::mBackgroundBitmap
private

Definition at line 143 of file AutoDuck.h.

◆ mControlPointMoveActivated

bool EffectAutoDuck::Panel::mControlPointMoveActivated
private

Definition at line 148 of file AutoDuck.h.

◆ mControlPoints

wxPoint EffectAutoDuck::Panel::mControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS]
private

Definition at line 145 of file AutoDuck.h.

◆ mCurrentControlPoint

EControlPoint EffectAutoDuck::Panel::mCurrentControlPoint
private

Definition at line 144 of file AutoDuck.h.

◆ mEffect

EffectAutoDuck* EffectAutoDuck::Panel::mEffect
private

Definition at line 142 of file AutoDuck.h.

◆ mMouseDownPoint

wxPoint EffectAutoDuck::Panel::mMouseDownPoint
private

Definition at line 147 of file AutoDuck.h.

◆ mMoveStartControlPoints

wxPoint EffectAutoDuck::Panel::mMoveStartControlPoints[AUTO_DUCK_PANEL_NUM_CONTROL_POINTS]
private

Definition at line 146 of file AutoDuck.h.

◆ mParent

wxWindow* EffectAutoDuck::Panel::mParent
private

Definition at line 141 of file AutoDuck.h.


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