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	ChannelGroupData

struct	Dispatcher
	Helper for recursive case of metafunction implementing Track::TypeSwitch. More...

struct	Executor
	Variadic template implements metafunction with specializations, to dispatch Track::TypeSwitch. More...

struct	Executor< Tag, R, ArgumentType >
	Base case of metafunction implementing Track::TypeSwitch. More...

struct	Executor< Tag, R, ArgumentType, Function, Functions... >
	Implements Track::TypeSwitch, its operator() invokes the first function that can accept ArgumentType*. 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
enum class	LinkType : int { None = 0 , Group = 2 , Aligned }
	For two tracks describes the type of the linkage. More...

using	ChannelGroupAttachments = ClientData::Site< ChannelGroupData, ClientData::Cloneable<>, ClientData::DeepCopying >
	Hosting of objects attached by higher level code. More...

using	AttachedObjects = ::AttachedTrackObjects
	Alias for my base type. More...

using	IntervalData = TrackIntervalData

using	Interval = TrackInterval

using	Intervals = std::vector< Interval >

using	ConstInterval = ConstTrackInterval

using	ConstIntervals = std::vector< ConstInterval >

using	Holder = std::shared_ptr< Track >

template<typename R = void>
using	Continuation = std::function< R() >
	Type of arguments passed as optional second parameter to TypeSwitch() cases. More...

using	Fallthrough = Continuation<>
	Type of arguments passed as optional second parameter to TypeSwitch<void>() cases. More...

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 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 &) const =0
	Find or create the destination track for a paste, maybe in a different project. More...

virtual ConstIntervals	GetIntervals () const
	Report times on the track where important intervals begin and end, for UI to snap to. More...

virtual Intervals	GetIntervals ()

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

bool	LinkConsistencyCheck (bool completeList)
	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

bool	IsAlignedWithLeader () const
	Returns true if the leader track has link type LinkType::Aligned. More...

ChannelGroupData &	GetGroupData ()

const ChannelGroupData &	GetGroupData () const

	Track ()

	Track (const Track &orig, ProtectedCreationArg &&)

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

virtual	~Track ()

void	Init (const Track &orig)

virtual Holder	Duplicate () const

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	EnsureVisible (bool modifyState=false)

virtual double	GetOffset () const =0

void	Offset (double t)

virtual void	SetOffset (double o)

virtual Holder	Cut (double WXUNUSED(t0), double WXUNUSED(t1))=0

virtual Holder	Copy (double WXUNUSED(t0), double WXUNUSED(t1), bool forClipboard=true) const =0

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

virtual void	Paste (double WXUNUSED(t), const Track *WXUNUSED(src))=0

virtual void	SyncLockAdjust (double oldT1, double newT1)

virtual void	Silence (double WXUNUSED(t0), double WXUNUSED(t1))=0

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

bool	SameKindAs (const Track &track) const

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions)
	Use this function rather than testing track type explicitly and making down-casts. More...

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions) const
	Use this function rather than testing track type explicitly and making down-casts. More...

virtual void	WriteXML (XMLWriter &xmlFile) const =0

virtual bool	GetErrorOpening ()

virtual double	GetStartTime () const =0

virtual double	GetEndTime () const =0

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

bool	Any () const

bool	IsSelected () const

bool	IsLeader () const

bool	IsSelectedLeader () 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...

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	FinishCopy (const Track n, Track dest)

template<typename TrackType >
static void	checkTrackType ()

template<typename R , typename TrackType , typename... Functions>
static R	CallExecutor (R , std::tuple<> , TrackType &, const Functions &...)

template<typename R , typename TrackType , typename... Functions, typename Executor , typename... Executors>
static R	CallExecutor (R , std::tuple< Executor, Executors... > , TrackType &track, const Functions &...functions)

template<typename ... Executors>
static constexpr unsigned	UsedCases (std::tuple< Executors... > *)

template<typename Tag , bool IsConst, typename R , typename ... TrackTypes, typename ... Functions>
static R	DoTypeSwitch (std::conditional_t< IsConst, const Track, Track > &track, TypeList::List< TrackTypes... >, const Functions &...functions)
	Deduce two packs from arguments. More...

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

Public Attributes
std::pair< int, int >	vrulerSize

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

double	mOffset

Private Member Functions
void	SetId (TrackId id)

int	GetIndex () const

void	SetIndex (int index)

ChannelGroupData &	MakeGroupData ()

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 Holder	Clone () const =0

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

std::unique_ptr< ChannelGroupData >	mpGroupData

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

Member Typedef Documentation

◆ AttachedObjects

using Track::AttachedObjects = ::AttachedTrackObjects

Alias for my base type.

Definition at line 212 of file Track.h.

◆ ChannelGroupAttachments

using Track::ChannelGroupAttachments = ClientData::Site< ChannelGroupData, ClientData::Cloneable<>, ClientData::DeepCopying >

Hosting of objects attached by higher level code.

Definition at line 181 of file Track.h.

◆ ConstInterval

using Track::ConstInterval = ConstTrackInterval

Definition at line 263 of file Track.h.

◆ ConstIntervals

using Track::ConstIntervals = std::vector< ConstInterval >

Definition at line 264 of file Track.h.

◆ Continuation

template<typename R = void>

using Track::Continuation = std::function< R() >

Type of arguments passed as optional second parameter to TypeSwitch() cases.

Definition at line 457 of file Track.h.

◆ Fallthrough

using Track::Fallthrough = Continuation<>

Type of arguments passed as optional second parameter to TypeSwitch<void>() cases.

Definition at line 459 of file Track.h.

◆ Holder

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

Definition at line 295 of file Track.h.

◆ Interval

using Track::Interval = TrackInterval

Definition at line 261 of file Track.h.

◆ IntervalData

using Track::IntervalData = TrackIntervalData

Definition at line 260 of file Track.h.

◆ Intervals

using Track::Intervals = std::vector< Interval >

Definition at line 262 of file Track.h.

Member Enumeration Documentation

◆ LinkType

enum class Track::LinkType : int

strong

For two tracks describes the type of the linkage.

Enumerator
None
Group
Aligned

Definition at line 172 of file Track.h.

                       : int {
       None = 0, //< No linkage
       Group = 2, //< Tracks are grouped together
       Aligned, //< Tracks are grouped and changes should be synchronized
   };

Constructor & Destructor Documentation

◆ Track() [1/2]

Track::Track ( )

Definition at line 39 of file Track.cpp.

:  vrulerSize(36,0)
{
   mIndex = 0;
 
   mOffset = 0.0;
}

References mIndex, and mOffset.

◆ Track() [2/2]

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

Definition at line 47 of file Track.cpp.

: vrulerSize( orig.vrulerSize )
{
   mIndex = 0;
   mOffset = orig.mOffset;
}

References mIndex, and mOffset.

◆ ~Track()

Track::~Track ( )

virtual

Definition at line 114 of file Track.cpp.

115{

116}

Member Function Documentation

◆ AdjustPositions()

void Track::AdjustPositions ( )

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

291 { return true; }

Referenced by EffectLoudness::AllocBuffers(), TrackList::Channels_(), ExportPlugin::CreateMixer(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), TrackList::EmptyRange(), Exporter::ExamineTracks(), ExportMixerDialog::ExportMixerDialog(), AUPImportFileHandle::HandleImport(), anonymous_namespace{ProjectFileManager.cpp}::ImportProject(), MakeTransportTracks(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), anonymous_namespace{MixerBoard.cpp}::PlayableTracksExistFlag(), EffectLoudness::Process(), EffectNormalize::Process(), and ProjectWindow::ZoomAfterImport().

Here is the caller graph for this function:

◆ CallExecutor() [1/2]

template<typename R , typename TrackType , typename... Functions, typename Executor , typename... Executors>

static R Track::CallExecutor	(	R *	,
		std::tuple< Executor, Executors... > *	,
		TrackType &	track,
		const Functions &...	functions
	)

inlinestatic

Definition at line 675 of file Track.h.

   {
      checkTrackType<TrackType>();
      const auto &info = Executor::NominalType::ClassTypeInfo();
      // Dynamic type test of track
      // Assumes Executor classes are sequenced with more specific accepted
      // types earlier
      if ( info.IsBaseOf(track.GetTypeInfo()) )
         // Dispatch to an Executor that knows which of functions applies
         return Executor{}(&track, functions...);
      else
         // Recur, with fewer candidate Executors and all of functions
         return CallExecutor( (R*)nullptr,
            (std::tuple<Executors...>*)nullptr, track, functions...);
   }

◆ CallExecutor() [2/2]

template<typename R , typename TrackType , typename... Functions>

static R Track::CallExecutor	(	R *	,
		std::tuple<> *	,
		TrackType &	,
		const Functions &	...
	)

inlinestatic

Definition at line 660 of file Track.h.

   {
      // This overload is needed so that the other overload of CallExecutor
      // compiles, but it should never be reached at run-time, because an
      // Executor generated for (const) Track should have been the catch-all.
      wxASSERT(false);
      checkTrackType<TrackType>();
      if constexpr (std::is_void_v<R>)
         return;
      else
         return R{};
   }

◆ checkTrackType()

template<typename TrackType >

static void Track::checkTrackType ( )

inlinestatic

Definition at line 653 of file Track.h.

   {
      static_assert(
         std::is_same_v<Track, TrackType> ||
         std::is_same_v<const Track, TrackType>, "Error" );
   }

◆ ClassTypeInfo()

auto Track::ClassTypeInfo ( )

static

Definition at line 1126 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	WXUNUSEDt0,
		double	WXUNUSEDt1
	)

pure virtual

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

Here is the caller graph for this function:

◆ Clone()

virtual Holder Track::Clone ( ) const

privatepure virtual

Implemented in TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

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

Here is the caller graph for this function:

◆ Copy()

virtual Holder Track::Copy	(	double	WXUNUSEDt0,
		double	WXUNUSEDt1,
		bool	forClipboard = `true`
	)		const

pure virtual

◆ Cut()

virtual Holder Track::Cut	(	double	WXUNUSEDt0,
		double	WXUNUSEDt1
	)

pure virtual

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 187 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->mpGroupData.reset();
      assert(!GetLinkedTrack());
   
      // Change the link type
      MakeGroupData().mLinkType = linkType;
 
      // If this acquired a partner, it loses any old group data
      if (auto partner = GetLinkedTrack())
         partner->mpGroupData.reset();
   }
   else if (linkType == LinkType::None) {
      // Becoming unlinked
      assert(mpGroupData);
      if (HasLinkedTrack()) {
         if (auto partner = GetLinkedTrack()) {
            // Make independent copy of group data in the partner, which should
            // have had none
            assert(!partner->mpGroupData);
            partner->mpGroupData =
               std::make_unique<ChannelGroupData>(*mpGroupData);
            partner->mpGroupData->mLinkType = LinkType::None;
         }
      }
      mpGroupData->mLinkType = LinkType::None;
   }
   else {
      // Remaining linked, changing the type
      assert(mpGroupData);
      MakeGroupData().mLinkType = linkType;
   }
 
   // Assertion checks only in a debug build, does not have side effects!
   assert(LinkConsistencyCheck(completeList));
}

References GetLinkedTrack(), GetLinkType(), HasLinkedTrack(), LinkConsistencyCheck(), MakeGroupData(), Track::ChannelGroupData::mLinkType, mpGroupData, and None.

Referenced by SetLinkType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoTypeSwitch()

template<typename Tag , bool IsConst, typename R , typename ... TrackTypes, typename ... Functions>

static R Track::DoTypeSwitch	(	std::conditional_t< IsConst, const Track, Track > &	track,
		TypeList::List< TrackTypes... >	,
		const Functions &...	functions
	)

inlinestatic

Deduce two packs from arguments.

Definition at line 707 of file Track.h.

   {
      // Generate Executor classes, for each of TrackTypes,
      // each zero-sized and with an operator () that calls the correct
      // one of functions, assuming the track is of the corresponding type
      using Executors = std::tuple< Executor<
         Tag, R,
         std::conditional_t<IsConst, const TrackTypes, TrackTypes>,
         Functions...
      >... >;
      // Don't even construct the tuple of zero-sized types, just point
      constexpr Executors *executors = nullptr;
 
      // Compile time reachability check of the given functions
      enum { All = sizeof...( functions ) };
      static_assert( (1u << All) - 1u == UsedCases(executors),
         "Uncallable case in Track::TypeSwitch");
 
      // Do dynamic dispatch to one of the Executors
      return CallExecutor((R *)nullptr, executors, track, functions...);
   }

◆ Duplicate()

Track::Holder Track::Duplicate ( ) const

virtual

Definition at line 101 of file Track.cpp.

{
   // invoke "virtual constructor" to copy track object proper:
   auto result = Clone();
 
   AttachedTrackObjects::ForEach([&](auto &attachment){
      // Copy view state that might be important to undo/redo
      attachment.CopyTo( *result );
   });
 
   return result;
}

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

Here is the call graph for this function:

◆ EnsureVisible()

void Track::EnsureVisible ( bool modifyState = false )

Definition at line 94 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList)
      pList->EnsureVisibleEvent( SharedPointer(), modifyState );
}

References mList, and SharedPointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FinishCopy()

void Track::FinishCopy	(	const Track *	n,
		Track *	dest
	)

static

Definition at line 304 of file Track.cpp.

{
   if (dest) {
      dest->mpGroupData = n->mpGroupData ?
         std::make_unique<ChannelGroupData>(*n->mpGroupData) : nullptr;
   }
}

References mpGroupData.

Referenced by anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), anonymous_namespace{EditMenus.cpp}::FinishCopy(), and anonymous_namespace{ProjectFileManager.cpp}::ImportProject().

Here is the caller graph for this function:

◆ GetEndTime()

virtual double Track::GetEndTime ( ) const

pure virtual

Implemented in TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

Referenced by WaveTrack::ClearAndPaste(), anonymous_namespace{TrackMenus.cpp}::DoAlign(), ExportMultipleDialog::ExportMultipleByTrack(), TrackList::GetEndTime(), StretchHandle::GetT1(), SelectActions::Handler::OnCursorTrackEnd(), ProjectAudioManager::OnRecord(), SelectActions::Handler::OnSelectCursorEnd(), SelectActions::Handler::OnSelectTrackStartToEnd(), NyquistEffect::ProcessOne(), SelectionState::SelectTrackLength(), and SyncLockAdjust().

Here is the caller graph for this function:

◆ GetErrorOpening()

virtual bool Track::GetErrorOpening ( )

inlinevirtual

Reimplemented in WaveTrack.

Definition at line 787 of file Track.h.

787{ return false; }

◆ GetGroupData() [1/2]

Track::ChannelGroupData & Track::GetGroupData ( )

Definition at line 171 of file Track.cpp.

{
   auto pTrack = this;
   if (auto pList = GetOwner())
      if (auto pLeader = *pList->FindLeader(pTrack))
         pTrack = pLeader;
   // May make on demand
   return pTrack->MakeGroupData();
}

References GetOwner().

Referenced by SpectrogramSettings::Get(), WaveformSettings::Get(), WaveformScale::Get(), anonymous_namespace{PlayableTrack.cpp}::MuteAndSolo::Get(), RealtimeEffectList::Get(), anonymous_namespace{WaveTrackView.cpp}::PlacementArray::Get(), anonymous_namespace{WaveTrack.cpp}::GainAndPan::Get(), SpectrogramBounds::Get(), GetGroupData(), GetName(), GetSelected(), 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 Track::ChannelGroupData & Track::GetGroupData ( ) const

Definition at line 181 of file Track.cpp.

{
   // May make group data on demand, but consider that logically const
   return const_cast<Track *>(this)->GetGroupData();
}

References GetGroupData().

Here is the call graph for this function:

◆ GetId()

TrackId Track::GetId ( ) const

inline

Definition at line 214 of file Track.h.

214{ return mId; }

Track::mId

TrackId mId

Identifies the track only in-session, not persistently.

Definition: Track.h:198

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

Here is the caller graph for this function:

◆ GetIndex()

int Track::GetIndex ( ) const

private

Definition at line 134 of file Track.cpp.

{
   return mIndex;
}

References mIndex.

Referenced by TrackList::RecalcPositions().

Here is the caller graph for this function:

◆ GetIntervals() [1/2]

auto Track::GetIntervals ( )

virtual

This overload exposes the extra data of the intervals as non-const This overload exposes the extra data of the intervals as non-const

Reimplemented in WaveTrack, LabelTrack, and NoteTrack.

Definition at line 1143 of file Track.cpp.

{
   return {};
}

◆ GetIntervals() [2/2]

auto Track::GetIntervals ( ) const

virtual

Report times on the track where important intervals begin and end, for UI to snap to.

Some intervals may be empty, and no ordering of the intervals is assumed.

Reimplemented in WaveTrack, LabelTrack, and NoteTrack.

Definition at line 1138 of file Track.cpp.

{
   return {};
}

Referenced by TrackShifter::InitIntervals().

Here is the caller graph for this function:

◆ GetLinkedTrack()

Track * Track::GetLinkedTrack ( ) const

private

Definition at line 234 of file Track.cpp.

{
   auto pList = mList.lock();
   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 HasLinkedTrack(), mList, 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 1212 of file Track.cpp.

{
    return mpGroupData ? mpGroupData->mLinkType : LinkType::None;
}

References mpGroupData, and None.

Referenced by WaveClipTrimHandle::AdjustBetweenBorders::AdjustBetweenBorders(), DoSetLinkType(), WaveClipTrimHandle::AdjustBorder::FindSnapPoints(), ClipMoveState::Init(), 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 GetGroupData().mName;
}

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

Referenced by ProjectFileManager::AddImportedTracks(), LabelDialog::AddLabels(), CompareAudioCommand::Apply(), TrackInfo::CloseTitleDrawFunction(), TrackUtilities::DoMoveTrack(), TrackUtilities::DoRemoveTrack(), anonymous_namespace{TrackMenus.cpp}::DoSortTracks(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), MixerBoard::GetMusicalInstrumentBitmap(), anonymous_namespace{TrackPanel.cpp}::GetTrackNameExtent(), TimeTrack::Init(), WaveTrack::Join(), WaveTrack::LinkConsistencyFix(), LinkConsistencyFix(), WaveTrack::MakeNewClipName(), WaveTrackMenuTable::OnMergeStereo(), 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 119 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(), TrackList::MoveUp(), and TrackList::Remove().

Here is the caller graph for this function:

◆ GetOffset()

virtual double Track::GetOffset ( ) const

pure virtual

Implemented in TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

Referenced by anonymous_namespace{TrackMenus.cpp}::DoAlign(), TrackList::GetMinOffset(), SelectActions::Handler::OnCursorTrackStart(), and SelectionState::SelectTrackLength().

Here is the caller graph for this function:

◆ GetOwner()

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

inline

Definition at line 333 of file Track.h.

333{ return mList.lock(); }

Referenced by RealtimeEffectManager::AddTrack(), TrackShifter::CommonMayMigrateTo(), WaveClipTrimHandle::AdjustBorder::FindSnapPoints(), anonymous_namespace{SyncLock.cpp}::FindSyncLockGroup(), GetGroupData(), anonymous_namespace{TimeTrack.cpp}::GetRate(), SyncLock::Group(), IsAlignedWithLeader(), SyncLock::IsSyncLockSelected(), WaveTrack::LinkConsistencyFix(), WaveTrack::PasteWaveTrack(), and TrackList::SwapChannels().

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 GetGroupData().mSelected;
}

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

Referenced by ClipParameters::ClipParameters(), TrackInfo::CloseTitleDrawFunction(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), TrackArt::DrawBackgroundWithSelection(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), TrackInfo::DrawCloseButton(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), anonymous_namespace{PlayableTrackControls.cpp}::EffectsDrawFunction(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), SelectionState::HandleListSelection(), IsSelected(), SyncLock::IsSyncLockSelected(), TrackInfo::MinimizeSyncLockDrawFunction(), anonymous_namespace{PlayableTrackControls.cpp}::MuteOrSoloDrawFunction(), NavigationActions::Handler::OnToggle(), EffectChangeSpeed::Process(), Generator::Process(), EffectRepeat::Process(), EffectSBSMS::Process(), LabelTrack::SetSelected(), and WriteCommonXMLAttributes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStartTime()

virtual double Track::GetStartTime ( ) const

pure virtual

Implemented in TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

Referenced by anonymous_namespace{TrackMenus.cpp}::DoAlign(), ExportMultipleDialog::ExportMultipleByTrack(), TrackList::GetStartTime(), StretchHandle::GetT0(), SelectActions::Handler::OnSelectStartCursor(), SelectActions::Handler::OnSelectTrackStartToEnd(), and NyquistEffect::ProcessOne().

Here is the caller graph for this function:

◆ GetTypeInfo()

virtual const TypeInfo & Track::GetTypeInfo ( ) const

pure virtual

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

Referenced by SameKindAs().

Here is the caller graph for this function:

◆ GetTypeNames()

virtual const TypeNames & Track::GetTypeNames ( ) const

inlinevirtual

Definition at line 289 of file Track.h.

290 { return GetTypeInfo().names; }

Track::GetTypeInfo

virtual const TypeInfo & GetTypeInfo() const =0

Track::TypeInfo::names

TypeNames names

Definition: Track.h:274

◆ HandleCommonXMLAttribute()

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

Definition at line 1165 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 TimeTrack::HandleXMLTag(), WaveTrack::HandleXMLTag(), LabelTrack::HandleXMLTag(), and NoteTrack::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 260 of file Track.cpp.

{
    return mpGroupData && mpGroupData->mLinkType != LinkType::None;
}

References mpGroupData, and None.

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

Here is the caller graph for this function:

◆ HasOwner()

bool Track::HasOwner ( ) const

inline

Definition at line 331 of file Track.h.

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

◆ Init()

void Track::Init ( const Track & orig )

Definition at line 55 of file Track.cpp.

{
   mId = orig.mId;
 
   // Deep copy of any group data
   mpGroupData = orig.mpGroupData ?
      std::make_unique<ChannelGroupData>(*orig.mpGroupData) : nullptr;
}

References mId, and mpGroupData.

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

Here is the caller graph for this function:

◆ InsertSilence()

virtual void Track::InsertSilence	(	double	WXUNUSEDt,
		double	WXUNUSEDlen
	)

pure virtual

◆ IsAlignedWithLeader()

bool Track::IsAlignedWithLeader ( ) const

Returns true if the leader track has link type LinkType::Aligned.

Definition at line 1217 of file Track.cpp.

{
   if (auto owner = GetOwner())
   {
      auto leader = *owner->FindLeader(this);
      return leader != this && leader->GetLinkType() == Track::LinkType::Aligned;
   }
   return false;
}

References Aligned, and GetOwner().

Referenced by WaveClipTrimHandle::AdjustBetweenBorders::AdjustBetweenBorders(), and ClipMoveState::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLeader()

bool Track::IsLeader ( ) const

Definition at line 296 of file Track.cpp.

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

References GetLinkedTrack(), and HasLinkedTrack().

Referenced by anonymous_namespace{FileMenus.cpp}::DoExport(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), TrackList::FindLeader(), SampleTrack::GetChannelType(), IsSelectedLeader(), TrackList::Leaders(), EffectLoudness::Process(), EffectNormalize::Process(), and StereoRequiredFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSelected()

bool Track::IsSelected ( ) const

Definition at line 293 of file Track.cpp.

294 { return GetSelected(); }

Track::GetSelected

bool GetSelected() const

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

Definition: Track.cpp:78

References GetSelected().

Referenced by ProjectAudioManager::ChooseExistingRecordingTracks(), ExportPlugin::CreateMixer(), anonymous_namespace{TrackMenus.cpp}::DoPanTracks(), Exporter::ExamineTracks(), ExportMixerDialog::ExportMixerDialog(), IsSelectedLeader(), SyncLock::IsSelectedOrSyncLockSelected(), SyncLock::IsSyncLockSelected(), MakeTransportTracks(), ProjectAudioManager::OnRecord(), SelectActions::Handler::OnSelectSyncLockSel(), EffectPaulstretch::Process(), EffectTruncSilence::ProcessIndependently(), and TrackList::Selected().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSelectedLeader()

bool Track::IsSelectedLeader ( ) const

Definition at line 301 of file Track.cpp.

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

Track::IsSelected

bool IsSelected() const

Definition: Track.cpp:293

Track::IsLeader

bool IsLeader() const

Definition: Track.cpp:296

References IsLeader(), and IsSelected().

Referenced by TrackList::SelectedLeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LinkConsistencyCheck()

bool Track::LinkConsistencyCheck ( bool completeList )

inline

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

Definition at line 328 of file Track.h.

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

Track::LinkConsistencyFix

virtual bool LinkConsistencyFix(bool doFix=true, bool completeList=true)

Check consistency of channel groups, and maybe fix it.

Definition: Track.cpp:313

Referenced by DoSetLinkType().

Here is the caller graph for this function:

◆ LinkConsistencyFix()

bool Track::LinkConsistencyFix	(	bool	doFix = `true`,
		bool	completeList = `true`
	)

virtual

Check consistency of channel groups, and maybe fix it.

Parameters

doFix	whether to make any changes to correct inconsistencies
completeList	whether to assume that the TrackList containing this is completely loaded; if false, skip some of the checks

Returns: true if no inconsistencies were found

Reimplemented in WaveTrack.

Definition at line 313 of file Track.cpp.

{
   // 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 (completeList && 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(), None, and SetLinkType().

Referenced by WaveTrack::LinkConsistencyFix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeGroupData()

Track::ChannelGroupData & Track::MakeGroupData ( )

private

Definition at line 163 of file Track.cpp.

{
   if (!mpGroupData)
      // Make on demand
      mpGroupData = std::make_unique<ChannelGroupData>();
   return *mpGroupData;
}

References mpGroupData.

Referenced by DoSetLinkType().

Here is the caller graph for this function:

◆ Notify()

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

Definition at line 265 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:

◆ Offset()

void Track::Offset ( double t )

inline

Definition at line 403 of file Track.h.

403{ SetOffset(GetOffset() + t); }

Track::SetOffset

virtual void SetOffset(double o)

Definition: Track.h:404

Track::GetOffset

virtual double GetOffset() const =0

Referenced by TrackShifter::DoHorizontalOffset(), EffectPreview(), and StretchHandle::Stretch().

Here is the caller graph for this function:

◆ operator=()

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

delete

◆ Paste()

virtual void Track::Paste	(	double	WXUNUSEDt,
		const Track *	WXUNUSEDsrc
	)

pure virtual

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

◆ PasteInto()

virtual Holder Track::PasteInto ( AudacityProject & ) const

pure virtual

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

Returns: A smart pointer to the track; its use_count() can tell whether it is new

Implemented in TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

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

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

References GetTypeInfo().

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

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

216{ mId = id; }

id

int id

Definition: WaveTrackControls.cpp:582

References id.

Referenced by TrackList::DoAddToHead(), and TrackList::Replace().

Here is the caller graph for this function:

◆ SetIndex()

void Track::SetIndex ( int index )

private

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

{
   auto pList = mList.lock();
   if (pList && !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 69 of file Track.cpp.

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

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

Referenced by SetTrackStatusCommand::ApplyInner(), TimeTrack::CleanState(), HandleCommonXMLAttribute(), 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:

◆ SetOffset()

virtual void Track::SetOffset ( double o )

inlinevirtual

Reimplemented in LabelTrack, WaveTrack, and TimeTrack.

Definition at line 404 of file Track.h.

404{ mOffset = o; }

Referenced by NoteTrack::Clear(), NoteTrack::HandleXMLTag(), ImportMIDI(), NoteTrack::Paste(), and NoteTrack::Trim().

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 125 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(), TrackList::Remove(), TrackList::Replace(), and TrackList::SwapNodes().

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 = GetGroupData().mSelected;
   if (selected != s) {
      selected = s;
      auto pList = mList.lock();
      if (pList)
         pList->SelectionEvent(*this);
   }
}

References GetGroupData(), mList, and Track::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 224 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(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), SpectrumView::DoDraw(), TimeShiftHandle::Drag(), EnsureVisible(), TrackPanelAx::GetFocus(), SelectHandle::HandleCenterFrequencyClick(), ClipMoveState::Init(), SelectHandle::MoveSnappingFreqSelection(), Notify(), SelectionState::SelectTrack(), TrackFocus::Set(), TrackPanelAx::SetFocus(), SharedPointer(), anonymous_namespace{MIDIPlay.h}::MIDIPlay::StartOtherStream(), 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 232 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 248 of file Track.h.

249 { 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 244 of file Track.h.

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

References SharedPointer().

Here is the call graph for this function:

◆ Silence()

virtual void Track::Silence	(	double	WXUNUSEDt0,
		double	WXUNUSEDt1
	)

pure virtual

◆ SubstituteOriginalTrack()

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

Definition at line 1106 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList) {
      const auto id = GetId();
      const auto pred = [=]( const ListOfTracks::value_type &ptr ) {
         return ptr->GetId() == id; };
      const auto end = pList->mPendingUpdates.end();
      const auto it = std::find_if( pList->mPendingUpdates.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 1085 of file Track.cpp.

{
   // Linear search.  Tracks in a project are usually very few.
   auto pList = mList.lock();
   if (pList) {
      const auto id = GetId();
      const auto end = pList->mPendingUpdates.end();
      auto it = std::find_if(
         pList->mPendingUpdates.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 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 1101 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 1133 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

Reimplemented in WaveTrack, and LabelTrack.

Definition at line 272 of file Track.cpp.

{
   if (newT1 > oldT1) {
      // Insert space within the track
 
      if (oldT1 > GetEndTime())
         return;
 
      auto tmp = Cut(oldT1, GetEndTime());
 
      Paste(newT1, tmp.get());
   }
   else if (newT1 < oldT1) {
      // Remove from the track
      Clear(newT1, oldT1);
   }
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeSwitch() [1/2]

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

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

inline

Use this function rather than testing track type explicitly and making down-casts.

A variadic function taking any number of function objects, each taking a pointer to Track or a subclass, maybe const-qualified, and maybe a second argument which is a fall-through continuation.

Each of the function objects (and supplied continuations) returns R (or a type convertible to R). Calls the first in the sequence that accepts the actual type of the track.

If no function accepts the track, do nothing and return R{} if R is not void.

If one of the functions invokes the fall-through, then the next following applicable function is called.

Template Parameters

R	Return type of this function and each function argument
Functions	callable types deduced from arguments

Parameters

functions typically lambdas, taking a pointer to a track subclass, and optionally a fall-through call-back

Definition at line 755 of file Track.h.

   {
      struct Tag : TrackTypeTag {};
      // Collect all concrete and abstract track types known at compile time
      using TrackTypes = TypeList::Reverse_t<
         typename TypeEnumerator::CollectTypes<TrackTypeTag, Tag>::type>;
      // Generate a function that dispatches dynamically on track type
      return DoTypeSwitch<Tag, false, R>(*this, TrackTypes{}, functions...);
   }

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

Use this function rather than testing track type explicitly and making down-casts.

A variadic function taking any number of function objects, each taking a pointer to Track or a subclass, maybe const-qualified, and maybe a second argument which is a fall-through continuation.

Each of the function objects (and supplied continuations) returns R (or a type convertible to R). Calls the first in the sequence that accepts the actual type of the track.

If no function accepts the track, do nothing and return R{} if R is not void.

If one of the functions invokes the fall-through, then the next following applicable function is called.

Template Parameters

R	Return type of this function and each function argument
Functions	callable types deduced from arguments

Parameters

functions typically lambdas, taking a pointer to a track subclass, and optionally a fall-through call-back

This is the overload for const tracks, only taking callable arguments that accept first arguments that are pointers to const.

Definition at line 772 of file Track.h.

   {
      struct Tag : TrackTypeTag {};
      // Collect all concrete and abstract track types known at compile time
      using TrackTypes = TypeList::Reverse_t<
         typename TypeEnumerator::CollectTypes<TrackTypeTag, Tag>::type>;
      // Generate a function that dispatches dynamically on track type
      return DoTypeSwitch<Tag, true, R>(*this, TrackTypes{}, functions...);
   }

◆ UsedCases()

template<typename ... Executors>

static constexpr unsigned Track::UsedCases ( std::tuple< Executors... > * )

inlinestaticconstexpr

Definition at line 694 of file Track.h.

   {
      return (Executors::SetUsed | ...); // My very first fold expression :-)
   }

◆ WriteCommonXMLAttributes()

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

Definition at line 1149 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(), WaveTrack::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 TimeTrack, WaveTrack, LabelTrack, and NoteTrack.

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 845 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 828 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 195 of file Track.h.

Member Data Documentation

◆ mId

TrackId Track::mId

private

Identifies the track only in-session, not persistently.

Definition at line 198 of file Track.h.

Referenced by Init().

◆ mIndex

int Track::mIndex

protected

0-based position of this track in its TrackList

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

Referenced by AdjustPositions(), EnsureVisible(), GetLinkedTrack(), 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 206 of file Track.h.

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

◆ mOffset

double Track::mOffset

protected

Definition at line 372 of file Track.h.

Referenced by LabelTrack::GetOffset(), NoteTrack::GetOffset(), WaveTrack::NewestOrNewClip(), WaveTrack::RightmostOrNewClip(), WaveTrack::SetOffset(), and Track().

◆ mpGroupData

std::unique_ptr<ChannelGroupData> Track::mpGroupData

private

Definition at line 200 of file Track.h.

Referenced by DoSetLinkType(), FinishCopy(), GetLinkType(), HasLinkedTrack(), Init(), MakeGroupData(), and TrackList::SwapChannels().

◆ vrulerSize

std::pair<int, int> Track::vrulerSize

mutable

Definition at line 313 of file Track.h.

Referenced by SpectrumVRulerControls::DoUpdateVRuler(), WaveformVRulerControls::DoUpdateVRuler(), and TrackPanel::UpdateTrackVRuler().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AttachedObjects

◆ ChannelGroupAttachments

◆ ConstInterval

◆ ConstIntervals

◆ Continuation

◆ Fallthrough

◆ Holder

◆ Interval

◆ IntervalData

◆ Intervals

Member Enumeration Documentation

◆ LinkType

Constructor & Destructor Documentation

◆ Track() [1/2]

◆ Track() [2/2]

◆ ~Track()

Member Function Documentation

◆ AdjustPositions()

◆ Any()

◆ CallExecutor() [1/2]

◆ CallExecutor() [2/2]

◆ checkTrackType()

◆ ClassTypeInfo()

◆ Clear()

◆ Clone()

◆ Copy()

◆ Cut()

◆ DoSetLinkType()

◆ DoTypeSwitch()

◆ Duplicate()

◆ EnsureVisible()

◆ FinishCopy()

◆ GetEndTime()

◆ GetErrorOpening()

◆ GetGroupData() [1/2]

◆ GetGroupData() [2/2]

◆ GetId()

◆ GetIndex()

◆ GetIntervals() [1/2]

◆ GetIntervals() [2/2]

◆ GetLinkedTrack()

◆ GetLinkType()

◆ GetName()

◆ GetNode()

◆ GetOffset()

◆ GetOwner()

◆ GetSelected()

◆ GetStartTime()

◆ GetTypeInfo()

◆ GetTypeNames()

◆ HandleCommonXMLAttribute()

◆ HasLinkedTrack()

◆ HasOwner()

◆ Init()

◆ InsertSilence()

◆ IsAlignedWithLeader()

◆ IsLeader()

◆ IsSelected()

◆ IsSelectedLeader()

◆ LinkConsistencyCheck()

◆ LinkConsistencyFix()

◆ MakeGroupData()

◆ Notify()

◆ Offset()

◆ operator=()

◆ Paste()

◆ PasteInto()

◆ SameKindAs()