ContrastBase Class Reference

#include <ContrastBase.h>

Inheritance diagram for ContrastBase:

Public Attributes
double	mT0
double	mT1
double	mProjectRate
double	mStartTimeF
double	mEndTimeF
double	mStartTimeB
double	mEndTimeB

Protected Member Functions
bool	GetDB (float &dB)
void	SetStartAndEndTime ()

Protected Attributes
float	foregrounddB
float	backgrounddB
bool	mForegroundIsDefined
bool	mBackgroundIsDefined
double	mT0orig
double	mT1orig
bool	mDoBackground
double	length

Private Member Functions
virtual AudacityProject &	GetProject ()=0

Detailed Description

Definition at line 12 of file ContrastBase.h.

Member Function Documentation

GetDB()

bool ContrastBase::GetDB ( float &  dB )

protected

Definition at line 16 of file ContrastBase.cpp.

{
   float rms = float(0.0);
 
   // For stereo tracks: sqrt((mean(L)+mean(R))/2)
   double meanSq = 0.0;
 
   auto& p = GetProject();
   auto range = TrackList::Get(p).Selected<const WaveTrack>();
   auto numberSelectedTracks = range.size();
   using namespace BasicUI;
   if (numberSelectedTracks > 1)
   {
      ShowMessageBox(
         XO("You can only measure one track at a time."),
         MessageBoxOptions {}.IconStyle(Icon::Error));
      return false;
   }
   if (numberSelectedTracks == 0)
   {
      ShowMessageBox(
         XO("Please select an audio track."),
         MessageBoxOptions {}.IconStyle(Icon::Error));
      return false;
   }
 
   const auto first = *range.begin();
   const auto channels = first->Channels();
   assert(mT0 <= mT1);
   // Ignore whitespace beyond ends of track.
   mT0 = std::max(mT0, first->GetStartTime());
   mT1 = std::min(mT1, first->GetEndTime());
   for (auto t : channels)
   {
 
      auto SelT0 = t->TimeToLongSamples(mT0);
      auto SelT1 = t->TimeToLongSamples(mT1);
 
      if (SelT0 > SelT1)
      {
         ShowMessageBox(
            XO("Invalid audio selection.\nPlease ensure that audio is selected."),
            MessageBoxOptions {}.IconStyle(Icon::Error));
         return false;
      }
 
      if (SelT0 == SelT1)
      {
         ShowMessageBox(
            XO("Nothing to measure.\nPlease select a section of a track."),
            MessageBoxOptions {}.IconStyle(Icon::Error));
         return false;
      }
 
      // Don't throw in this analysis dialog
      rms = WaveChannelUtilities::GetRMS(*t, mT0, mT1, false);
      meanSq += rms * rms;
   }
   // TODO: This works for stereo, provided the audio clips are in both
   // channels. We should really count gaps between clips as silence.
   rms = (meanSq > 0.0) ? sqrt(meanSq / static_cast<double>(channels.size())) :
                          0.0;
 
   // Gives warning C4056, Overflow in floating-point constant arithmetic
   // -INFINITY is intentional here.
   // Looks like we are stuck with this warning, as
   // #pragma warning( disable : 4056)
   // even around the whole function does not disable it successfully.
 
   dB = (rms == 0.0) ? -INFINITY : LINEAR_TO_DB(rms);
   return true;
}

References TrackList::Get(), GetProject(), WaveChannelUtilities::GetRMS(), BasicUI::MessageBoxOptions::IconStyle(), INFINITY, LINEAR_TO_DB, min(), mT0, mT1, TrackList::Selected(), BasicUI::ShowMessageBox(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), staffpad::audio::simd::sqrt(), and XO().

Referenced by ContrastDialog::OnGetBackground(), and ContrastDialog::OnGetForeground().

Here is the call graph for this function:

Here is the caller graph for this function:

GetProject()

virtual AudacityProject & ContrastBase::GetProject ( )

privatepure virtual

Implemented in ContrastDialog.

Referenced by GetDB(), and SetStartAndEndTime().

Here is the caller graph for this function:

SetStartAndEndTime()

void ContrastBase::SetStartAndEndTime ( )

protected

Definition at line 89 of file ContrastBase.cpp.

{
   auto& p = GetProject();
   auto& selectedRegion = ViewInfo::Get(p).selectedRegion;
   mT0 = selectedRegion.t0();
   mT1 = selectedRegion.t1();
}

References ViewInfo::Get(), GetProject(), mT0, mT1, and ViewInfo::selectedRegion.

Referenced by ContrastDialog::OnGetBackground(), and ContrastDialog::OnGetForeground().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

backgrounddB

float ContrastBase::backgrounddB

protected

Definition at line 25 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), ContrastDialog::OnExport(), ContrastDialog::OnGetBackground(), and ContrastDialog::results().

foregrounddB

float ContrastBase::foregrounddB

protected

Definition at line 24 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), ContrastDialog::OnExport(), ContrastDialog::OnGetForeground(), and ContrastDialog::results().

length

double ContrastBase::length

protected

Definition at line 35 of file ContrastBase.h.

mBackgroundIsDefined

bool ContrastBase::mBackgroundIsDefined

protected

Definition at line 27 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), ContrastDialog::OnExport(), ContrastDialog::OnGetBackground(), ContrastDialog::OnReset(), and ContrastDialog::results().

mDoBackground

bool ContrastBase::mDoBackground

protected

Definition at line 31 of file ContrastBase.h.

mEndTimeB

double ContrastBase::mEndTimeB

Definition at line 21 of file ContrastBase.h.

mEndTimeF

double ContrastBase::mEndTimeF

Definition at line 19 of file ContrastBase.h.

mForegroundIsDefined

bool ContrastBase::mForegroundIsDefined

protected

Definition at line 26 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), ContrastDialog::OnExport(), ContrastDialog::OnGetForeground(), ContrastDialog::OnReset(), and ContrastDialog::results().

mProjectRate

double ContrastBase::mProjectRate

Definition at line 17 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog().

mStartTimeB

double ContrastBase::mStartTimeB

Definition at line 20 of file ContrastBase.h.

mStartTimeF

double ContrastBase::mStartTimeF

Definition at line 18 of file ContrastBase.h.

mT0

double ContrastBase::mT0

Definition at line 15 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), GetDB(), and SetStartAndEndTime().

mT0orig

double ContrastBase::mT0orig

protected

Definition at line 28 of file ContrastBase.h.

mT1

double ContrastBase::mT1

Definition at line 16 of file ContrastBase.h.

Referenced by ContrastDialog::ContrastDialog(), GetDB(), and SetStartAndEndTime().

mT1orig

double ContrastBase::mT1orig

protected

Definition at line 29 of file ContrastBase.h.

---

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

• ContrastBase.h
• ContrastBase.cpp