A LabelTrack is a Track that holds labels (LabelStruct). More...

#include <LabelTrack.h>

Inheritance diagram for LabelTrack:

Collaboration diagram for LabelTrack:

Classes
struct	Interval

Public Types
using	Holder = std::shared_ptr< LabelTrack >

Public Types inherited from Track
using	AttachedObjects = ::AttachedTrackObjects
	Alias for my base type. More...

using	Holder = std::shared_ptr< Track >

Public Types inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
using	DataType = ClientData

using	DataPointer = Pointer< ClientData >

using	DataFactory = std::function< DataPointer(Host &) >
	Type of function from which RegisteredFactory is constructed; it builds attachments. More...

Public Types inherited from ChannelGroup
enum class	LinkType : int { None = 0 , Group = 2 , Aligned }
	For two tracks describes the type of the linkage. More...

using	Attachments = ChannelGroupAttachments

using	Interval = WideChannelGroupInterval

Public Types inherited from Channel
using	Interval = ChannelInterval

Public Types inherited from Observer::Publisher< struct LabelTrackEvent >
using	message_type = struct LabelTrackEvent

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const struct LabelTrackEvent &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	LabelTrack ()

	LabelTrack (const LabelTrack &orig, ProtectedCreationArg &&)

virtual	~LabelTrack ()

void	SetLabel (size_t iLabel, const LabelStruct &newLabel)

void	MoveTo (double dOffset) override
	Change start time to given time point. More...

void	ShiftBy (double t0, double delta) override
	Shift all intervals that starts after `t0` by `delta` seconds. More...

void	SetSelected (bool s) override

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

void	WriteXML (XMLWriter &xmlFile) const override

Track::Holder	Cut (double t0, double t1) override
	Create tracks and modify this track. More...

Track::Holder	Copy (double t0, double t1, bool forClipboard=true) const override
	Create new tracks and don't modify this track. More...

void	Clear (double t0, double t1) override

void	Paste (double t, const Track &src) override
	Weak precondition allows overrides to replicate one channel into many. More...

bool	Repeat (double t0, double t1, int n)

void	SyncLockAdjust (double oldT1, double newT1) override

void	Silence (double t0, double t1, ProgressReporter reportProgress={}) override

void	InsertSilence (double t, double len) override

void	Import (wxTextFile &f, LabelFormat format)
	Import labels, handling files with or without end-times. More...

void	Export (wxTextFile &f, LabelFormat format) const
	Export labels including label start and end-times. More...

int	GetNumLabels () const

const LabelStruct *	GetLabel (int index) const

const LabelArray &	GetLabels () const

void	OnLabelAdded (const wxString &title, int pos)

int	AddLabel (const SelectedRegion &region, const wxString &title)

void	DeleteLabel (int index)

bool	PasteOver (double t, const Track &src)

void	ShiftLabelsOnInsert (double length, double pt)

void	ChangeLabelsOnReverse (double b, double e)

void	ScaleLabels (double b, double e, double change)

double	AdjustTimeStampOnScale (double t, double b, double e, double change)

void	WarpLabels (const TimeWarper &warper)

wxString	GetTextOfLabels (double t0, double t1) const

int	FindNextLabel (const SelectedRegion &currentSelection)

int	FindPrevLabel (const SelectedRegion &currentSelection)

const TypeInfo &	GetTypeInfo () const override

Track::Holder	PasteInto (AudacityProject &project, TrackList &list) const override

std::shared_ptr< Interval >	MakeInterval (size_t index)

void	SortLabels ()

size_t	NIntervals () const override
	Report the number of intervals. More...

Public Member Functions inherited from UniqueChannelTrack< Base >
size_t	NChannels () const override
	Report the number of channels. More...

std::shared_ptr< Channel >	DoGetChannel (size_t iChannel) override

Public Member Functions inherited from Track
TrackId	GetId () const

template<typename Subclass = Track>
std::shared_ptr< Subclass >	SharedPointer ()

template<typename Subclass = const Track>
auto	SharedPointer () const -> std::enable_if_t< std::is_const_v< Subclass >, std::shared_ptr< Subclass > >

virtual const TypeInfo &	GetTypeInfo () const =0

virtual const TypeNames &	GetTypeNames () const

virtual bool	SupportsBasicEditing () const
	Whether this track type implements cut-copy-paste; by default, true. More...

virtual Holder	PasteInto (AudacityProject &project, TrackList &list) const =0

virtual bool	LinkConsistencyFix (bool doFix=true)
	Check consistency of channel groups, and maybe fix it. More...

bool	LinkConsistencyCheck ()
	Do the non-mutating part of consistency fix only and return status. More...

bool	HasOwner () const

std::shared_ptr< TrackList >	GetOwner () const

LinkType	GetLinkType () const noexcept

	Track ()

	Track (const Track &orig, ProtectedCreationArg &&)

Track &	operator= (const Track &orig)=delete

virtual	~Track ()

void	Init (const Track &orig)

virtual Holder	Duplicate (DuplicateOptions={}) const
	public nonvirtual duplication function that invokes Clone() More...

void	ReparentAllAttachments ()

const wxString &	GetName () const
	Name is always the same for all channels of a group. More...

void	SetName (const wxString &n)

bool	GetSelected () const
	Selectedness is always the same for all channels of a group. More...

virtual void	SetSelected (bool s)

virtual Holder	Cut (double t0, double t1)=0
	Create tracks and modify this track. More...

virtual Holder	Copy (double t0, double t1, bool forClipboard=true) const =0
	Create new tracks and don't modify this track. More...

virtual void	Clear (double t0, double t1)=0

virtual void	Paste (double t, const Track &src)=0
	Weak precondition allows overrides to replicate one channel into many. More...

virtual void	SyncLockAdjust (double oldT1, double newT1)

virtual void	Silence (double t0, double t1, ProgressReporter reportProgress={})=0

virtual void	InsertSilence (double t, double len)=0

bool	SameKindAs (const Track &track) const

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions)

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions) const

virtual void	WriteXML (XMLWriter &xmlFile) const =0

virtual std::optional< TranslatableString >	GetErrorOpening () const

void	Notify (bool allChannels, int code=-1)

bool	Any () const

bool	IsSelected () const

bool	IsLeader () const

void	AdjustPositions ()

void	WriteCommonXMLAttributes (XMLWriter &xmlFile, bool includeNameAndSelected=true) const

bool	HandleCommonXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
	~Site ()

	Site ()

	Site (const Site &other)

Site &	operator= (const Site &other)

	Site (Site &&other)

Site &	operator= (Site &&other)

size_t	size () const
	How many attachment pointers are in the Site. More...

template<typename Subclass = ClientData>
Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = const ClientData>
auto	Get (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass & >
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = ClientData>
Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename Subclass = const ClientData>
auto	Find (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass * >
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename ReplacementPointer >
void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...

Public Member Functions inherited from ChannelGroup
virtual	~ChannelGroup ()

double	GetStartTime () const
	Get the minimum of Start() values of intervals, or 0 when none. More...

double	GetEndTime () const
	Get the maximum of End() values of intervals, or 0 when none. More...

void	ShiftBy (double t)
	Change start time by given duration. More...

virtual void	ShiftBy (double t0, double delta)=0
	Shift all intervals that starts after `t0` by `delta` seconds. More...

virtual void	MoveTo (double o)=0
	Change start time to given time point. More...

template<typename ChannelType = Channel>
std::shared_ptr< ChannelType >	GetChannel (size_t iChannel)
	Retrieve a channel, cast to the given type. More...

template<typename ChannelType = const Channel>
auto	GetChannel (size_t iChannel) const -> std::enable_if_t< std::is_const_v< ChannelType >, std::shared_ptr< ChannelType > >

template<typename ChannelType = Channel>
IteratorRange< ChannelIterator< ChannelType > >	Channels ()
	Get range of channels with mutative access. More...

template<typename ChannelType = const Channel>
auto	Channels () const -> std::enable_if_t< std::is_const_v< ChannelType >, IteratorRange< ChannelIterator< ChannelType > > >
	Get range of channels with read-only access. More...

std::shared_ptr< Channel >	NthChannel (size_t nChannel)

std::shared_ptr< const Channel >	NthChannel (size_t nChannel) const

template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...

template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >

template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...

template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...

Public Member Functions inherited from Channel
virtual	~Channel ()

ChannelGroup &	GetChannelGroup ()
	Channel object's lifetime is assumed to be nested in its Track's. More...

const ChannelGroup &	GetChannelGroup () const
	Channel object's lifetime is assumed to be nested in its Track's. More...

size_t	GetChannelIndex () const

size_t	NIntervals () const
	Report the number of intervals. More...

template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...

template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >

template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...

template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...

Public Member Functions inherited from Observer::Publisher< struct LabelTrackEvent >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static wxString	GetDefaultName ()

static LabelTrack *	New (AudacityProject &project)

static LabelTrack *	Create (TrackList &trackList, const wxString &name)
	Create a new LabelTrack with specified `name` and append it to the `trackList`. More...

static LabelTrack *	Create (TrackList &trackList)
	Create a new LabelTrack with unique default name and append it to the `trackList`. More...

static LabelFormat	FormatForFileName (const wxString &fileName)

static const TypeInfo &	ClassTypeInfo ()

Static Public Member Functions inherited from Track
template<typename Subclass = Track>
static std::shared_ptr< Subclass >	SharedPointer (Track *pTrack)

template<typename Subclass = const Track>
static std::shared_ptr< Subclass >	SharedPointer (const Track *pTrack)

static const TypeInfo &	ClassTypeInfo ()

static void	CopyAttachments (Track &dst, const Track &src, bool deep)
	Copy (deep) or just share (!deep) AttachedTrackObjects. More...

Static Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
static size_t	numFactories ()
	How many static factories have been registered with this specialization of Site. More...

Static Public Attributes
static const FileNames::FileType	SubripFiles { XO("SubRip text file"), { wxT("srt") }, true }

static const FileNames::FileType	WebVTTFiles { XO("WebVTT file"), { wxT("vtt") }, true }

Static Public Attributes inherited from Observer::Publisher< struct LabelTrackEvent >
static constexpr bool	notifies_all

Private Member Functions
Track::Holder	Clone (bool backup) const override

std::shared_ptr< WideChannelGroupInterval >	DoGetInterval (size_t iInterval) override
	Retrieve an interval. More...

Private Attributes
LabelArray	mLabels

double	mClipLen

int	miLastLabel

Additional Inherited Members
Protected Member Functions inherited from UniqueChannelTrack< Base >
ChannelGroup &	DoGetChannelGroup () const override
	Subclass must override. More...

Protected Member Functions inherited from Track
void	SetLinkType (LinkType linkType, bool completeList=true)

Protected Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
template<typename Function >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForCorresponding (Site &other, const Function &function, bool create=true)

template<typename Function >
ClientData *	FindIf (const Function &function)
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
const ClientData *	FindIf (const Function &function) const
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
void	EraseIf (const Function &function)
	Erase attached objects satisfying a predicate. More...

void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in `this`, build and store it. More...

virtual std::shared_ptr< Channel >	DoGetChannel (size_t iChannel)=0

virtual std::shared_ptr< Interval >	DoGetInterval (size_t iInterval)=0
	Retrieve an interval. More...

virtual ChannelGroup &	DoGetChannelGroup () const =0
	Subclass must override. More...

Protected Member Functions inherited from Observer::Publisher< struct LabelTrackEvent >
CallbackReturn	Publish (const struct LabelTrackEvent &message)
	Send a message to connected callbacks. More...

Protected Attributes inherited from Track
std::weak_ptr< TrackList >	mList

TrackNodePointer	mNode {}
	Holds iterator to self, so that TrackList::Find can be constant-time. More...

Detailed Description

A LabelTrack is a Track that holds labels (LabelStruct).

These are used to annotate a waveform. Each label has a start time and an end time. The text of the labels is editable and the positions of the end points are draggable.

Definition at line 95 of file LabelTrack.h.

Member Typedef Documentation

◆ Holder

using LabelTrack::Holder = std::shared_ptr<LabelTrack>

Definition at line 129 of file LabelTrack.h.

Constructor & Destructor Documentation

◆ LabelTrack() [1/2]

LabelTrack::LabelTrack ( )

Definition at line 122 of file LabelTrack.cpp.

   : UniqueChannelTrack{}
   , mClipLen{ 0.0 }
   , miLastLabel{ -1 }
{
}

◆ LabelTrack() [2/2]

LabelTrack::LabelTrack	(	const LabelTrack &	orig,
		ProtectedCreationArg &&	a
	)

Definition at line 129 of file LabelTrack.cpp.

   : UniqueChannelTrack{ orig, std::move(a) }
   , mClipLen{ 0.0 }
{
   for (auto &original: orig.mLabels) {
      LabelStruct l { original.selectedRegion, original.title };
      mLabels.push_back(l);
   }
}

References mLabels, and LabelStruct::selectedRegion.

◆ ~LabelTrack()

LabelTrack::~LabelTrack ( )

virtual

Definition at line 192 of file LabelTrack.cpp.

193{

194}

Member Function Documentation

◆ AddLabel()

int LabelTrack::AddLabel	(	const SelectedRegion &	region,
		const wxString &	title
	)

Definition at line 1074 of file LabelTrack.cpp.

{
   LabelStruct l { selectedRegion, title };
 
   int len = mLabels.size();
   int pos = 0;
 
   while (pos < len && mLabels[pos].getT0() < selectedRegion.t0())
      pos++;
 
   mLabels.insert(mLabels.begin() + pos, l);
 
   Publish({ LabelTrackEvent::Addition,
      this->SharedPointer<LabelTrack>(), title, -1, pos });
 
   return pos;
}

References LabelTrackEvent::Addition, mLabels, Observer::Publisher< struct LabelTrackEvent >::Publish(), SelectedRegion::t0(), and title.

Referenced by VampEffect::AddFeatures(), and FindClippingBase::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AdjustTimeStampOnScale()

double LabelTrack::AdjustTimeStampOnScale	(	double	t,
		double	b,
		double	e,
		double	change
	)

Definition at line 304 of file LabelTrack.cpp.

{
//t is the time stamp we'll be changing
//b and e are the selection start and end
 
   if (t < b){
      return t;
   }else if (t > e){
      double shift = (e-b)*change - (e-b);
      return t + shift;
   }else{
      double shift = (t-b)*change - (t-b);
      return t + shift;
   }
}

Referenced by ScaleLabels().

Here is the caller graph for this function:

◆ ChangeLabelsOnReverse()

void LabelTrack::ChangeLabelsOnReverse	(	double	b,
		double	e
	)

Definition at line 280 of file LabelTrack.cpp.

{
   for (auto &labelStruct: mLabels) {
      if (labelStruct.RegionRelation(b, e, this) ==
                                    LabelStruct::SURROUNDS_LABEL)
      {
         double aux     = b + (e - labelStruct.getT1());
         labelStruct.selectedRegion.setTimes(
            aux,
            e - (labelStruct.getT0() - b));
      }
   }
   SortLabels();
}

References mLabels, SortLabels(), and LabelStruct::SURROUNDS_LABEL.

Here is the call graph for this function:

◆ ClassTypeInfo()

auto LabelTrack::ClassTypeInfo ( )

static

Definition at line 151 of file LabelTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Here is the call graph for this function:

◆ Clear()

void LabelTrack::Clear	(	double	t0,
		double	t1
	)

overridevirtual

May assume precondition: t0 <= t1

Implements Track.

Definition at line 218 of file LabelTrack.cpp.

{
   // May DELETE labels, so use subscripts to iterate
   for (size_t i = 0; i < mLabels.size(); ++i) {
      auto &labelStruct = mLabels[i];
      LabelStruct::TimeRelations relation =
                        labelStruct.RegionRelation(b, e, this);
      if (relation == LabelStruct::BEFORE_LABEL)
         labelStruct.selectedRegion.move(- (e-b));
      else if (relation == LabelStruct::SURROUNDS_LABEL) {
         DeleteLabel( i );
         --i;
      }
      else if (relation == LabelStruct::ENDS_IN_LABEL)
         labelStruct.selectedRegion.setTimes(
            b,
            labelStruct.getT1() - (e - b));
      else if (relation == LabelStruct::BEGINS_IN_LABEL)
         labelStruct.selectedRegion.setT1(b);
      else if (relation == LabelStruct::WITHIN_LABEL)
         labelStruct.selectedRegion.moveT1( - (e-b));
   }
}

References LabelStruct::BEFORE_LABEL, LabelStruct::BEGINS_IN_LABEL, DeleteLabel(), LabelStruct::ENDS_IN_LABEL, mLabels, LabelStruct::SURROUNDS_LABEL, and LabelStruct::WITHIN_LABEL.

Referenced by Cut(), and SyncLockAdjust().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clone()

Track::Holder LabelTrack::Clone ( bool backup ) const

overrideprivatevirtual

Subclass responsibility implements only a part of Duplicate(), copying the track data proper (not associated data such as for groups and views) including TrackId

Parameters

backup whether the duplication is for backup purposes while opening a project, instead of other editing operations

Postcondition: result tracks have same TrackIds as the channels of this

Implements Track.

Definition at line 374 of file LabelTrack.cpp.

{
   auto result = std::make_shared<LabelTrack>(*this, ProtectedCreationArg{});
   result->Init(*this);
   return result;
}

◆ Copy()

Track::Holder LabelTrack::Copy	(	double	t0,
		double	t1,
		bool	forClipboard = `true`
	)		const

overridevirtual

Create new tracks and don't modify this track.

Returns: non-NULL or else throw Note that subclasses may want to distinguish tracks stored in a clipboard from those stored in a project May assume precondition: t0 <= t1 Should invoke Track::Init

Implements Track.

Definition at line 837 of file LabelTrack.cpp.

{
   auto tmp = std::make_shared<LabelTrack>();
   tmp->Init(*this);
   const auto lt = static_cast<LabelTrack*>(tmp.get());
 
   for (auto &labelStruct: mLabels) {
      LabelStruct::TimeRelations relation =
                        labelStruct.RegionRelation(t0, t1, this);
      if (relation == LabelStruct::SURROUNDS_LABEL) {
         LabelStruct l {
            labelStruct.selectedRegion,
            labelStruct.getT0() - t0,
            labelStruct.getT1() - t0,
            labelStruct.title
         };
         lt->mLabels.push_back(l);
      }
      else if (relation == LabelStruct::WITHIN_LABEL) {
         LabelStruct l {
            labelStruct.selectedRegion,
            0,
            t1-t0,
            labelStruct.title
         };
         lt->mLabels.push_back(l);
      }
      else if (relation == LabelStruct::BEGINS_IN_LABEL) {
         LabelStruct l {
            labelStruct.selectedRegion,
            0,
            labelStruct.getT1() - t0,
            labelStruct.title
         };
         lt->mLabels.push_back(l);
      }
      else if (relation == LabelStruct::ENDS_IN_LABEL) {
         LabelStruct l {
            labelStruct.selectedRegion,
            labelStruct.getT0() - t0,
            t1 - t0,
            labelStruct.title
         };
         lt->mLabels.push_back(l);
      }
   }
   lt->mClipLen = (t1 - t0);
 
   return tmp;
}

References LabelStruct::BEGINS_IN_LABEL, LabelStruct::ENDS_IN_LABEL, mLabels, LabelStruct::selectedRegion, LabelStruct::SURROUNDS_LABEL, and LabelStruct::WITHIN_LABEL.

Referenced by Cut(), ModifiedAnalysisTrack::ModifiedAnalysisTrack(), and RepeatBase::Process().

Here is the caller graph for this function:

◆ Create() [1/2]

LabelTrack * LabelTrack::Create ( TrackList & trackList )

static

Create a new LabelTrack with unique default name and append it to the trackList.

Returns: New LabelTrack with unique default name

Definition at line 117 of file LabelTrack.cpp.

{
   return Create(trackList, trackList.MakeUniqueTrackName(GetDefaultName()));
}

References Create(), GetDefaultName(), and TrackList::MakeUniqueTrackName().

Here is the call graph for this function:

◆ Create() [2/2]

LabelTrack * LabelTrack::Create	(	TrackList &	trackList,
		const wxString &	name
	)

static

Create a new LabelTrack with specified name and append it to the trackList.

Returns: New LabelTrack with custom name

Definition at line 109 of file LabelTrack.cpp.

{
   auto track = std::make_shared<LabelTrack>();
   track->SetName(name);
   trackList.Add(track);
   return track.get();
}

References TrackList::Add(), and name.

Referenced by AddedAnalysisTrack::AddedAnalysisTrack(), Create(), anonymous_namespace{LabelMenus.cpp}::DoAddLabel(), anonymous_namespace{DropoutDetector.cpp}::DropoutSubscription::DropoutSubscription(), anonymous_namespace{LabelMenus.cpp}::OnNewLabelTrack(), and anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cut()

Track::Holder LabelTrack::Cut	(	double	t0,
		double	t1
	)

overridevirtual

Create tracks and modify this track.

Returns: non-NULL or else throw May assume precondition: t0 <= t1

Implements Track.

Definition at line 816 of file LabelTrack.cpp.

{
   auto tmp = Copy(t0, t1);
   Clear(t0, t1);
   return tmp;
}

References Clear(), and Copy().

Here is the call graph for this function:

◆ DeleteLabel()

void LabelTrack::DeleteLabel ( int index )

Definition at line 1093 of file LabelTrack.cpp.

{
   wxASSERT((index < (int)mLabels.size()));
   auto iter = mLabels.begin() + index;
   const auto title = iter->title;
   mLabels.erase(iter);
 
   Publish({ LabelTrackEvent::Deletion,
      this->SharedPointer<LabelTrack>(), title, index, -1 });
}

References LabelTrackEvent::Deletion, mLabels, Observer::Publisher< struct LabelTrackEvent >::Publish(), and title.

Referenced by Clear(), and Silence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetInterval()

std::shared_ptr< WideChannelGroupInterval > LabelTrack::DoGetInterval ( size_t iInterval )

overrideprivatevirtual

Retrieve an interval.

Postcondition: result: !(iInterval < NIntervals()) || result

Implements ChannelGroup.

Definition at line 178 of file LabelTrack.cpp.

{
   return MakeInterval(iInterval);
}

References MakeInterval().

Here is the call graph for this function:

◆ Export()

void LabelTrack::Export	(	wxTextFile &	f,
		LabelFormat	format
	)		const

Export labels including label start and end-times.

Definition at line 672 of file LabelTrack.cpp.

{
   if (format == LabelFormat::WEBVTT) {
      f.AddLine(wxT("WEBVTT"));
      f.AddLine(wxT(""));
   }
 
   // PRL: to do: export other selection fields
   int index = 0;
   for (auto &labelStruct: mLabels)
      labelStruct.Export(f, format, index++);
}

References anonymous_namespace{ExportPCM.cpp}::format, mLabels, WEBVTT, and wxT().

Here is the call graph for this function:

◆ FindNextLabel()

int LabelTrack::FindNextLabel ( const SelectedRegion & currentSelection )

Definition at line 1159 of file LabelTrack.cpp.

{
   int i = -1;
 
   if (!mLabels.empty()) {
      int len = (int) mLabels.size();
      if (miLastLabel >= 0 && miLastLabel + 1 < len
         && currentRegion.t0() == mLabels[miLastLabel].getT0()
         && currentRegion.t0() == mLabels[miLastLabel + 1].getT0() ) {
         i = miLastLabel + 1;
      }
      else {
         i = 0;
         if (currentRegion.t0() < mLabels[len - 1].getT0()) {
            while (i < len &&
                  mLabels[i].getT0() <= currentRegion.t0()) {
               i++;
            }
         }
      }
   }
 
   miLastLabel = i;
   return i;
}

References miLastLabel, mLabels, and SelectedRegion::t0().

Referenced by anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindPrevLabel()

int LabelTrack::FindPrevLabel ( const SelectedRegion & currentSelection )

Definition at line 1185 of file LabelTrack.cpp.

{
   int i = -1;
 
   if (!mLabels.empty()) {
      int len = (int) mLabels.size();
      if (miLastLabel > 0 && miLastLabel < len
         && currentRegion.t0() == mLabels[miLastLabel].getT0()
         && currentRegion.t0() == mLabels[miLastLabel - 1].getT0() ) {
         i = miLastLabel - 1;
      }
      else {
         i = len - 1;
         if (currentRegion.t0() > mLabels[0].getT0()) {
            while (i >=0  &&
                  mLabels[i].getT0() >= currentRegion.t0()) {
               i--;
            }
         }
      }
   }
 
   miLastLabel = i;
   return i;
}

References miLastLabel, mLabels, and SelectedRegion::t0().

Referenced by anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FormatForFileName()

LabelFormat LabelTrack::FormatForFileName ( const wxString & fileName )

static

Definition at line 685 of file LabelTrack.cpp.

{
   LabelFormat format = LabelFormat::TEXT;
   if (fileName.Right(4).CmpNoCase(wxT(".srt")) == 0) {
      format = LabelFormat::SUBRIP;
   } else if (fileName.Right(4).CmpNoCase(wxT(".vtt")) == 0) {
      format = LabelFormat::WEBVTT;
   }
   return format;
}

References anonymous_namespace{ExportPCM.cpp}::format, SUBRIP, TEXT, WEBVTT, and wxT().

Referenced by LabelDialog::OnExport(), anonymous_namespace{FileMenus.cpp}::OnExportLabels(), LabelDialog::OnImport(), and anonymous_namespace{FileMenus.cpp}::OnImportLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDefaultName()

wxString LabelTrack::GetDefaultName ( )

static

Definition at line 96 of file LabelTrack.cpp.

{
   return _("Labels");
}

References _.

Referenced by Create(), and NyquistBase::ProcessOne().

Here is the caller graph for this function:

◆ GetLabel()

const LabelStruct * LabelTrack::GetLabel ( int index ) const

Definition at line 1069 of file LabelTrack.cpp.

{
   return &mLabels[index];
}

References mLabels.

Referenced by LabelDialog::AddLabels(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), and anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel().

Here is the caller graph for this function:

◆ GetLabels()

const LabelArray & LabelTrack::GetLabels ( ) const

inline

Definition at line 160 of file LabelTrack.h.

160{ return mLabels; }

Referenced by LabelTrackView::Draw(), LabelTrackView::OverATextBox(), LabelTrackView::OverGlyph(), and GetInfoCommand::SendLabels().

Here is the caller graph for this function:

◆ GetNumLabels()

int LabelTrack::GetNumLabels ( ) const

Definition at line 1064 of file LabelTrack.cpp.

{
   return mLabels.size();
}

References mLabels.

Referenced by LabelDialog::AddLabels(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), and anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel().

Here is the caller graph for this function:

◆ GetTextOfLabels()

wxString LabelTrack::GetTextOfLabels	(	double	t0,
		double	t1
	)		const

Definition at line 1140 of file LabelTrack.cpp.

{
   bool firstLabel = true;
   wxString retVal;
 
   for (auto &labelStruct: mLabels) {
      if (labelStruct.getT0() >= t0 &&
          labelStruct.getT1() <= t1)
      {
         if (!firstLabel)
            retVal += '\t';
         firstLabel = false;
         retVal += labelStruct.title;
      }
   }
 
   return retVal;
}

References mLabels.

◆ GetTypeInfo()

auto LabelTrack::GetTypeInfo ( ) const

overridevirtual

Implements Track.

Definition at line 146 of file LabelTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Here is the call graph for this function:

◆ HandleXMLChild()

XMLTagHandler * LabelTrack::HandleXMLChild ( const std::string_view & tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 787 of file LabelTrack.cpp.

{
   if (tag == "label")
      return this;
   else
      return NULL;
}

◆ HandleXMLTag()

bool LabelTrack::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overridevirtual

Implements XMLTagHandler.

Definition at line 726 of file LabelTrack.cpp.

{
   if (tag == "label") {
 
      SelectedRegion selectedRegion;
      wxString title;
 
      // loop through attrs, which is a null-terminated list of
      // attribute-value pairs
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (selectedRegion.HandleXMLAttribute(attr, value, "t", "t1"))
            ;
         // Bug 1905 no longer applies, as valueView has no limits anyway
         else if (attr == "title")
            title = value.ToWString();
 
      } // while
 
      // Handle files created by Audacity 1.1.   Labels in Audacity 1.1
      // did not have separate start- and end-times.
      // PRL: this superfluous now, given class SelectedRegion's internal
      // consistency guarantees
      //if (selectedRegion.t1() < 0)
      //   selectedRegion.collapseToT0();
 
      LabelStruct l { selectedRegion, title };
      mLabels.push_back(l);
 
      return true;
   }
   else if (tag == "labeltrack") {
      long nValue = -1;
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (this->Track::HandleCommonXMLAttribute(attr, value))
            ;
         else if (attr == "numlabels" && value.TryGet(nValue))
         {
            if (nValue < 0)
            {
               wxLogWarning(wxT("Project shows negative number of labels: %d"), nValue);
               return false;
            }
            mLabels.clear();
            mLabels.reserve(nValue);
         }
      }
 
      return true;
   }
 
   return false;
}

References Track::HandleCommonXMLAttribute(), SelectedRegion::HandleXMLAttribute(), mLabels, title, and wxT().

Here is the call graph for this function:

◆ Import()

void LabelTrack::Import	(	wxTextFile &	f,
		LabelFormat	format
	)

Import labels, handling files with or without end-times.

Definition at line 697 of file LabelTrack.cpp.

{
   if (format == LabelFormat::WEBVTT) {
      BasicUI::ShowMessageBox( XO("Importing WebVTT files is not currently supported.") );
      return;
   }
 
   int lines = in.GetLineCount();
 
   mLabels.clear();
   mLabels.reserve(lines);
 
   //Currently, we expect a tag file to have two values and a label
   //on each line. If the second token is not a number, we treat
   //it as a single-value label.
   bool error = false;
   for (int index = 0; index < lines;) {
      try {
         // Let LabelStruct::Import advance index
         LabelStruct l { LabelStruct::Import(in, index, format) };
         mLabels.push_back(l);
      }
      catch(const LabelStruct::BadFormatException&) { error = true; }
   }
   if (error)
      BasicUI::ShowMessageBox( XO("One or more saved labels could not be read.") );
   SortLabels();
}

References anonymous_namespace{ExportPCM.cpp}::format, LabelStruct::Import(), mLabels, BasicUI::ShowMessageBox(), SortLabels(), WEBVTT, and XO().

Here is the call graph for this function:

◆ InsertSilence()

void LabelTrack::InsertSilence	(	double	t,
		double	len
	)

overridevirtual

May assume precondition: t0 <= t1

Implements Track.

Definition at line 1050 of file LabelTrack.cpp.

{
   for (auto &labelStruct: mLabels) {
      double t0 = labelStruct.getT0();
      double t1 = labelStruct.getT1();
      if (t0 >= t)
         t0 += len;
 
      if (t1 >= t)
         t1 += len;
      labelStruct.selectedRegion.setTimes(t0, t1);
   }
}

References mLabels.

◆ MakeInterval()

auto LabelTrack::MakeInterval ( size_t index )

Definition at line 170 of file LabelTrack.cpp.

{
   if (index >= mLabels.size())
      return {};
   return std::make_shared<Interval>(*this, index);
}

Referenced by DoGetInterval().

Here is the caller graph for this function:

◆ MoveTo()

void LabelTrack::MoveTo ( double o )

overridevirtual

Change start time to given time point.

Implements ChannelGroup.

Definition at line 197 of file LabelTrack.cpp.

{
   if (!mLabels.empty()) {
      const auto offset = origin - mLabels[0].selectedRegion.t0();
      for (auto &labelStruct: mLabels) {
         labelStruct.selectedRegion.move(offset);
      }
   }
}

References mLabels.

Referenced by ModifiedAnalysisTrack::ModifiedAnalysisTrack().

Here is the caller graph for this function:

◆ New()

LabelTrack * LabelTrack::New ( AudacityProject & project )

static

Definition at line 101 of file LabelTrack.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto result = tracks.Add(std::make_shared<LabelTrack>());
   result->AttachedTrackObjects::BuildAll();
   return result;
}

References TrackList::Get(), project, and tracks.

Here is the call graph for this function:

◆ NIntervals()

size_t LabelTrack::NIntervals ( ) const

overridevirtual

Report the number of intervals.

Implements ChannelGroup.

Definition at line 165 of file LabelTrack.cpp.

{
   return mLabels.size();
}

References mLabels.

◆ OnLabelAdded()

void LabelTrack::OnLabelAdded	(	const wxString &	title,
		int	pos
	)

◆ Paste()

void LabelTrack::Paste	(	double	t,
		const Track &	src
	)

overridevirtual

Weak precondition allows overrides to replicate one channel into many.

Precondition: SameKindAs(src); src.NChannels() == 1 || src.NChannels() == NChannels()

Implements Track.

Definition at line 918 of file LabelTrack.cpp.

{
   bool bOk = src.TypeSwitch<bool>([&](const LabelTrack &lt) {
      double shiftAmt = lt.mClipLen > 0.0 ? lt.mClipLen : lt.GetEndTime();
 
      ShiftLabelsOnInsert(shiftAmt, t);
      PasteOver(t, src);
 
      return true;
   });
 
   if (!bOk)
      // THROW_INCONSISTENCY_EXCEPTION; // ?
      (void)0;// intentionally do nothing
}

References PasteOver(), ShiftLabelsOnInsert(), and Track::TypeSwitch().

Referenced by RepeatBase::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PasteInto()

Track::Holder LabelTrack::PasteInto	(	AudacityProject &	project,
		TrackList &	list
	)		const

overridevirtual

Find or create the destination track for a paste, maybe in a different project

Parameters

list	to which any newly created tracks are added; but left unchanged if an existing track is found in the project instead

Returns: A smart pointer to a track

Implements Track.

Definition at line 156 of file LabelTrack.cpp.

{
   auto pNewTrack = std::make_shared<LabelTrack>();
   pNewTrack->Init(*this);
   pNewTrack->Paste(0.0, *this);
   list.Add(pNewTrack);
   return pNewTrack;
}

References TrackList::Add().

Here is the call graph for this function:

◆ PasteOver()

bool LabelTrack::PasteOver	(	double	t,
		const Track &	src
	)

Definition at line 889 of file LabelTrack.cpp.

{
   auto result = src.TypeSwitch<bool>([&](const LabelTrack &sl) {
      int len = mLabels.size();
      int pos = 0;
 
      while (pos < len && mLabels[pos].getT0() < t)
         pos++;
 
      for (auto &labelStruct: sl.mLabels) {
         LabelStruct l {
            labelStruct.selectedRegion,
            labelStruct.getT0() + t,
            labelStruct.getT1() + t,
            labelStruct.title
         };
         mLabels.insert(mLabels.begin() + pos++, l);
      }
 
      return true;
   });
 
   if (!result)
      // THROW_INCONSISTENCY_EXCEPTION; // ?
      (void)0;// intentionally do nothing
 
   return result;
}

References mLabels, LabelStruct::selectedRegion, and Track::TypeSwitch().

Referenced by Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repeat()

bool LabelTrack::Repeat	(	double	t0,
		double	t1,
		int	n
	)

Definition at line 935 of file LabelTrack.cpp.

{
   // Sanity-check the arguments
   if (n < 0 || t1 < t0)
      return false;
 
   double tLen = t1 - t0;
 
   // Insert space for the repetitions
   ShiftLabelsOnInsert(tLen * n, t1);
 
   // mLabels may resize as we iterate, so use subscripting
   for (unsigned int i = 0; i < mLabels.size(); ++i)
   {
      LabelStruct::TimeRelations relation =
                        mLabels[i].RegionRelation(t0, t1, this);
      if (relation == LabelStruct::SURROUNDS_LABEL)
      {
         // Label is completely inside the selection; duplicate it in each
         // repeat interval
         unsigned int pos = i; // running label insertion position in mLabels
 
         for (int j = 1; j <= n; j++)
         {
            const LabelStruct &label = mLabels[i];
            LabelStruct l {
               label.selectedRegion,
               label.getT0() + j * tLen,
               label.getT1() + j * tLen,
               label.title
            };
 
            // Figure out where to insert
            while (pos < mLabels.size() &&
                   mLabels[pos].getT0() < l.getT0())
               pos++;
            mLabels.insert(mLabels.begin() + pos, l);
         }
      }
      else if (relation == LabelStruct::BEGINS_IN_LABEL)
      {
         // Label ends inside the selection; ShiftLabelsOnInsert() hasn't touched
         // it, and we need to extend it through to the last repeat interval
         mLabels[i].selectedRegion.moveT1(n * tLen);
      }
 
      // Other cases have already been handled by ShiftLabelsOnInsert()
   }
 
   return true;
}

References LabelStruct::BEGINS_IN_LABEL, label, mLabels, ShiftLabelsOnInsert(), and LabelStruct::SURROUNDS_LABEL.

Referenced by RepeatBase::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScaleLabels()

void LabelTrack::ScaleLabels	(	double	b,
		double	e,
		double	change
	)

Definition at line 295 of file LabelTrack.cpp.

{
   for (auto &labelStruct: mLabels) {
      labelStruct.selectedRegion.setTimes(
         AdjustTimeStampOnScale(labelStruct.getT0(), b, e, change),
         AdjustTimeStampOnScale(labelStruct.getT1(), b, e, change));
   }
}

References AdjustTimeStampOnScale(), and mLabels.

Here is the call graph for this function:

◆ SetLabel()

void LabelTrack::SetLabel	(	size_t	iLabel,
		const LabelStruct &	newLabel
	)

Definition at line 183 of file LabelTrack.cpp.

{
   if( iLabel >= mLabels.size() ) {
      wxASSERT( false );
      mLabels.resize( iLabel + 1 );
   }
   mLabels[ iLabel ] = newLabel;
}

References mLabels.

Referenced by DEFINE_ATTACHED_VIRTUAL_OVERRIDE().

Here is the caller graph for this function:

◆ SetSelected()

void LabelTrack::SetSelected ( bool s )

overridevirtual

Reimplemented from Track.

Definition at line 365 of file LabelTrack.cpp.

{
   bool selected = GetSelected();
   Track::SetSelected( s );
   if ( selected != GetSelected() )
      Publish({ LabelTrackEvent::Selection,
         this->SharedPointer<LabelTrack>(), {}, -1, -1 });
}

References Track::GetSelected(), Observer::Publisher< struct LabelTrackEvent >::Publish(), LabelTrackEvent::Selection, and Track::SetSelected().

Here is the call graph for this function:

◆ ShiftBy()

void LabelTrack::ShiftBy	(	double	t0,
		double	delta
	)

overridevirtual

Shift all intervals that starts after t0 by delta seconds.

Implements ChannelGroup.

Definition at line 207 of file LabelTrack.cpp.

{
   if (mLabels.empty())
   return;
   for (auto &labelStruct: mLabels)
   {
      if(labelStruct.selectedRegion.t0() >= t0)
         labelStruct.selectedRegion.move(delta);
   }
}

References mLabels.

◆ ShiftLabelsOnInsert()

void LabelTrack::ShiftLabelsOnInsert	(	double	length,
		double	pt
	)

Definition at line 267 of file LabelTrack.cpp.

{
   for (auto &labelStruct: mLabels) {
      LabelStruct::TimeRelations relation =
                        labelStruct.RegionRelation(pt, pt, this);
 
      if (relation == LabelStruct::BEFORE_LABEL)
         labelStruct.selectedRegion.move(length);
      else if (relation == LabelStruct::WITHIN_LABEL)
         labelStruct.selectedRegion.moveT1(length);
   }
}

References LabelStruct::BEFORE_LABEL, mLabels, and LabelStruct::WITHIN_LABEL.

Referenced by Paste(), Repeat(), and SyncLockAdjust().

Here is the caller graph for this function:

◆ Silence()

void LabelTrack::Silence	(	double	t0,
		double	t1,
		ProgressReporter	reportProgress = `{}`
	)

overridevirtual

Implements Track.

Definition at line 1004 of file LabelTrack.cpp.

{
   int len = mLabels.size();
 
   // mLabels may resize as we iterate, so use subscripting
   for (int i = 0; i < len; ++i) {
      LabelStruct::TimeRelations relation =
                        mLabels[i].RegionRelation(t0, t1, this);
      if (relation == LabelStruct::WITHIN_LABEL)
      {
         // Split label around the selection
         const LabelStruct &label = mLabels[i];
         LabelStruct l {
            label.selectedRegion,
            t1,
            label.getT1(),
            label.title
         };
 
         mLabels[i].selectedRegion.setT1(t0);
 
         // This might not be the right place to insert, but we sort at the end
         ++i;
         mLabels.insert(mLabels.begin() + i, l);
      }
      else if (relation == LabelStruct::ENDS_IN_LABEL)
      {
         // Beginning of label to selection end
         mLabels[i].selectedRegion.setT0(t1);
      }
      else if (relation == LabelStruct::BEGINS_IN_LABEL)
      {
         // End of label to selection beginning
         mLabels[i].selectedRegion.setT1(t0);
      }
      else if (relation == LabelStruct::SURROUNDS_LABEL)
      {
         DeleteLabel( i );
         len--;
         i--;
      }
   }
 
   SortLabels();
}

References LabelStruct::BEGINS_IN_LABEL, DeleteLabel(), LabelStruct::ENDS_IN_LABEL, label, mLabels, SortLabels(), LabelStruct::SURROUNDS_LABEL, and LabelStruct::WITHIN_LABEL.

Here is the call graph for this function:

◆ SortLabels()

void LabelTrack::SortLabels ( )

Sorts the labels in order of their starting times. This function is called often (whilst dragging a label) We expect them to be very nearly in order, so insertion sort (with a linear search) is a reasonable choice.

Definition at line 1108 of file LabelTrack.cpp.

{
   const auto begin = mLabels.begin();
   const auto nn = (int)mLabels.size();
   int i = 1;
   while (true)
   {
      // Find the next disorder
      while (i < nn && mLabels[i - 1].getT0() <= mLabels[i].getT0())
         ++i;
      if (i >= nn)
         break;
 
      // Where must element i sink to?  At most i - 1, maybe less
      int j = i - 2;
      while( (j >= 0) && (mLabels[j].getT0() > mLabels[i].getT0()) )
         --j;
      ++j;
 
      // Now fix the disorder
      std::rotate(
         begin + j,
         begin + i,
         begin + i + 1
      );
 
      // Let listeners update their stored indices
      Publish({ LabelTrackEvent::Permutation,
         this->SharedPointer<LabelTrack>(), mLabels[j].title, i, j });
   }
}

References details::begin(), mLabels, LabelTrackEvent::Permutation, Observer::Publisher< struct LabelTrackEvent >::Publish(), and staffpad::vo::rotate().

Referenced by ChangeLabelsOnReverse(), Import(), Silence(), and WarpLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SyncLockAdjust()

void LabelTrack::SyncLockAdjust	(	double	oldT1,
		double	newT1
	)

overridevirtual

This can be used to adjust a sync-lock selected track when the selection is replaced by one of a different length.

Reimplemented from Track.

Definition at line 987 of file LabelTrack.cpp.

{
   if (newT1 > oldT1) {
      // Insert space within the track
 
      if (oldT1 > GetEndTime())
         return;
 
      //Clear(oldT1, newT1);
      ShiftLabelsOnInsert(newT1 - oldT1, oldT1);
   }
   else if (newT1 < oldT1) {
      // Remove from the track
      Clear(newT1, oldT1);
   }
}

References Clear(), ChannelGroup::GetEndTime(), and ShiftLabelsOnInsert().

Here is the call graph for this function:

◆ WarpLabels()

void LabelTrack::WarpLabels ( const TimeWarper & warper )

Definition at line 323 of file LabelTrack.cpp.

                                                    {
   for (auto &labelStruct: mLabels) {
      labelStruct.selectedRegion.setTimes(
         warper.Warp(labelStruct.getT0()),
         warper.Warp(labelStruct.getT1()));
   }
 
   // This should not be needed, assuming the warper is nondecreasing, but
   // let's not assume too much.
   SortLabels();
}

References mLabels, SortLabels(), and TimeWarper::Warp().

Referenced by ChangeSpeedBase::ProcessLabelTrack(), and SBSMSBase::ProcessLabelTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteXML()

void LabelTrack::WriteXML ( XMLWriter & xmlFile ) const

overridevirtual

Implements Track.

Definition at line 795 of file LabelTrack.cpp.

{
   int len = mLabels.size();
 
   xmlFile.StartTag(wxT("labeltrack"));
   this->Track::WriteCommonXMLAttributes( xmlFile );
   xmlFile.WriteAttr(wxT("numlabels"), len);
 
   for (auto &labelStruct: mLabels) {
      xmlFile.StartTag(wxT("label"));
      labelStruct.getSelectedRegion()
         .WriteXMLAttributes(xmlFile, "t", "t1");
      // PRL: to do: write other selection fields
      xmlFile.WriteAttr(wxT("title"), labelStruct.title);
      xmlFile.EndTag(wxT("label"));
   }
 
   xmlFile.EndTag(wxT("labeltrack"));
}

References Track::WriteCommonXMLAttributes(), and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mClipLen

double LabelTrack::mClipLen

private

Definition at line 225 of file LabelTrack.h.

◆ miLastLabel

int LabelTrack::miLastLabel

private

Definition at line 227 of file LabelTrack.h.

Referenced by FindNextLabel(), and FindPrevLabel().

◆ mLabels

LabelArray LabelTrack::mLabels

private

Definition at line 222 of file LabelTrack.h.

Referenced by AddLabel(), ChangeLabelsOnReverse(), Clear(), Copy(), DeleteLabel(), Export(), FindNextLabel(), FindPrevLabel(), GetLabel(), GetNumLabels(), GetTextOfLabels(), HandleXMLTag(), Import(), InsertSilence(), LabelTrack(), MoveTo(), NIntervals(), PasteOver(), Repeat(), ScaleLabels(), GetInfoCommand::SendLabels(), SetLabel(), ShiftBy(), ShiftLabelsOnInsert(), Silence(), SortLabels(), and WarpLabels().

◆ SubripFiles

const FileNames::FileType LabelTrack::SubripFiles { XO("SubRip text file"), { wxT("srt") }, true }

static

Definition at line 131 of file LabelTrack.h.

Referenced by LabelDialog::OnExport(), anonymous_namespace{FileMenus.cpp}::OnExportLabels(), LabelDialog::OnImport(), and anonymous_namespace{FileMenus.cpp}::OnImportLabels().

◆ WebVTTFiles

const FileNames::FileType LabelTrack::WebVTTFiles { XO("WebVTT file"), { wxT("vtt") }, true }

static

Definition at line 132 of file LabelTrack.h.

Referenced by LabelDialog::OnExport(), and anonymous_namespace{FileMenus.cpp}::OnExportLabels().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Holder

Constructor & Destructor Documentation

◆ LabelTrack() [1/2]

◆ LabelTrack() [2/2]

◆ ~LabelTrack()

Member Function Documentation

◆ AddLabel()

◆ AdjustTimeStampOnScale()

◆ ChangeLabelsOnReverse()

◆ ClassTypeInfo()

◆ Clear()

◆ Clone()

◆ Copy()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Cut()

◆ DeleteLabel()

◆ DoGetInterval()

◆ Export()

◆ FindNextLabel()

◆ FindPrevLabel()

◆ FormatForFileName()

◆ GetDefaultName()

◆ GetLabel()

◆ GetLabels()

◆ GetNumLabels()

◆ GetTextOfLabels()

◆ GetTypeInfo()

◆ HandleXMLChild()

◆ HandleXMLTag()

◆ Import()

◆ InsertSilence()

◆ MakeInterval()

◆ MoveTo()

◆ New()

◆ NIntervals()

◆ OnLabelAdded()

◆ Paste()

◆ PasteInto()

◆ PasteOver()

◆ Repeat()

◆ ScaleLabels()

◆ SetLabel()

◆ SetSelected()

◆ ShiftBy()

◆ ShiftLabelsOnInsert()

◆ Silence()

◆ SortLabels()

◆ SyncLockAdjust()

◆ WarpLabels()

◆ WriteXML()

Member Data Documentation

◆ mClipLen

◆ miLastLabel

◆ mLabels

◆ SubripFiles

◆ WebVTTFiles