#include <Contrast.h>

Inheritance diagram for ContrastDialog:

Collaboration diagram for ContrastDialog:

Public Member Functions
	ContrastDialog (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos)

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Attributes
wxButton *	m_pButton_UseCurrentF

wxButton *	m_pButton_UseCurrentB

wxButton *	m_pButton_GetURL

wxButton *	m_pButton_Export

wxButton *	m_pButton_Reset

wxButton *	m_pButton_Close

NumericTextCtrl *	mForegroundStartT

NumericTextCtrl *	mForegroundEndT

NumericTextCtrl *	mBackgroundStartT

NumericTextCtrl *	mBackgroundEndT

double	mT0

double	mT1

double	mProjectRate

double	mStartTimeF

double	mEndTimeF

double	mStartTimeB

double	mEndTimeB

Private Member Functions
void	OnChar (wxKeyEvent &event)

void	OnGetURL (wxCommandEvent &event)

void	OnExport (wxCommandEvent &event)

void	OnGetForeground (wxCommandEvent &event)

void	OnGetBackground (wxCommandEvent &event)

void	results ()

void	OnReset (wxCommandEvent &event)

void	OnClose (wxCommandEvent &event)

bool	GetDB (float &dB)

void	SetStartAndEndTime ()

Private Attributes
wxTextCtrl *	mForegroundRMSText

wxTextCtrl *	mBackgroundRMSText

wxTextCtrl *	mPassFailText

wxTextCtrl *	mDiffText

float	foregrounddB

float	backgrounddB

bool	mForegroundIsDefined

bool	mBackgroundIsDefined

double	mT0orig

double	mT1orig

bool	mDoBackground

double	length

Detailed Description

Definition at line 27 of file Contrast.h.

Constructor & Destructor Documentation

◆ ContrastDialog()

ContrastDialog::ContrastDialog	(	wxWindow *	parent,
		wxWindowID	id,
		const TranslatableString &	title,
		const wxPoint &	pos
	)

Definition at line 193 of file Contrast.cpp.

                                               :
  wxDialogWrapper(parent, id, title, pos, wxDefaultSize,
     wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxMAXIMIZE_BOX )
{
   SetName();
 
   mT0 = 0.0;
   mT1 = 0.0;
   foregrounddB = 0.0;
   backgrounddB = 0.0;
   mForegroundIsDefined = false;
   mBackgroundIsDefined = false;
 
   // NULL out the control members until the controls are created.
   mForegroundStartT = NULL;
   mForegroundEndT = NULL;
   mBackgroundStartT = NULL;
   mBackgroundEndT = NULL;
   wxString number;
 
   auto p = FindProjectFromWindow( this );
   mProjectRate = ProjectRate::Get(*p).GetRate();
 
      const auto options = NumericTextCtrl::Options{}
         .AutoPos(true)
         .MenuEnabled(false)
         .ReadOnly(true);
 
   ShuttleGui S(this, eIsCreating);
 
   S.SetBorder(5);
   S.StartHorizontalLay(wxCENTER, false);
   {
      S.AddTitle(
         /* i18n-hint: RMS abbreviates root mean square, a certain averaging method */
         XO("Contrast Analyzer, for measuring RMS volume differences between two selections of audio."));
   }
   S.EndHorizontalLay();
   S.StartStatic( XO("Parameters") );
   {
      S.StartMultiColumn(5, wxEXPAND);
      {
 
         // Headings
         S.AddFixedText( {} );   // spacer
         S.AddFixedText(XO("Start"));
         S.AddFixedText(XO("End"));
         S.AddFixedText( {} );   // spacer
         S.AddFixedText(XO("Volume    "));
 
         //Foreground
         S.AddFixedText(XO("&Foreground:"), false);
         if (S.GetMode() == eIsCreating)
         {
            mForegroundStartT = safenew
               NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                         S.GetParent(), ID_FOREGROUNDSTART_T,
                         NumericConverterType_TIME(),
                         NumericConverterFormats::HundredthsFormat().Internal(),
                         0.0,
                         options);
         }
         S.Name(XO("Foreground start time"))
            .AddWindow(mForegroundStartT);
 
         if (S.GetMode() == eIsCreating)
         {
            mForegroundEndT = safenew
               NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                         S.GetParent(), ID_FOREGROUNDEND_T,
                         NumericConverterType_TIME(),
                         NumericConverterFormats::HundredthsFormat().Internal(),
                         0.0,
                         options);
         }
         S.Name(XO("Foreground end time"))
            .AddWindow(mForegroundEndT);
 
         m_pButton_UseCurrentF = S.Id(ID_BUTTON_USECURRENTF).AddButton(XXO("&Measure selection"));
         mForegroundRMSText = S.Id(ID_FOREGROUNDDB_TEXT)
            .ConnectRoot(wxEVT_KEY_DOWN,
                         &ContrastDialog::OnChar)
            .AddTextBox( {}, wxT(""), 17);
 
         //Background
         S.AddFixedText(XO("&Background:"));
         if (S.GetMode() == eIsCreating)
         {
            mBackgroundStartT = safenew
               NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                         S.GetParent(), ID_BACKGROUNDSTART_T,
                         NumericConverterType_TIME(),
                         NumericConverterFormats::HundredthsFormat().Internal(),
                         0.0,
                         options);
         }
         S.Name(XO("Background start time"))
            .AddWindow(mBackgroundStartT);
 
         if (S.GetMode() == eIsCreating)
         {
            mBackgroundEndT = safenew
               NumericTextCtrl(FormatterContext::SampleRateContext(mProjectRate),
                         S.GetParent(), ID_BACKGROUNDEND_T,
                         NumericConverterType_TIME(),
                         NumericConverterFormats::HundredthsFormat().Internal(),
                         0.0,
                         options);
         }
         S.Name(XO("Background end time"))
            .AddWindow(mBackgroundEndT);
 
         m_pButton_UseCurrentB = S.Id(ID_BUTTON_USECURRENTB).AddButton(XXO("Mea&sure selection"));
         mBackgroundRMSText = S.Id(ID_BACKGROUNDDB_TEXT)
            .ConnectRoot(wxEVT_KEY_DOWN,
                         &ContrastDialog::OnChar)
            .AddTextBox( {}, wxT(""), 17);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   //Result
   S.StartStatic( XO("Result") );
   {
      S.StartMultiColumn(3, wxCENTER);
      {
         auto label = XO("Co&ntrast Result:");
         S.AddFixedText(label);
         mPassFailText = S.Id(ID_RESULTS_TEXT)
            .Name(label)
            .ConnectRoot(wxEVT_KEY_DOWN,
                         &ContrastDialog::OnChar)
            .AddTextBox( {}, wxT(""), 50);
         m_pButton_Reset = S.Id(ID_BUTTON_RESET).AddButton(XXO("R&eset"));
 
         label = XO("&Difference:");
         S.AddFixedText(label);
         mDiffText = S.Id(ID_RESULTSDB_TEXT)
            .Name(label)
            .ConnectRoot(wxEVT_KEY_DOWN,
                         &ContrastDialog::OnChar)
            .AddTextBox( {}, wxT(""), 50);
         m_pButton_Export = S.Id(ID_BUTTON_EXPORT).AddButton(XXO("E&xport..."));
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
   S.AddStandardButtons(eCloseButton |eHelpButton);
#if 0
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(1);
      m_pButton_GetURL = S.Id(ID_BUTTON_GETURL).AddButton(XO("&Help"));
      S.AddFixedText({});   // spacer
      m_pButton_Close = S.Id(ID_BUTTON_CLOSE).AddButton(XO("&Close"));
   }
   S.EndMultiColumn();
#endif
   Layout();
   Fit();
   SetMinSize(GetSize());
   Center();
}

References NumericTextCtrl::Options::AutoPos(), backgrounddB, eCloseButton, eHelpButton, eIsCreating, FindProjectFromWindow(), foregrounddB, ProjectRate::Get(), ProjectRate::GetRate(), NumericConverterFormats::HundredthsFormat(), ID_BACKGROUNDDB_TEXT, ID_BACKGROUNDEND_T, ID_BACKGROUNDSTART_T, ID_BUTTON_EXPORT, ID_BUTTON_RESET, ID_BUTTON_USECURRENTB, ID_BUTTON_USECURRENTF, ID_FOREGROUNDDB_TEXT, ID_FOREGROUNDEND_T, ID_FOREGROUNDSTART_T, ID_RESULTS_TEXT, ID_RESULTSDB_TEXT, Internal, label, m_pButton_Close, m_pButton_Export, m_pButton_GetURL, m_pButton_Reset, m_pButton_UseCurrentB, m_pButton_UseCurrentF, mBackgroundEndT, mBackgroundIsDefined, mBackgroundRMSText, mBackgroundStartT, mDiffText, NumericTextCtrl::Options::MenuEnabled(), mForegroundEndT, mForegroundIsDefined, mForegroundRMSText, mForegroundStartT, mPassFailText, mProjectRate, mT0, mT1, NumericConverterType_TIME(), OnChar(), NumericTextCtrl::Options::ReadOnly(), S, safenew, FormatterContext::SampleRateContext(), wxDialogWrapper::SetName(), wxT(), XO(), and XXO().

Here is the call graph for this function:

Member Function Documentation

◆ GetDB()

bool ContrastDialog::GetDB ( float & dB )

private

Definition at line 53 of file Contrast.cpp.

{
   float rms = float(0.0);
 
   // For stereo tracks: sqrt((mean(L)+mean(R))/2)
   double meanSq = 0.0;
 
   auto p = FindProjectFromWindow( this );
   auto range =
      TrackList::Get(*p).Selected<const WaveTrack>();
   auto numberSelectedTracks = range.size();
   if (numberSelectedTracks > 1) {
      AudacityMessageDialog m(
         nullptr,
         XO("You can only measure one track at a time."),
         XO("Error"),
         wxOK);
      m.ShowModal();
      return false;
   }
   if(numberSelectedTracks == 0) {
      AudacityMessageDialog m(
         nullptr,
         XO("Please select an audio track."),
         XO("Error"),
         wxOK);
      m.ShowModal();
      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)
      {
         AudacityMessageDialog m(
            nullptr,
            XO("Invalid audio selection.\nPlease ensure that audio is selected."),
            XO("Error"),
            wxOK);
         m.ShowModal();
         return false;
      }
 
      if(SelT0 == SelT1)
      {
         AudacityMessageDialog m(
            nullptr,
            XO("Nothing to measure.\nPlease select a section of a track."),
            XO("Error"),
            wxOK);
         m.ShowModal();
         return false;
      }
 
      // Don't throw in this analysis dialog
      rms = t->GetRMS(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 FindProjectFromWindow(), TrackList::Get(), INFINITY, LINEAR_TO_DB, min(), mT0, mT1, TrackList::Selected(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), staffpad::audio::simd::sqrt(), and XO().

Referenced by OnGetBackground(), and OnGetForeground().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnChar()

void ContrastDialog::OnChar ( wxKeyEvent & event )

private

Definition at line 179 of file Contrast.cpp.

{
   // Is this still required?
   if (event.GetKeyCode() == WXK_TAB) {
      // pass to next handler
      event.Skip();
      return;
   }
 
   // ignore any other key
   event.Skip(false);
   return;
}

Referenced by ContrastDialog().

Here is the caller graph for this function:

◆ OnClose()

void ContrastDialog::OnClose ( wxCommandEvent & event )

private

Definition at line 367 of file Contrast.cpp.

{
   wxCommandEvent dummyEvent;
   OnReset(dummyEvent);
 
   Show(false);
}

References OnReset(), and ExportProgressUI::Show().

Here is the call graph for this function:

◆ OnExport()

void ContrastDialog::OnExport ( wxCommandEvent & event )

private

Definition at line 529 of file Contrast.cpp.

{
   // TODO: Handle silence checks better (-infinity dB)
   auto project = FindProjectFromWindow( this );
   wxString fName = wxT("contrast.txt");
 
   fName = SelectFile(FileNames::Operation::Export,
      XO("Export Contrast Result As:"),
      wxEmptyString,
      fName,
      wxT("txt"),
      { FileNames::TextFiles, FileNames::AllFiles },
      wxFD_SAVE | wxRESIZE_BORDER,
      this);
 
   if (fName.empty())
      return;
 
   wxFFileOutputStream ffStream{ fName };
 
   if (!ffStream.IsOk()) {
      AudacityMessageBox( XO("Couldn't write to file: %s").Format( fName ) );
      return;
   }
 
   wxTextOutputStream ss(ffStream);
 
   ss
      << wxT("===================================") << '\n'
   /* i18n-hint: WCAG abbreviates Web Content Accessibility Guidelines */
      << XO("WCAG 2.0 Success Criteria 1.4.7 Contrast Results") << '\n'
      << '\n'
      << XO("Filename = %s.").Format( ProjectFileIO::Get(*project).GetFileName() ) << '\n'
      << '\n'
      << XO("Foreground") << '\n';
 
   float t = (float)mForegroundStartT->GetValue();
   int h = (int)(t/3600);  // there must be a standard function for this!
   int m = (int)((t - h*3600)/60);
   float s = t - h*3600.0 - m*60.0;
 
   ss
      << XO("Time started = %2d hour(s), %2d minute(s), %.2f seconds.")
         .Format( h, m, s ) << '\n';
 
   t = (float)mForegroundEndT->GetValue();
   h = (int)(t/3600);
   m = (int)((t - h*3600)/60);
   s = t - h*3600.0 - m*60.0;
 
   ss
      << XO("Time ended = %2d hour(s), %2d minute(s), %.2f seconds.")
         .Format( h, m, s ) << '\n'
      << FormatRMSMessage( mForegroundIsDefined ? &foregrounddB : nullptr ) << '\n'
      << '\n'
      << XO("Background") << '\n';
 
   t = (float)mBackgroundStartT->GetValue();
   h = (int)(t/3600);
   m = (int)((t - h*3600)/60);
   s = t - h*3600.0 - m*60.0;
 
   ss
      << XO("Time started = %2d hour(s), %2d minute(s), %.2f seconds.")
         .Format( h, m, s ) << '\n';
 
   t = (float)mBackgroundEndT->GetValue();
   h = (int)(t/3600);
   m = (int)((t - h*3600)/60);
   s = t - h*3600.0 - m*60.0;
 
   ss
      << XO("Time ended = %2d hour(s), %2d minute(s), %.2f seconds.")
         .Format( h, m, s ) << '\n'
      << FormatRMSMessage( mBackgroundIsDefined ? &backgrounddB : nullptr ) << '\n'
      << '\n'
      << XO("Results") << '\n';
 
   float diffdB = foregrounddB - backgrounddB;
 
   ss
      << FormatDifferenceForExport( diffdB ) << '\n'
      << (( diffdB > 20. )
         ? XO("Success Criteria 1.4.7 of WCAG 2.0: Pass")
         : XO("Success Criteria 1.4.7 of WCAG 2.0: Fail")) << '\n'
      << '\n'
      << XO("Data gathered") << '\n';
 
   wxDateTime now = wxDateTime::Now();
   int year = now.GetYear();
   wxDateTime::Month month = now.GetMonth();
   wxString monthName = now.GetMonthName(month);
   int dom = now.GetDay();
   int hour = now.GetHour();
   int minute = now.GetMinute();
   int second = now.GetSecond();
   /* i18n-hint: day of month, month, year, hour, minute, second */
   auto sNow = XO("%d %s %02d %02dh %02dm %02ds")
      .Format( dom, monthName, year, hour, minute, second );
 
   ss <<
      sNow << '\n'
      << wxT("===================================") << '\n'
      << '\n';
}

References FileNames::AllFiles, AudacityMessageBox(), backgrounddB, FindProjectFromWindow(), foregrounddB, anonymous_namespace{Contrast.cpp}::FormatDifferenceForExport(), anonymous_namespace{Contrast.cpp}::FormatRMSMessage(), ProjectFileIO::Get(), ProjectFileIO::GetFileName(), NumericConverter::GetValue(), mBackgroundEndT, mBackgroundIsDefined, mBackgroundStartT, mForegroundEndT, mForegroundIsDefined, mForegroundStartT, project, SelectFile(), FileNames::TextFiles, wxT(), and XO().

Here is the call graph for this function:

◆ OnGetBackground()

void ContrastDialog::OnGetBackground ( wxCommandEvent & event )

private

Definition at line 391 of file Contrast.cpp.

{
   auto p = FindProjectFromWindow( this );
   auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
 
   if (TrackList::Get(*p).Selected<const WaveTrack>()) {
      mBackgroundStartT->SetValue(selectedRegion.t0());
      mBackgroundEndT->SetValue(selectedRegion.t1());
   }
 
   SetStartAndEndTime();
   mBackgroundIsDefined = GetDB(backgrounddB);
   m_pButton_UseCurrentB->SetFocus();
   results();
}

References backgrounddB, FindProjectFromWindow(), ViewInfo::Get(), TrackList::Get(), GetDB(), m_pButton_UseCurrentB, mBackgroundEndT, mBackgroundIsDefined, mBackgroundStartT, results(), TrackList::Selected(), ViewInfo::selectedRegion, SetStartAndEndTime(), and NumericTextCtrl::SetValue().

Here is the call graph for this function:

◆ OnGetForeground()

void ContrastDialog::OnGetForeground ( wxCommandEvent & event )

private

Definition at line 375 of file Contrast.cpp.

{
   auto p = FindProjectFromWindow( this );
   auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
 
   if (TrackList::Get(*p).Selected<const WaveTrack>()) {
      mForegroundStartT->SetValue(selectedRegion.t0());
      mForegroundEndT->SetValue(selectedRegion.t1());
   }
 
   SetStartAndEndTime();
   mForegroundIsDefined = GetDB(foregrounddB);
   m_pButton_UseCurrentF->SetFocus();
   results();
}

References FindProjectFromWindow(), foregrounddB, ViewInfo::Get(), TrackList::Get(), GetDB(), m_pButton_UseCurrentF, mForegroundEndT, mForegroundIsDefined, mForegroundStartT, results(), TrackList::Selected(), ViewInfo::selectedRegion, SetStartAndEndTime(), and NumericTextCtrl::SetValue().

Here is the call graph for this function:

◆ OnGetURL()

void ContrastDialog::OnGetURL ( wxCommandEvent & event )

private

Definition at line 360 of file Contrast.cpp.

{
   // Original help page is back on-line (March 2016), but the manual should be more reliable.
   // http://www.eramp.com/WCAG_2_audio_contrast_tool_help.htm
   HelpSystem::ShowHelp(this, L"Contrast");
}

References HelpSystem::ShowHelp().

Here is the call graph for this function:

◆ OnReset()

void ContrastDialog::OnReset ( wxCommandEvent & event )

private

Definition at line 635 of file Contrast.cpp.

{
   mForegroundStartT->SetValue(0.0);
   mForegroundEndT->SetValue(0.0);
   mBackgroundStartT->SetValue(0.0);
   mBackgroundEndT->SetValue(0.0);
   mForegroundIsDefined = false;
   mBackgroundIsDefined = false;
 
   mForegroundRMSText->SetName(_("No foreground measured"));   // Read by screen-readers
   mBackgroundRMSText->SetName(_("No background measured"));
   mForegroundRMSText->ChangeValue(wxT("")); // Displayed value
   mBackgroundRMSText->ChangeValue(wxT(""));
   mPassFailText->ChangeValue(wxT(""));
   mDiffText->ChangeValue(wxT(""));
}

References _, mBackgroundEndT, mBackgroundIsDefined, mBackgroundRMSText, mBackgroundStartT, mDiffText, mForegroundEndT, mForegroundIsDefined, mForegroundRMSText, mForegroundStartT, mPassFailText, NumericTextCtrl::SetValue(), and wxT().

Referenced by OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ results()

void ContrastDialog::results ( )

private

Definition at line 469 of file Contrast.cpp.

{
   mPassFailText->SetName(wxT(""));
   mPassFailText->ChangeValue(wxT(""));
   mDiffText->ChangeValue(wxT(""));
 
   // foreground and background defined.
   if(mForegroundIsDefined && mBackgroundIsDefined) {
      float diffdB = std::fabs(foregrounddB - backgrounddB);
      if(foregrounddB > DB_MAX_LIMIT) {
         mPassFailText->ChangeValue(_("Foreground level too high"));
      }
      else if (backgrounddB > DB_MAX_LIMIT) {
         mPassFailText->ChangeValue(_("Background level too high"));
      }
      else if (backgrounddB > foregrounddB) {
         mPassFailText->ChangeValue(_("Background higher than foreground"));
      }
      else if(diffdB > WCAG2_PASS) {
         /* i18n-hint: WCAG2 is the 'Web Content Accessibility Guidelines (WCAG) 2.0', see http://www.w3.org/TR/WCAG20/ */
         mPassFailText->ChangeValue(_("WCAG2 Pass"));
      }
      else {
         /* i18n-hint: WCAG abbreviates Web Content Accessibility Guidelines */
         mPassFailText->ChangeValue(_("WCAG2 Fail"));
      }
 
      /* i18n-hint: i.e. difference in loudness at the moment. */
      mDiffText->SetName(_("Current difference"));
      mDiffText->ChangeValue( FormatDifference( diffdB ).Translation() );
   }
 
   if (mForegroundIsDefined) {
      mForegroundRMSText->SetName(_("Measured foreground level"));   // Read by screen-readers
      if(std::isinf(- foregrounddB))
         mForegroundRMSText->ChangeValue(_("zero"));
      else
         // i18n-hint: short form of 'decibels'
         mForegroundRMSText->ChangeValue(wxString::Format(_("%.2f dB"), foregrounddB));
   }
   else {
      mForegroundRMSText->SetName(_("No foreground measured"));   // Read by screen-readers
      mForegroundRMSText->ChangeValue(wxT(""));
      mPassFailText->ChangeValue(_("Foreground not yet measured"));
   }
 
   if (mBackgroundIsDefined) {
      mBackgroundRMSText->SetName(_("Measured background level"));
      if(std::isinf(- backgrounddB))
         mBackgroundRMSText->ChangeValue(_("zero"));
      else
         mBackgroundRMSText->ChangeValue(wxString::Format(_("%.2f dB"), backgrounddB));
   }
   else {
      mBackgroundRMSText->SetName(_("No background measured"));
      mBackgroundRMSText->ChangeValue(wxT(""));
      mPassFailText->ChangeValue(_("Background not yet measured"));
   }
}

References _, backgrounddB, DB_MAX_LIMIT, foregrounddB, anonymous_namespace{Contrast.cpp}::FormatDifference(), mBackgroundIsDefined, mBackgroundRMSText, mDiffText, mForegroundIsDefined, mForegroundRMSText, mPassFailText, WCAG2_PASS, and wxT().

Referenced by OnGetBackground(), and OnGetForeground().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStartAndEndTime()

void ContrastDialog::SetStartAndEndTime ( )

private

Definition at line 136 of file Contrast.cpp.

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

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

Referenced by OnGetBackground(), and OnGetForeground().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ backgrounddB

float ContrastDialog::backgrounddB

private

Definition at line 71 of file Contrast.h.

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

◆ foregrounddB

float ContrastDialog::foregrounddB

private

Definition at line 70 of file Contrast.h.

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

◆ length

double ContrastDialog::length

private

Definition at line 81 of file Contrast.h.

◆ m_pButton_Close

wxButton* ContrastDialog::m_pButton_Close

Definition at line 39 of file Contrast.h.

Referenced by ContrastDialog().

◆ m_pButton_Export

wxButton* ContrastDialog::m_pButton_Export

Definition at line 37 of file Contrast.h.

Referenced by ContrastDialog().

◆ m_pButton_GetURL

wxButton* ContrastDialog::m_pButton_GetURL

Definition at line 36 of file Contrast.h.

Referenced by ContrastDialog().

◆ m_pButton_Reset

wxButton* ContrastDialog::m_pButton_Reset

Definition at line 38 of file Contrast.h.

Referenced by ContrastDialog().

◆ m_pButton_UseCurrentB

wxButton* ContrastDialog::m_pButton_UseCurrentB

Definition at line 35 of file Contrast.h.

Referenced by ContrastDialog(), and OnGetBackground().

◆ m_pButton_UseCurrentF

wxButton* ContrastDialog::m_pButton_UseCurrentF

Definition at line 34 of file Contrast.h.

Referenced by ContrastDialog(), and OnGetForeground().

◆ mBackgroundEndT

NumericTextCtrl* ContrastDialog::mBackgroundEndT

Definition at line 44 of file Contrast.h.

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

◆ mBackgroundIsDefined

bool ContrastDialog::mBackgroundIsDefined

private

Definition at line 73 of file Contrast.h.

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

◆ mBackgroundRMSText

wxTextCtrl* ContrastDialog::mBackgroundRMSText

private

Definition at line 66 of file Contrast.h.

Referenced by ContrastDialog(), OnReset(), and results().

◆ mBackgroundStartT

NumericTextCtrl* ContrastDialog::mBackgroundStartT

Definition at line 43 of file Contrast.h.

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

◆ mDiffText

wxTextCtrl* ContrastDialog::mDiffText

private

Definition at line 68 of file Contrast.h.

Referenced by ContrastDialog(), OnReset(), and results().

◆ mDoBackground

bool ContrastDialog::mDoBackground

private

Definition at line 77 of file Contrast.h.

◆ mEndTimeB

double ContrastDialog::mEndTimeB

Definition at line 52 of file Contrast.h.

◆ mEndTimeF

double ContrastDialog::mEndTimeF

Definition at line 50 of file Contrast.h.

◆ mForegroundEndT

NumericTextCtrl* ContrastDialog::mForegroundEndT

Definition at line 42 of file Contrast.h.

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

◆ mForegroundIsDefined

bool ContrastDialog::mForegroundIsDefined

private

Definition at line 72 of file Contrast.h.

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

◆ mForegroundRMSText

wxTextCtrl* ContrastDialog::mForegroundRMSText

private

Definition at line 65 of file Contrast.h.

Referenced by ContrastDialog(), OnReset(), and results().

◆ mForegroundStartT

NumericTextCtrl* ContrastDialog::mForegroundStartT

Definition at line 41 of file Contrast.h.

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

◆ mPassFailText

wxTextCtrl* ContrastDialog::mPassFailText

private

Definition at line 67 of file Contrast.h.

Referenced by ContrastDialog(), OnReset(), and results().

◆ mProjectRate

double ContrastDialog::mProjectRate

Definition at line 48 of file Contrast.h.

Referenced by ContrastDialog().

◆ mStartTimeB

double ContrastDialog::mStartTimeB

Definition at line 51 of file Contrast.h.

◆ mStartTimeF

double ContrastDialog::mStartTimeF

Definition at line 49 of file Contrast.h.

◆ mT0

double ContrastDialog::mT0

Definition at line 46 of file Contrast.h.

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

◆ mT0orig

double ContrastDialog::mT0orig

private

Definition at line 74 of file Contrast.h.

◆ mT1

double ContrastDialog::mT1

Definition at line 47 of file Contrast.h.

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

◆ mT1orig

double ContrastDialog::mT1orig

private

Definition at line 75 of file Contrast.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ContrastDialog()

Member Function Documentation

◆ GetDB()

◆ OnChar()

◆ OnClose()

◆ OnExport()

◆ OnGetBackground()

◆ OnGetForeground()

◆ OnGetURL()

◆ OnReset()

◆ results()

◆ SetStartAndEndTime()

Member Data Documentation

◆ backgrounddB

◆ foregrounddB

◆ length

◆ m_pButton_Close

◆ m_pButton_Export

◆ m_pButton_GetURL

◆ m_pButton_Reset

◆ m_pButton_UseCurrentB

◆ m_pButton_UseCurrentF

◆ mBackgroundEndT

◆ mBackgroundIsDefined

◆ mBackgroundRMSText

◆ mBackgroundStartT

◆ mDiffText

◆ mDoBackground

◆ mEndTimeB

◆ mEndTimeF

◆ mForegroundEndT

◆ mForegroundIsDefined

◆ mForegroundRMSText

◆ mForegroundStartT

◆ mPassFailText

◆ mProjectRate

◆ mStartTimeB

◆ mStartTimeF

◆ mT0

◆ mT0orig

◆ mT1

◆ mT1orig