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	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 = ClientData::Site< ChannelGroupData, ClientData::Cloneable<>, ClientData::DeepCopying >
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 > >
std::shared_ptr< Track >	SubstitutePendingChangedTrack ()
std::shared_ptr< const Track >	SubstitutePendingChangedTrack () const
std::shared_ptr< const Track >	SubstituteOriginalTrack () const
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
TrackList *	GetHolder () const
LinkType	GetLinkType () const noexcept
ChannelGroupData &	GetGroupData ()
const ChannelGroupData &	GetGroupData () const
	May make group data on demand, but consider that logically const. More...
	Track ()
	Track (const Track &orig, ProtectedCreationArg &&)
Track &	operator= (const Track &orig)=delete
virtual	~Track ()
void	Init (const Track &orig)
virtual TrackListHolder	Duplicate () const
	public nonvirtual duplication function that invokes Clone() More...
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)
void	OnProjectTempoChange (double newTempo)
	method to set project tempo on track More...
virtual TrackListHolder	Cut (double t0, double t1)=0
	Create tracks and modify this track. More...
virtual TrackListHolder	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...
void	Paste (double t, const TrackList &src)
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 override
bool	IsSelectedLeader () const
void	AdjustPositions ()
void	WriteCommonXMLAttributes (XMLWriter &xmlFile, bool includeNameAndSelected=true) const
bool	HandleCommonXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)
const std::optional< double > &	GetProjectTempo () const
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 bool	IsLeader () const =0
ChannelGroupData &	GetGroupData ()
	Make attachment site on demand as needed. More...
const ChannelGroupData &	GetGroupData () const
ChannelGroupData *	FindGroupData ()
	Do not make attachment site on demand if absent. More...
const ChannelGroupData *	FindGroupData () const
	Do not make attachment site on demand if absent. More...
void	Init (const ChannelGroup &other)
	Copy, including cloning of attached objects. More...
void	DestroyGroupData ()
	Leave all attachments null. More...
std::unique_ptr< ChannelGroupData >	DetachGroupData ()
	Move attachments out. More...
void	AssignGroupData (std::unique_ptr< ChannelGroupData > pGroupData)
	Replace any previous attachments. 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...
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 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)
virtual void	DoOnProjectTempoChange (const std::optional< double > &oldTempo, double newTempo)=0
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 >
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...
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
	Retrieve a channel. More...
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...
int	mIndex
	0-based position of this track in its TrackList More...

Private Member Functions
void	SetId (TrackId id)
int	GetIndex () const
void	SetIndex (int index)
void	DoSetLinkType (LinkType linkType, bool completeList=true)
Track *	GetLinkedTrack () const
bool	HasLinkedTrack () const noexcept
	Returns 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 TrackListHolder	Clone () const =0

Private Attributes
TrackId	mId
	Identifies the track only in-session, not persistently. More...

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 117 of file Track.h.

Member Typedef Documentation

AttachedObjects

using Track::AttachedObjects = ::AttachedTrackObjects

Alias for my base type.

Definition at line 148 of file Track.h.

Holder

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

Definition at line 225 of file Track.h.

Constructor & Destructor Documentation

Track() [1/2]

Track::Track

(

)

Definition at line 39 of file Track.cpp.

{
   mIndex = 0;
}

References mIndex.

Track() [2/2]

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

Definition at line 44 of file Track.cpp.

{
   mIndex = 0;
}

References mIndex.

~Track()

Track::~Track ( )

virtual

Definition at line 110 of file Track.cpp.

{
}

Member Function Documentation

AdjustPositions()

void Track::AdjustPositions

(

)

Definition at line 1260 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 285 of file Track.cpp.

   { return true; }

Referenced by EffectLoudness::AllocBuffers(), TrackList::Channels_(), WaveTrack::DuplicateWithOtherTempo(), TrackList::EmptyRange(), ExportUtils::FindExportWaveTracks(), MakeTransportTracks(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), EffectNoiseReduction::Worker::Process(), and TrackList::Size().

Here is the caller graph for this function:

ClassTypeInfo()

auto Track::ClassTypeInfo ( )

static

Definition at line 1206 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

Precondition

IsLeader()

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 TrackListHolder Track::Clone ( ) 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)

Parameters

unstretchInterval

If set, this time interval's stretching must be applied.

Precondition

!unstretchInterval.has_value() || unstretchInterval->first < unstretchInterval->second

IsLeader()

Postcondition

result: NChannels() == result->NChannels()

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by Duplicate(), and TrackList::RegisterPendingChangedTrack().

Here is the caller graph for this function:

Copy()

virtual TrackListHolder 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

Precondition

IsLeader

Postcondition

result: result->NChannels() == NChannels()

Implemented in TimeTrack, NoteTrack, WaveTrack, and LabelTrack.

Cut()

virtual TrackListHolder 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

Precondition

IsLeader()

Postcondition

result: result->NChannels() == NChannels()

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

DoOnProjectTempoChange()

virtual void Track::DoOnProjectTempoChange ( const std::optional< double > &  oldTempo, double  newTempo  )

protectedpure virtual

Precondition

IsLeader()

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

Referenced by OnProjectTempoChange().

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 174 of file Track.cpp.

{
   auto oldType = GetLinkType();
   if (linkType == oldType)
      // No change
      return;
 
   if (oldType == LinkType::None) {
      // Becoming linked
 
      // First ensure there is no partner
      if (auto partner = GetLinkedTrack())
         partner->DestroyGroupData();
      assert(!GetLinkedTrack());
 
      // Change the link type
      GetGroupData().mLinkType = linkType;
 
      // If this acquired a partner, it loses any old group data
      if (auto partner = GetLinkedTrack())
         partner->DestroyGroupData();
   }
   else if (linkType == LinkType::None) {
      // Becoming unlinked
      assert(FindGroupData());
      if (HasLinkedTrack()) {
         if (auto partner = GetLinkedTrack()) {
            // Make independent copy of group data in the partner, which should
            // have had none
            assert(!partner->FindGroupData());
            partner->ChannelGroup::Init(*this);
            partner->GetGroupData().mLinkType = LinkType::None;
         }
      }
      GetGroupData().mLinkType = LinkType::None;
   }
   else {
      // Remaining linked, changing the type
      assert(FindGroupData());
      GetGroupData().mLinkType = linkType;
   }
 
   // Assertion checks only in a debug build, does not have side effects!
   assert(!completeList || LinkConsistencyCheck());
}

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

Referenced by SetLinkType().

Here is the call graph for this function:

Here is the caller graph for this function:

Duplicate()

TrackListHolder Track::Duplicate ( ) const

virtual

public nonvirtual duplication function that invokes Clone()

Precondition

IsLeader()

Postcondition

result: NChannels() == result->NChannels()

Definition at line 86 of file Track.cpp.

{
   assert(IsLeader());
   // invoke "virtual constructor" to copy track object proper:
   auto result = Clone();
 
   auto iter = TrackList::Channels(*result->begin()).begin();
   const auto copyOne = [&](const Track *pChannel){
      pChannel->AttachedTrackObjects::ForEach([&](auto &attachment){
         // Copy view state that might be important to undo/redo
         attachment.CopyTo(**iter);
      });
      ++iter;
   };
 
   if (GetOwner())
      for (const auto pChannel : TrackList::Channels(this))
         copyOne(pChannel);
   else
      copyOne(this);
 
   return result;
}

References TrackList::Channels(), Clone(), GetOwner(), and IsLeader().

Referenced by WaveTrack::DuplicateWithOtherTempo(), and WaveTrack::MonoToStereo().

Here is the call graph for this function:

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

Precondition

IsLeader()

Reimplemented in WaveTrack.

Definition at line 252 of file Track.cpp.

{
   return {};
}

GetGroupData() [1/2]

ChannelGroup::ChannelGroupData & Track::GetGroupData

(

)

Definition at line 159 of file Track.cpp.

{
   auto pTrack = this;
   if (auto pList = GetHolder())
      if (auto pLeader = *pList->Find(pTrack))
         pTrack = pLeader;
   // May make on demand
   return pTrack->ChannelGroup::GetGroupData();
}

References GetHolder().

Referenced by DoSetLinkType(), SpectrogramSettings::Get(), WaveformSettings::Get(), WaveformScale::Get(), anonymous_namespace{PlayableTrack.cpp}::MuteAndSolo::Get(), anonymous_namespace{WaveChannelView.cpp}::PlacementArray::Get(), anonymous_namespace{WaveTrack.cpp}::WaveTrackData::Get(), SpectrogramBounds::Get(), GetGroupData(), GetName(), GetProjectTempo(), GetSelected(), OnProjectTempoChange(), SpectrogramSettings::Own(), SpectrogramSettings::Reset(), WaveformSettings::Set(), SetName(), and SetSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

GetGroupData() [2/2]

const ChannelGroup::ChannelGroupData & Track::GetGroupData

(

)

const

May make group data on demand, but consider that logically const.

Definition at line 169 of file Track.cpp.

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

References GetGroupData().

Here is the call graph for this function:

GetHolder()

TrackList * Track::GetHolder ( ) const

inline

Definition at line 1462 of file Track.h.

                                  {
   return static_cast<TrackList*>(mNode.second); }

References mNode.

Referenced by SpectrumView::DoDraw(), WaveformView::DoDraw(), GetGroupData(), and WaveTrack::ReallyDoGetChannelGroup().

Here is the caller graph for this function:

GetId()

TrackId Track::GetId ( ) const

inline

Definition at line 150 of file Track.h.

{ return mId; }

Referenced by TrackList::HasPendingTracks(), SetLinkType(), SubstituteOriginalTrack(), and SubstitutePendingChangedTrack().

Here is the caller graph for this function:

GetIndex()

int Track::GetIndex ( ) const

private

Definition at line 130 of file Track.cpp.

{
   return mIndex;
}

References mIndex.

Referenced by TrackList::RecalcPositions().

Here is the caller graph for this function:

GetLinkedTrack()

Track * Track::GetLinkedTrack ( ) const

private

Definition at line 220 of file Track.cpp.

{
   auto pList = static_cast<TrackList*>(mNode.second);
   if (!pList)
      return nullptr;
 
   if (!pList->isNull(mNode)) {
      if (HasLinkedTrack()) {
         auto next = pList->getNext( mNode );
         if ( !pList->isNull( next ) )
            return next.first->get();
      }
 
      if (mNode.first != mNode.second->begin()) {
         auto prev = pList->getPrev( mNode );
         if ( !pList->isNull( prev ) ) {
            auto track = prev.first->get();
            if (track && track->HasLinkedTrack())
               return track;
         }
      }
   }
 
   return nullptr;
}

References TrackList::getNext(), 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 1280 of file Track.cpp.

{
   const auto pGroupData = FindGroupData();
   return pGroupData ? pGroupData->mLinkType : LinkType::None;
}

References ChannelGroup::FindGroupData(), and ChannelGroup::None.

Referenced by DoSetLinkType(), ProjectFileManager::FixTracks(), WaveTrack::LinkConsistencyFix(), and WaveTrack::WriteOneXML().

Here is the call graph for this function:

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 56 of file Track.cpp.

{
   return GetGroupData().mName;
}

References GetGroupData(), and ChannelGroup::ChannelGroupData::mName.

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetNode()

TrackNodePointer Track::GetNode ( ) const

private

Retrieve mNode with debug checks.

Definition at line 115 of file Track.cpp.

{
   wxASSERT(mList.lock() == NULL || this == mNode.first->get());
   return mNode;
}

References mList, and mNode.

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

Here is the caller graph for this function:

GetOwner()

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

inline

Definition at line 254 of file Track.h.

{ return mList.lock(); }

Referenced by WaveTrack::Append(), WaveTrack::Clone(), TrackShifter::CommonMayMigrateTo(), WaveTrack::DoGet(), Duplicate(), AdjustClipBorder::FindSnapPoints(), anonymous_namespace{SyncLock.cpp}::FindSyncLockGroup(), WaveTrack::GetClipInterfaces(), WaveTrack::GetEnvelopeAtTime(), WaveTrack::GetEnvelopeValues(), anonymous_namespace{TrackArt.cpp}::BeatsGridlinePainter::GetProject(), anonymous_namespace{TimeTrack.cpp}::GetRate(), SyncLock::Group(), WaveTrack::HasTrivialEnvelope(), SyncLock::IsSyncLockSelected(), WaveTrack::MonoToStereo(), WaveTrack::NChannels(), WaveTrack::PasteOne(), TrackList::ReplaceOne(), TrackList::SwapChannels(), and WaveTrack::WidestEffectiveFormat().

Here is the caller graph for this function:

GetProjectTempo()

const std::optional< double > & Track::GetProjectTempo

(

)

const

Definition at line 1369 of file Track.cpp.

{
   return GetGroupData().mProjectTempo;
}

References GetGroupData(), and ChannelGroup::ChannelGroupData::mProjectTempo.

Referenced by WaveTrack::ClearAndPaste(), WaveTrack::ClearAndPasteAtSameTempo(), WaveTrack::CreateClip(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), WaveTrack::InsertClip(), WaveTrack::PasteWaveTrack(), and WaveTrack::PasteWaveTrackAtSameTempo().

Here is the call graph for this function:

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 70 of file Track.cpp.

{
   return GetGroupData().mSelected;
}

References GetGroupData(), and ChannelGroup::ChannelGroupData::mSelected.

Referenced by CommonTrackInfo::CloseTitleDrawFunction(), TrackArt::DrawBackgroundWithSelection(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), 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(), anonymous_namespace{PlayableTrackControls.cpp}::MuteOrSoloDrawFunction(), NavigationActions::Handler::OnToggle(), EffectRepeat::Process(), LabelTrack::SetSelected(), and WriteCommonXMLAttributes().

Here is the call graph for this function:

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 219 of file Track.h.

   { return GetTypeInfo().names; }

HandleCommonXMLAttribute()

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

Definition at line 1235 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

Returns true for leaders of multichannel groups.

Definition at line 246 of file Track.cpp.

{
   auto pGroupData = FindGroupData();
   return pGroupData && pGroupData->mLinkType != LinkType::None;
}

References ChannelGroup::FindGroupData(), and ChannelGroup::None.

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

Here is the call graph for this function:

Here is the caller graph for this function:

HasOwner()

bool Track::HasOwner ( ) const

inline

Definition at line 252 of file Track.h.

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

Init()

void Track::Init

(

const Track &

orig

)

Definition at line 50 of file Track.cpp.

{
   ChannelGroup::Init(orig);
   mId = orig.mId;
}

References ChannelGroup::Init(), and mId.

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

Precondition

IsLeader()

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

IsLeader()

bool Track::IsLeader ( ) const

overridevirtual

Implements ChannelGroup.

Reimplemented in SampleTrack, WritableSampleTrack, and WaveTrack.

Definition at line 291 of file Track.cpp.

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

References GetLinkedTrack(), and HasLinkedTrack().

Referenced by TrackList::Any(), NoteTrack::Clear(), TimeTrack::Clear(), LabelTrack::Clear(), TimeTrack::Clone(), LabelTrack::Clone(), CoarseTrackShifter::CoarseTrackShifter(), TrackShifter::CommonMayMigrateTo(), NoteTrack::Cut(), TimeTrack::Cut(), LabelTrack::Cut(), DEFINE_ATTACHED_VIRTUAL(), NoteTrack::DoOnProjectTempoChange(), TimeTrack::DoOnProjectTempoChange(), LabelTrack::DoOnProjectTempoChange(), ProjectAudioManager::DoRecord(), TimeShiftHandle::DoSlideVertical(), Duplicate(), TrackList::Find(), anonymous_namespace{TrackPanel.cpp}::FindAdjustedChannelHeights(), SelectionState::HandleListSelection(), ClipMoveState::Init(), TrackList::Insert(), NoteTrack::InsertSilence(), TimeTrack::InsertSilence(), LabelTrack::InsertSilence(), WaveTrack::IsLeader(), IsSelectedLeader(), LinkConsistencyFix(), 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(), NavigationActions::Handler::OnLastTrack(), OnProjectTempoChange(), anonymous_namespace{LabelMenus.cpp}::OnSilenceLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitCutLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitDeleteLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitLabels(), NavigationActions::Handler::OnToggle(), NoteTrack::PasteInto(), TimeTrack::PasteInto(), LabelTrack::PasteInto(), TrackList::RegisterPendingChangedTrack(), TrackList::Remove(), TrackList::ReplaceOne(), SelectionState::SelectTrack(), SelectionState::SelectTrackLength(), Viewport::ShowTrack(), NoteTrack::Silence(), TimeTrack::Silence(), LabelTrack::Silence(), SyncLockAdjust(), LabelTrack::SyncLockAdjust(), TrackPanel::UpdateTrackVRuler(), and AddedAnalysisTrack::~AddedAnalysisTrack().

Here is the call graph for this function:

IsSelected()

bool Track::IsSelected

(

)

const

Definition at line 288 of file Track.cpp.

   { return GetSelected(); }

References GetSelected().

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsSelectedLeader()

bool Track::IsSelectedLeader

(

)

const

Definition at line 296 of file Track.cpp.

   { return IsSelected() && IsLeader(); }

References IsLeader(), and IsSelected().

Referenced by 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 249 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 299 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()) /* which implies IsLeader() */ {
      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 257 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(), and PlayableTrack::SetSolo().

Here is the call graph for this function:

Here is the caller graph for this function:

OnProjectTempoChange()

void Track::OnProjectTempoChange

(

double

newTempo

)

method to set project tempo on track

Precondition

IsLeader()

Definition at line 1361 of file Track.cpp.

{
   assert(IsLeader());
   auto &mProjectTempo = GetGroupData().mProjectTempo;
   DoOnProjectTempoChange(mProjectTempo, newTempo);
   mProjectTempo = newTempo;
}

References DoOnProjectTempoChange(), GetGroupData(), IsLeader(), and ChannelGroup::ChannelGroupData::mProjectTempo.

Referenced by WaveTrack::DuplicateWithOtherTempo().

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() [1/2]

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

pure virtual

Weak precondition allows overrides to replicate one channel into many.

Precondition

IsLeader()

SameKindAs(src)

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

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

Referenced by Paste(), and SyncLockAdjust().

Here is the caller graph for this function:

Paste() [2/2]

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

Non-virtual overload that passes the first track of a given list

Precondition

IsLeader()

SameKindAs(**src.begin()).NChannels()

NChannels == (**src.begin()).NChannels()

Definition at line 264 of file Track.cpp.

{
   Paste(t, **src.begin());
}

References TrackList::begin(), and Paste().

Here is the call 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

Precondition

IsLeader()

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 leader track

Implemented in NoteTrack, TimeTrack, WaveTrack, and LabelTrack.

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

Here is the caller graph for this function:

SameKindAs()

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

inline

Definition at line 410 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 152 of file Track.h.

{ mId = id; }

References id.

Referenced by TrackList::DoAddToHead().

Here is the caller graph for this function:

SetIndex()

void Track::SetIndex ( int  index )

private

Definition at line 135 of file Track.cpp.

{
   mIndex = index;
}

References mIndex.

Referenced by TrackList::RecalcPositions().

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 140 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList && pList->mPendingUpdates && !pList->mPendingUpdates->empty()) {
      auto orig = pList->FindById( GetId() );
      if (orig && orig != this) {
         orig->SetLinkType(linkType);
         return;
      }
   }
 
   DoSetLinkType(linkType, completeList);
 
   if (pList) {
      pList->RecalcPositions(mNode);
      pList->ResizingEvent(mNode);
   }
}

References DoSetLinkType(), GetId(), mList, and mNode.

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

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 61 of file Track.cpp.

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

References GetGroupData(), ChannelGroup::ChannelGroupData::mName, name, and Notify().

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

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 121 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::SwapNodes().

Here is the caller graph for this function:

SetSelected()

void Track::SetSelected ( bool  s )

virtual

Reimplemented in LabelTrack.

Definition at line 75 of file Track.cpp.

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

References GetGroupData(), mList, and ChannelGroup::ChannelGroupData::mSelected.

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

Here is the call graph for this function:

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 160 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 SelectHandle::AdjustSelection(), SelectionState::ChangeSelectionOnShiftClick(), WaveTrack::CopyOne(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), TimeShiftHandle::DoSlideVertical(), TimeShiftHandle::Drag(), TrackFocus::GetFocus(), SelectHandle::HandleCenterFrequencyClick(), ClipMoveState::Init(), SelectHandle::MoveSnappingFreqSelection(), Notify(), EffectStereoToMono::ProcessOne(), SelectionState::SelectTrack(), TrackFocus::Set(), TrackFocus::SetFocus(), SharedPointer(), RealtimeEffectPanel::ShowPanel(), SubstituteOriginalTrack(), and SubstitutePendingChangedTrack().

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 168 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 184 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 180 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

Precondition

IsLeader()

Implemented in WaveTrack, NoteTrack, TimeTrack, and LabelTrack.

SubstituteOriginalTrack()

std::shared_ptr< const Track > Track::SubstituteOriginalTrack

(

)

const

Definition at line 1185 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList && pList->mPendingUpdates) {
      const auto id = GetId();
      const auto pred = [=]( const ListOfTracks::value_type &ptr ) {
         return ptr->GetId() == id; };
      const auto end = pList->mPendingUpdates->ListOfTracks::end();
      const auto it =
         std::find_if(pList->mPendingUpdates->ListOfTracks::begin(), end, pred);
      if (it != end) {
         const auto &list2 = (const ListOfTracks &) *pList;
         const auto end2 = list2.end();
         const auto it2 = std::find_if( list2.begin(), end2, pred );
         if ( it2 != end2 )
            return *it2;
      }
   }
   return SharedPointer();
}

References PackedArray::end(), GetId(), id, mList, and SharedPointer().

Referenced by SyncLock::IsSyncLockSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

SubstitutePendingChangedTrack() [1/2]

std::shared_ptr< Track > Track::SubstitutePendingChangedTrack

(

)

Definition at line 1164 of file Track.cpp.

{
   // Linear search.  Tracks in a project are usually very few.
   auto pList = mList.lock();
   if (pList && pList->mPendingUpdates) {
      const auto id = GetId();
      const auto end = pList->mPendingUpdates->ListOfTracks::end();
      auto it = std::find_if(
         pList->mPendingUpdates->ListOfTracks::begin(), end,
         [=](const ListOfTracks::value_type &ptr){ return ptr->GetId() == id; } );
      if (it != end)
         return *it;
   }
   return SharedPointer();
}

References PackedArray::end(), GetId(), mList, and SharedPointer().

Referenced by anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), TrackPanel::DrawTracks(), SubstitutePendingChangedTrack(), and ProjectFileIO::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

SubstitutePendingChangedTrack() [2/2]

std::shared_ptr< const Track > Track::SubstitutePendingChangedTrack

(

)

const

Definition at line 1180 of file Track.cpp.

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

References SubstitutePendingChangedTrack().

Here is the call graph for this function:

SupportsBasicEditing()

bool Track::SupportsBasicEditing ( ) const

virtual

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

Reimplemented in TimeTrack.

Definition at line 1213 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.

Precondition

IsLeader()

Reimplemented in WaveTrack, and LabelTrack.

Definition at line 269 of file Track.cpp.

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

References Clear(), Cut(), ChannelGroup::GetEndTime(), IsLeader(), ChannelGroup::NChannels(), 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 418 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(), NyquistEffect::ProcessOne(), and StretchHandle::Stretch().

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 429 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 1219 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.

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 622 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 605 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 133 of file Track.h.

Member Data Documentation

mId

TrackId Track::mId

private

Identifies the track only in-session, not persistently.

Definition at line 136 of file Track.h.

Referenced by Init().

mIndex

int Track::mIndex

protected

0-based position of this track in its TrackList

Definition at line 143 of file Track.h.

Referenced by GetIndex(), SetIndex(), and Track().

mList

std::weak_ptr<TrackList> Track::mList

protected

Back pointer to owning TrackList

Definition at line 139 of file Track.h.

Referenced by AdjustPositions(), GetNode(), TrackList::MakeMultiChannelTrack(), Notify(), SetLinkType(), SetOwner(), SetSelected(), SubstituteOriginalTrack(), SubstitutePendingChangedTrack(), and TrackList::UnlinkChannels().

mNode

TrackNodePointer Track::mNode {}

protected

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

mNode's pointer to std::list might not be this TrackList, if it's a pending update track

Definition at line 142 of file Track.h.

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

---

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

• Track.h
• Track.cpp