CompareAudioCommand Class Reference

Returns information about the amount of audio that is about a certain threshold of difference in two selected tracks. More...

#include <CompareAudioCommand.h>

Inheritance diagram for CompareAudioCommand:

Collaboration diagram for CompareAudioCommand:

Public Member Functions
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)
bool	VisitSettings (SettingsVisitor &S) override
bool	VisitSettings (ConstSettingsVisitor &S) override
void	PopulateOrExchange (ShuttleGui &S) override
ManualPageID	ManualPage () override
bool	Apply (const CommandContext &context) override
Public Member Functions inherited from AudacityCommand
	AudacityCommand ()
virtual	~AudacityCommand ()
PluginPath	GetPath () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
ComponentInterfaceSymbol	GetSymbol () const override=0
virtual TranslatableString	GetDescription () const override
virtual ManualPageID	ManualPage ()
virtual bool	IsBatchProcessing () const
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog *	CreateUI (wxWindow *parent, AudacityCommand *client)
bool	SaveSettingsAsString (wxString &parms)
bool	LoadSettingsFromString (const wxString &parms)
bool	DoAudacityCommand (const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool	Init ()
virtual bool	PromptUser (AudacityProject &)
virtual bool	CheckWhetherSkipAudacityCommand ()
virtual void	End ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool	TransferDataToWindow ()
virtual bool	TransferDataFromWindow ()
virtual bool	VisitSettings (SettingsVisitor &)
virtual bool	VisitSettings (ConstSettingsVisitor &)
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Compare Audio") }

Protected Member Functions
double	CompareSample (double value1, double value2)

Private Member Functions
bool	GetSelection (const CommandContext &context, AudacityProject &proj)

Private Attributes
double	errorThreshold
double	mT0
double	mT1
const WaveTrack *	mTrack0
const WaveTrack *	mTrack1

Additional Inherited Members
Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Detailed Description

Returns information about the amount of audio that is about a certain threshold of difference in two selected tracks.

Definition at line 26 of file CompareAudioCommand.h.

Member Function Documentation

Apply()

bool CompareAudioCommand::Apply ( const CommandContext &  context )

override

Definition at line 119 of file CompareAudioCommand.cpp.

{
   if (!GetSelection(context, context.project))
   {
      return false;
   }
 
   wxString msg = wxT("Comparing tracks '");
   msg += mTrack0->GetName() + wxT("' and '")
      + mTrack1->GetName() + wxT("'.");
   context.Status(msg);
 
   long errorCount = 0;
   // Initialize buffers for track data to be analyzed
   auto buffSize = std::min(mTrack0->GetMaxBlockSize(), mTrack1->GetMaxBlockSize());
 
   Floats buff0{ buffSize };
   Floats buff1{ buffSize };
 
   // Compare tracks block by block
   auto s0 = mTrack0->TimeToLongSamples(mT0);
   auto s1 = mTrack0->TimeToLongSamples(mT1);
   const auto channels0 = mTrack0->Channels();
   auto iter = mTrack1->Channels().begin();
   for (const auto pChannel0 : channels0) {
      const auto pChannel1 = *iter++;
      auto position = s0;
      auto length = s1 - s0;
      while (position < s1) {
         // Get a block of data into the buffers
         auto block = limitSampleBufferSize(
            pChannel0->GetBestBlockSize(position), s1 - position
         );
         pChannel0->GetFloats(buff0.get(), position, block);
         pChannel1->GetFloats(buff1.get(), position, block);
 
         for (decltype(block) buffPos = 0; buffPos < block; ++buffPos)
            if (CompareSample(buff0[buffPos], buff1[buffPos]) > errorThreshold)
               ++errorCount;
 
         position += block;
         context.Progress(
            (position - s0).as_double() /
            length.as_double()
         );
      }
   }
 
   // Output the results
   double errorSeconds = mTrack0->LongSamplesToTime(errorCount);
   context.Status(wxString::Format(wxT("%li"), errorCount));
   context.Status(wxString::Format(wxT("%.4f"), errorSeconds));
   context.Status(wxString::Format(wxT("Finished comparison: %li samples (%.3f seconds) exceeded the error threshold of %f."), errorCount, errorSeconds, errorThreshold));
   return true;
}

References WaveTrack::Channels(), CompareSample(), errorThreshold, WaveTrack::GetMaxBlockSize(), Track::GetName(), GetSelection(), limitSampleBufferSize(), WideSampleSequence::LongSamplesToTime(), min(), mT0, mT1, mTrack0, mTrack1, CommandContext::Progress(), CommandContext::project, CommandContext::Status(), WideSampleSequence::TimeToLongSamples(), and wxT().

Here is the call graph for this function:

CompareSample()

double CompareAudioCommand::CompareSample ( double  value1, double  value2  )

protected

Definition at line 109 of file CompareAudioCommand.cpp.

{
   return fabs(value1 - value2);
}

Referenced by Apply().

Here is the caller graph for this function:

GetDescription()

TranslatableString CompareAudioCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 33 of file CompareAudioCommand.h.

{return XO("Compares a range on two tracks.");};

References XO().

Here is the call graph for this function:

GetSelection()

bool CompareAudioCommand::GetSelection ( const CommandContext &  context, AudacityProject &  proj  )

private

Definition at line 75 of file CompareAudioCommand.cpp.

{
   // Get the selected time interval
   auto &selectedRegion = ViewInfo::Get( proj ).selectedRegion;
   mT0 = selectedRegion.t0();
   mT1 = selectedRegion.t1();
   if (mT0 >= mT1)
   {
      context.Error(wxT("There is no selection!"));
      return false;
   }
 
   // Get the selected tracks and check that there are at least two to
   // compare
   auto trackRange = TrackList::Get(proj).Selected<const WaveTrack>();
   mTrack0 = *trackRange.first;
   if (!mTrack0) {
      context.Error(wxT("No tracks selected! Select two tracks to compare."));
      return false;
   }
   mTrack1 = * ++ trackRange.first;
   if (!mTrack1) {
      context.Error(wxT("Only one track selected! Select two tracks to compare."));
      return false;
   }
   if (mTrack0->NChannels() != mTrack1->NChannels()) {
      context.Error(wxT("Selected tracks must have the same number of channels!"));
      return false;
   }
   if (* ++ trackRange.first)
      context.Status(wxT("More than two tracks selected - only the first two will be compared."));
   return true;
}

References CommandContext::Error(), ViewInfo::Get(), TrackList::Get(), mT0, mT1, mTrack0, mTrack1, WaveTrack::NChannels(), TrackList::Selected(), ViewInfo::selectedRegion, CommandContext::Status(), and wxT().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol CompareAudioCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 32 of file CompareAudioCommand.h.

{return Symbol;}

References Symbol.

ManualPage()

ManualPageID CompareAudioCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 40 of file CompareAudioCommand.h.

{return L"Extra_Menu:_Scriptables_II#compare_Audio";}

PopulateOrExchange()

void CompareAudioCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 63 of file CompareAudioCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(XXO("Threshold:"),errorThreshold);
   }
   S.EndMultiColumn();
}

References errorThreshold, S, and XXO().

Here is the call graph for this function:

VisitSettings() [1/3]

bool CompareAudioCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 60 of file CompareAudioCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool CompareAudioCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 57 of file CompareAudioCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool CompareAudioCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 53 of file CompareAudioCommand.cpp.

                                                                       {
   S.Define( errorThreshold,  wxT("Threshold"),   0.0f,  0.0f,    0.01f,    1.0f );
   return true;
}

References errorThreshold, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

errorThreshold

double CompareAudioCommand::errorThreshold

private

Definition at line 45 of file CompareAudioCommand.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

mT0

double CompareAudioCommand::mT0

private

Definition at line 46 of file CompareAudioCommand.h.

Referenced by Apply(), and GetSelection().

mT1

double CompareAudioCommand::mT1

private

Definition at line 46 of file CompareAudioCommand.h.

Referenced by Apply(), and GetSelection().

mTrack0

const WaveTrack* CompareAudioCommand::mTrack0

private

Definition at line 47 of file CompareAudioCommand.h.

Referenced by Apply(), and GetSelection().

mTrack1

const WaveTrack* CompareAudioCommand::mTrack1

private

Definition at line 48 of file CompareAudioCommand.h.

Referenced by Apply(), and GetSelection().

Symbol

const ComponentInterfaceSymbol CompareAudioCommand::Symbol { XO("Compare Audio") }

static

Definition at line 29 of file CompareAudioCommand.h.

Referenced by GetSymbol().

---

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

• CompareAudioCommand.h
• CompareAudioCommand.cpp