#include <DownwardMeterValueProvider.h>

Inheritance diagram for DownwardMeterValueProvider:

Collaboration diagram for DownwardMeterValueProvider:

Public Member Functions
	DownwardMeterValueProvider (float upperValue=0.f)

	~DownwardMeterValueProvider ()=default

void	Update (float value, bool alsoFiveSecondMax) override

float	GetGlobalMax () const override

float	GetFiveSecMax () const override

float	GetCurrentMax () const override

Direction	GetDirection () const override

bool	IsInvisible () const override

Public Member Functions inherited from MeterValueProvider
virtual	~MeterValueProvider ()=default

virtual void	Update (float value, bool alsoFiveSecondMax)=0

virtual float	GetGlobalMax () const =0

virtual float	GetFiveSecMax () const =0

virtual float	GetCurrentMax () const =0

virtual Direction	GetDirection () const =0

virtual bool	IsInvisible () const =0

Private Attributes
const float	mUpperValue

float	mGlobalMin

float	mCurrentMin

float	mFiveSecMinState

std::vector< std::pair< int, float > >	mLastFiveSeconds

std::array< float, ringBufferLength >	mRingBuffer

size_t	mRingBufferIndex = 0

int	mTimerCount = 0

Static Private Attributes
static constexpr auto	displayDelayMs = 100

static constexpr auto	ringBufferLength

Additional Inherited Members
Public Types inherited from MeterValueProvider
enum class	Direction { Upwards , Downwards }

Static Public Member Functions inherited from MeterValueProvider
static std::unique_ptr< MeterValueProvider >	Create (Direction direction)

Detailed Description

Audacity: A Digital Audio Editor

DownwardMeterValueProvider.h

Matthieu Hodgkinson

Definition at line 19 of file DownwardMeterValueProvider.h.

Constructor & Destructor Documentation

◆ DownwardMeterValueProvider()

DownwardMeterValueProvider::DownwardMeterValueProvider ( float upperValue = 0.f )

Definition at line 24 of file DownwardMeterValueProvider.cpp.

    : mUpperValue { upperValue }
    , mGlobalMin { upperValue }
    , mCurrentMin { upperValue }
    , mFiveSecMinState { upperValue }
{
   mRingBuffer.fill(upperValue);
}

References mRingBuffer.

◆ ~DownwardMeterValueProvider()

DownwardMeterValueProvider::~DownwardMeterValueProvider ( )

default

Member Function Documentation

◆ GetCurrentMax()

float DownwardMeterValueProvider::GetCurrentMax ( ) const

overridevirtual

Implements MeterValueProvider.

Definition at line 79 of file DownwardMeterValueProvider.cpp.

{
   return mCurrentMin;
}

References mCurrentMin.

Referenced by UpwardMeterValueProvider::GetCurrentMax().

Here is the caller graph for this function:

◆ GetDirection()

DownwardMeterValueProvider::Direction DownwardMeterValueProvider::GetDirection ( ) const

overridevirtual

Implements MeterValueProvider.

Definition at line 85 of file DownwardMeterValueProvider.cpp.

{
   return Direction::Downwards;
}

References MeterValueProvider::Downwards.

◆ GetFiveSecMax()

float DownwardMeterValueProvider::GetFiveSecMax ( ) const

overridevirtual

Implements MeterValueProvider.

Definition at line 74 of file DownwardMeterValueProvider.cpp.

{
   return mFiveSecMinState;
}

References mFiveSecMinState.

Referenced by UpwardMeterValueProvider::GetFiveSecMax().

Here is the caller graph for this function:

◆ GetGlobalMax()

float DownwardMeterValueProvider::GetGlobalMax ( ) const

overridevirtual

Implements MeterValueProvider.

Definition at line 69 of file DownwardMeterValueProvider.cpp.

{
   return mGlobalMin;
}

References mGlobalMin.

Referenced by UpwardMeterValueProvider::GetGlobalMax().

Here is the caller graph for this function:

◆ IsInvisible()

bool DownwardMeterValueProvider::IsInvisible ( ) const

overridevirtual

Implements MeterValueProvider.

Definition at line 90 of file DownwardMeterValueProvider.cpp.

{
   return mCurrentMin >= mUpperValue;
}

References mCurrentMin, and mUpperValue.

Referenced by UpwardMeterValueProvider::IsInvisible().

Here is the caller graph for this function:

◆ Update()

void DownwardMeterValueProvider::Update	(	float	value,
		bool	alsoFiveSecondMax
	)

overridevirtual

Implements MeterValueProvider.

Definition at line 33 of file DownwardMeterValueProvider.cpp.

{
   ++mTimerCount;
 
   const auto value = mRingBuffer[mRingBufferIndex];
   mRingBuffer[mRingBufferIndex] = newValue;
   mRingBufferIndex = (mRingBufferIndex + 1) % ringBufferLength;
 
   if (value < mCurrentMin)
   {
      mCurrentMin = value;
      mGlobalMin = std::min(mGlobalMin, value);
   }
   else
      mCurrentMin = std::min(mCurrentMin + decayPerTickDb, mUpperValue);
 
   mLastFiveSeconds.emplace_back(mTimerCount, value);
   while (!mLastFiveSeconds.empty() &&
          mLastFiveSeconds.front().first < mTimerCount - maxTickCount)
      mLastFiveSeconds.erase(mLastFiveSeconds.begin());
 
   if (!mLastFiveSeconds.empty() && alsoFiveSecondMax)
   {
      const auto rawMin =
         std::min_element(
            mLastFiveSeconds.begin(), mLastFiveSeconds.end(),
            [](const auto& a, const auto& b) { return a.second < b.second; })
            ->second;
      if (rawMin <= mFiveSecMinState)
         mFiveSecMinState = rawMin;
      else
         mFiveSecMinState =
            std::min(mFiveSecMinState + decayPerTickDb, mUpperValue);
   }
}