A LabelStruct holds information for ONE label in a LabelTrack. More...

#include <LabelTrack.h>

Collaboration diagram for LabelStruct:

Classes
struct	BadFormatException

Public Types
enum	TimeRelations { BEFORE_LABEL , AFTER_LABEL , SURROUNDS_LABEL , WITHIN_LABEL , BEGINS_IN_LABEL , ENDS_IN_LABEL }
	Relationships between selection region and labels. More...

Public Member Functions
	LabelStruct ()=default

	LabelStruct (const SelectedRegion &region, const wxString &aTitle)

	LabelStruct (const SelectedRegion &region, double t0, double t1, const wxString &aTitle)

const SelectedRegion &	getSelectedRegion () const

double	getDuration () const

double	getT0 () const

double	getT1 () const

bool	AdjustEdge (int iEdge, double fNewTime)

void	MoveLabel (int iEdge, double fNewTime)

void	Export (wxTextFile &file, LabelFormat format, int index) const

TimeRelations	RegionRelation (double reg_t0, double reg_t1, const LabelTrack *parent=NULL) const

Static Public Member Functions
static LabelStruct	Import (wxTextFile &file, int &index, LabelFormat format)

Public Attributes
SelectedRegion	selectedRegion

wxString	title

int	width {}
	Text of the label. More...

int	x {}
	width of the text in pixels. More...

int	x1 {}
	Pixel position of left hand glyph. More...

int	xText {}
	Pixel position of right hand glyph. More...

int	y {}
	Pixel position of left hand side of text box. More...

bool	updated {}
	Pixel position of label. More...

Detailed Description

A LabelStruct holds information for ONE label in a LabelTrack.

LabelStruct also has label specific functions, mostly functions for drawing different aspects of the label and its text box.

Definition at line 36 of file LabelTrack.h.

Member Enumeration Documentation

◆ TimeRelations

enum LabelStruct::TimeRelations

Relationships between selection region and labels.

Enumerator
BEFORE_LABEL
AFTER_LABEL
SURROUNDS_LABEL
WITHIN_LABEL
BEGINS_IN_LABEL
ENDS_IN_LABEL

Definition at line 59 of file LabelTrack.h.

   {
       BEFORE_LABEL,
       AFTER_LABEL,
       SURROUNDS_LABEL,
       WITHIN_LABEL,
       BEGINS_IN_LABEL,
       ENDS_IN_LABEL
   };

Constructor & Destructor Documentation

◆ LabelStruct() [1/3]

LabelStruct::LabelStruct ( )

default

◆ LabelStruct() [2/3]

LabelStruct::LabelStruct	(	const SelectedRegion &	region,
		const wxString &	aTitle
	)

Definition at line 309 of file LabelTrack.cpp.

: selectedRegion(region)
, title(aTitle)
{
   updated = false;
   width = 0;
   x = 0;
   x1 = 0;
   xText = 0;
   y = 0;
}

References updated, width, x, x1, xText, and y.

◆ LabelStruct() [3/3]

LabelStruct::LabelStruct	(	const SelectedRegion &	region,
		double	t0,
		double	t1,
		const wxString &	aTitle
	)

Definition at line 322 of file LabelTrack.cpp.

: selectedRegion(region)
, title(aTitle)
{
   // Overwrite the times
   selectedRegion.setTimes(t0, t1);
 
   updated = false;
   width = 0;
   x = 0;
   x1 = 0;
   xText = 0;
   y = 0;
}

References selectedRegion, SelectedRegion::setTimes(), updated, width, x, x1, xText, and y.

Here is the call graph for this function:

Member Function Documentation

◆ AdjustEdge()

bool LabelStruct::AdjustEdge	(	int	iEdge,
		double	fNewTime
	)

Definition at line 357 of file LabelTrack.cpp.

{
   updated = true;
   if( iEdge < 0 )
      return selectedRegion.setT0(fNewTime);
   else
      return selectedRegion.setT1(fNewTime);
}

References selectedRegion, SelectedRegion::setT0(), SelectedRegion::setT1(), and updated.

Here is the call graph for this function:

◆ Export()

void LabelStruct::Export	(	wxTextFile &	file,
		LabelFormat	format,
		int	index
	)		const

Definition at line 575 of file LabelTrack.cpp.

{
   switch (format) {
   case LabelFormat::TEXT:
   default:
   {
      file.AddLine(wxString::Format(wxT("%s\t%s\t%s"),
         Internat::ToString(getT0(), FLT_DIG),
         Internat::ToString(getT1(), FLT_DIG),
         title
      ));
 
   // Do we need more lines?
   auto f0 = selectedRegion.f0();
   auto f1 = selectedRegion.f1();
   if ((f0 == SelectedRegion::UndefinedFrequency &&
      f1 == SelectedRegion::UndefinedFrequency) ||
      LabelStyleSetting.ReadEnum())
      return;
 
      // Write a \ character at the start of a second line,
      // so that earlier versions of Audacity ignore it.
      file.AddLine(wxString::Format(wxT("\\\t%s\t%s"),
         Internat::ToString(f0, FLT_DIG),
         Internat::ToString(f1, FLT_DIG)
      ));
 
      // Additional lines in future formats should also start with '\'.
      break;
   }
   case LabelFormat::SUBRIP:
   case LabelFormat::WEBVTT:
   {
      // Note that the identifier is optional in WebVTT, but required in SubRip.
      // We include it for both.
      file.AddLine(wxString::Format(wxT("%d"), index + 1));
 
      file.AddLine(wxString::Format(wxT("%s --> %s"),
         SubRipTimestampFromDouble(getT0(), format == LabelFormat::WEBVTT),
         SubRipTimestampFromDouble(getT1(), format == LabelFormat::WEBVTT)));
 
      file.AddLine(title);
      file.AddLine(wxT(""));
 
      break;
   }
   }
}

References SelectedRegion::f0(), SelectedRegion::f1(), anonymous_namespace{ExportPCM.cpp}::format, getT0(), getT1(), anonymous_namespace{LabelTrack.cpp}::LabelStyleSetting, EnumSetting< Enum >::ReadEnum(), selectedRegion, SUBRIP, SubRipTimestampFromDouble(), TEXT, title, Internat::ToString(), SelectedRegion::UndefinedFrequency, WEBVTT, and wxT().

Here is the call graph for this function:

◆ getDuration()

double LabelStruct::getDuration ( ) const

inline

Definition at line 46 of file LabelTrack.h.

46{ return selectedRegion.duration(); }

SelectedRegion::duration

double duration() const

Definition: SelectedRegion.h:88

Referenced by MoveLabel().

Here is the caller graph for this function:

◆ getSelectedRegion()

const SelectedRegion & LabelStruct::getSelectedRegion ( ) const

inline

Definition at line 45 of file LabelTrack.h.

45{ return selectedRegion; }

◆ getT0()

double LabelStruct::getT0 ( ) const

inline

Definition at line 47 of file LabelTrack.h.

47{ return selectedRegion.t0(); }

SelectedRegion::t0

double t0() const

Definition: SelectedRegion.h:86

Referenced by LabelTrackView::DrawLines(), Export(), and anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel().

Here is the caller graph for this function:

◆ getT1()

double LabelStruct::getT1 ( ) const

inline

Definition at line 48 of file LabelTrack.h.

48{ return selectedRegion.t1(); }

SelectedRegion::t1

double t1() const

Definition: SelectedRegion.h:87

Referenced by LabelTrackView::DrawLines(), Export(), and anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel().

Here is the caller graph for this function:

◆ Import()

LabelStruct LabelStruct::Import	(	wxTextFile &	file,
		int &	index,
		LabelFormat	format
	)

static

Definition at line 439 of file LabelTrack.cpp.

{
   SelectedRegion sr;
   wxString title;
 
   wxString firstLine = file.GetLine(index++);
 
   switch (format) {
   case LabelFormat::TEXT:
   {
      static const wxString continuation{ wxT("\\") };
 
      {
         // Assume tab is an impossible character within the exported text
         // of the label, so can be only a delimiter.  But other white space may
         // be part of the label text.
         wxStringTokenizer toker { firstLine, wxT("\t") };
 
         //get the timepoint of the left edge of the label.
         auto token = toker.GetNextToken();
 
         double t0;
         if (!Internat::CompatibleToDouble(token, &t0))
            throw BadFormatException{};
 
         token = toker.GetNextToken();
 
         double t1;
         if (!Internat::CompatibleToDouble(token, &t1))
            //s1 is not a number.
            t1 = t0;  //This is a one-sided label; t1 == t0.
         else
            token = toker.GetNextToken();
 
         sr.setTimes( t0, t1 );
 
         title = token;
      }
 
      // Newer selection fields are written on additional lines beginning with
      // '\' which is an impossible numerical character that older versions of
      // audacity will ignore.  Test for the presence of such a line and then
      // parse it if we can.
 
      // There may also be additional continuation lines from future formats that
      // we ignore.
 
      // Advance index over all continuation lines first, before we might throw
      // any exceptions.
      int index2 = index;
      while (index < (int)file.GetLineCount() &&
             file.GetLine(index).StartsWith(continuation))
         ++index;
 
      if (index2 < index) {
         wxStringTokenizer toker { file.GetLine(index2++), wxT("\t") };
         auto token = toker.GetNextToken();
         if (token != continuation)
            throw BadFormatException{};
 
         token = toker.GetNextToken();
         double f0;
         if (!Internat::CompatibleToDouble(token, &f0))
            throw BadFormatException{};
 
         token = toker.GetNextToken();
         double f1;
         if (!Internat::CompatibleToDouble(token, &f1))
            throw BadFormatException{};
 
         sr.setFrequencies(f0, f1);
      }
      break;
   }
   case LabelFormat::SUBRIP:
   {
      if ((int)file.GetLineCount() < index + 2)
         throw BadFormatException{};
 
      long identifier;
      // The first line should be a numeric counter; we can ignore it otherwise
      if (!firstLine.ToLong(&identifier))
         throw BadFormatException{};
 
      wxString timestamp = file.GetLine(index++);
      // Parsing data of the form 'HH:MM:SS,sss --> HH:MM:SS,sss'
      // Assume that the line is in exactly that format, with no extra whitespace
      // and less than 24 hours.
      if (timestamp.length() != 29)
         throw BadFormatException{};
      if (!timestamp.substr(12, 5).IsSameAs(" --> "))
         throw BadFormatException{};
 
      double t0 = SubRipTimestampToDouble(timestamp.substr(0, 12));
      double t1 = SubRipTimestampToDouble(timestamp.substr(17, 12));
 
      sr.setTimes(t0, t1);
 
      // Assume that if there is an empty subtitle, there still is a second
      // blank line after it
      title = file[index++];
 
      // Labels in audacity should be only one line, so join multiple lines
      // with spaces.  This is not reversed on export.
      while (index < (int)file.GetLineCount() &&
             !file.GetLine(index).IsEmpty())
         title += " " + file.GetLine(index);
 
      index++; // Skip over empty line
 
      break;
   }
   default:
      throw BadFormatException{};
   }
 
   return LabelStruct{ sr, title };
}

References Internat::CompatibleToDouble(), anonymous_namespace{ExportPCM.cpp}::format, SelectedRegion::setFrequencies(), SelectedRegion::setTimes(), SUBRIP, SubRipTimestampToDouble(), TEXT, title, and wxT().

Referenced by LabelTrack::Import().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MoveLabel()

void LabelStruct::MoveLabel	(	int	iEdge,
		double	fNewTime
	)

Definition at line 367 of file LabelTrack.cpp.

{
   double fTimeSpan = getDuration();
 
   if( iEdge < 0 )
   {
      selectedRegion.setTimes(fNewTime, fNewTime+fTimeSpan);
   }
   else
   {
      selectedRegion.setTimes(fNewTime-fTimeSpan, fNewTime);
   }
   updated = true;
}

References getDuration(), selectedRegion, SelectedRegion::setTimes(), and updated.

Here is the call graph for this function:

◆ RegionRelation()

auto LabelStruct::RegionRelation	(	double	reg_t0,
		double	reg_t1,
		const LabelTrack *	parent = `NULL`
	)		const

Returns relationship between a region described and this label; if parent is set, it will consider point labels at the very beginning and end of parent to be within a region that borders them (this makes it possible to DELETE capture all labels with a Select All).

Definition at line 624 of file LabelTrack.cpp.

{
   bool retainLabels = false;
 
   wxASSERT(reg_t0 <= reg_t1);
   gPrefs->Read(wxT("/GUI/RetainLabels"), &retainLabels);
 
   if(retainLabels) {
 
      // Desired behavior for edge cases: The length of the selection is smaller
      // than the length of the label if the selection is within the label or
      // matching exactly a (region) label.
 
      if (reg_t0 < getT0() && reg_t1 > getT1())
         return SURROUNDS_LABEL;
      else if (reg_t1 < getT0())
         return BEFORE_LABEL;
      else if (reg_t0 > getT1())
         return AFTER_LABEL;
 
      else if (reg_t0 >= getT0() && reg_t0 <= getT1() &&
               reg_t1 >= getT0() && reg_t1 <= getT1())
         return WITHIN_LABEL;
 
      else if (reg_t0 >= getT0() && reg_t0 <= getT1())
         return BEGINS_IN_LABEL;
      else
         return ENDS_IN_LABEL;
 
   } else {
 
      // AWD: Desired behavior for edge cases: point labels bordered by the
      // selection are included within it. Region labels are included in the
      // selection to the extent that the selection covers them; specifically,
      // they're not included at all if the selection borders them, and they're
      // fully included if the selection covers them fully, even if it just
      // borders their endpoints. This is just one of many possible schemes.
 
      // The first test catches bordered point-labels and selected-through
      // region-labels; move it to third and selection edges become inclusive
      // WRT point-labels.
      if (reg_t0 <= getT0() && reg_t1 >= getT1())
         return SURROUNDS_LABEL;
      else if (reg_t1 <= getT0())
         return BEFORE_LABEL;
      else if (reg_t0 >= getT1())
         return AFTER_LABEL;
 
      // At this point, all point labels should have returned.
 
      else if (reg_t0 > getT0() && reg_t0 < getT1() &&
               reg_t1 > getT0() && reg_t1 < getT1())
         return WITHIN_LABEL;
 
      // Knowing that none of the other relations match simplifies remaining
      // tests
      else if (reg_t0 > getT0() && reg_t0 < getT1())
         return BEGINS_IN_LABEL;
      else
         return ENDS_IN_LABEL;
 
   }
}