MeterPanel is a panel that paints the meter used for monitoring or playback. More...

#include <MeterPanel.h>

Inheritance diagram for MeterPanel:

Collaboration diagram for MeterPanel:

Classes
struct	State

Public Types
enum	Style { AutomaticStereo , HorizontalStereo , VerticalStereo , MixerTrackCluster , HorizontalStereoCompact , VerticalStereoCompact }

Public Member Functions
	MeterPanel (AudacityProject , wxWindow parent, wxWindowID id, bool isInput, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, Style style=HorizontalStereo, float fDecayRate=60.0f)

void	SetFocusFromKbd () override

void	Clear () override

Style	GetStyle () const

Style	GetDesiredStyle () const

void	SetStyle (Style newStyle)

void	Reset (double sampleRate, bool resetClipping) override
	This method is thread-safe! Feel free to call from a different thread (like from an audio I/O callback). More...

void	UpdateDisplay (unsigned numChannels, int numFrames, const float *sampleData) override
	Update the meters with a block of audio data. More...

bool	IsMeterDisabled () const override
	Find out if the level meter is disabled or not. More...

float	GetMaxPeak () const override

float	GetPeakHold () const

bool	IsMonitoring () const

bool	IsActive () const

bool	IsClipping () const override

void	StartMonitoring ()

void	StopMonitoring ()

State	SaveState ()

void	RestoreState (const State &state)

void	SetMixer (wxCommandEvent &event)

int	GetDBRange () const override

bool	ShowDialog ()

void	Increase (float steps)

void	Decrease (float steps)

void	UpdateSliderControl ()

void	ShowMenu (const wxPoint &pos)

void	SetName (const TranslatableString &name)

Public Member Functions inherited from MeterPanelBase
	~MeterPanelBase () override

template<typename ... Args>
	MeterPanelBase (Args &&...args)

std::shared_ptr< Meter >	GetMeter () const

virtual void	Clear ()=0

virtual void	Reset (double sampleRate, bool resetClipping)=0

virtual void	UpdateDisplay (unsigned numChannels, int numFrames, const float *sampleData)=0

virtual bool	IsMeterDisabled () const =0

virtual float	GetMaxPeak () const =0

virtual bool	IsClipping () const =0

virtual int	GetDBRange () const =0

	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"))

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

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	UpdatePrefs () override

void	UpdateSelectedPrefs (int) override

void	OnErase (wxEraseEvent &evt)

void	OnPaint (wxPaintEvent &evt)

void	OnSize (wxSizeEvent &evt)

void	OnMouse (wxMouseEvent &evt)

void	OnKeyDown (wxKeyEvent &evt)

void	OnCharHook (wxKeyEvent &evt)

void	OnContext (wxContextMenuEvent &evt)

void	OnSetFocus (wxFocusEvent &evt)

void	OnKillFocus (wxFocusEvent &evt)

void	OnAudioIOStatus (AudioIOEvent)

void	OnAudioCapture (AudioIOEvent)

void	OnMeterUpdate (wxTimerEvent &evt)

void	OnTipTimeout (wxTimerEvent &evt)

void	HandleLayout (wxDC &dc)

void	SetActiveStyle (Style style)

void	SetBarAndClip (int iBar, bool vert)

void	DrawMeterBar (wxDC &dc, MeterBar *meterBar)

void	ResetBar (MeterBar *bar, bool resetClipping)

void	RepaintBarsNow ()

wxFont	GetFont () const

void	OnMonitor (wxCommandEvent &evt)

void	OnPreferences (wxCommandEvent &evt)

wxString	Key (const wxString &key) const

Private Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

virtual void	UpdateSelectedPrefs (int id)

Private Attributes
Observer::Subscription	mAudioIOStatusSubscription

Observer::Subscription	mAudioCaptureSubscription

AudacityProject *	mProject

MeterUpdateQueue	mQueue

wxTimer	mTimer

wxTimer	mTipTimer

int	mWidth

int	mHeight

int	mRulerWidth {}

int	mRulerHeight {}

bool	mIsInput

Style	mStyle {}

Style	mDesiredStyle

bool	mGradient

bool	mDB

int	mDBRange

bool	mDecay

float	mDecayRate {}

bool	mClip

int	mNumPeakSamplesToClip

double	mPeakHoldDuration

double	mT

double	mRate

long	mMeterRefreshRate {}

long	mMeterDisabled {}

bool	mMonitoring

bool	mActive

unsigned	mNumBars

MeterBar	mBar [kMaxMeterBars] {}

bool	mLayoutValid

std::unique_ptr< wxBitmap >	mBitmap

wxPoint	mLeftTextPos

wxPoint	mRightTextPos

wxSize	mLeftSize

wxSize	mRightSize

wxPen	mPen

wxPen	mPeakPeakPen

wxBrush	mBrush

wxBrush	mRMSBrush

wxBrush	mClipBrush

wxBrush	mBkgndBrush

wxBrush	mDisabledBkgndBrush

wxBrush	mMeterBkgndBrush

Ruler	mRuler

wxString	mLeftText

wxString	mRightText

std::unique_ptr< LWSlider >	mSlider

wxPoint	mSliderPos

wxSize	mSliderSize

bool	mEnabled { true }

bool	mIsFocused {}

wxRect	mFocusRect

Friends
class	MeterAx

Additional Inherited Members
Static Public Member Functions inherited from MeterPanelBase
static TempAllowFocus	TemporarilyAllowFocus ()

Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

MeterPanel is a panel that paints the meter used for monitoring or playback.

VU Meter, for displaying recording/playback level.

This is a bunch of common code that can display many different forms of VU meters and other displays.

But note that a lot of later code here assumes these are MeterToolBar meters, e.g., MeterPanel::StartMonitoring, so these are not as generic/common as originally intended.

Definition at line 88 of file MeterPanel.h.

Member Enumeration Documentation

◆ Style

enum MeterPanel::Style

Enumerator
AutomaticStereo
HorizontalStereo
VerticalStereo
MixerTrackCluster
HorizontalStereoCompact
VerticalStereoCompact

Definition at line 97 of file MeterPanel.h.

              {
      AutomaticStereo,
      HorizontalStereo,
      VerticalStereo,
      MixerTrackCluster, // Doesn't show menu, icon, or L/R labels, but otherwise like VerticalStereo.
      HorizontalStereoCompact, // Thinner.
      VerticalStereoCompact, // Narrower.
   };

Constructor & Destructor Documentation

◆ MeterPanel()

MeterPanel::MeterPanel	(	AudacityProject *	project,
		wxWindow *	parent,
		wxWindowID	id,
		bool	isInput,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		Style	style = `HorizontalStereo`,
		float	fDecayRate = `60.0f`
	)

Definition at line 229 of file MeterPanel.cpp.

: MeterPanelBase(parent, id, pos, size, wxTAB_TRAVERSAL | wxNO_BORDER | wxWANTS_CHARS),
   mProject(project),
   mQueue{ 1024 },
   mWidth(size.x),
   mHeight(size.y),
   mIsInput(isInput),
   mDesiredStyle(style),
   mGradient(true),
   mDB(true),
   mDBRange(DecibelScaleCutoff.Read()),
   mDecay(true),
   mDecayRate(fDecayRate),
   mClip(true),
   mNumPeakSamplesToClip(3),
   mPeakHoldDuration(3),
   mT(0),
   mRate(0),
   mMonitoring(false),
   mActive(false),
   mNumBars(0),
   mLayoutValid(false),
   mBitmap{},
   mRuler{ LinearUpdater::Instance(), LinearDBFormat::Instance() }
{
   // i18n-hint: Noun (the meter is used for playback or record level monitoring)
   SetName( XO("Meter") );
   // Suppress warnings about the header file
   wxUnusedVar(SpeakerMenu_xpm);
   wxUnusedVar(MicMenu_xpm);
   wxUnusedVar(PrefStyles);
 
   mStyle = mDesiredStyle;
 
   mIsFocused = false;
 
#if wxUSE_ACCESSIBILITY
   SetAccessible(safenew MeterAx(this));
#endif
 
   // Do this BEFORE UpdatePrefs()!
   mRuler.SetFonts(GetFont(), GetFont(), GetFont());
   mRuler.SetFlip(mStyle != MixerTrackCluster);
   mRuler.SetLabelEdges(true);
   //mRuler.SetTickColour( wxColour( 0,0,255 ) );
 
   if (mStyle != MixerTrackCluster)
   {
      mSlider = std::make_unique<LWSlider>(this, XO(""),
         pos,
         size,
         PERCENT_SLIDER,
         false,   /* showlabels */
         false,   /* drawticks */
         false,   /* drawtrack */
         false     /* alwayshidetip */
      );
      mSlider->SetScroll(0.1f, 2.0f);
   }
 
   UpdateSliderControl();
   UpdatePrefs();
 
   wxColour backgroundColour = theTheme.Colour(clrMedium);
   mBkgndBrush = wxBrush(backgroundColour, wxBRUSHSTYLE_SOLID);
   SetBackgroundColour( backgroundColour );
 
   mPeakPeakPen = wxPen(theTheme.Colour( clrMeterPeak),        1, wxPENSTYLE_SOLID);
 
   mAudioIOStatusSubscription = AudioIO::Get()
      ->Subscribe(*this, &MeterPanel::OnAudioIOStatus);
 
   mAudioCaptureSubscription = AudioIO::Get()
      ->Subscribe(*this, &MeterPanel::OnAudioCapture);
 
   if (mIsInput) {
      mPen       = wxPen(   theTheme.Colour( clrMeterInputPen         ), 1, wxPENSTYLE_SOLID);
      mBrush     = wxBrush( theTheme.Colour( clrMeterInputBrush       ), wxBRUSHSTYLE_SOLID);
      mRMSBrush  = wxBrush( theTheme.Colour( clrMeterInputRMSBrush    ), wxBRUSHSTYLE_SOLID);
      mClipBrush = wxBrush( theTheme.Colour( clrMeterInputClipBrush   ), wxBRUSHSTYLE_SOLID);
//      mLightPen  = wxPen(   theTheme.Colour( clrMeterInputLightPen    ), 1, wxSOLID);
//      mDarkPen   = wxPen(   theTheme.Colour( clrMeterInputDarkPen     ), 1, wxSOLID);
   }
   else {
      mPen       = wxPen(   theTheme.Colour( clrMeterOutputPen        ), 1, wxPENSTYLE_SOLID);
      mBrush     = wxBrush( theTheme.Colour( clrMeterOutputBrush      ), wxBRUSHSTYLE_SOLID);
      mRMSBrush  = wxBrush( theTheme.Colour( clrMeterOutputRMSBrush   ), wxBRUSHSTYLE_SOLID);
      mClipBrush = wxBrush( theTheme.Colour( clrMeterOutputClipBrush  ), wxBRUSHSTYLE_SOLID);
//      mLightPen  = wxPen(   theTheme.Colour( clrMeterOutputLightPen   ), 1, wxSOLID);
//      mDarkPen   = wxPen(   theTheme.Colour( clrMeterOutputDarkPen    ), 1, wxSOLID);
   }
 
 
   mTipTimer.SetOwner(this, OnTipTimeoutID);
   mTimer.SetOwner(this, OnMeterUpdateID);
   // TODO: Yikes.  Hard coded sample rate.
   // JKC: I've looked at this, and it's benignish.  It just means that the meter
   // balistics are right for 44KHz and a bit more frisky than they should be
   // for higher sample rates.
   Reset(44100.0, true);
}

Member Function Documentation

◆ Clear()

void MeterPanel::Clear ( )

overridevirtual

Implements MeterPanelBase.

Definition at line 337 of file MeterPanel.cpp.

{
   mQueue.Clear();
}

References mQueue.

◆ Decrease()

void MeterPanel::Decrease ( float steps )

Definition at line 826 of file MeterPanel.cpp.

{
   if (mSlider)
   {
      wxCommandEvent e;
 
      mSlider->Decrease(steps);
      SetMixer(e);
   }
}

References mSlider, and SetMixer().

Referenced by MeterToolBar::AdjustInputGain(), and MeterToolBar::AdjustOutputGain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawMeterBar()

void MeterPanel::DrawMeterBar	(	wxDC &	dc,
		MeterBar *	meterBar
	)

private

Definition at line 1535 of file MeterPanel.cpp.

{
   // Cache some metrics
   wxCoord x = bar->r.GetLeft();
   wxCoord y = bar->r.GetTop();
   wxCoord w = bar->r.GetWidth();
   wxCoord h = bar->r.GetHeight();
   wxCoord ht;
   wxCoord wd;
 
   // Setup for erasing the background
   dc.SetPen(*wxTRANSPARENT_PEN);
   mMeterBkgndBrush.SetColour( theTheme.Colour(clrMeterBackground) ); 
   dc.SetBrush(mMeterBkgndBrush);
 
   if (mGradient)
   {
      // Map the predrawn bitmap into the source DC
      wxMemoryDC srcDC;
      srcDC.SelectObject(*mBitmap);
 
      if (bar->vert)
      {
         // Copy as much of the predrawn meter bar as is required for the
         // current peak.
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         ht = (int)(bar->peak * (h - 1) + 0.5);
 
         // Blank out the rest
         if (h - ht)
         {
            // ht includes peak value...not really needed but doesn't hurt
            dc.DrawRectangle(x, y, w, h - ht);
         }
 
         // Copy as much of the predrawn meter bar as is required for the
         // current peak.
         // +/-1 to include the peak position
         if (ht)
         {
            dc.Blit(x, y + h - ht - 1, w, ht + 1, &srcDC, x, y + h - ht - 1);
         }
 
         // Draw the "recent" peak hold line using the predrawn meter bar so that
         // it will be the same color as the original level.
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         ht = (int)(bar->peakHold * (h - 1) + 0.5);
         if (ht > 1)
         {
            dc.Blit(x, y + h - ht - 1, w, 2, &srcDC, x, y + h - ht - 1);
         }
 
         // Draw the "maximum" peak hold line
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPeakPeakPen);
         ht = (int)(bar->peakPeakHold * (h - 1) + 0.5);
         if (ht > 0)
         {
            AColor::Line(dc, x, y + h - ht - 1, x + w - 1, y + h - ht - 1);
            if (ht > 1)
            {
               AColor::Line(dc, x, y + h - ht, x + w - 1, y + h - ht);
            }
         }
      }
      else
      {
         // Calculate the peak position
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         wd = (int)(bar->peak * (w - 1) + 0.5);
 
         // Blank out the rest
         if (w - wd)
         {
            // wd includes peak value...not really needed but doesn't hurt
            dc.DrawRectangle(x + wd, y, w - wd, h);
         }
 
         // Copy as much of the predrawn meter bar as is required for the
         // current peak.  But, only blit() if there's something to copy
         // to prevent display corruption.
         // +1 to include peak position
         if (wd)
         {
            dc.Blit(x, y, wd + 1, h, &srcDC, x, y);
         }
 
         // Draw the "recent" peak hold line using the predrawn meter bar so that
         // it will be the same color as the original level.
         // -1 to give a 2 pixel width
         wd = (int)(bar->peakHold * (w - 1) + 0.5);
         if (wd > 1)
         {
            dc.Blit(x + wd - 1, y, 2, h, &srcDC, x + wd, y);
         }
 
         // Draw the "maximum" peak hold line using a themed color
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPeakPeakPen);
         wd = (int)(bar->peakPeakHold * (w - 1) + 0.5);
         if (wd > 0)
         {
            AColor::Line(dc, x + wd, y, x + wd, y + h - 1);
            if (wd > 1)
            {
               AColor::Line(dc, x + wd - 1, y, x + wd - 1, y + h - 1);
            }
         }
      }
 
      // No longer need the source DC, so unselect the predrawn bitmap
      srcDC.SelectObject(wxNullBitmap);
   }
   else
   {
      if (bar->vert)
      {
         // Calculate the peak position
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         ht = (int)(bar->peak * (h - 1) + 0.5);
 
         // Blank out the rest
         if (h - ht)
         {
            // ht includes peak value...not really needed but doesn't hurt
            dc.DrawRectangle(x, y, w, h - ht);
         }
 
         // Draw the peak level
         // +/-1 to include the peak position
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(mBrush);
         if (ht)
         {
            dc.DrawRectangle(x, y + h - ht - 1, w, ht + 1);
         }
 
         // Draw the "recent" peak hold line
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPen);
         ht = (int)(bar->peakHold * (h - 1) + 0.5);
         if (ht > 0)
         {
            AColor::Line(dc, x, y + h - ht - 1, x + w - 1, y + h - ht - 1);
            if (ht > 1)
            {
               AColor::Line(dc, x, y + h - ht, x + w - 1, y + h - ht);
            }
         }
 
         // Calculate the rms position
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         // +1 to include the rms position
         ht = (int)(bar->rms * (h - 1) + 0.5);
 
         // Draw the RMS level
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(mRMSBrush);
         if (ht)
         {
            dc.DrawRectangle(x, y + h - ht - 1, w, ht + 1);
         }
 
         // Draw the "maximum" peak hold line
         // (h - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPeakPeakPen);
         ht = (int)(bar->peakPeakHold * (h - 1) + 0.5);
         if (ht > 0)
         {
            AColor::Line(dc, x, y + h - ht - 1, x + w - 1, y + h - ht - 1);
            if (ht > 1)
            {
               AColor::Line(dc, x, y + h - ht, x + w - 1, y + h - ht);
            }
         }
      }
      else
      {
         // Calculate the peak position
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         wd = (int)(bar->peak * (w - 1) + 0.5);
 
         // Blank out the rest
         if (w - wd)
         {
            // wd includes peak value...not really needed but doesn't hurt
            dc.DrawRectangle(x + wd, y, w - wd, h);
         }
 
         // Draw the peak level
         // +1 to include peak position
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(mBrush);
         if (wd)
         {
            dc.DrawRectangle(x, y, wd + 1, h);
         }
 
         // Draw the "recent" peak hold line
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPen);
         wd = (int)(bar->peakHold * (w - 1) + 0.5);
         if (wd > 0)
         {
            AColor::Line(dc, x + wd, y, x + wd, y + h - 1);
            if (wd > 1)
            {
               AColor::Line(dc, x + wd - 1, y, x + wd - 1, y + h - 1);
            }
         }
 
         // Calculate the rms position
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         wd = (int)(bar->rms * (w - 1) + 0.5);
 
         // Draw the rms level
         // +1 to include the rms position
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(mRMSBrush);
         if (wd)
         {
            dc.DrawRectangle(x, y, wd + 1, h);
         }
 
         // Draw the "maximum" peak hold line using a themed color
         // (w - 1) corresponds to the mRuler.SetBounds() in HandleLayout()
         dc.SetPen(mPeakPeakPen);
         wd = (int)(bar->peakPeakHold * (w - 1) + 0.5);
         if (wd > 0)
         {
            AColor::Line(dc, x + wd, y, x + wd, y + h - 1);
            if (wd > 1)
            {
               AColor::Line(dc, x + wd - 1, y, x + wd - 1, y + h - 1);
            }
         }
      }
   }
 
   // If meter had a clipping indicator, draw or erase it
   // LLL:  At least I assume that's what "mClip" is supposed to be for as
   //       it is always "true".
   if (mClip)
   {
      if (bar->clipping)
      {
         dc.SetBrush(mClipBrush);
      }
      else
      {
         dc.SetBrush(mBkgndBrush);
      }
      dc.SetPen(*wxTRANSPARENT_PEN);
      dc.DrawRectangle(bar->rClip);
   }
}

References MeterBar::clipping, ThemeBase::Colour(), AColor::Line(), mBitmap, mBkgndBrush, mBrush, mClip, mClipBrush, mGradient, mMeterBkgndBrush, mPeakPeakPen, mPen, mRMSBrush, MeterBar::peak, MeterBar::peakHold, MeterBar::peakPeakHold, MeterBar::r, MeterBar::rClip, MeterBar::rms, theTheme, and MeterBar::vert.

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDBRange()

int MeterPanel::GetDBRange ( ) const

inlineoverridevirtual

Implements MeterPanelBase.

Definition at line 186 of file MeterPanel.h.

186{ return mDB ? mDBRange : -1; }

◆ GetDesiredStyle()

Style MeterPanel::GetDesiredStyle ( ) const

inline

Definition at line 120 of file MeterPanel.h.

120{ return mDesiredStyle; }

◆ GetFont()

wxFont MeterPanel::GetFont ( ) const

private

Definition at line 1101 of file MeterPanel.cpp.

{
   int fontSize = 10;
#if defined __WXMSW__
   fontSize = 8;
#endif
 
   return wxFont(fontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
}

Referenced by HandleLayout(), and OnPaint().

Here is the caller graph for this function:

◆ GetMaxPeak()

float MeterPanel::GetMaxPeak ( ) const

overridevirtual

Implements MeterPanelBase.

Definition at line 1083 of file MeterPanel.cpp.

{
   float maxPeak = 0.;
 
   for(unsigned int j=0; j<mNumBars; j++)
      maxPeak = mBar[j].peak > maxPeak ? mBar[j].peak : maxPeak;
 
   return(maxPeak);
}

References mBar, and mNumBars.

◆ GetPeakHold()

float MeterPanel::GetPeakHold ( ) const

Definition at line 1093 of file MeterPanel.cpp.

{
   auto peakHold = .0f;
   for (unsigned int i = 0; i < mNumBars; i++)
      peakHold = std::max(peakHold, mBar[i].peakPeakHold);
   return peakHold;
}

References mBar, and mNumBars.

◆ GetStyle()

Style MeterPanel::GetStyle ( ) const

inline

Definition at line 119 of file MeterPanel.h.

119{ return mStyle; }

◆ HandleLayout()

void MeterPanel::HandleLayout ( wxDC & dc )

private

Definition at line 1231 of file MeterPanel.cpp.

{
   // Refresh to reflect any language changes
   /* i18n-hint: One-letter abbreviation for Left, in VU Meter */
   mLeftText = _("L");
   /* i18n-hint: One-letter abbreviation for Right, in VU Meter */
   mRightText = _("R");
 
   dc.SetFont(GetFont());
   int width = mWidth;
   int height = mHeight;
   int left = 0;
   int top = 0;
   int barw;
   int barh;
   int lside;
   int rside;
 
   // MixerTrackCluster has no L/R labels or icon
   if (mStyle != MixerTrackCluster)
   {
      if (mDesiredStyle == AutomaticStereo)
      {
         SetActiveStyle(width > height ? HorizontalStereo : VerticalStereo);
      }
 
      if (mStyle == HorizontalStereoCompact || mStyle == HorizontalStereo)
      {
         SetActiveStyle(height < 50 ? HorizontalStereoCompact : HorizontalStereo);
      }
      else if (mStyle == VerticalStereoCompact || mStyle == VerticalStereo)
      {
         SetActiveStyle(width < 100 ? VerticalStereoCompact : VerticalStereo);
      }
 
      if (mLeftSize.GetWidth() == 0)  // Not yet initialized to dc.
      {
         dc.GetTextExtent(mLeftText, &mLeftSize.x, &mLeftSize.y);
         dc.GetTextExtent(mRightText, &mRightSize.x, &mRightSize.y);
      }
   }
 
   int ltxtWidth = mLeftSize.GetWidth();
   int ltxtHeight = mLeftSize.GetHeight();
   int rtxtWidth = mRightSize.GetWidth();
   int rtxtHeight = mRightSize.GetHeight();
 
   switch (mStyle)
   {
   default:
      wxPrintf(wxT("Style not handled yet!\n"));
      break;
   case MixerTrackCluster:
      // width is now the entire width of the meter canvas
      width -= mRulerWidth + left;
 
      // height is now the entire height of the meter canvas
      height -= top + gap;
 
      // barw is half of the canvas while allowing for a gap between meters
      barw = (width - gap) / 2;
 
      // barh is now the height of the canvas
      barh = height;
 
      // We always have 2 bars
      mNumBars = 2;
 
      // Save dimensions of the left bevel
      mBar[0].b = wxRect(left, top, barw, barh);
 
      // Save dimensions of the right bevel
      mBar[1].b = mBar[0].b;
      mBar[1].b.SetLeft(mBar[0].b.GetRight() + 1 + gap); // +1 for right edge
 
      // Set bar and clipping indicator dimensions
      SetBarAndClip(0, true);
      SetBarAndClip(1, true);
 
      mRuler.SetBounds(mBar[1].r.GetRight() + 1,   // +1 for the bevel
                       mBar[1].r.GetTop(),
                       mWidth,
                       mBar[1].r.GetBottom());
      mRuler.OfflimitsPixels(0, 0);
      break;
   case VerticalStereo:
      // Determine required width of each side;
      lside = ltxtWidth + gap;
      rside = intmax(mRulerWidth, rtxtWidth);
 
      // left is now the right edge of the icon or L label
      left = lside;
 
      // Ensure there's a margin between top edge of window and the meters
      top = gap;
 
      // Position the L/R labels
      mLeftTextPos = wxPoint(left - ltxtWidth - gap, height - gap - ltxtHeight);
      mRightTextPos = wxPoint(width - rside - gap, height - gap - rtxtHeight);
 
      // left is now left edge of left bar
      left += gap;
 
      // width is now the entire width of the meter canvas
      width -= gap + rside + gap + left;
 
      // height is now the entire height of the meter canvas
      height -= top + gap;
 
      mSliderPos = wxPoint{ 0, top - gap };
      mSliderSize = wxSize{ width, height + 2 * gap };
 
      // barw is half of the canvas while allowing for a gap between meters
      barw = (width - gap) / 2;
 
      // barh is now the height of the canvas
      barh = height;
 
      // We always have 2 bars
      mNumBars = 2;
 
      // Save dimensions of the left bevel
      mBar[0].b = wxRect(left, top, barw, barh);
 
      // Save dimensions of the right bevel
      mBar[1].b = mBar[0].b;
      mBar[1].b.SetLeft(mBar[0].b.GetRight() + 1 + gap); // +1 for right edge
 
      // Set bar and clipping indicator dimensions
      SetBarAndClip(0, true);
      SetBarAndClip(1, true);
 
      mRuler.SetBounds(mBar[1].r.GetRight() + 1,   // +1 for the bevel
                       mBar[1].r.GetTop(),
                       mWidth,
                       mBar[1].r.GetBottom());
      mRuler.OfflimitsPixels(mRightTextPos.y - gap, mBar[1].r.GetBottom());
      break;
   case VerticalStereoCompact:
      // Ensure there's a margin between top edge of window and the meters
      top = gap;
 
      // height is now the entire height of the meter canvas
      height -= top + gap + ltxtHeight + gap;
 
      mSliderPos = wxPoint{ 0, top - gap };
      mSliderSize = wxSize{ width, height + 2 * gap };
 
      // barw is half of the canvas while allowing for a gap between meters
      barw = (width / 2) - gap;
 
      // barh is now the height of the canvas
      barh = height;
 
      // We always have 2 bars
      mNumBars = 2;
 
      // Save dimensions of the left bevel
      mBar[0].b = wxRect(left, top, barw, barh);
 
      // Save dimensions of the right bevel
      mBar[1].b = mBar[0].b;
      mBar[1].b.SetLeft(mBar[0].b.GetRight() + 1 + gap); // +1 for right edge
 
      // Set bar and clipping indicator dimensions
      SetBarAndClip(0, true);
      SetBarAndClip(1, true);
 
      // L/R is centered horizontally under each bar
      mLeftTextPos = wxPoint(mBar[0].b.GetLeft() + ((mBar[0].b.GetWidth() - ltxtWidth) / 2), top + barh + gap);
      mRightTextPos = wxPoint(mBar[1].b.GetLeft() + ((mBar[1].b.GetWidth() - rtxtWidth) / 2), top + barh + gap);
 
      mRuler.SetBounds((mWidth - mRulerWidth) / 2,
                       mBar[1].r.GetTop(),
                       (mWidth - mRulerWidth) / 2,
                       mBar[1].r.GetBottom());
      mRuler.OfflimitsPixels(0, 0);
      break;
   case HorizontalStereo:
      // Button right next to dragger.
      left = 0;
 
      // Add a gap between bottom of icon and bottom of window
      height -= gap;
 
      left = gap;
 
      // Make sure there's room for icon and gap between the bottom of the meter and icon
      height -= rtxtHeight + gap;
 
      // L/R is centered vertically and to the left of a each bar
      mLeftTextPos = wxPoint(left, (height / 4) - ltxtHeight / 2);
      mRightTextPos = wxPoint(left, (height * 3 / 4) - rtxtHeight / 2);
 
      // Add width of widest of the L/R characters
      left += intmax(ltxtWidth, rtxtWidth); //, iconWidth);
 
      mSliderPos = wxPoint{ left - gap, 0 };
 
      // Add gap between L/R and meter bevel
      left += gap;
 
      // width is now the entire width of the meter canvas
      width -= left;
 
      mSliderSize = wxSize{ width + 2 * gap, height };
 
      // barw is now the width of the canvas minus gap between canvas and right window edge
      barw = width - gap;
 
      // barh is half of the canvas while allowing for a gap between meters
      barh = (height - gap) / 2;
 
      // We always have 2 bars
      mNumBars = 2;
 
      // Save dimensions of the top bevel
      mBar[0].b = wxRect(left, top, barw, barh);
 
      // Save dimensions of the bottom bevel
      mBar[1].b = mBar[0].b;
      mBar[1].b.SetTop(mBar[0].b.GetBottom() + 1 + gap); // +1 for bottom edge
 
      // Set bar and clipping indicator dimensions
      SetBarAndClip(0, false);
      SetBarAndClip(1, false);
 
      mRuler.SetBounds(mBar[1].r.GetLeft(),
                       mBar[1].r.GetBottom() + 1, // +1 to fit below bevel
                       mBar[1].r.GetRight(),
                       mHeight - mBar[1].r.GetBottom() + 1);
      break;
   case HorizontalStereoCompact:
      left = gap;
 
      // L/R is centered vertically and to the left of a each bar
      mLeftTextPos = wxPoint(left, (height / 4) - (ltxtHeight / 2));
      mRightTextPos = wxPoint(left, (height * 3 / 4) - (ltxtHeight / 2));
 
      // Add width of widest of the L/R characters
      left += intmax(ltxtWidth, rtxtWidth);
 
      mSliderPos = wxPoint{ left - gap, 0 };
 
      // Add gap between L/R and meter bevel
      left += gap;
 
      // width is now the entire width of the meter canvas
      width -= left;
 
      mSliderSize = wxSize{ width + 2 * gap, height };
 
      // barw is now the width of the canvas minus gap between canvas and window edge
      barw = width - gap;
 
      // barh is half of the canvas while allowing for a gap between meters
      barh = (height - gap) / 2;
 
      // We always have 2 bars
      mNumBars = 2;
 
      // Save dimensions of the top bevel
      mBar[0].b = wxRect(left, top, barw, barh);
 
      // Save dimensions of the bottom bevel
      // Since the bars butt up against the window's top and bottom edges, we need
      // to include an extra pixel in the bottom bar when the window height and
      // meter height do not exactly match.
      mBar[1].b = mBar[0].b;
      mBar[1].b.SetTop(mBar[0].b.GetBottom() + 1 + gap); // +1 for bottom bevel
      mBar[1].b.SetHeight(mHeight - mBar[1].b.GetTop() - 1); // +1 for bottom bevel
 
      // Add clipping indicators - do after setting bar/bevel dimensions above
      SetBarAndClip(0, false);
      SetBarAndClip(1, false);
 
      mRuler.SetBounds(mBar[1].r.GetLeft(),
                       mBar[1].b.GetTop() - (mRulerHeight / 2),
                       mBar[1].r.GetRight(),
                       mBar[1].b.GetTop() - (mRulerHeight / 2));
      mRuler.OfflimitsPixels(0, 0);
      break;
   }
 
   mLayoutValid = true;
}

References _, AutomaticStereo, MeterBar::b, gap, GetFont(), HorizontalStereo, HorizontalStereoCompact, intmax(), mBar, mDesiredStyle, mHeight, MixerTrackCluster, mLayoutValid, mLeftSize, mLeftText, mLeftTextPos, mNumBars, mRightSize, mRightText, mRightTextPos, mRuler, mRulerHeight, mRulerWidth, mSliderPos, mSliderSize, mStyle, mWidth, Ruler::OfflimitsPixels(), MeterBar::r, SetActiveStyle(), SetBarAndClip(), Ruler::SetBounds(), VerticalStereo, VerticalStereoCompact, and wxT().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Increase()

void MeterPanel::Increase ( float steps )

Definition at line 815 of file MeterPanel.cpp.

{
   if (mSlider)
   {
      wxCommandEvent e;
 
      mSlider->Increase(steps);
      SetMixer(e);
   }
}

References mSlider, and SetMixer().

Referenced by MeterToolBar::AdjustInputGain(), and MeterToolBar::AdjustOutputGain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsActive()

bool MeterPanel::IsActive ( ) const

Definition at line 1126 of file MeterPanel.cpp.

{
   return mActive;
}

References mActive.

◆ IsClipping()

bool MeterPanel::IsClipping ( ) const

overridevirtual

Implements MeterPanelBase.

Definition at line 1136 of file MeterPanel.cpp.

{
   for (int c = 0; c < mNumBars; c++)
      if (mBar[c].clipping)
         return true;
   return false;
}

References mBar, and mNumBars.

◆ IsMeterDisabled()

bool MeterPanel::IsMeterDisabled ( ) const

overridevirtual

Find out if the level meter is disabled or not.

This method is thread-safe! Feel free to call from a different thread (like from an audio I/O callback).

Implements MeterPanelBase.

Definition at line 1792 of file MeterPanel.cpp.

{
   return mMeterDisabled != 0;
}

References mMeterDisabled.

◆ IsMonitoring()

bool MeterPanel::IsMonitoring ( ) const

Definition at line 1131 of file MeterPanel.cpp.

{
   return mMonitoring;
}

References mMonitoring.

◆ Key()

wxString MeterPanel::Key ( const wxString & key ) const

private

Definition at line 2036 of file MeterPanel.cpp.

{
   if (mStyle == MixerTrackCluster)
   {
      return wxT("/Meter/Mixerboard/") + key;
   }
 
   if (mIsInput)
   {
      return wxT("/Meter/Input/") + key;
   }
 
   return wxT("/Meter/Output/") + key;
}

References key, mIsInput, mStyle, and wxT().

Referenced by OnPreferences(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAudioCapture()

void MeterPanel::OnAudioCapture ( AudioIOEvent event )

private

Definition at line 1849 of file MeterPanel.cpp.

{
   if (
      event.type == AudioIOEvent::CAPTURE &&
      (event.pProject != mProject || !event.on))
   {
      mEnabled = !event.on;
 
      if (mSlider)
         mSlider->SetEnabled(mEnabled);
   }
}

References AudioIOEvent::CAPTURE, mEnabled, mProject, mSlider, AudioIOEvent::on, AudioIOEvent::pProject, and AudioIOEvent::type.

◆ OnAudioIOStatus()

void MeterPanel::OnAudioIOStatus ( AudioIOEvent evt )

private

Definition at line 1825 of file MeterPanel.cpp.

{
   if (evt.type == AudioIOEvent::PAUSE)
      return;
 
   if (!mIsInput != (evt.type == AudioIOEvent::PLAYBACK))
      return;
 
   AudacityProject *p = evt.pProject;
   mActive = evt.on && (p == mProject);
   if( mActive ){
      mTimer.Start(1000 / mMeterRefreshRate);
      if (evt.type == AudioIOEvent::MONITOR)
         mMonitoring = mActive;
   } else {
      mTimer.Stop();
      mMonitoring = false;
   }
 
   // Only refresh is we're the active meter
   if (IsShownOnScreen())
      Refresh(false);
}

References mActive, mIsInput, mMeterRefreshRate, mMonitoring, AudioIOEvent::MONITOR, mProject, mTimer, AudioIOEvent::on, AudioIOEvent::PAUSE, AudioIOEvent::PLAYBACK, AudioIOEvent::pProject, and AudioIOEvent::type.

◆ OnCharHook()

void MeterPanel::OnCharHook ( wxKeyEvent & evt )

private

Definition at line 690 of file MeterPanel.cpp.

{
   switch(evt.GetKeyCode())
   {
   // These are handled in the OnCharHook handler because, on Windows at least, the
   // key up event will be passed on to the menu if we show it here.  This causes
   // the default sound to be heard if assigned.
   case WXK_RETURN:
   case WXK_NUMPAD_ENTER:
   case WXK_WINDOWS_MENU:
   case WXK_MENU:
      if (mStyle != MixerTrackCluster)
         ShowMenu(GetClientRect().GetBottomLeft());
      else
         evt.Skip();
      break;
   default:
      evt.Skip();
      break;
   }
}

References mStyle, and ShowMenu().

Here is the call graph for this function:

◆ OnContext()

void MeterPanel::OnContext ( wxContextMenuEvent & evt )

private

Definition at line 712 of file MeterPanel.cpp.

{
   if (mStyle != MixerTrackCluster) // MixerTrackCluster style has no menu.
   {
      ShowMenu(GetClientRect().GetBottomLeft());
   }
   else
   {
      evt.Skip();
   }
}

References mStyle, and ShowMenu().

Here is the call graph for this function:

◆ OnErase()

void MeterPanel::OnErase ( wxEraseEvent & evt )

private

Definition at line 432 of file MeterPanel.cpp.

{
   // Ignore it to prevent flashing
}

◆ OnKeyDown()

void MeterPanel::OnKeyDown ( wxKeyEvent & evt )

private

Definition at line 724 of file MeterPanel.cpp.

{
   switch (evt.GetKeyCode())
   {
   case WXK_TAB:
      if (evt.ShiftDown())
         Navigate(wxNavigationKeyEvent::IsBackward);
      else
         Navigate(wxNavigationKeyEvent::IsForward);
      break;
   default:
      mSlider->OnKeyDown(evt);
      break;
   }
}

References mSlider.

◆ OnKillFocus()

void MeterPanel::OnKillFocus ( wxFocusEvent & evt )

private

Definition at line 746 of file MeterPanel.cpp.

{
   if(mSlider)
      mSlider->OnKillFocus();
   mTipTimer.Stop();
 
   mIsFocused = false;
   Refresh(false);
}

References mIsFocused, mSlider, and mTipTimer.

◆ OnMeterUpdate()

void MeterPanel::OnMeterUpdate ( wxTimerEvent & evt )

private

Definition at line 979 of file MeterPanel.cpp.

{
   MeterUpdateMsg msg;
   int numChanges = 0;
#ifdef EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT
   double maxPeak = 0.0;
   bool discarded = false;
#endif
 
   // We shouldn't receive any events if the meter is disabled, but clear it to be safe
   if (mMeterDisabled) {
      mQueue.Clear();
      return;
   }
 
 
   // There may have been several update messages since the last
   // time we got to this function.  Catch up to real-time by
   // popping them off until there are none left.  It is necessary
   // to process all of them, otherwise we won't handle peaks and
   // peak-hold bars correctly.
   while(mQueue.Get(msg)) {
      numChanges++;
      double deltaT = msg.numFrames / mRate;
 
      mT += deltaT;
      for(unsigned int j=0; j<mNumBars; j++) {
         mBar[j].isclipping = false;
 
         //
         if (mDB) {
            msg.peak[j] = ToDB(msg.peak[j], mDBRange);
            msg.rms[j] = ToDB(msg.rms[j], mDBRange);
         }
 
         if (mDecay) {
            if (mDB) {
               float decayAmount = mDecayRate * deltaT / mDBRange;
               mBar[j].peak = floatMax(msg.peak[j],
                                       mBar[j].peak - decayAmount);
            }
            else {
               double decayAmount = mDecayRate * deltaT;
               double decayFactor = DB_TO_LINEAR(-decayAmount);
               mBar[j].peak = floatMax(msg.peak[j],
                                       mBar[j].peak * decayFactor);
            }
         }
         else
            mBar[j].peak = msg.peak[j];
 
         // This smooths out the RMS signal
         float smooth = pow(0.9, (double)msg.numFrames/1024.0);
         mBar[j].rms = mBar[j].rms * smooth + msg.rms[j] * (1.0 - smooth);
 
         if (mT - mBar[j].peakHoldTime > mPeakHoldDuration ||
             mBar[j].peak > mBar[j].peakHold) {
            mBar[j].peakHold = mBar[j].peak;
            mBar[j].peakHoldTime = mT;
         }
 
         if (mBar[j].peak > mBar[j].peakPeakHold )
            mBar[j].peakPeakHold = mBar[j].peak;
 
         if (msg.clipping[j] ||
             mBar[j].tailPeakCount+msg.headPeakCount[j] >=
             mNumPeakSamplesToClip){
            mBar[j].clipping = true;
            mBar[j].isclipping = true;
         }
 
         mBar[j].tailPeakCount = msg.tailPeakCount[j];
#ifdef EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT
         if (mT > gAudioIO->AILAGetLastDecisionTime()) {
            discarded = false;
            maxPeak = msg.peak[j] > maxPeak ? msg.peak[j] : maxPeak;
            wxPrintf("%f@%f ", msg.peak[j], mT);
         }
         else {
            discarded = true;
            wxPrintf("%f@%f discarded\n", msg.peak[j], mT);
         }
#endif
      }
   } // while
 
   if (numChanges > 0) {
      #ifdef EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT
         if (gAudioIO->AILAIsActive() && mIsInput && !discarded) {
            gAudioIO->AILAProcess(maxPeak);
            putchar('\n');
         }
      #endif
      RepaintBarsNow();
   }
}

References MeterBar::clipping, MeterUpdateMsg::clipping, DB_TO_LINEAR, floatMax(), MeterUpdateMsg::headPeakCount, MeterBar::isclipping, mBar, mDB, mDBRange, mDecay, mDecayRate, mIsInput, mMeterDisabled, mNumBars, mNumPeakSamplesToClip, mPeakHoldDuration, mQueue, mRate, mT, MeterUpdateMsg::numFrames, MeterBar::peak, MeterUpdateMsg::peak, MeterBar::peakHold, MeterBar::peakHoldTime, MeterBar::peakPeakHold, RepaintBarsNow(), MeterBar::rms, MeterUpdateMsg::rms, MeterBar::tailPeakCount, MeterUpdateMsg::tailPeakCount, and ToDB().

Here is the call graph for this function:

◆ OnMonitor()

void MeterPanel::OnMonitor ( wxCommandEvent & evt )

private

Definition at line 1916 of file MeterPanel.cpp.

{
   StartMonitoring();
}

References StartMonitoring().

Here is the call graph for this function:

◆ OnMouse()

void MeterPanel::OnMouse ( wxMouseEvent & evt )

private

Definition at line 664 of file MeterPanel.cpp.

{
   if ((evt.GetEventType() == wxEVT_MOTION || evt.Entering() || evt.Leaving())) {
      mLayoutValid = false;
      Refresh();
   }
 
   if (mStyle == MixerTrackCluster) // MixerTrackCluster style has no menu.
      return;
 
   if (evt.Entering()) {
      mTipTimer.StartOnce(500);
   }
   else if(evt.Leaving())
      mTipTimer.Stop();
 
   if (evt.RightDown())
      ShowMenu(evt.GetPosition());
   else
   {
 
      if (mSlider)
         mSlider->OnMouseEvent(evt);
   }
}

References mLayoutValid, mSlider, mStyle, mTipTimer, and ShowMenu().

Here is the call graph for this function:

◆ OnPaint()

void MeterPanel::OnPaint ( wxPaintEvent & evt )

private

Definition at line 437 of file MeterPanel.cpp.

{
#if defined(__WXMAC__)
   auto paintDC = std::make_unique<wxPaintDC>(this);
#else
   std::unique_ptr<wxDC> paintDC{ wxAutoBufferedPaintDCFactory(this) };
#endif
   wxDC & destDC = *paintDC;
   wxColour clrText = theTheme.Colour( clrTrackPanelText );
   wxColour clrBoxFill = theTheme.Colour( clrMedium );
 
   if (mLayoutValid == false || (mStyle == MixerTrackCluster ))
   {
      // Create a NEW one using current size and select into the DC
      mBitmap = std::make_unique<wxBitmap>();
      mBitmap->Create(mWidth, mHeight, destDC);
      wxMemoryDC dc;
      dc.SelectObject(*mBitmap);
 
      // Go calculate all of the layout metrics
      HandleLayout(dc);
 
      mBkgndBrush.SetColour( GetBackgroundColour() );
      dc.SetPen(*wxTRANSPARENT_PEN);
      dc.SetBrush(mBkgndBrush);
      dc.DrawRectangle(0, 0, mWidth, mHeight);
 
      // MixerTrackCluster style has no icon or L/R labels
      if (mStyle != MixerTrackCluster)
      {
         dc.SetFont(GetFont());
         dc.SetTextForeground( clrText );
         dc.SetTextBackground( clrBoxFill );
         dc.DrawText(mLeftText, mLeftTextPos.x, mLeftTextPos.y);
         dc.DrawText(mRightText, mRightTextPos.x, mRightTextPos.y);
      }
 
      // Setup the colors for the 3 sections of the meter bars
      wxColor green(117, 215, 112);
      wxColor yellow(255, 255, 0);
      wxColor red(255, 0, 0);
 
      // Bug #2473 - (Sort of) Hack to make text on meters more
      // visible with darker backgrounds. It would be better to have
      // different colors entirely and as part of the theme.
      if (GetBackgroundColour().GetLuminance() < 0.25)
      {
         green = wxColor(117-100, 215-100, 112-100);
         yellow = wxColor(255-100, 255-100, 0);
         red = wxColor(255-100, 0, 0);
      }
      else if (GetBackgroundColour().GetLuminance() < 0.50)
      {
         green = wxColor(117-50, 215-50, 112-50);
         yellow = wxColor(255-50, 255-50, 0);
         red = wxColor(255-50, 0, 0);
      }
 
      // Draw the meter bars at maximum levels
      for (unsigned int i = 0; i < mNumBars; i++)
      {
         // Cache bar rect
         wxRect r = mBar[i].r;
 
         if (mGradient)
         {
            // Calculate the size of the two gradiant segments of the meter
            double gradw;
            double gradh;
            if (mDB)
            {
               gradw = (double) r.GetWidth() / mDBRange * 6.0;
               gradh = (double) r.GetHeight() / mDBRange * 6.0;
            }
            else
            {
               gradw = (double) r.GetWidth() / 100 * 25;
               gradh = (double) r.GetHeight() / 100 * 25;
            }
 
            if (mBar[i].vert)
            {
               // Draw the "critical" segment (starts at top of meter and works down)
               r.SetHeight(gradh);
               dc.GradientFillLinear(r, red, yellow, wxSOUTH);
 
               // Draw the "warning" segment
               r.SetTop(r.GetBottom());
               dc.GradientFillLinear(r, yellow, green, wxSOUTH);
 
               // Draw the "safe" segment
               r.SetTop(r.GetBottom());
               r.SetBottom(mBar[i].r.GetBottom());
               dc.SetPen(*wxTRANSPARENT_PEN);
               dc.SetBrush(green);
               dc.DrawRectangle(r);
            }
            else
            {
               // Draw the "safe" segment
               r.SetWidth(r.GetWidth() - (int) (gradw + gradw + 0.5));
               dc.SetPen(*wxTRANSPARENT_PEN);
               dc.SetBrush(green);
               dc.DrawRectangle(r);
 
               // Draw the "warning"  segment
               r.SetLeft(r.GetRight() + 1);
               r.SetWidth(floor(gradw));
               dc.GradientFillLinear(r, green, yellow);
 
               // Draw the "critical" segment
               r.SetLeft(r.GetRight() + 1);
               r.SetRight(mBar[i].r.GetRight());
               dc.GradientFillLinear(r, yellow, red);
            }
#ifdef EXPERIMENTAL_METER_LED_STYLE
            if (!mBar[i].vert)
            {
               wxRect r = mBar[i].r;
               wxPen BackgroundPen;
               BackgroundPen.SetColour( wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE) );
               dc.SetPen( BackgroundPen );
               int i;
               for(i=0;i<r.width;i++)
               {
                  // 2 pixel spacing between the LEDs
                  if( (i%7)<2 ){
                     AColor::Line( dc, i+r.x, r.y, i+r.x, r.y+r.height );
                  } else {
                     // The LEDs have triangular ends.
                     // This code shapes the ends.
                     int j = abs( (i%7)-4);
                     AColor::Line( dc, i+r.x, r.y, i+r.x, r.y+j +1);
                     AColor::Line( dc, i+r.x, r.y+r.height-j, i+r.x, r.y+r.height );
                  }
               }
            }
#endif
         }
      }
 
      {//Strokes
         dc.SetPen(AColor::darkPen[0]);
         dc.SetBrush(*wxTRANSPARENT_BRUSH);
 
         //Stroke around group
         dc.DrawRectangle(wxRect(
            mBar[0].r.GetTopLeft(),
            mBar[mNumBars - 1].r.GetBottomRight()
         ).Inflate(1));
 
         //strokes between meters
         for(unsigned n = 0; n < mNumBars - 1; ++n)
            dc.DrawLine(mBar[n].b.GetBottomLeft(), mBar[n].b.GetBottomRight());
         if constexpr (gap > 0)
         {
            for(unsigned n = 1; n < mNumBars; ++n)
               dc.DrawLine(mBar[n].b.GetTopLeft(), mBar[n].b.GetTopRight());
         }
 
         //stroke around clip indicators
         for(unsigned n = 0; n < mNumBars; ++n)
            dc.DrawRectangle(wxRect(mBar[n].rClip).Inflate(1));
      }
 
      mRuler.SetTickColour( clrText );
      dc.SetTextForeground( clrText );
 
      mRuler.Draw(dc); // Draw the ruler
 
      // Bitmap created...unselect
      dc.SelectObject(wxNullBitmap);
   }
 
   // Copy predrawn bitmap to the dest DC
   destDC.DrawBitmap(*mBitmap, 0, 0);
 
   // Go draw the meter bars, Left & Right channels using current levels
   for (unsigned int i = 0; i < mNumBars; i++)
   {
      DrawMeterBar(destDC, &mBar[i]);
   }
 
   destDC.SetTextForeground( clrText );
   
   // We can have numbers over the bars, in which case we have to draw them each time.
   if(mStyle == HorizontalStereoCompact || mStyle == VerticalStereoCompact)
   {
      mRuler.SetTickColour( clrText );
      // If the text colour is too similar to the meter colour, then we need a background
      // for the text.  We require a total of at least one full-scale RGB difference.
      int d = theTheme.ColourDistance( clrText, theTheme.Colour( clrMeterOutputRMSBrush ) );
      if( d < 256 )
      {
         destDC.SetBackgroundMode( wxSOLID );
         destDC.SetTextBackground( clrBoxFill );
      }
      mRuler.Draw(destDC);
   }
 
   if (mStyle != MixerTrackCluster)
   {
      bool highlighted =
      wxRect{ mSliderPos, mSliderSize }.Contains(
         ScreenToClient(
            ::wxGetMousePosition()));
 
      mSlider->Move(mSliderPos);
      mSlider->AdjustSize(mSliderSize);
      mSlider->OnPaint(destDC, highlighted);
   }
 
   if (mIsFocused)
   {
      auto r = GetClientRect();
      AColor::DrawFocus(destDC, r);
   }
}

References MeterBar::b, ThemeBase::Colour(), ThemeBase::ColourDistance(), AColor::darkPen, Ruler::Draw(), AColor::DrawFocus(), DrawMeterBar(), gap, GetFont(), HandleLayout(), HorizontalStereoCompact, AColor::Line(), mBar, mBitmap, mBkgndBrush, mDB, mDBRange, mGradient, mHeight, mIsFocused, mLayoutValid, mLeftText, mLeftTextPos, mNumBars, mRightText, mRightTextPos, mRuler, mSlider, mSliderPos, mSliderSize, mStyle, mWidth, MeterBar::r, Ruler::SetTickColour(), theTheme, and VerticalStereoCompact.

Here is the call graph for this function:

◆ OnPreferences()

void MeterPanel::OnPreferences ( wxCommandEvent & evt )

private

Definition at line 1921 of file MeterPanel.cpp.

{
   wxTextCtrl *rate;
   wxRadioButton *gradient;
   wxRadioButton *rms;
   wxRadioButton *db;
   wxRadioButton *linear;
   wxRadioButton *automatic;
   wxRadioButton *horizontal;
   wxRadioButton *vertical;
   int meterRefreshRate = mMeterRefreshRate;
 
   auto title = mIsInput ? XO("Recording Meter Options") : XO("Playback Meter Options");
 
   // Dialog is a child of the project, rather than of the toolbar.
   // This determines where it pops up.
 
   wxDialogWrapper dlg( FindProjectFrame( mProject ), wxID_ANY, title);
   dlg.SetName();
   ShuttleGui S(&dlg, eIsCreating);
   S.StartVerticalLay();
   {
      S.StartStatic(XO("Refresh Rate"), 0);
      {
         S.AddFixedText(XO(
"Higher refresh rates make the meter show more frequent\nchanges. A rate of 30 per second or less should prevent\nthe meter affecting audio quality on slower machines."));
         S.StartHorizontalLay();
         {
            rate = S.Name(XO("Meter refresh rate per second [1-100]"))
               .Validator<IntegerValidator<long>>(
                  &mMeterRefreshRate, NumValidatorStyle::DEFAULT,
                  MIN_REFRESH_RATE, MAX_REFRESH_RATE)
               .AddTextBox(XXO("Meter refresh rate per second [1-100]: "),
                                wxString::Format(wxT("%d"), meterRefreshRate),
                                10);
         }
         S.EndHorizontalLay();
      }
      S.EndStatic();
 
      S.StartHorizontalLay();
      {
        S.StartStatic(XO("Meter Style"), 0);
        {
           S.StartVerticalLay();
           {
              gradient = S.AddRadioButton(XXO("Gradient"), true, mGradient);
              rms = S.AddRadioButtonToGroup(XXO("RMS"), false, mGradient);
           }
           S.EndVerticalLay();
        }
        S.EndStatic();
 
        S.StartStatic(XO("Meter Type"), 0);
        {
           S.StartVerticalLay();
           {
              db = S.AddRadioButton(XXO("dB"), true, mDB);
              linear = S.AddRadioButtonToGroup(XXO("Linear"), false, mDB);
           }
           S.EndVerticalLay();
        }
        S.EndStatic();
 
        S.StartStatic(XO("Orientation"), 1);
        {
           S.StartVerticalLay();
           {
              automatic = S.AddRadioButton(
                  XXO("Automatic"), AutomaticStereo, mDesiredStyle);
              horizontal = S.AddRadioButtonToGroup(
                  XXO("Horizontal"), HorizontalStereo, mDesiredStyle);
              vertical = S.AddRadioButtonToGroup(
                  XXO("Vertical"), VerticalStereo, mDesiredStyle);
           }
           S.EndVerticalLay();
        }
        S.EndStatic();
      }
      S.EndHorizontalLay();
      S.AddStandardButtons();
   }
   S.EndVerticalLay();
   dlg.Layout();
   dlg.Fit();
 
   dlg.CenterOnParent();
 
   if (dlg.ShowModal() == wxID_OK)
   {
      wxArrayStringEx style{
         wxT("AutomaticStereo") ,
         wxT("HorizontalStereo") ,
         wxT("VerticalStereo") ,
      };
 
      int s = 0;
      s = automatic->GetValue() ? 0 : s;
      s = horizontal->GetValue() ? 1 : s;
      s = vertical->GetValue() ? 2 : s;
 
      gPrefs->Write(Key(wxT("Style")), style[s]);
      gPrefs->Write(Key(wxT("Bars")), gradient->GetValue() ? wxT("Gradient") : wxT("RMS"));
      gPrefs->Write(Key(wxT("Type")), db->GetValue() ? wxT("dB") : wxT("Linear"));
      gPrefs->Write(Key(wxT("RefreshRate")), rate->GetValue());
 
      gPrefs->Flush();
 
      // Currently, there are 2 playback meters and 2 record meters and any number of
      // mixerboard meters, so we have to send out an preferences updated message to
      // ensure they all update themselves.
      PrefsListener::Broadcast(MeterPrefsID());
   }
}

References AutomaticStereo, PrefsListener::Broadcast(), eIsCreating, FindProjectFrame(), audacity::BasicSettings::Flush(), gPrefs, HorizontalStereo, Key(), MAX_REFRESH_RATE, mDB, mDesiredStyle, MeterPrefsID(), mGradient, MIN_REFRESH_RATE, mIsInput, mMeterRefreshRate, mProject, S, wxDialogWrapper::SetName(), anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, title, VerticalStereo, audacity::BasicSettings::Write(), wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ OnSetFocus()

void MeterPanel::OnSetFocus ( wxFocusEvent & evt )

private

Definition at line 740 of file MeterPanel.cpp.

{
   mIsFocused = true;
   Refresh(false);
}

References mIsFocused.

◆ OnSize()

void MeterPanel::OnSize ( wxSizeEvent & evt )

private

Definition at line 656 of file MeterPanel.cpp.

{
   GetClientSize(&mWidth, &mHeight);
 
   mLayoutValid = false;
   Refresh();
}

References mHeight, mLayoutValid, and mWidth.

◆ OnTipTimeout()

void MeterPanel::OnTipTimeout ( wxTimerEvent & evt )

private

Definition at line 1076 of file MeterPanel.cpp.

{
   if(mSlider)
      mSlider->ShowTip(true);
}

References mSlider.

◆ RepaintBarsNow()

void MeterPanel::RepaintBarsNow ( )

private

Definition at line 1518 of file MeterPanel.cpp.

{
   if (mLayoutValid)
   {
      // Invalidate the bars so they get redrawn
      for (unsigned int i = 0; i < mNumBars; i++)
      {
         Refresh(false);
      }
 
      // Immediate redraw (using wxPaintDC)
      Update();
 
      return;
   }
}

References mLayoutValid, and mNumBars.

Referenced by OnMeterUpdate().

Here is the caller graph for this function:

◆ Reset()

void MeterPanel::Reset	(	double	sampleRate,
		bool	resetClipping
	)

overridevirtual

This method is thread-safe! Feel free to call from a different thread (like from an audio I/O callback).

Implements MeterPanelBase.

Definition at line 837 of file MeterPanel.cpp.

{
   mT = 0;
   mRate = sampleRate;
   for (int j = 0; j < kMaxMeterBars; j++)
   {
      ResetBar(&mBar[j], resetClipping);
   }
 
   // wxTimers seem to be a little unreliable - sometimes they stop for
   // no good reason, so this "primes" it every now and then...
   mTimer.Stop();
 
   // While it's stopped, empty the queue
   mQueue.Clear();
 
   mLayoutValid = false;
 
   mTimer.Start(1000 / mMeterRefreshRate);
 
   Refresh(false);
}

References kMaxMeterBars, mBar, mLayoutValid, mMeterRefreshRate, mQueue, mRate, mT, mTimer, ResetBar(), and anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetBar()

void MeterPanel::ResetBar	(	MeterBar *	bar,
		bool	resetClipping
	)

private

Definition at line 1111 of file MeterPanel.cpp.

{
   b->peak = 0.0;
   b->rms = 0.0;
   b->peakHold = 0.0;
   b->peakHoldTime = 0.0;
   if (resetClipping)
   {
      b->clipping = false;
      b->peakPeakHold = 0.0;
   }
   b->isclipping = false;
   b->tailPeakCount = 0;
}

References MeterBar::clipping, MeterBar::isclipping, MeterBar::peak, MeterBar::peakHold, MeterBar::peakHoldTime, MeterBar::peakPeakHold, MeterBar::rms, and MeterBar::tailPeakCount.

Referenced by Reset().

Here is the caller graph for this function:

◆ RestoreState()

void MeterPanel::RestoreState ( const State & state )

Definition at line 1870 of file MeterPanel.cpp.

{
   if (!state.mSaved)
      return;
 
   mMonitoring = state.mMonitoring;
   mActive = state.mActive;
   //wxLogDebug("Restore state for %p, is %i", this, mActive );
 
   if (mActive)
      mTimer.Start(1000 / mMeterRefreshRate);
}

References MeterPanel::State::mActive, mActive, mMeterRefreshRate, MeterPanel::State::mMonitoring, mMonitoring, MeterPanel::State::mSaved, and mTimer.

Referenced by MeterToolBar::ReCreateButtons().

Here is the caller graph for this function:

◆ SaveState()

auto MeterPanel::SaveState ( )

Definition at line 1865 of file MeterPanel.cpp.

{
   return { true, mMonitoring, mActive };
}

Referenced by MeterToolBar::ReCreateButtons().

Here is the caller graph for this function:

◆ SetActiveStyle()

void MeterPanel::SetActiveStyle ( Style style )

private

Definition at line 1144 of file MeterPanel.cpp.

{
   mStyle = newStyle;
 
   // Set dummy ruler bounds so width/height can be retrieved
   // NOTE: Make sure the Right and Bottom values are large enough to
   //       ensure full width/height of digits get calculated.
   mRuler.SetBounds(0, 0, 500, 500);
 
   if (mDB)
   {
      mRuler.SetFormat(&LinearDBFormat::Instance());
      if (mStyle == HorizontalStereo || mStyle == HorizontalStereoCompact)
      {
         mRuler.SetOrientation(wxHORIZONTAL);
         mRuler.SetRange(-mDBRange, 0);
      }
      else
      {
         mRuler.SetOrientation(wxVERTICAL);
         mRuler.SetRange(0, -mDBRange);
      }
   }
   else
   {
      mRuler.SetFormat(&RealFormat::LinearInstance());
      if (mStyle == HorizontalStereo || mStyle == HorizontalStereoCompact)
      {
         mRuler.SetOrientation(wxHORIZONTAL);
         mRuler.SetRange(0, 1);
      }
      else
      {
         mRuler.SetOrientation(wxVERTICAL);
         mRuler.SetRange(1, 0);
      }
   }
 
   mRuler.GetMaxSize(&mRulerWidth, &mRulerHeight);
}

References Ruler::GetMaxSize(), HorizontalStereo, HorizontalStereoCompact, LinearDBFormat::Instance(), RealFormat::LinearInstance(), mDB, mDBRange, mRuler, mRulerHeight, mRulerWidth, mStyle, Ruler::SetBounds(), Ruler::SetFormat(), Ruler::SetOrientation(), and Ruler::SetRange().

Referenced by HandleLayout(), SetStyle(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBarAndClip()

void MeterPanel::SetBarAndClip	(	int	iBar,
		bool	vert
	)

private

Definition at line 1185 of file MeterPanel.cpp.

{
   constexpr static auto StrokeWidth = 1;
   //either width or height, depending on meter orientation
   constexpr static auto ClipIndicatorSize = 3;
   constexpr static auto ClipIndicatorPadding = 1;
   // Save the orientation
   mBar[iBar].vert = vert;
 
   if (mClip)
   {
      // Create the clip rectangle and adjust
      // meter's boundaries
      if (vert)
      {
         mBar[iBar].rClip = wxRect(
            mBar[iBar].b.x + StrokeWidth,
            mBar[iBar].b.y + StrokeWidth,
            mBar[iBar].b.width - StrokeWidth * 2,
            ClipIndicatorSize
         );
 
         // Make room for the clipping indicator
         constexpr auto yOffset =
            gap + ClipIndicatorPadding + StrokeWidth * 2 + ClipIndicatorSize;
         mBar[iBar].b.y += yOffset;
         mBar[iBar].b.height -= yOffset;
      }
      else
      {
         mBar[iBar].rClip = wxRect(
            mBar[iBar].b.GetRight() - StrokeWidth - ClipIndicatorSize + 1,
            mBar[iBar].b.GetTop() + StrokeWidth,
            ClipIndicatorSize,
            mBar[iBar].b.height - StrokeWidth * 2
         );
         // Make room for the clipping indicator
         mBar[iBar].b.width -=
            gap + ClipIndicatorPadding + StrokeWidth * 2 + ClipIndicatorSize;
      }
   }
   // Create the bar rectangle and educe to fit inside the bevel
   mBar[iBar].r = mBar[iBar].b;
   mBar[iBar].r.Deflate(StrokeWidth);
}

References MeterBar::b, gap, mBar, mClip, MeterBar::r, MeterBar::rClip, and MeterBar::vert.

Referenced by HandleLayout().

Here is the caller graph for this function:

◆ SetFocusFromKbd()

void MeterPanel::SetFocusFromKbd ( )

override

Definition at line 2054 of file MeterPanel.cpp.

{
   auto temp = TemporarilyAllowFocus();
   SetFocus();
}

References BasicUI::SetFocus(), and MeterPanelBase::TemporarilyAllowFocus().

Here is the call graph for this function:

◆ SetMixer()

void MeterPanel::SetMixer ( wxCommandEvent & event )

Definition at line 768 of file MeterPanel.cpp.

{
#if USE_PORTMIXER
   if (mSlider)
   {
      float inputVolume;
      float outputVolume;
      int inputSource;
 
      Refresh();
 
      auto gAudioIO = AudioIO::Get();
      gAudioIO->GetMixer(&inputSource, &inputVolume, &outputVolume);
 
      if (mIsInput)
         inputVolume = mSlider->Get();
      else
         outputVolume = mSlider->Get();
 
      gAudioIO->SetMixer(inputSource, inputVolume, outputVolume);
 
#if wxUSE_ACCESSIBILITY
      GetAccessible()->NotifyEvent( wxACC_EVENT_OBJECT_VALUECHANGE,
                                    this,
                                    wxOBJID_CLIENT,
                                    wxACC_SELF );
#endif
 
   }
#endif // USE_PORTMIXER
}

References AudioIO::Get(), mIsInput, and mSlider.

Referenced by Decrease(), Increase(), and ShowDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetName()

void MeterPanel::SetName ( const TranslatableString & name )

Definition at line 1908 of file MeterPanel.cpp.

{
   wxPanelWrapper::SetName(tip);
   if(mSlider)
      mSlider->SetName(tip);
}

References mSlider, and wxPanelWrapper::SetName().

Referenced by MeterToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStyle()

void MeterPanel::SetStyle ( Style newStyle )

Definition at line 756 of file MeterPanel.cpp.

{
   if (mStyle != newStyle && mDesiredStyle == AutomaticStereo)
   {
      SetActiveStyle(newStyle);
 
      mLayoutValid = false;
 
      Refresh(false);
   }
}

References AutomaticStereo, mDesiredStyle, mLayoutValid, mStyle, and SetActiveStyle().

Here is the call graph for this function:

◆ ShowDialog()

bool MeterPanel::ShowDialog ( )

Definition at line 800 of file MeterPanel.cpp.

{
   if (!mSlider)
      return false;
 
   auto changed = mSlider->ShowDialog();
   if (changed)
   {
      wxCommandEvent e;
      SetMixer(e);
   }
 
   return changed;
}

References mSlider, and SetMixer().

Referenced by MeterToolBar::ShowInputGainDialog(), and MeterToolBar::ShowOutputGainDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowMenu()

void MeterPanel::ShowMenu ( const wxPoint & pos )

Definition at line 1887 of file MeterPanel.cpp.

{
   wxMenu menu;
   // Note: these should be kept in the same order as the enum
   if (mIsInput) {
      wxMenuItem *mi;
      if (mMonitoring)
         mi = menu.Append(OnMonitorID, _("Disable Silent Monitoring"));
      else
         mi = menu.Append(OnMonitorID, _("Enable Silent Monitoring"));
      mi->Enable(!mActive || mMonitoring);
   }
 
   menu.Append(OnPreferencesID, _("Options..."));
 
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ this },
      { pos.x, pos.y }
   );
}

References _, mActive, mIsInput, mMonitoring, OnMonitorID, OnPreferencesID, and BasicMenu::Handle::Popup().

Referenced by OnCharHook(), OnContext(), OnMouse(), and MeterToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartMonitoring()

void MeterPanel::StartMonitoring ( )

Definition at line 1797 of file MeterPanel.cpp.

{
   bool start = !mMonitoring;
 
   auto gAudioIO = AudioIO::Get();
   if (gAudioIO->IsMonitoring()){
      gAudioIO->StopStream();
   }
 
   if (start && !gAudioIO->IsBusy()){
      AudacityProject *p = mProject;
      if (p)
         gAudioIO->StartMonitoring(ProjectAudioIO::GetDefaultOptions(*p));
 
      mLayoutValid = false;
 
      Refresh(false);
   }
}

References AudioIO::Get(), ProjectAudioIO::GetDefaultOptions(), mLayoutValid, mMonitoring, and mProject.

Referenced by OnMonitor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopMonitoring()

void MeterPanel::StopMonitoring ( )

Definition at line 1817 of file MeterPanel.cpp.

                               {
   mMonitoring = false;
   auto gAudioIO = AudioIO::Get();
   if (gAudioIO->IsMonitoring()){
      gAudioIO->StopStream();
   }
}

References AudioIO::Get(), and mMonitoring.

Here is the call graph for this function:

◆ UpdateDisplay()

void MeterPanel::UpdateDisplay	(	unsigned	numChannels,
		int	numFrames,
		const float *	sampleData
	)

overridevirtual

Update the meters with a block of audio data.

Process the supplied block of audio data, extracting the peak and RMS levels to send to the meter. Also record runs of clipped samples to detect clipping that lies on block boundaries. This method is thread-safe! Feel free to call from a different thread (like from an audio I/O callback).

First overload:

Parameters

numChannels	The number of channels of audio being played back or recorded.
numFrames	The number of frames (samples) in this data block. It is assumed that there are the same number of frames in each channel.
sampleData	The audio data itself, as interleaved samples. So indexing through the array we get the first sample of channel, first sample of channel 2 etc up to the first sample of channel (numChannels), then the second sample of channel 1, second sample of channel 2, and so to the second sample of channel (numChannels). The last sample in the array will be the (numFrames) sample for channel (numChannels).

The second overload is for ease of use in MixerBoard.

Implements MeterPanelBase.

Definition at line 897 of file MeterPanel.cpp.

{
   auto sptr = sampleData;
   auto num = std::min(numChannels, mNumBars);
   MeterUpdateMsg msg;
 
   memset(&msg, 0, sizeof(msg));
   msg.numFrames = numFrames;
 
   for(int i=0; i<numFrames; i++) {
      for(unsigned int j=0; j<num; j++) {
         msg.peak[j] = floatMax(msg.peak[j], fabs(sptr[j]));
         msg.rms[j] += sptr[j]*sptr[j];
 
         // In addition to looking for mNumPeakSamplesToClip peaked
         // samples in a row, also send the number of peaked samples
         // at the head and tail, in case there's a run of peaked samples
         // that crosses block boundaries
         if (fabs(sptr[j])>=MAX_AUDIO) {
            if (msg.headPeakCount[j]==i)
               msg.headPeakCount[j]++;
            msg.tailPeakCount[j]++;
            if (msg.tailPeakCount[j] > mNumPeakSamplesToClip)
               msg.clipping[j] = true;
         }
         else
            msg.tailPeakCount[j] = 0;
      }
      sptr += numChannels;
   }
   for(unsigned int j=0; j<mNumBars; j++)
      msg.rms[j] = sqrt(msg.rms[j]/numFrames);
 
   mQueue.Put(msg);
}

References MeterUpdateMsg::clipping, floatMax(), MeterUpdateMsg::headPeakCount, MAX_AUDIO, min(), mNumBars, mNumPeakSamplesToClip, mQueue, MeterUpdateMsg::numFrames, MeterUpdateMsg::peak, MeterUpdateMsg::rms, staffpad::audio::simd::sqrt(), and MeterUpdateMsg::tailPeakCount.

Here is the call graph for this function:

◆ UpdatePrefs()

void MeterPanel::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 342 of file MeterPanel.cpp.

{
   mDBRange = DecibelScaleCutoff.Read();
 
   mMeterRefreshRate =
      std::max(MIN_REFRESH_RATE, std::min(MAX_REFRESH_RATE,
         gPrefs->Read(Key(wxT("RefreshRate")), 30L)));
   mGradient = gPrefs->Read(Key(wxT("Bars")), wxT("Gradient")) == wxT("Gradient");
   mDB = gPrefs->Read(Key(wxT("Type")), wxT("dB")) == wxT("dB");
   mMeterDisabled = gPrefs->Read(Key(wxT("Disabled")), 0L);
 
   if (mDesiredStyle != MixerTrackCluster)
   {
      wxString style = gPrefs->Read(Key(wxT("Style")));
      if (style == wxT("AutomaticStereo"))
      {
         mDesiredStyle = AutomaticStereo;
      }
      else if (style == wxT("HorizontalStereo"))
      {
         mDesiredStyle = HorizontalStereo;
      }
      else if (style == wxT("VerticalStereo"))
      {
         mDesiredStyle = VerticalStereo;
      }
      else
      {
         mDesiredStyle = AutomaticStereo;
      }
   }
 
   // Set the desired orientation (resets ruler orientation)
   SetActiveStyle(mDesiredStyle);
 
   // Reset to ensure NEW size is retrieved when language changes
   mLeftSize = wxSize(0, 0);
   mRightSize = wxSize(0, 0);
 
   Reset(mRate, false);
 
   mLayoutValid = false;
 
   Refresh(false);
}

References AutomaticStereo, DecibelScaleCutoff, gPrefs, HorizontalStereo, Key(), MAX_REFRESH_RATE, mDB, mDBRange, mDesiredStyle, mGradient, min(), MIN_REFRESH_RATE, mLayoutValid, mLeftSize, mMeterDisabled, mMeterRefreshRate, mRate, mRightSize, audacity::BasicSettings::Read(), Setting< T >::Read(), Reset(), SetActiveStyle(), anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, VerticalStereo, and wxT().

Referenced by UpdateSelectedPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSelectedPrefs()

void MeterPanel::UpdateSelectedPrefs ( int id )

overrideprivatevirtual

Reimplemented from PrefsListener.

Definition at line 394 of file MeterPanel.cpp.

{
   if (id == MeterPrefsID())
   {
#if USE_PORTMIXER
      if (mIsInput && mSlider)
      {
         // Show or hide the input slider based on whether it works
         auto gAudioIO = AudioIO::Get();
         mSlider->SetEnabled(mEnabled && gAudioIO->InputMixerWorks());
      }
#endif
      UpdatePrefs();
   }
}

References AudioIO::Get(), mEnabled, MeterPrefsID(), mIsInput, mSlider, and UpdatePrefs().

Here is the call graph for this function:

◆ UpdateSliderControl()

void MeterPanel::UpdateSliderControl ( )

Definition at line 410 of file MeterPanel.cpp.

{
#if USE_PORTMIXER
   float inputVolume;
   float playbackVolume;
   int inputSource;
 
   // Show or hide the input slider based on whether it works
   auto gAudioIO = AudioIO::Get();
   if (mIsInput && mSlider)
      mSlider->SetEnabled(mEnabled && gAudioIO->InputMixerWorks());
 
   gAudioIO->GetMixer(&inputSource, &inputVolume, &playbackVolume);
 
   const auto volume = mIsInput ? inputVolume : playbackVolume;
 
   if (mSlider && (mSlider->Get() != volume))
      mSlider->Set(volume);
 
#endif // USE_PORTMIXER
}

References AudioIO::Get(), mEnabled, mIsInput, and mSlider.

Referenced by MeterToolBar::AdjustInputGain(), MeterToolBar::AdjustOutputGain(), MeterToolBar::ShowInputGainDialog(), MeterToolBar::ShowOutputGainDialog(), and MeterToolBar::UpdateControls().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ MeterAx

friend class MeterAx

friend

Definition at line 303 of file MeterPanel.h.

Member Data Documentation

◆ mActive

bool MeterPanel::mActive

private

Definition at line 270 of file MeterPanel.h.

Referenced by IsActive(), OnAudioIOStatus(), RestoreState(), and ShowMenu().

◆ mAudioCaptureSubscription

Observer::Subscription MeterPanel::mAudioCaptureSubscription

private

Definition at line 238 of file MeterPanel.h.

◆ mAudioIOStatusSubscription

Observer::Subscription MeterPanel::mAudioIOStatusSubscription

private

Definition at line 237 of file MeterPanel.h.

◆ mBar

MeterBar MeterPanel::mBar[kMaxMeterBars] {}

private

Definition at line 273 of file MeterPanel.h.

Referenced by GetMaxPeak(), GetPeakHold(), HandleLayout(), IsClipping(), OnMeterUpdate(), OnPaint(), Reset(), and SetBarAndClip().

◆ mBitmap

std::unique_ptr<wxBitmap> MeterPanel::mBitmap

private

Definition at line 277 of file MeterPanel.h.

Referenced by DrawMeterBar(), and OnPaint().

◆ mBkgndBrush

wxBrush MeterPanel::mBkgndBrush

private

Definition at line 287 of file MeterPanel.h.

Referenced by DrawMeterBar(), and OnPaint().

◆ mBrush

wxBrush MeterPanel::mBrush

private

Definition at line 284 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mClip

bool MeterPanel::mClip

private

Definition at line 260 of file MeterPanel.h.

Referenced by DrawMeterBar(), and SetBarAndClip().

◆ mClipBrush

wxBrush MeterPanel::mClipBrush

private

Definition at line 286 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mDB

bool MeterPanel::mDB

private

Definition at line 256 of file MeterPanel.h.

Referenced by OnMeterUpdate(), OnPaint(), OnPreferences(), SetActiveStyle(), and UpdatePrefs().

◆ mDBRange

int MeterPanel::mDBRange

private

Definition at line 257 of file MeterPanel.h.

Referenced by OnMeterUpdate(), OnPaint(), SetActiveStyle(), and UpdatePrefs().

◆ mDecay

bool MeterPanel::mDecay

private

Definition at line 258 of file MeterPanel.h.

Referenced by OnMeterUpdate().

◆ mDecayRate

float MeterPanel::mDecayRate {}

private

Definition at line 259 of file MeterPanel.h.

Referenced by OnMeterUpdate().

◆ mDesiredStyle

Style MeterPanel::mDesiredStyle

private

Definition at line 254 of file MeterPanel.h.

Referenced by HandleLayout(), OnPreferences(), SetStyle(), and UpdatePrefs().

◆ mDisabledBkgndBrush

wxBrush MeterPanel::mDisabledBkgndBrush

private

Definition at line 288 of file MeterPanel.h.

◆ mEnabled

bool MeterPanel::mEnabled { true }

private

Definition at line 298 of file MeterPanel.h.

Referenced by OnAudioCapture(), UpdateSelectedPrefs(), and UpdateSliderControl().

◆ mFocusRect

wxRect MeterPanel::mFocusRect

private

Definition at line 301 of file MeterPanel.h.

◆ mGradient

bool MeterPanel::mGradient

private

Definition at line 255 of file MeterPanel.h.

Referenced by DrawMeterBar(), OnPaint(), OnPreferences(), and UpdatePrefs().

◆ mHeight

int MeterPanel::mHeight

private

Definition at line 246 of file MeterPanel.h.

Referenced by HandleLayout(), OnPaint(), and OnSize().

◆ mIsFocused

bool MeterPanel::mIsFocused {}

private

Definition at line 300 of file MeterPanel.h.

Referenced by OnKillFocus(), OnPaint(), and OnSetFocus().

◆ mIsInput

bool MeterPanel::mIsInput

private

Definition at line 251 of file MeterPanel.h.

Referenced by Key(), OnAudioIOStatus(), OnMeterUpdate(), OnPreferences(), SetMixer(), ShowMenu(), UpdateSelectedPrefs(), and UpdateSliderControl().

◆ mLayoutValid

bool MeterPanel::mLayoutValid

private

Definition at line 275 of file MeterPanel.h.

Referenced by HandleLayout(), OnMouse(), OnPaint(), OnSize(), RepaintBarsNow(), Reset(), SetStyle(), StartMonitoring(), and UpdatePrefs().

◆ mLeftSize

wxSize MeterPanel::mLeftSize

private

Definition at line 280 of file MeterPanel.h.

Referenced by HandleLayout(), and UpdatePrefs().

◆ mLeftText

wxString MeterPanel::mLeftText

private

Definition at line 291 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mLeftTextPos

wxPoint MeterPanel::mLeftTextPos

private

Definition at line 278 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mMeterBkgndBrush

wxBrush MeterPanel::mMeterBkgndBrush

private

Definition at line 289 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mMeterDisabled

long MeterPanel::mMeterDisabled {}

private

Definition at line 266 of file MeterPanel.h.

Referenced by IsMeterDisabled(), OnMeterUpdate(), and UpdatePrefs().

◆ mMeterRefreshRate

long MeterPanel::mMeterRefreshRate {}

private

Definition at line 265 of file MeterPanel.h.

Referenced by OnAudioIOStatus(), OnPreferences(), Reset(), RestoreState(), and UpdatePrefs().

◆ mMonitoring

bool MeterPanel::mMonitoring

private

Definition at line 268 of file MeterPanel.h.

Referenced by IsMonitoring(), OnAudioIOStatus(), RestoreState(), ShowMenu(), StartMonitoring(), and StopMonitoring().

◆ mNumBars

unsigned MeterPanel::mNumBars

private

Definition at line 272 of file MeterPanel.h.

Referenced by GetMaxPeak(), GetPeakHold(), HandleLayout(), IsClipping(), OnMeterUpdate(), OnPaint(), RepaintBarsNow(), and UpdateDisplay().

◆ mNumPeakSamplesToClip

int MeterPanel::mNumPeakSamplesToClip

private

Definition at line 261 of file MeterPanel.h.

Referenced by OnMeterUpdate(), and UpdateDisplay().

◆ mPeakHoldDuration

double MeterPanel::mPeakHoldDuration

private

Definition at line 262 of file MeterPanel.h.

Referenced by OnMeterUpdate().

◆ mPeakPeakPen

wxPen MeterPanel::mPeakPeakPen

private

Definition at line 283 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mPen

wxPen MeterPanel::mPen

private

Definition at line 282 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mProject

AudacityProject* MeterPanel::mProject

private

Definition at line 240 of file MeterPanel.h.

Referenced by OnAudioCapture(), OnAudioIOStatus(), OnPreferences(), and StartMonitoring().

◆ mQueue

MeterUpdateQueue MeterPanel::mQueue

private

Definition at line 241 of file MeterPanel.h.

Referenced by Clear(), OnMeterUpdate(), Reset(), and UpdateDisplay().

◆ mRate

double MeterPanel::mRate

private

Definition at line 264 of file MeterPanel.h.

Referenced by OnMeterUpdate(), Reset(), and UpdatePrefs().

◆ mRightSize

wxSize MeterPanel::mRightSize

private

Definition at line 281 of file MeterPanel.h.

Referenced by HandleLayout(), and UpdatePrefs().

◆ mRightText

wxString MeterPanel::mRightText

private

Definition at line 292 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mRightTextPos

wxPoint MeterPanel::mRightTextPos

private

Definition at line 279 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mRMSBrush

wxBrush MeterPanel::mRMSBrush

private

Definition at line 285 of file MeterPanel.h.

Referenced by DrawMeterBar().

◆ mRuler

Ruler MeterPanel::mRuler

private

Definition at line 290 of file MeterPanel.h.

Referenced by HandleLayout(), OnPaint(), and SetActiveStyle().

◆ mRulerHeight

int MeterPanel::mRulerHeight {}

private

Definition at line 249 of file MeterPanel.h.

Referenced by HandleLayout(), and SetActiveStyle().

◆ mRulerWidth

int MeterPanel::mRulerWidth {}

private

Definition at line 248 of file MeterPanel.h.

Referenced by HandleLayout(), and SetActiveStyle().

◆ mSlider

std::unique_ptr<LWSlider> MeterPanel::mSlider

private

Definition at line 294 of file MeterPanel.h.

Referenced by Decrease(), Increase(), OnAudioCapture(), OnKeyDown(), OnKillFocus(), OnMouse(), OnPaint(), OnTipTimeout(), SetMixer(), SetName(), ShowDialog(), UpdateSelectedPrefs(), and UpdateSliderControl().

◆ mSliderPos

wxPoint MeterPanel::mSliderPos

private

Definition at line 295 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mSliderSize

wxSize MeterPanel::mSliderSize

private

Definition at line 296 of file MeterPanel.h.

Referenced by HandleLayout(), and OnPaint().

◆ mStyle

Style MeterPanel::mStyle {}

private

Definition at line 253 of file MeterPanel.h.

Referenced by HandleLayout(), Key(), OnCharHook(), OnContext(), OnMouse(), OnPaint(), SetActiveStyle(), and SetStyle().

◆ mT

double MeterPanel::mT

private

Definition at line 263 of file MeterPanel.h.

Referenced by OnMeterUpdate(), and Reset().

◆ mTimer

wxTimer MeterPanel::mTimer

private

Definition at line 242 of file MeterPanel.h.

Referenced by OnAudioIOStatus(), Reset(), and RestoreState().

◆ mTipTimer

wxTimer MeterPanel::mTipTimer

private

Definition at line 243 of file MeterPanel.h.

Referenced by OnKillFocus(), and OnMouse().

◆ mWidth

int MeterPanel::mWidth

private

Definition at line 245 of file MeterPanel.h.

Referenced by HandleLayout(), OnPaint(), and OnSize().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Style

Constructor & Destructor Documentation

◆ MeterPanel()

Member Function Documentation

◆ Clear()

◆ Decrease()

◆ DrawMeterBar()

◆ GetDBRange()

◆ GetDesiredStyle()

◆ GetFont()

◆ GetMaxPeak()

◆ GetPeakHold()

◆ GetStyle()

◆ HandleLayout()

◆ Increase()

◆ IsActive()

◆ IsClipping()

◆ IsMeterDisabled()

◆ IsMonitoring()

◆ Key()

◆ OnAudioCapture()

◆ OnAudioIOStatus()

◆ OnCharHook()

◆ OnContext()

◆ OnErase()

◆ OnKeyDown()

◆ OnKillFocus()

◆ OnMeterUpdate()

◆ OnMonitor()

◆ OnMouse()

◆ OnPaint()

◆ OnPreferences()

◆ OnSetFocus()

◆ OnSize()

◆ OnTipTimeout()

◆ RepaintBarsNow()

◆ Reset()

◆ ResetBar()

◆ RestoreState()

◆ SaveState()

◆ SetActiveStyle()

◆ SetBarAndClip()

◆ SetFocusFromKbd()

◆ SetMixer()

◆ SetName()

◆ SetStyle()

◆ ShowDialog()

◆ ShowMenu()

◆ StartMonitoring()

◆ StopMonitoring()

◆ UpdateDisplay()

◆ UpdatePrefs()

◆ UpdateSelectedPrefs()

◆ UpdateSliderControl()

Friends And Related Function Documentation

◆ MeterAx

Member Data Documentation

◆ mActive

◆ mAudioCaptureSubscription

◆ mAudioIOStatusSubscription

◆ mBar

◆ mBitmap

◆ mBkgndBrush

◆ mBrush

◆ mClip

◆ mClipBrush

◆ mDB

◆ mDBRange

◆ mDecay

◆ mDecayRate

◆ mDesiredStyle