#include <CompressionMeterPanel.h>

Inheritance diagram for CompressionMeterPanel:

Collaboration diagram for CompressionMeterPanel:

Public Member Functions
	CompressionMeterPanel (wxWindow *parent, int id, CompressorInstance &instance, float dbRange, std::function< void()> onClipped)

void	SetDbRange (float dbRange)

void	Reset ()

void	ResetClipped ()

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

Protected Member Functions
	DECLARE_EVENT_TABLE ()

Private Member Functions
void	PaintMeter (wxPaintDC &dc, const wxColor &color, const wxRect &rect, const MeterValueProvider &provider)

void	OnPaint (wxPaintEvent &evt)

void	OnTimer (wxTimerEvent &evt)

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

Private Attributes
const std::shared_ptr< DynamicRangeProcessorMeterValuesQueue >	mMeterValuesQueue

const Observer::Subscription	mPlaybackStartStopSubscription

const Observer::Subscription	mPlaybackPausedSubscription

const std::function< void()>	mOnClipped

std::unique_ptr< MeterValueProvider >	mCompressionMeter

std::unique_ptr< MeterValueProvider >	mOutputMeter

float	mDbBottomEdgeValue

wxTimer	mTimer

bool	mStopWhenZero = false

bool	mClipped = false

Detailed Description

Definition at line 25 of file CompressionMeterPanel.h.

Constructor & Destructor Documentation

◆ CompressionMeterPanel()

CompressionMeterPanel::CompressionMeterPanel	(	wxWindow *	parent,
		int	id,
		CompressorInstance &	instance,
		float	dbRange,
		std::function< void()>	onClipped
	)

Definition at line 38 of file CompressionMeterPanel.cpp.

    : wxPanelWrapper { parent, id }
    , mMeterValuesQueue { std::make_unique<
         DynamicRangeProcessorMeterValuesQueue>(audioFramesPerTick) }
    , mPlaybackStartStopSubscription { static_cast<
                                          InitializeProcessingSettingsPublisher&>(
                                          instance)
                                          .Subscribe(
                                             [&](const std::optional<
                                                 InitializeProcessingSettings>&
                                                    evt) {
                                                if (evt)
                                                   Reset();
                                                else
                                                   mStopWhenZero = true;
                                             }) }
    , mPlaybackPausedSubscription { AudioIO::Get()->Subscribe(
         [this](const AudioIOEvent& evt) {
            if (evt.type != AudioIOEvent::PAUSE)
               return;
            if (evt.on)
               mTimer.Stop();
            else
               mTimer.Start(compressorMeterUpdatePeriodMs);
         }) }
    , mOnClipped { onClipped }
    , mDbBottomEdgeValue { -dbRange }
    , mCompressionMeter { MeterValueProvider::Create(
         MeterValueProvider::Direction::Downwards) }
    , mOutputMeter { MeterValueProvider::Create(
         MeterValueProvider::Direction::Upwards) }
{
   if (instance.GetSampleRate().has_value())
      // Playback is ongoing, and so the `InitializeProcessingSettings` event
      // was already fired.
      Reset();
   instance.SetMeterValuesQueue(mMeterValuesQueue);
   mTimer.SetOwner(this, timerId);
   SetDoubleBuffered(true);
}

Member Function Documentation

◆ AcceptsFocus()

bool CompressionMeterPanel::AcceptsFocus ( ) const

overrideprivate

Definition at line 218 of file CompressionMeterPanel.cpp.

{
   return false;
}

◆ AcceptsFocusFromKeyboard()

bool CompressionMeterPanel::AcceptsFocusFromKeyboard ( ) const

overrideprivate

Definition at line 223 of file CompressionMeterPanel.cpp.

{
   return false;
}

◆ DECLARE_EVENT_TABLE()

CompressionMeterPanel::DECLARE_EVENT_TABLE ( )

protected

◆ OnPaint()

void CompressionMeterPanel::OnPaint ( wxPaintEvent & evt )

private

Definition at line 103 of file CompressionMeterPanel.cpp.

{
   using namespace DynamicRangeProcessorPanel;
 
   wxPaintDC dc(this);
 
   const auto rect = DynamicRangeProcessorPanel::GetPanelRect(*this);
   const auto gc = MakeGraphicsContext(dc);
   const auto left = rect.GetLeft();
   const auto top = rect.GetTop();
   const auto width = rect.GetWidth();
   const auto height = rect.GetHeight();
 
   gc->SetPen(*wxTRANSPARENT_PEN);
   gc->SetBrush(GetGraphBackgroundBrush(*gc, height));
   gc->DrawRectangle(left, top, width, height);
 
   auto leftRect = rect;
   leftRect.SetWidth(rect.GetWidth() / 2 - 2);
   leftRect.Offset(1, 0);
   PaintMeter(dc, actualCompressionColor, leftRect, *mCompressionMeter);
 
   auto rightRect = leftRect;
   rightRect.Offset(leftRect.GetWidth(), 0);
   PaintMeter(dc, outputColor, rightRect, *mOutputMeter);
 
   gc->SetPen(lineColor);
   gc->SetBrush(wxNullBrush);
   gc->DrawRectangle(left, top, width, height);
}

References DynamicRangeProcessorPanel::actualCompressionColor, DynamicRangeProcessorPanel::GetGraphBackgroundBrush(), DynamicRangeProcessorPanel::GetPanelRect(), DynamicRangeProcessorPanel::lineColor, DynamicRangeProcessorPanel::MakeGraphicsContext(), mCompressionMeter, mOutputMeter, DynamicRangeProcessorPanel::outputColor, and PaintMeter().

Here is the call graph for this function:

◆ OnTimer()

void CompressionMeterPanel::OnTimer ( wxTimerEvent & evt )

private

Definition at line 181 of file CompressionMeterPanel.cpp.

{
   // Take the max of all values newly pushed by the audio frames - make sure we
   // don't miss a peak.
   MeterValues values;
   auto lowestCompressionGain = 0.f;
   auto highestOutputGain = std::numeric_limits<float>::lowest();
   while (mMeterValuesQueue->Get(values))
   {
      lowestCompressionGain =
         std::min(values.compressionGainDb, lowestCompressionGain);
      highestOutputGain = std::max(values.outputDb, highestOutputGain);
   }
 
   const auto updateFiveSecondMax = !mStopWhenZero;
   mCompressionMeter->Update(lowestCompressionGain, updateFiveSecondMax);
   mOutputMeter->Update(highestOutputGain, updateFiveSecondMax);
   const auto clipped = mOutputMeter->GetCurrentMax() > 0;
   if (clipped && !mClipped)
   {
      mOnClipped();
      mClipped = true;
   }
 
   Refresh(false);
 
   if (
      mCompressionMeter->IsInvisible() && mOutputMeter->IsInvisible() &&
      mStopWhenZero)
   {
      // Decay is complete. Until playback starts again, no need for
      // timer-triggered updates.
      mTimer.Stop();
      mStopWhenZero = false;
   }
}

References mClipped, mCompressionMeter, min(), mMeterValuesQueue, mOnClipped, mOutputMeter, mStopWhenZero, mTimer, and values.

Here is the call graph for this function:

◆ PaintMeter()

void CompressionMeterPanel::PaintMeter	(	wxPaintDC &	dc,
		const wxColor &	color,
		const wxRect &	rect,
		const MeterValueProvider &	provider
	)

private

Definition at line 134 of file CompressionMeterPanel.cpp.

{
   const auto dB = provider.GetCurrentMax();
   const auto maxDb = provider.GetGlobalMax();
   const auto fiveSecMaxDb = provider.GetFiveSecMax();
   const auto downwards =
      provider.GetDirection() == MeterValueProvider::Direction::Downwards;
 
   const auto gc = MakeGraphicsContext(dc);
 
   const double left = rect.GetLeft();
   const double top = rect.GetTop();
   const double width = rect.GetWidth();
   const double height = rect.GetHeight();
 
   constexpr auto lineWidth = 6.;
 
   const double dbFrac = std::clamp<double>(dB / mDbBottomEdgeValue, 0., 1.);
   // So that the top of the cap is aligned with the dB value.
   const auto yAdjust = lineWidth / 2 * (downwards ? -1 : 1);
   const double dbY = height * dbFrac + yAdjust;
   const double maxDbY = maxDb / mDbBottomEdgeValue * height + yAdjust;
   const double fiveSecMaxDbY =
      fiveSecMaxDb / mDbBottomEdgeValue * height + yAdjust;
 
   const auto levelTop = downwards ? top : dbY;
   const auto levelHeight = downwards ? dbY : height - dbY;
   const auto maxLevelTop = downwards ? levelHeight - top : maxDbY;
   const auto maxLevelHeight = std::abs(maxDbY - dbY);
 
   const auto rectLeft = left + 3;
   const auto rectWidth = width - 4;
   const auto opaqueColor = wxColor { color.GetRGB() };
   gc->SetBrush(GetColorMix(opaqueColor, wxTransparentColor, 0.8));
   gc->DrawRectangle(rectLeft, levelTop, rectWidth, levelHeight);
   gc->SetBrush(GetColorMix(opaqueColor, wxTransparentColor, 0.6));
   gc->DrawRectangle(rectLeft, maxLevelTop, rectWidth, maxLevelHeight);
   gc->SetBrush(opaqueColor);
   gc->DrawRectangle(rectLeft, dbY - 2, rectWidth, lineWidth);
   gc->DrawRectangle(rectLeft, maxDbY - 2, rectWidth, lineWidth);
   gc->SetPen({ opaqueColor, static_cast<int>(lineWidth / 2) });
   gc->StrokeLine(
      left + rectWidth / 2, fiveSecMaxDbY, left + rectWidth, fiveSecMaxDbY);
}

References MeterValueProvider::Downwards, DynamicRangeProcessorPanel::GetColorMix(), MeterValueProvider::GetCurrentMax(), MeterValueProvider::GetDirection(), MeterValueProvider::GetFiveSecMax(), MeterValueProvider::GetGlobalMax(), DynamicRangeProcessorPanel::MakeGraphicsContext(), and mDbBottomEdgeValue.

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void CompressionMeterPanel::Reset ( )

Definition at line 87 of file CompressionMeterPanel.cpp.

{
   mCompressionMeter =
      MeterValueProvider::Create(MeterValueProvider::Direction::Downwards);
   mOutputMeter =
      MeterValueProvider::Create(MeterValueProvider::Direction::Upwards);
   mStopWhenZero = false;
   mClipped = false;
   mTimer.Start(compressorMeterUpdatePeriodMs);
}

References compressorMeterUpdatePeriodMs, MeterValueProvider::Create(), MeterValueProvider::Downwards, mClipped, mCompressionMeter, mOutputMeter, mStopWhenZero, mTimer, and MeterValueProvider::Upwards.

Here is the call graph for this function:

◆ ResetClipped()

void CompressionMeterPanel::ResetClipped ( )

Definition at line 98 of file CompressionMeterPanel.cpp.

{
   mClipped = false;
}

References mClipped.

◆ SetDbRange()

void CompressionMeterPanel::SetDbRange ( float dbRange )

Definition at line 81 of file CompressionMeterPanel.cpp.

{
   mDbBottomEdgeValue = -dbRange;
   Refresh(true);
}

References mDbBottomEdgeValue.

Member Data Documentation

◆ mClipped

bool CompressionMeterPanel::mClipped = false

private

Definition at line 62 of file CompressionMeterPanel.h.

Referenced by OnTimer(), Reset(), and ResetClipped().

◆ mCompressionMeter

std::unique_ptr<MeterValueProvider> CompressionMeterPanel::mCompressionMeter

private

Definition at line 56 of file CompressionMeterPanel.h.

Referenced by OnPaint(), OnTimer(), and Reset().

◆ mDbBottomEdgeValue

float CompressionMeterPanel::mDbBottomEdgeValue

private

Definition at line 58 of file CompressionMeterPanel.h.

Referenced by PaintMeter(), and SetDbRange().

◆ mMeterValuesQueue

const std::shared_ptr<DynamicRangeProcessorMeterValuesQueue> CompressionMeterPanel::mMeterValuesQueue

private

Definition at line 52 of file CompressionMeterPanel.h.

Referenced by OnTimer().

◆ mOnClipped

const std::function<void()> CompressionMeterPanel::mOnClipped

private

Definition at line 55 of file CompressionMeterPanel.h.

Referenced by OnTimer().

◆ mOutputMeter

std::unique_ptr<MeterValueProvider> CompressionMeterPanel::mOutputMeter

private

Definition at line 57 of file CompressionMeterPanel.h.

Referenced by OnPaint(), OnTimer(), and Reset().

◆ mPlaybackPausedSubscription

const Observer::Subscription CompressionMeterPanel::mPlaybackPausedSubscription

private

Definition at line 54 of file CompressionMeterPanel.h.

◆ mPlaybackStartStopSubscription

const Observer::Subscription CompressionMeterPanel::mPlaybackStartStopSubscription

private

Definition at line 53 of file CompressionMeterPanel.h.

◆ mStopWhenZero

bool CompressionMeterPanel::mStopWhenZero = false

private

Definition at line 61 of file CompressionMeterPanel.h.

Referenced by OnTimer(), and Reset().

◆ mTimer

wxTimer CompressionMeterPanel::mTimer

private

Definition at line 60 of file CompressionMeterPanel.h.

Referenced by OnTimer(), and Reset().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CompressionMeterPanel()

Member Function Documentation

◆ AcceptsFocus()

◆ AcceptsFocusFromKeyboard()

◆ DECLARE_EVENT_TABLE()

◆ OnPaint()

◆ OnTimer()

◆ PaintMeter()

◆ Reset()

◆ ResetClipped()

◆ SetDbRange()

Member Data Documentation

◆ mClipped

◆ mCompressionMeter

◆ mDbBottomEdgeValue

◆ mMeterValuesQueue

◆ mOnClipped

◆ mOutputMeter

◆ mPlaybackPausedSubscription

◆ mPlaybackStartStopSubscription

◆ mStopWhenZero

◆ mTimer