Track Class Reference

Abstract base class for an object holding data associated with points on a time axis. More...

#include <Track.h>

Inheritance diagram for Track:

Collaboration diagram for Track:

Classes
struct	DuplicateOptions
	Choices when duplicating a track. More...
struct	ProtectedCreationArg
	Empty argument passed to some public constructors. More...
struct	TypeInfo
struct	TypeNames
	Names of a track type for various purposes. More...

Public Types
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 Member Functions
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	MoveTo (double o)=0
	Change start time to given time point. More...
virtual size_t	NChannels () const =0
	Report the number of channels. 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
virtual size_t	NIntervals () const =0
	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...

Static Public Member Functions
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...

Protected Member Functions
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...
Protected Member Functions inherited from ChannelGroup
virtual std::shared_ptr< Channel >	DoGetChannel (size_t iChannel)=0
virtual std::shared_ptr< Interval >	DoGetInterval (size_t iInterval)=0
	Retrieve an interval. More...

Protected Attributes
std::weak_ptr< TrackList >	mList
TrackNodePointer	mNode {}
	Holds iterator to self, so that TrackList::Find can be constant-time. More...

Private Member Functions
void	SetId (TrackId id)
void	DoSetLinkType (LinkType linkType, bool completeList=true)
Track *	GetLinkedTrack () const
bool	HasLinkedTrack () const noexcept
	During file loading only, true for leaders of multichannel groups. More...
TrackNodePointer	GetNode () const
	Retrieve mNode with debug checks. More...
void	SetOwner (const std::weak_ptr< TrackList > &list, TrackNodePointer node)
	Update mNode when Track is added to TrackList, or removed from it. More...
virtual Holder	Clone (bool backup) const =0
void	CopyGroupProperties (const Track &other)

Private Attributes
TrackId	mId
	Identifies the track only in-session, not persistently. More...
wxString	mName
LinkType	mLinkType { LinkType::None }
bool	mSelected { false }

Friends
class	TrackList
template<typename T >
std::enable_if_t< std::is_pointer_v< T >, T >	track_cast (Track *track)
	Encapsulate the checked down-casting of track pointers. More...
template<typename T >
std::enable_if_t< std::is_pointer_v< T > &&std::is_const_v< std::remove_pointer_t< T > >, T >	track_cast (const Track *track)
	Encapsulate the checked down-casting of track pointers. More...

Detailed Description

Abstract base class for an object holding data associated with points on a time axis.

Fundamental data object of Audacity, displayed in the TrackPanel. Classes derived form it include the WaveTrack, NoteTrack, LabelTrack and TimeTrack.

Definition at line 105 of file Track.h.

Member Typedef Documentation

AttachedObjects

using Track::AttachedObjects = ::AttachedTrackObjects

Alias for my base type.

Definition at line 134 of file Track.h.

Holder

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

Definition at line 202 of file Track.h.

Constructor & Destructor Documentation

Track() [1/2]

Track::Track

(

)

Definition at line 38 of file Track.cpp.

{
}

Track() [2/2]

Track::Track	(	const Track &	orig,
		ProtectedCreationArg &&
	)

Definition at line 42 of file Track.cpp.

{
}

~Track()

Track::~Track ( )

virtual

Definition at line 117 of file Track.cpp.

{
}

Member Function Documentation

AdjustPositions()

void Track::AdjustPositions

(

)

Definition at line 844 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList) {
      pList->RecalcPositions(mNode);
      pList->ResizingEvent(mNode);
   }
}

References mList, and mNode.

Any()

bool Track::Any

(

)

const

Definition at line 255 of file Track.cpp.

   { return true; }

Referenced by EffectLoudness::AllocBuffers(), TrackList::Channels_(), ProjectAudioManager::DoRecord(), TrackList::EmptyRange(), ExportUtils::FindExportWaveTracks(), MakeTransportTracks(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), and TrackList::Size().

Here is the caller graph for this function:

ClassTypeInfo()

auto Track::ClassTypeInfo ( )

static

Definition at line 790 of file Track.cpp.

{
   static Track::TypeInfo info{
      { "generic", "generic", XO("Generic Track") }, false };
   return info;
}

References XO().

Referenced by AudioTrack::ClassTypeInfo(), and typeInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

virtual void Track::Clear ( double  t0, double  t1  )

pure virtual

May assume precondition: t0 <= t1

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by anonymous_namespace{LabelMenus.cpp}::OnDeleteLabels(), and SyncLockAdjust().

Here is the caller graph for this function:

Clone()

virtual Holder Track::Clone ( bool  backup ) const

privatepure virtual

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

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Copy()

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

pure virtual

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

Implemented in TimeTrack, NoteTrack, WaveTrack, and LabelTrack.

CopyAttachments()

void Track::CopyAttachments ( Track &  dst, const Track &  src, bool  deep  )

static

Copy (deep) or just share (!deep) AttachedTrackObjects.

Definition at line 94 of file Track.cpp.

{
   if (!deep) {
      // Share the satellites with the original, though they do not point
      // back to the duplicate track
      AttachedTrackObjects &attachments = dst;
      attachments = src; // shallow copy
   }
   else
      src.AttachedTrackObjects::ForEach([&](auto &attachment){
         // Copy view state that might be important to undo/redo
         attachment.CopyTo(dst);
      });
}

Referenced by WaveTrack::EmptyCopy().

Here is the caller graph for this function:

CopyGroupProperties()

void Track::CopyGroupProperties ( const Track &  other )

private

Definition at line 145 of file Track.cpp.

{
   mName = other.mName;
   mSelected = other.mSelected;
}

References mName, and mSelected.

Referenced by Init().

Here is the caller graph for this function:

Cut()

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

pure virtual

Create tracks and modify this track.

Returns

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

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

DoSetLinkType()

void Track::DoSetLinkType ( LinkType  linkType, bool  completeList = true  )

private

Parameters

completeList

only influences debug build consistency checking

Definition at line 151 of file Track.cpp.

{
   auto oldType = GetLinkType();
   if (linkType == oldType)
      // No change
      return;
 
   if (oldType == LinkType::None) {
      // Becoming linked
 
      // First ensure that the previous does not link to this
      if (auto partner = GetLinkedTrack())
         partner->mLinkType = LinkType::None;
      assert(!GetLinkedTrack());
 
      // Change my link type
      mLinkType = linkType;
 
      // Keep link consistency, while still in un-zipped state
      if (auto partner = GetLinkedTrack()) {
         partner->mLinkType = LinkType::None;
         partner->CopyGroupProperties(*this);
      }
   }
   else if (linkType == LinkType::None) {
      // Becoming unlinked
      if (HasLinkedTrack()) {
         if (auto partner = GetLinkedTrack()) {
            // Make independent copy of group data in the partner, which should
            // have had none
            ChannelGroupAttachments &base = *partner;
            // Intentional slice assignment deep-copies the attachment array:
            base = *this;
            partner->CopyGroupProperties(*this);
            partner->mLinkType = LinkType::None;
         }
      }
      mLinkType = LinkType::None;
   }
   else
      // Remaining linked, changing the type
      mLinkType = linkType;
 
   // Assertion checks only in a debug build, does not have side effects!
   assert(!completeList || LinkConsistencyCheck());
}

References GetLinkedTrack(), GetLinkType(), HasLinkedTrack(), LinkConsistencyCheck(), mLinkType, and ChannelGroup::None.

Referenced by SetLinkType().

Here is the call graph for this function:

Here is the caller graph for this function:

Duplicate()

auto Track::Duplicate ( DuplicateOptions  options = {} ) const

virtual

public nonvirtual duplication function that invokes Clone()

Definition at line 109 of file Track.cpp.

{
   // invoke "virtual constructor" to copy track object proper:
   auto result = Clone(options.backup);
   CopyAttachments(*result, *this, !options.shallowCopyAttachments);
   return result;
}

Referenced by ProjectFileManager::ReadProjectFile(), and PendingTracks::RegisterPendingChangedTrack().

Here is the caller graph for this function:

GetErrorOpening()

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

virtual

Returns nonempty if an error was encountered while trying to open the track from XML

May assume consistency of stereo channel grouping and examine other channels

Reimplemented in WaveTrack.

Definition at line 229 of file Track.cpp.

{
   return {};
}

GetId()

TrackId Track::GetId ( ) const

inline

Definition at line 136 of file Track.h.

{ return mId; }

Referenced by PendingTracks::DoSubstituteOriginalChannel(), and PendingTracks::DoSubstitutePendingChangedChannel().

Here is the caller graph for this function:

GetLinkedTrack()

Track * Track::GetLinkedTrack ( ) const

private

Definition at line 198 of file Track.cpp.

{
   auto pList = GetOwner();
   if (!pList)
      return nullptr;
 
   if (!pList->isNull(mNode)) {
      if (HasLinkedTrack()) {
         auto next = pList->getNext( mNode );
         if ( !pList->isNull( next ) )
            return next->get();
      }
 
      if (mNode != pList->ListOfTracks::begin()) {
         auto prev = pList->getPrev( mNode );
         if ( !pList->isNull( prev ) ) {
            auto track = prev->get();
            if (track && track->HasLinkedTrack())
               return track;
         }
      }
   }
 
   return nullptr;
}

References GetOwner(), HasLinkedTrack(), and mNode.

Referenced by DoSetLinkType(), TrackList::GetPrev(), IsLeader(), and LinkConsistencyFix().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLinkType()

Track::LinkType Track::GetLinkType ( ) const

noexcept

Definition at line 853 of file Track.cpp.

{
   return mLinkType;
}

References mLinkType.

Referenced by DoSetLinkType(), and WaveTrack::LinkConsistencyFix().

Here is the caller graph for this function:

GetName()

const wxString & Track::GetName

(

)

const

Name is always the same for all channels of a group.

Definition at line 64 of file Track.cpp.

{
   return mName;
}

References mName.

Referenced by ProjectFileManager::AddImportedTracks(), LabelDialog::AddLabels(), CompareAudioCommand::Apply(), CommonTrackInfo::CloseTitleDrawFunction(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), TrackUtilities::DoMoveTrack(), ProjectAudioManager::DoRecord(), TrackUtilities::DoRemoveTrack(), anonymous_namespace{TrackMenus.cpp}::DoSortTracks(), MixerBoard::GetMusicalInstrumentBitmap(), TimeTrack::Init(), WaveTrack::LinkConsistencyFix(), LinkConsistencyFix(), WaveTrack::MakeNewClipName(), WaveTrackMenuTable::OnSplitStereo(), WaveTrackMenuTable::OnSplitStereoMono(), WaveTrackMenuTable::OnSwapChannels(), EffectFindClipping::Process(), RateMenuTable::SetRate(), RealtimeEffectStateUI::UpdateTrackData(), and WriteCommonXMLAttributes().

Here is the caller graph for this function:

GetNode()

TrackNodePointer Track::GetNode ( ) const

private

Retrieve mNode with debug checks.

Definition at line 122 of file Track.cpp.

{
   return mNode;
}

References mNode.

Referenced by TrackList::GetNext(), TrackList::GetPrev(), TrackList::MoveDown(), TrackList::MoveUp(), and TrackList::ReplaceOne().

Here is the caller graph for this function:

GetOwner()

std::shared_ptr< TrackList > Track::GetOwner ( ) const

inline

Definition at line 230 of file Track.h.

{ return mList.lock(); }

Referenced by TrackShifter::CommonMayMigrateTo(), TimeTrackView::Draw(), AdjustClipBorder::FindSnapPoints(), anonymous_namespace{SyncLock.cpp}::FindSyncLockGroup(), GetLinkedTrack(), anonymous_namespace{TrackArt.cpp}::GetProject(), anonymous_namespace{TimeTrack.cpp}::GetRate(), SyncLock::Group(), SyncLock::IsSyncLockSelected(), WaveTrack::PasteWaveTrackAtSameTempo(), TrackList::ReplaceOne(), and WaveTrack::ZipClips().

Here is the caller graph for this function:

GetSelected()

bool Track::GetSelected

(

)

const

Selectedness is always the same for all channels of a group.

Definition at line 78 of file Track.cpp.

{
   return mSelected;
}

References mSelected.

Referenced by CommonTrackInfo::CloseTitleDrawFunction(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), CommonTrackInfo::DrawCloseButton(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), EffectOutputTracks::EffectOutputTracks(), anonymous_namespace{PlayableTrackControls.cpp}::EffectsDrawFunction(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), SelectionState::HandleListSelection(), IsSelected(), SyncLock::IsSyncLockSelected(), CommonTrackInfo::MinimizeSyncLockDrawFunction(), SelectHandle::MoveSnappingFreqSelection(), anonymous_namespace{PlayableTrackControls.cpp}::MuteOrSoloDrawFunction(), NavigationActions::Handler::OnToggle(), EffectRepeat::Process(), PerTrackEffect::ProcessPass(), LabelTrack::SetSelected(), and WriteCommonXMLAttributes().

Here is the caller graph for this function:

GetTypeInfo()

virtual const TypeInfo & Track::GetTypeInfo ( ) const

pure virtual

Implemented in NoteTrack, SampleTrack, WritableSampleTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by SameKindAs().

Here is the caller graph for this function:

GetTypeNames()

virtual const TypeNames & Track::GetTypeNames ( ) const

inlinevirtual

Definition at line 196 of file Track.h.

   { return GetTypeInfo().names; }

HandleCommonXMLAttribute()

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

Definition at line 819 of file Track.cpp.

{
   long nValue = -1;
 
   bool handled = false;
   AttachedTrackObjects::ForEach([&](auto &attachment){
      handled = handled || attachment.HandleXMLAttribute( attr, valueView );
   });
   if (handled)
      ;
   // Note that the per-group properties of name and selectedness may have
   // been written redundantly for each channel, and values for the last
   // channel will be the last ones assigned
   else if (attr == "name") {
      SetName(valueView.ToWString());
      return true;
   }
   else if (attr == "isSelected" && valueView.TryGet(nValue)) {
      this->SetSelected(nValue != 0);
      return true;
   }
   return false;
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), SetName(), SetSelected(), XMLAttributeValueView::ToWString(), and XMLAttributeValueView::TryGet().

Referenced by NoteTrack::HandleXMLTag(), TimeTrack::HandleXMLTag(), WaveTrack::HandleXMLTag(), and LabelTrack::HandleXMLTag().

Here is the call graph for this function:

Here is the caller graph for this function:

HasLinkedTrack()

bool Track::HasLinkedTrack ( ) const

privatenoexcept

During file loading only, true for leaders of multichannel groups.

Definition at line 224 of file Track.cpp.

{
   return mLinkType != LinkType::None;
}

References mLinkType, and ChannelGroup::None.

Referenced by DoSetLinkType(), GetLinkedTrack(), TrackList::GetNext(), TrackList::GetPrev(), IsLeader(), and LinkConsistencyFix().

Here is the caller graph for this function:

HasOwner()

bool Track::HasOwner ( ) const

inline

Definition at line 228 of file Track.h.

{ return static_cast<bool>(GetOwner());}

Init()

void Track::Init

(

const Track &

orig

)

Definition at line 47 of file Track.cpp.

{
   mId = orig.mId;
   ChannelGroupAttachments &base = *this;
   // Intentional slice assignment deep-copies the attachment array:
   base = orig;
   CopyGroupProperties(orig);
   mLinkType = orig.mLinkType;
}

References CopyGroupProperties(), mId, and mLinkType.

Referenced by TimeTrack::Init(), and WaveTrack::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

InsertSilence()

virtual void Track::InsertSilence ( double  t, double  len  )

pure virtual

May assume precondition: t0 <= t1

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

IsLeader()

bool Track::IsLeader

(

)

const

Definition at line 261 of file Track.cpp.

{
    return !GetLinkedTrack() || HasLinkedTrack();
}

References GetLinkedTrack(), and HasLinkedTrack().

Referenced by TrackList::Any(), TrackList::Find(), WaveTrack::LinkConsistencyFix(), and LinkConsistencyFix().

Here is the call graph for this function:

Here is the caller graph for this function:

IsSelected()

bool Track::IsSelected

(

)

const

Definition at line 258 of file Track.cpp.

   { return GetSelected(); }

References GetSelected().

Referenced by ProjectAudioManager::ChooseExistingRecordingTracks(), anonymous_namespace{TrackMenus.cpp}::DoPanTracks(), ExportUtils::FindExportWaveTracks(), SyncLock::IsSelectedOrSyncLockSelected(), SyncLock::IsSyncLockSelected(), MakeTransportTracks(), SelectActions::Handler::OnSelectSyncLockSel(), EffectTruncSilence::ProcessIndependently(), and TrackList::Selected().

Here is the call graph for this function:

Here is the caller graph for this function:

LinkConsistencyCheck()

bool Track::LinkConsistencyCheck ( )

inline

Do the non-mutating part of consistency fix only and return status.

Definition at line 225 of file Track.h.

   { return const_cast<Track*>(this)->LinkConsistencyFix(false); }

Referenced by DoSetLinkType().

Here is the caller graph for this function:

LinkConsistencyFix()

bool Track::LinkConsistencyFix ( bool  doFix = true )

virtual

Check consistency of channel groups, and maybe fix it.

Parameters

doFix

whether to make any changes to correct inconsistencies

Precondition

!doFix || IsLeader()

Returns

true if no inconsistencies were found

Reimplemented in WaveTrack.

Definition at line 266 of file Track.cpp.

{
   assert(!doFix || IsLeader());
   // Sanity checks for linked tracks; unsetting the linked property
   // doesn't fix the problem, but it likely leaves us with orphaned
   // sample blocks instead of much worse problems.
   bool err = false;
   if (HasLinkedTrack()) {
      if (auto link = GetLinkedTrack()) {
         // A linked track's partner should never itself be linked
         if (link->HasLinkedTrack()) {
            err = true;
            if (doFix) {
               wxLogWarning(
                  L"Left track %s had linked right track %s with extra right "
                   "track link.\n   Removing extra link from right track.",
                  GetName(), link->GetName());
               link->SetLinkType(LinkType::None);
            }
         }
      }
      else {
         err = true;
         if (doFix) {
            wxLogWarning(
               L"Track %s had link to NULL track. Setting it to not be linked.",
               GetName());
            SetLinkType(LinkType::None);
         }
      }
   }
   return ! err;
}

References GetLinkedTrack(), GetName(), HasLinkedTrack(), IsLeader(), ChannelGroup::None, and SetLinkType().

Referenced by WaveTrack::LinkConsistencyFix().

Here is the call graph for this function:

Here is the caller graph for this function:

Notify()

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

Definition at line 234 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList)
      pList->DataEvent(SharedPointer(), allChannels, code);
}

References mList, and SharedPointer().

Referenced by WaveTrack::SetGain(), PlayableTrack::SetMute(), SetName(), WaveTrack::SetPan(), PlayableTrack::SetSolo(), and NoteTrack::SetVelocity().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

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

delete

Paste()

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

pure virtual

Weak precondition allows overrides to replicate one channel into many.

Precondition

SameKindAs(src)

src.NChannels() == 1 || src.NChannels() == NChannels()

Implemented in NoteTrack, TimeTrack, LabelTrack, WaveTrack, and WaveTrack.

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

PasteInto()

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

pure virtual

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

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected().

Here is the caller graph for this function:

ReparentAllAttachments()

void Track::ReparentAllAttachments

(

)

Definition at line 57 of file Track.cpp.

{
   this->AttachedTrackObjects::ForEach([&](auto &attachment){
      attachment.Reparent(this->SharedPointer());
   });
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), and SharedPointer().

Here is the call graph for this function:

SameKindAs()

bool Track::SameKindAs ( const Track &  track ) const

inline

Definition at line 373 of file Track.h.

      { return &GetTypeInfo() == &track.GetTypeInfo(); }

References GetTypeInfo().

Referenced by TrackShifter::CommonMayMigrateTo(), anonymous_namespace{TimeShiftHandle.cpp}::FindCorrespondence(), and anonymous_namespace{EditMenus.cpp}::FitsInto().

Here is the call graph for this function:

Here is the caller graph for this function:

SetId()

void Track::SetId ( TrackId  id )

inlineprivate

Definition at line 138 of file Track.h.

{ mId = id; }

References id.

Referenced by TrackList::DoAddToHead().

Here is the caller graph for this function:

SetLinkType()

void Track::SetLinkType ( LinkType  linkType, bool  completeList = true  )

protected

Parameters

completeList

only influences debug build consistency checking

Definition at line 136 of file Track.cpp.

{
   DoSetLinkType(linkType, completeList);
   if (const auto pList = mList.lock()) {
      pList->RecalcPositions(mNode);
      pList->ResizingEvent(mNode);
   }
}

References DoSetLinkType(), mList, and mNode.

Referenced by WaveTrack::HandleXMLTag(), WaveTrack::LinkConsistencyFix(), LinkConsistencyFix(), and WaveTrack::ZipClips().

Here is the call graph for this function:

Here is the caller graph for this function:

SetName()

void Track::SetName

(

const wxString &

n

)

Definition at line 69 of file Track.cpp.

{
   auto &name = mName;
   if (name != n) {
      name = n;
      Notify(true);
   }
}

References mName, name, and Notify().

Referenced by SetTrackStatusCommand::ApplyInner(), TimeTrack::CleanState(), HandleCommonXMLAttribute(), anonymous_namespace{ImportMIDI.cpp}::ImportMIDI(), TimeTrack::Init(), ModifiedAnalysisTrack::ModifiedAnalysisTrack(), and NoteTrack::NoteTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

SetOwner()

void Track::SetOwner ( const std::weak_ptr< TrackList > &  list, TrackNodePointer  node  )

private

Update mNode when Track is added to TrackList, or removed from it.

Definition at line 127 of file Track.cpp.

{
   // BUG: When using this function to clear an owner, we may need to clear
   // focused track too.  Otherwise focus could remain on an invisible (or deleted) track.
   mList = list;
   mNode = node;
}

References mList, and mNode.

Referenced by TrackList::DoAddToHead(), TrackList::Permute(), and TrackList::ReplaceOne().

Here is the caller graph for this function:

SetSelected()

void Track::SetSelected ( bool  s )

virtual

Reimplemented in LabelTrack.

Definition at line 83 of file Track.cpp.

{
   auto &selected = mSelected;
   if (selected != s) {
      selected = s;
      auto pList = mList.lock();
      if (pList)
         pList->SelectionEvent(*this);
   }
}

References mList, and mSelected.

Referenced by SetTrackStatusCommand::ApplyInner(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), HandleCommonXMLAttribute(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), SelectionState::SelectTrack(), and LabelTrack::SetSelected().

Here is the caller graph for this function:

SharedPointer() [1/4]

template<typename Subclass = Track>

std::shared_ptr< Subclass > Track::SharedPointer ( )

inline

Definition at line 146 of file Track.h.

   {
      // shared_from_this is injected into class scope by base class
      // std::enable_shared_from_this<Track>
      return std::static_pointer_cast<Subclass>( shared_from_this() );
   }

Referenced by SelectionState::ChangeSelectionOnShiftClick(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), CommonChannelCell::DoFindTrack(), WaveChannelView::DoGetAffordance(), TimeShiftHandle::DoSlideVertical(), TimeShiftHandle::Drag(), TrackFocus::GetFocus(), ClipMoveState::Init(), Notify(), EffectStereoToMono::ProcessOne(), ReparentAllAttachments(), SelectionState::SelectTrack(), TrackFocus::Set(), TrackFocus::SetFocus(), SharedPointer(), and RealtimeEffectPanel::ShowPanel().

Here is the caller graph for this function:

SharedPointer() [2/4]

template<typename Subclass = const Track>

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

inline

Definition at line 154 of file Track.h.

   {
      // shared_from_this is injected into class scope by base class
      // std::enable_shared_from_this<Track>
      return std::static_pointer_cast<Subclass>( shared_from_this() );
   }

SharedPointer() [3/4]

template<typename Subclass = const Track>

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

inlinestatic

Definition at line 170 of file Track.h.

   { return pTrack ? pTrack->SharedPointer<Subclass>() : nullptr; }

References SharedPointer().

Here is the call graph for this function:

SharedPointer() [4/4]

template<typename Subclass = Track>

static std::shared_ptr< Subclass > Track::SharedPointer ( Track *  pTrack )

inlinestatic

Definition at line 166 of file Track.h.

   { return pTrack ? pTrack->SharedPointer<Subclass>() : nullptr; }

References SharedPointer().

Here is the call graph for this function:

Silence()

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

pure virtual

Implemented in WaveTrack, NoteTrack, TimeTrack, and LabelTrack.

SupportsBasicEditing()

bool Track::SupportsBasicEditing ( ) const

virtual

Whether this track type implements cut-copy-paste; by default, true.

Reimplemented in TimeTrack.

Definition at line 797 of file Track.cpp.

{
   return true;
}

Referenced by SelectActions::Handler::OnCursorTrackEnd(), SelectActions::Handler::OnCursorTrackStart(), anonymous_namespace{EditMenus.cpp}::OnCut(), SelectActions::Handler::OnSelectSyncLockSel(), and anonymous_namespace{EditMenus.cpp}::OnSplitCut().

Here is the caller graph for this function:

SyncLockAdjust()

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

virtual

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

Reimplemented in WaveTrack, and LabelTrack.

Definition at line 241 of file Track.cpp.

{
   const auto endTime = GetEndTime();
   if (newT1 > oldT1 && oldT1 > endTime)
         return;
   if (newT1 > oldT1) {
      auto cutChannels = Cut(oldT1, endTime);
      Paste(newT1, *cutChannels);
   }
   else if (newT1 < oldT1)
      // Remove from the track
      Clear(newT1, oldT1);
}

References Clear(), Cut(), ChannelGroup::GetEndTime(), and Paste().

Here is the call graph for this function:

TypeSwitch() [1/2]

template<typename R = void, typename ... Functions>

R Track::TypeSwitch ( const Functions &...  functions )

inline

Do a TypeSwitch on this track, among all subtypes enumerated up to the point of the call

Definition at line 381 of file Track.h.

   {
      struct Here : TrackTypeTag {};
      // List more derived classes later
      using TrackTypes =
         typename TypeEnumerator::CollectTypes<TrackTypeTag, Here>::type;
      return TypeSwitch::VDispatch<R, TrackTypes>(*this, functions...);
   }

Referenced by SetEnvelopeCommand::ApplyInner(), EffectAutoDuck::Init(), anonymous_namespace{LabelMenus.cpp}::OnCopyLabels(), anonymous_namespace{LabelMenus.cpp}::OnCutLabels(), anonymous_namespace{LabelMenus.cpp}::OnDeleteLabels(), anonymous_namespace{LabelMenus.cpp}::OnDisjoinLabels(), anonymous_namespace{LabelMenus.cpp}::OnJoinLabels(), anonymous_namespace{EditMenus.cpp}::OnPaste(), anonymous_namespace{LabelMenus.cpp}::OnSilenceLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitCutLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitDeleteLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitLabels(), NoteTrack::Paste(), TimeTrack::Paste(), LabelTrack::Paste(), LabelTrack::PasteOver(), and NyquistEffect::ProcessOne().

Here is the caller graph for this function:

TypeSwitch() [2/2]

template<typename R = void, typename ... Functions>

R Track::TypeSwitch ( const Functions &...  functions ) const

inline

Do a TypeSwitch on this track, among all subtypes enumerated up to the point of the call

Definition at line 392 of file Track.h.

   {
      struct Here : TrackTypeTag {};
      // List more derived classes later
      using namespace TypeList;
      using TrackTypes = Map_t<Fn<std::add_const_t>,
         typename TypeEnumerator::CollectTypes<TrackTypeTag, Here>::type>;
      return TypeSwitch::VDispatch<R, TrackTypes>(*this, functions...);
   }

WriteCommonXMLAttributes()

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

Definition at line 803 of file Track.cpp.

{
   if (includeNameAndSelected) {
      // May write name and selectedness redundantly for right channels,
      // but continue doing that in case the file is opened in Audacity 3.1.x
      // which does not have unique ChannelGroupData for the track
      xmlFile.WriteAttr(wxT("name"), GetName());
      xmlFile.WriteAttr(wxT("isSelected"), this->GetSelected());
   }
   AttachedTrackObjects::ForEach([&](auto &attachment){
      attachment.WriteXMLAttributes( xmlFile );
   });
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), GetName(), GetSelected(), XMLWriter::WriteAttr(), and wxT().

Referenced by TimeTrack::WriteXML(), and LabelTrack::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteXML()

virtual void Track::WriteXML ( XMLWriter &  xmlFile ) const

pure virtual

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by ProjectFileIO::WriteXML().

Here is the caller graph for this function:

Friends And Related Function Documentation

track_cast [1/2]

template<typename T >

std::enable_if_t< std::is_pointer_v< T > && std::is_const_v< std::remove_pointer_t< T > >, T > track_cast ( const Track *  track )

friend

Encapsulate the checked down-casting of track pointers.

Eliminates possibility of error – and not quietly casting away const

Typical usage:

if (auto wt = track_cast<const WaveTrack*>(track)) { ... }

This overload for const pointers can cast only to other const pointer types.

Definition at line 497 of file Track.h.

{
   using BareType = std::remove_pointer_t< T >;
   if (track &&
       BareType::ClassTypeInfo().IsBaseOf(track->GetTypeInfo() ))
      return reinterpret_cast<T>(track);
   else
      return nullptr;
}

track_cast [2/2]

template<typename T >

std::enable_if_t< std::is_pointer_v< T >, T > track_cast ( Track *  track )

friend

Encapsulate the checked down-casting of track pointers.

Eliminates possibility of error – and not quietly casting away const

Typical usage:

if (auto wt = track_cast<const WaveTrack*>(track)) { ... }

Definition at line 480 of file Track.h.

{
   using BareType = std::remove_pointer_t< T >;
   if (track &&
       BareType::ClassTypeInfo().IsBaseOf(track->GetTypeInfo() ))
      return reinterpret_cast<T>(track);
   else
      return nullptr;
}

TrackList

friend class TrackList

friend

Definition at line 121 of file Track.h.

Member Data Documentation

mId

TrackId Track::mId

private

Identifies the track only in-session, not persistently.

Definition at line 124 of file Track.h.

Referenced by Init().

mLinkType

LinkType Track::mLinkType { LinkType::None }

private

Definition at line 439 of file Track.h.

Referenced by DoSetLinkType(), GetLinkType(), HasLinkedTrack(), and Init().

mList

std::weak_ptr<TrackList> Track::mList

protected

Back pointer to owning TrackList

Definition at line 127 of file Track.h.

Referenced by AdjustPositions(), Notify(), SetLinkType(), SetOwner(), and SetSelected().

mName

wxString Track::mName

private

Definition at line 437 of file Track.h.

Referenced by CopyGroupProperties(), GetName(), and SetName().

mNode

TrackNodePointer Track::mNode {}

protected

Holds iterator to self, so that TrackList::Find can be constant-time.

Definition at line 129 of file Track.h.

Referenced by AdjustPositions(), GetLinkedTrack(), GetNode(), SetLinkType(), and SetOwner().

mSelected

bool Track::mSelected { false }

private

Definition at line 440 of file Track.h.

Referenced by CopyGroupProperties(), GetSelected(), and SetSelected().

---

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

• Track.h
• Track.cpp