TrackList Class Reference

A flat linked list of tracks supporting Add, Remove, Clear, and Contains, serialization of the list of tracks, event notifications. More...

#include <Track.h>

Inheritance diagram for TrackList:

Collaboration diagram for TrackList:

Public Types
using	iterator = TrackIter< Track >
using	const_iterator = TrackIter< const Track >
using	value_type = Track *
using	reverse_iterator = std::reverse_iterator< iterator >
using	const_reverse_iterator = std::reverse_iterator< const_iterator >
Public Types inherited from Observer::Publisher< TrackListEvent >
using	message_type = TrackListEvent
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const TrackListEvent &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	TrackList (AudacityProject *pOwner)
void	Swap (TrackList &that)
virtual	~TrackList ()
AudacityProject *	GetOwner ()
const AudacityProject *	GetOwner () const
wxString	MakeUniqueTrackName (const wxString &baseTrackName) const
	Returns string that contains baseTrackName, but is guaranteed to be unique among other tracks in that list. More...
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
reverse_iterator	rbegin ()
reverse_iterator	rend ()
const_reverse_iterator	rbegin () const
const_reverse_iterator	rend () const
const_reverse_iterator	crbegin () const
const_reverse_iterator	crend () const
TrackIter< Track >	DoFind (Track *pTrack)
TrackIter< Track >	Find (Track *pTrack)
TrackIter< const Track >	Find (const Track *pTrack) const
template<typename TrackType = Track>
auto	Any () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	Any () const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIterRange< TrackType > >
template<typename TrackType = Track>
auto	Selected () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	Selected () const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIterRange< TrackType > >
void	Insert (const Track *before, const Track::Holder &pSrc, bool assignIds=false)
	Moves *pSrc to position where before is located. If before is nullptr the track is appended. More...
void	Permute (const std::vector< Track * > &tracks)
Track *	FindById (TrackId id)
template<typename TrackKind >
TrackKind *	AddToHead (const std::shared_ptr< TrackKind > &t)
	Add a Track, giving it a fresh id if this is not temporary. More...
template<typename TrackKind >
TrackKind *	Add (const std::shared_ptr< TrackKind > &t, bool assignIds=true)
Track::Holder	ReplaceOne (Track &t, TrackList &&with)
Track::Holder	Remove (Track &track)
	Remove a track and return it. More...
void	Clear (bool sendEvent=true)
	Make the list empty. More...
bool	CanMoveUp (Track &t) const
bool	CanMoveDown (Track &t) const
bool	MoveUp (Track &t)
bool	MoveDown (Track &t)
bool	Move (Track &t, bool up)
template<typename Subclass >
std::shared_ptr< Subclass >	Lock (const std::weak_ptr< Subclass > &wTrack)
bool	empty () const
size_t	Size () const
double	GetStartTime () const
	Return the least start time of the tracks, or 0 when no tracks. More...
double	GetEndTime () const
	Return the greatest end time of the tracks, or 0 when no tracks. More...
void	Append (TrackList &&list, bool assignIds=true)
	Remove all tracks from list and put them at the end of this More...
void	AppendOne (TrackList &&list)
	Remove first track (if any) from list and put it at the end of this More...
Track::Holder	DetachFirst ()
	Remove and return the first track. More...
Public Member Functions inherited from Observer::Publisher< TrackListEvent >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static TrackList &	Get (AudacityProject &project)
static const TrackList &	Get (const AudacityProject &project)
static TrackListHolder	Create (AudacityProject *pOwner)
template<typename TrackType >
static auto	SingletonRange (TrackType *pTrack) -> TrackIterRange< TrackType >
template<typename TrackType >
static auto	Channels (TrackType *pTrack) -> TrackIterRange< TrackType >
static TrackListHolder	Temporary (AudacityProject *pProject, const Track::Holder &pTrack={})

Private Member Functions
	TrackList (const TrackList &that)=delete
TrackList &	operator= (const TrackList &)=delete
	TrackList (TrackList &&that)=delete
TrackList &	operator= (TrackList &&)=delete
void	clear ()=delete
iterator	Begin ()
	This private function still iterates channels not tracks. More...
iterator	End ()
	This private function still iterates channels not tracks. More...
const_iterator	Begin () const
	This private function still iterates channels not tracks. More...
const_iterator	End () const
	This private function still iterates channels not tracks. More...
Track *	DoAddToHead (const std::shared_ptr< Track > &t)
Track *	DoAdd (const std::shared_ptr< Track > &t, bool assignIds)
template<typename TrackType = Track, typename Pred = typename TrackIterRange< TrackType >::iterator::FunctionType>
auto	Tracks (const Pred &pred={}) -> TrackIterRange< TrackType >
template<typename TrackType = const Track, typename Pred = typename TrackIterRange< TrackType >::iterator::FunctionType>
auto	Tracks (const Pred &pred={}) const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIterRange< TrackType > >
Track *	GetPrev (Track &, bool linked=false) const
Track *	GetNext (Track &, bool linked=false) const
	Return a track in the list that comes after Track t. More...
template<typename TrackType >
TrackIter< TrackType >	MakeTrackIterator (TrackNodePointer iter) const
template<typename TrackType >
TrackIter< TrackType >	EndIterator () const
TrackIterRange< Track >	EmptyRange () const
bool	isNull (TrackNodePointer p) const
TrackNodePointer	getEnd () const
TrackNodePointer	getBegin () const
TrackNodePointer	getNext (TrackNodePointer p) const
	Move an iterator to the next node, if any; else stay at end. More...
TrackNodePointer	getPrev (TrackNodePointer p) const
	Move an iterator to the previous node, if any; else wrap to end. More...
void	RecalcPositions (TrackNodePointer node)
void	QueueEvent (TrackListEvent event)
void	SelectionEvent (Track &track)
void	PermutationEvent (TrackNodePointer node)
void	DataEvent (const std::shared_ptr< Track > &pTrack, bool allChannels, int code)
void	DeletionEvent (std::weak_ptr< Track > node, bool duringReplace)
void	AdditionEvent (TrackNodePointer node)
void	ResizingEvent (TrackNodePointer node)
void	SwapNodes (TrackNodePointer s1, TrackNodePointer s2)

Static Private Member Functions
template<typename TrackType , typename InTrackType >
static TrackIterRange< TrackType >	Channels_ (TrackIter< InTrackType > iter1)

Private Attributes
AudacityProject *	mOwner
bool	mAssignsIds { true }

Static Private Attributes
static long	sCounter = -1

Friends
class	Track

Additional Inherited Members
Static Public Attributes inherited from Observer::Publisher< TrackListEvent >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< TrackListEvent >
CallbackReturn	Publish (const TrackListEvent &message)
	Send a message to connected callbacks. More...

Detailed Description

A flat linked list of tracks supporting Add, Remove, Clear, and Contains, serialization of the list of tracks, event notifications.

Definition at line 845 of file Track.h.

Member Typedef Documentation

const_iterator

using TrackList::const_iterator = TrackIter<const Track>

Definition at line 902 of file Track.h.

const_reverse_iterator

using TrackList::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 914 of file Track.h.

iterator

using TrackList::iterator = TrackIter<Track>

Definition at line 901 of file Track.h.

reverse_iterator

using TrackList::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 913 of file Track.h.

value_type

using TrackList::value_type = Track *

Definition at line 904 of file Track.h.

Constructor & Destructor Documentation

TrackList() [1/3]

TrackList::TrackList ( const TrackList &  that )

privatedelete

TrackList() [2/3]

TrackList::TrackList ( TrackList &&  that )

privatedelete

TrackList() [3/3]

TrackList::TrackList ( AudacityProject *  pOwner )

explicit

Definition at line 324 of file Track.cpp.

   : mOwner{ pOwner }
{
}

~TrackList()

TrackList::~TrackList ( )

virtual

Definition at line 364 of file Track.cpp.

{
   Clear(false);
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Add()

template<typename TrackKind >

TrackKind * TrackList::Add ( const std::shared_ptr< TrackKind > &  t, bool  assignIds = true  )

inline

Add a Track, giving it a fresh id if this is not temporary and assignIds is true

Definition at line 1048 of file Track.h.

            { return static_cast<TrackKind*>(DoAdd(t, assignIds)); }

Referenced by Append(), AppendOne(), PendingTracks::ApplyPendingTracks(), LabelTrack::Create(), AUPImportFileHandle::HandleLabelTrack(), AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::HandleWaveTrack(), Insert(), NoteTrack::PasteInto(), TimeTrack::PasteInto(), WaveTrack::PasteInto(), LabelTrack::PasteInto(), anonymous_namespace{UndoTracks.cpp}::TrackListRestorer::TrackListRestorer(), and LabelDialog::TransferDataFromWindow().

Here is the caller graph for this function:

AdditionEvent()

void TrackList::AdditionEvent ( TrackNodePointer  node )

private

Definition at line 442 of file Track.cpp.

{
   QueueEvent({ TrackListEvent::ADDITION, *node });
}

References TrackListEvent::ADDITION, and QueueEvent().

Referenced by DoAdd(), DoAddToHead(), and ReplaceOne().

Here is the call graph for this function:

Here is the caller graph for this function:

AddToHead()

template<typename TrackKind >

TrackKind * TrackList::AddToHead ( const std::shared_ptr< TrackKind > &  t )

inline

Add a Track, giving it a fresh id if this is not temporary.

Definition at line 1042 of file Track.h.

         { return static_cast<TrackKind*>(DoAddToHead(t)); }

Any() [1/2]

template<typename TrackType = Track>

auto TrackList::Any ( ) -> TrackIterRange< TrackType >

inline

Definition at line 950 of file Track.h.

   {
      return Tracks< TrackType >( &Track::IsLeader );
   }

References Track::IsLeader().

Referenced by anonymous_namespace{Track.cpp}::Accumulate(), audacity::cloud::audiocom::sync::anonymous_namespace{MixdownUploader.cpp}::CalculateChannels(), audacity::cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::CalculateChannels(), PendingTracks::ClearPendingTracks(), LabelDefaultClickHandle::Click(), anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), LabelTrackView::DoKeyDown(), TimeShiftHandle::DoSlideVertical(), TrackPanel::DrawTracks(), EffectOutputTracks::EffectOutputTracks(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), anonymous_namespace{EditMenus.cpp}::EstimateCopiedBlocks(), anonymous_namespace{EditMenus.cpp}::EstimateCopyBytesCount(), LabelDialog::FindAllLabels(), anonymous_namespace{TimeShiftHandle.cpp}::FindCorrespondence(), anonymous_namespace{EditMenus.cpp}::FindCorrespondence(), ImportUtils::ForEachChannel(), GetAllSeqBlocks(), anonymous_namespace{EditMenus.cpp}::HasHiddenData(), MixerBoard::HasSolo(), ProjectFileManager::Import(), VampEffect::Init(), MakeTransportTracks(), anonymous_namespace{ExportMIDI.cpp}::NoteTracksExistFlag(), ExportFilePanel::OnChannelsConfigure(), ExportAudioDialog::OnExport(), TranscriptionToolBar::PlayAtSpeed(), TrackSelectHandle::Preview(), EffectFindClipping::Process(), NyquistEffect::Process(), NyquistEffect::ProcessOne(), PerTrackEffect::ProcessPass(), RealtimeEffectPanel::RealtimeEffectPanel(), TracksExistFlag(), LabelDialog::TransferDataFromWindow(), ExportFilePanel::UpdateMaxChannels(), MixerBoard::UpdateTrackClusters(), TrackPanel::UpdateVRulerSize(), WaveTracksExistFlag(), ZoomInAvailableFlag(), and ZoomOutAvailableFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

Any() [2/2]

template<typename TrackType = const Track>

auto TrackList::Any ( ) const -> std::enable_if_t< std::is_const_v<TrackType>, TrackIterRange< TrackType > >

inline

Definition at line 957 of file Track.h.

   {
      return Tracks< TrackType >( &Track::IsLeader );
   }

References Track::IsLeader().

Here is the call graph for this function:

Append()

void TrackList::Append	(	TrackList &&	list,
		bool	assignIds = true
	)

Remove all tracks from list and put them at the end of this

Parameters

assignIds

ignored if this is a temporary list; else if false, suppresses TrackId assignment

Definition at line 870 of file Track.cpp.

{
   auto iter = list.ListOfTracks::begin(),
      end = list.ListOfTracks::end();
   while (iter != end) {
      auto pTrack = *iter;
      iter = list.erase(iter);
      this->Add(pTrack, assignIds);
   }
}

References Add(), and end().

Referenced by PendingTracks::RegisterPendingNewTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

AppendOne()

void TrackList::AppendOne

(

TrackList &&

list

)

Remove first track (if any) from list and put it at the end of this

Definition at line 881 of file Track.cpp.

{
   const auto iter = list.ListOfTracks::begin(),
      end = list.ListOfTracks::end();
   if (iter != end) {
      auto pTrack = *iter;
      list.erase(iter);
      this->Add(pTrack);
   }
}

References Add(), and end().

Referenced by EffectOutputTracks::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

begin() [1/2]

iterator TrackList::begin ( )

inline

Definition at line 905 of file Track.h.

{ return Any().begin(); }

Referenced by PendingTracks::ApplyPendingTracks(), PendingTracks::DoSubstituteOriginalChannel(), PendingTracks::HasPendingTracks(), and SwapNodes().

Here is the caller graph for this function:

Begin() [1/2]

iterator TrackList::Begin ( )

inlineprivate

This private function still iterates channels not tracks.

Definition at line 939 of file Track.h.

{ return Tracks<Track>().begin(); }

Referenced by empty().

Here is the caller graph for this function:

begin() [2/2]

const_iterator TrackList::begin ( ) const

inline

Definition at line 907 of file Track.h.

{ return Any().begin(); }

Begin() [2/2]

const_iterator TrackList::Begin ( ) const

inlineprivate

This private function still iterates channels not tracks.

Definition at line 944 of file Track.h.

{ return Tracks<const Track>().begin(); }

CanMoveDown()

bool TrackList::CanMoveDown

(

Track &

t

)

const

Definition at line 677 of file Track.cpp.

{
   return GetNext(t, true) != nullptr;
}

References GetNext().

Here is the call graph for this function:

CanMoveUp()

bool TrackList::CanMoveUp

(

Track &

t

)

const

Definition at line 672 of file Track.cpp.

{
   return GetPrev(t, true) != nullptr;
}

References GetPrev().

Here is the call graph for this function:

cbegin()

const_iterator TrackList::cbegin ( ) const

inline

Definition at line 909 of file Track.h.

{ return begin(); }

References details::begin().

Here is the call graph for this function:

cend()

const_iterator TrackList::cend ( ) const

inline

Definition at line 910 of file Track.h.

{ return end(); }

References details::end().

Here is the call graph for this function:

Channels()

template<typename TrackType >

static auto TrackList::Channels ( TrackType *  pTrack ) -> TrackIterRange< TrackType >

inlinestatic

Definition at line 1016 of file Track.h.

   {
      return Channels_<TrackType>(pTrack->GetOwner()->Find(pTrack));
   }

Referenced by DataEvent(), WaveTrack::FormatConsistencyCheck(), WaveTrack::LinkConsistencyFix(), Permute(), WaveTrack::RateConsistencyCheck(), ProjectFileManager::ReadProjectFile(), and SelectionEvent().

Here is the caller graph for this function:

Channels_()

template<typename TrackType , typename InTrackType >

static TrackIterRange< TrackType > TrackList::Channels_ ( TrackIter< InTrackType >  iter1 )

inlinestaticprivate

Definition at line 995 of file Track.h.

   {
      if (*iter1) {
         return {
            iter1.Filter( &Track::Any )
               .template Filter<TrackType>(),
            (++iter1).Filter( &Track::Any )
               .template Filter<TrackType>()
         };
      }
      else
         // empty range
         return {
            iter1.template Filter<TrackType>(),
            iter1.template Filter<TrackType>()
         };
   }

References Track::Any(), and TrackIter< TrackType >::Filter().

Here is the call graph for this function:

clear()

void TrackList::clear ( )

privatedelete

Clear()

void TrackList::Clear

(

bool

sendEvent = true

)

Make the list empty.

Definition at line 605 of file Track.cpp.

{
   // Null out the back-pointers to this in tracks, in case there
   // are outstanding shared_ptrs to those tracks, making them outlive
   // the temporary ListOfTracks below.
   for (auto pTrack: Tracks<Track>()) {
      pTrack->SetOwner({}, {});
 
      if (sendEvent)
         DeletionEvent(pTrack->shared_from_this(), false);
   }
 
   ListOfTracks tempList;
   tempList.swap( *this );
}

References DeletionEvent().

Referenced by ~TrackList().

Here is the call graph for this function:

Here is the caller graph for this function:

crbegin()

const_reverse_iterator TrackList::crbegin ( ) const

inline

Definition at line 919 of file Track.h.

{ return rbegin(); }

Create()

TrackListHolder TrackList::Create ( AudacityProject *  pOwner )

static

Definition at line 330 of file Track.cpp.

{
   return std::make_shared<TrackList>(pOwner);
}

Referenced by ProjectFileManager::DoSave(), anonymous_namespace{EditMenus.cpp}::DuplicateDiscardTrimmed(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), EffectOutputTracks::EffectOutputTracks(), EffectPreview(), anonymous_namespace{EditMenus.cpp}::OnCopy(), anonymous_namespace{EditMenus.cpp}::OnCut(), anonymous_namespace{EditMenus.cpp}::OnSplitCut(), audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncStarted(), EffectTwoPassSimpleMono::Process(), EffectManager::PromptUser(), ProjectFileManager::ReadProjectFile(), ProjectFileIO::SaveProject(), and Temporary().

Here is the caller graph for this function:

crend()

const_reverse_iterator TrackList::crend ( ) const

inline

Definition at line 920 of file Track.h.

{ return rend(); }

DataEvent()

void TrackList::DataEvent ( const std::shared_ptr< Track > &  pTrack, bool  allChannels, int  code  )

private

Definition at line 418 of file Track.cpp.

{
   auto doQueueEvent = [this, code](const std::shared_ptr<Track> &theTrack){
      QueueEvent({ TrackListEvent::TRACK_DATA_CHANGE, theTrack, code });
   };
   if (allChannels)
      for (auto channel : Channels(pTrack.get()))
         doQueueEvent(channel->shared_from_this());
   else
      doQueueEvent(pTrack);
}

References Channels(), QueueEvent(), and TrackListEvent::TRACK_DATA_CHANGE.

Here is the call graph for this function:

DeletionEvent()

void TrackList::DeletionEvent ( std::weak_ptr< Track >  node, bool  duringReplace  )

private

Definition at line 436 of file Track.cpp.

{
   QueueEvent(
      { TrackListEvent::DELETION, std::move(node), duringReplace ? 1 : 0 });
}

References TrackListEvent::DELETION, and QueueEvent().

Referenced by Clear(), Remove(), and ReplaceOne().

Here is the call graph for this function:

Here is the caller graph for this function:

DetachFirst()

Track::Holder TrackList::DetachFirst

(

)

Remove and return the first track.

Definition at line 892 of file Track.cpp.

{
   auto iter = ListOfTracks::begin();
   auto result = *iter;
   erase(iter);
   result->SetOwner({}, {});
   return result;
}

References details::begin().

Here is the call graph for this function:

DoAdd()

Track * TrackList::DoAdd ( const std::shared_ptr< Track > &  t, bool  assignIds  )

private

Definition at line 540 of file Track.cpp.

{
   if (!ListOfTracks::empty()) {
      auto &pLast = *ListOfTracks::rbegin();
      if (pLast->mLinkType != Track::LinkType::None)
         t->CopyGroupProperties(*pLast);
   }
 
   push_back(t);
 
   auto n = getPrev( getEnd() );
 
   t->SetOwner(shared_from_this(), n);
   if (mAssignsIds && assignIds)
      t->SetId(TrackId{ ++sCounter });
   RecalcPositions(n);
   AdditionEvent(n);
   return back().get();
}

References AdditionEvent(), getEnd(), getPrev(), mAssignsIds, ChannelGroup::None, RecalcPositions(), and sCounter.

Here is the call graph for this function:

DoAddToHead()

Track * TrackList::DoAddToHead ( const std::shared_ptr< Track > &  t )

private

Definition at line 528 of file Track.cpp.

{
   Track *pTrack = t.get();
   push_front(ListOfTracks::value_type(t));
   auto n = getBegin();
   pTrack->SetOwner(shared_from_this(), n);
   pTrack->SetId( TrackId{ ++sCounter } );
   RecalcPositions(n);
   AdditionEvent(n);
   return front().get();
}

References AdditionEvent(), getBegin(), RecalcPositions(), sCounter, Track::SetId(), and Track::SetOwner().

Here is the call graph for this function:

DoFind()

auto TrackList::DoFind

(

Track *

pTrack

)

Turn a pointer into a TrackIter (constant time); get end iterator if this does not own the track

Definition at line 462 of file Track.cpp.

{
   if (!pTrack || pTrack->GetOwner().get() != this)
      return EndIterator<Track>();
   else
      return MakeTrackIterator<Track>(pTrack->GetNode());
}

Referenced by RecalcPositions().

Here is the caller graph for this function:

empty()

bool TrackList::empty

(

)

const

Definition at line 758 of file Track.cpp.

{
   return Begin() == End();
}

References Begin(), and End().

Referenced by anonymous_namespace{Track.cpp}::Accumulate(), ImportCommand::Apply(), ProjectFileManager::Import(), ApplyMacroDialog::OnApplyToFiles(), and anonymous_namespace{TimerRecordDialog.cpp}::OnTimerRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

EmptyRange()

auto TrackList::EmptyRange ( ) const

private

Definition at line 452 of file Track.cpp.

{
   auto it = const_cast<TrackList*>(this)->getEnd();
   return {
      { it, it, it, &Track::Any },
      { it, it, it, &Track::Any }
   };
}

References Track::Any(), and getEnd().

Here is the call graph for this function:

end() [1/2]

iterator TrackList::end ( )

inline

Definition at line 906 of file Track.h.

{ return Any().end(); }

Referenced by Append(), AppendOne(), PendingTracks::ApplyPendingTracks(), PendingTracks::DoSubstituteOriginalChannel(), and PendingTracks::HasPendingTracks().

Here is the caller graph for this function:

End() [1/2]

iterator TrackList::End ( )

inlineprivate

This private function still iterates channels not tracks.

Definition at line 941 of file Track.h.

{ return Tracks<Track>().end(); }

Referenced by empty(), and RecalcPositions().

Here is the caller graph for this function:

end() [2/2]

const_iterator TrackList::end ( ) const

inline

Definition at line 908 of file Track.h.

{ return Any().end(); }

End() [2/2]

const_iterator TrackList::End ( ) const

inlineprivate

This private function still iterates channels not tracks.

Definition at line 946 of file Track.h.

{ return Tracks<const Track>().end(); }

EndIterator()

template<typename TrackType >

TrackIter< TrackType > TrackList::EndIterator ( ) const

inlineprivate

Definition at line 1166 of file Track.h.

   {
      auto e = const_cast<TrackList*>(this)->getEnd();
      return { e, e, e };
   }

Find() [1/2]

TrackIter< const Track > TrackList::Find ( const Track *  pTrack ) const

inline

Definition at line 930 of file Track.h.

   {
      return const_cast<TrackList*>(this)->
         Find(const_cast<Track*>(pTrack)).Filter<const Track>();
   }

References ActiveProjects::Find().

Here is the call graph for this function:

Find() [2/2]

auto TrackList::Find

(

Track *

pTrack

)

Definition at line 470 of file Track.cpp.

{
   auto iter = DoFind(pTrack);
   while( *iter && ! ( *iter )->IsLeader() )
      --iter;
   return iter.Filter( &Track::IsLeader );
}

References Track::IsLeader().

Referenced by TimeShiftHandle::DoSlideVertical(), anonymous_namespace{TimeShiftHandle.cpp}::FindCorrespondence(), Insert(), and anonymous_namespace{ChannelView.cpp}::TrackPositioner::OnUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

FindById()

Track * TrackList::FindById

(

TrackId

id

)

Definition at line 517 of file Track.cpp.

{
   // Linear search.  Tracks in a project are usually very few.
   // Search only the non-pending tracks.
   auto it = std::find_if( ListOfTracks::begin(), ListOfTracks::end(),
      [=](const ListOfTracks::value_type &ptr){ return ptr->GetId() == id; } );
   if (it == ListOfTracks::end())
      return {};
   return it->get();
}

References details::begin(), and details::end().

Referenced by PendingTracks::ApplyPendingTracks(), and PendingTracks::UpdatePendingTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [1/2]

TrackList & TrackList::Get ( AudacityProject &  project )

static

Definition at line 314 of file Track.cpp.

{
   return project.AttachedObjects::Get< TrackList >( key );
}

References key, and project.

Referenced by SelectUtilities::ActivatePlayRegion(), ProjectFileManager::AddImportedTracks(), AdornedRulerPanel::AdornedRulerPanel(), AnyTracksSelectedPred(), AppendItem(), SetTrackBase::Apply(), ImportCommand::Apply(), SelectTimeCommand::Apply(), SelectTracksCommand::Apply(), SetClipCommand::Apply(), SetLabelCommand::Apply(), BrushHandleHitTest(), TrackSelectHandle::CalculateRearrangingThresholds(), TrackPanelResizeHandle::Cancel(), ProjectAudioManager::ChooseExistingRecordingTracks(), ButtonHandle::Click(), TrackPanelResizeHandle::Click(), LabelDefaultClickHandle::Click(), LabelGlyphHandle::Click(), SelectHandle::Click(), TimeShiftHandle::Click(), BackgroundHandle::Click(), Viewport::CollapseAllTracks(), anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), anonymous_namespace{LabelMenus.cpp}::DoAddLabel(), anonymous_namespace{TrackMenus.cpp}::DoAlign(), anonymous_namespace{SelectMenus.cpp}::DoBoundaryMove(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), LOFImportFileHandle::doDurationAndScrollOffset(), LabelTrackView::DoEditLabels(), EffectUI::DoEffect(), anonymous_namespace{FileMenus.cpp}::DoExport(), ExportAudioDialog::DoExportSplitByTracks(), anonymous_namespace{ImportMIDI.cpp}::DoImportMIDI(), Scrubber::DoKeyboardScrub(), LabelTrackView::DoKeyDown(), SelectUtilities::DoListSelection(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel(), TrackUtilities::DoMoveTrack(), anonymous_namespace{SpectrumView.cpp}::DoNextPeakFrequency(), anonymous_namespace{NavigationMenus.cpp}::DoNextTrack(), anonymous_namespace{TrackMenus.cpp}::DoPanTracks(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), anonymous_namespace{EditMenus.cpp}::DoPasteText(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), ProjectAudioManager::DoRecord(), TrackUtilities::DoRemoveTrack(), TrackUtilities::DoRemoveTracks(), ProjectFileManager::DoSave(), SelectUtilities::DoSelectSomething(), anonymous_namespace{SelectUtilities.cpp}::DoSelectTimeAndAudioTracks(), SelectUtilities::DoSelectTimeAndTracks(), anonymous_namespace{TrackMenus.cpp}::DoSortTracks(), TrackUtilities::DoTrackMute(), TrackUtilities::DoTrackSolo(), ButtonHandle::Drag(), TrackPanelResizeHandle::Drag(), LabelTextHandle::Drag(), NoteTrackVZoomHandle::Drag(), TimeTrackVZoomHandle::Drag(), SelectHandle::Drag(), TimeShiftHandle::Drag(), TrackSelectHandle::Drag(), anonymous_namespace{DropoutDetector.cpp}::DropoutSubscription::DropoutSubscription(), EditableTracksSelectedPred(), audacity::cloud::ShareAudioToolbar::EnableDisableButtons(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), EstimateRemovedBlocks(), TimerRecordDialog::ExecutePostRecordActions(), Viewport::ExpandAllTracks(), GetInfoCommand::ExploreTrackPanel(), ExportAudioDialog::ExportAudioDialog(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), anonymous_namespace{EditMenus.cpp}::FindSourceTracks(), TrackFocus::FindTrack(), SpectrumView::ForAll(), ProjectFileIO::GenerateDoc(), Get(), GetAllSeqBlocks(), FrequencyPlotDialog::GetAudio(), ContrastDialog::GetDB(), anonymous_namespace{PitchAndSpeedDialog.cpp}::GetHitClip(), GetPropertiesOfSelected(), CompareAudioCommand::GetSelection(), SliderHandle::GetSlider(), TrackFocus::GetTracks(), Viewport::GetZoomOfToFit(), LabelGlyphHandle::HandleGlyphDragRelease(), AUPImportFileHandle::HandleImport(), AUPImportFileHandle::HandleLabelTrack(), AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::HandleWaveTrack(), audacity::cloud::audiocom::sync::anonymous_namespace{MixdownUploader.cpp}::HasPlayableTracks(), SelectHandle::HitTest(), ProjectFileManager::Import(), AUPImportFileHandle::Import(), anonymous_namespace{ProjectFileManager.cpp}::ImportProject(), EffectEqualization::Init(), NyquistEffect::Init(), ExportFilePanel::Init(), CLExportProcessor::Initialize(), FLACExportProcessor::Initialize(), FFmpegExportProcessor::Initialize(), MP2ExportProcessor::Initialize(), MP3ExportProcessor::Initialize(), OGGExportProcessor::Initialize(), OpusExportProcessor::Initialize(), PCMExportProcessor::Initialize(), WavPackExportProcessor::Initialize(), anonymous_namespace{EditMenus.cpp}::JoinClipsAvailableFlag(), anonymous_namespace{LabelMenus.cpp}::LabelsSelectedFlag(), LabelTracksExistFlag(), LOFImportFileHandle::lofOpenFiles(), Scrubber::MaybeStartScrubbing(), MixerBoard::MixerBoard(), SpectralSelectionBar::ModifySpectralSelection(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), anonymous_namespace{TrackMenus.cpp}::MuteTracks(), anonymous_namespace{SelectMenus.cpp}::NearestZeroCrossing(), NoteTrack::New(), TimeTrack::New(), WaveTrack::New(), LabelTrack::New(), anonymous_namespace{ExportMIDI.cpp}::NoteTracksExistFlag(), anonymous_namespace{EditMenus.cpp}::NotificationScope(), ApplyMacroDialog::OnApplyToFiles(), ExportFilePanel::OnChannelsConfigure(), ProjectManager::OnCloseWindow(), anonymous_namespace{EditMenus.cpp}::OnCopy(), anonymous_namespace{LabelMenus.cpp}::OnCopyLabels(), SelectActions::Handler::OnCursorTrackEnd(), SelectActions::Handler::OnCursorTrackStart(), anonymous_namespace{EditMenus.cpp}::OnCut(), anonymous_namespace{LabelMenus.cpp}::OnCutLabels(), anonymous_namespace{EditMenus.cpp}::OnDelete(), anonymous_namespace{LabelMenus.cpp}::OnDeleteLabels(), anonymous_namespace{EditMenus.cpp}::OnDisjoin(), anonymous_namespace{LabelMenus.cpp}::OnDisjoinLabels(), anonymous_namespace{EditMenus.cpp}::OnDuplicate(), ExportAudioDialog::OnExport(), anonymous_namespace{FileMenus.cpp}::OnExportLabels(), anonymous_namespace{ExportMIDI.cpp}::OnExportMIDI(), NavigationActions::Handler::OnFirstTrack(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), anonymous_namespace{EditMenus.cpp}::OnJoin(), anonymous_namespace{LabelMenus.cpp}::OnJoinLabels(), NavigationActions::Handler::OnLastTrack(), WaveTrackMenuTable::OnMergeStereo(), anonymous_namespace{LabelMenus.cpp}::OnNewLabelTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewStereoTrack(), anonymous_namespace{TimeTrackMenuItems.cpp}::OnNewTimeTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewWaveTrack(), anonymous_namespace{FileMenus.cpp}::OnOpen(), anonymous_namespace{EditMenus.cpp}::OnPaste(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), anonymous_namespace{TransportMenus.cpp}::OnPunchAndRoll(), ProjectAudioManager::OnRecord(), anonymous_namespace{EditMenus.cpp}::OnRedo(), anonymous_namespace{TrackMenus.cpp}::OnResample(), SelectActions::Handler::OnSelectAll(), SelectActions::Handler::OnSelectCursorEnd(), SelectActions::Handler::OnSelectStartCursor(), SelectActions::Handler::OnSelectSyncLockSel(), SelectActions::Handler::OnSelectTrackStartToEnd(), anonymous_namespace{EditMenus.cpp}::OnSilence(), anonymous_namespace{LabelMenus.cpp}::OnSilenceLabels(), anonymous_namespace{EditMenus.cpp}::OnSplit(), anonymous_namespace{EditMenus.cpp}::OnSplitCut(), anonymous_namespace{LabelMenus.cpp}::OnSplitCutLabels(), anonymous_namespace{EditMenus.cpp}::OnSplitDelete(), anonymous_namespace{LabelMenus.cpp}::OnSplitDeleteLabels(), anonymous_namespace{LabelMenus.cpp}::OnSplitLabels(), anonymous_namespace{EditMenus.cpp}::OnSplitNew(), audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncStarted(), anonymous_namespace{TimerRecordDialog.cpp}::OnTimerRecord(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveBottom(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveDown(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveTop(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveUp(), anonymous_namespace{EditMenus.cpp}::OnTrim(), anonymous_namespace{EditMenus.cpp}::OnUndo(), anonymous_namespace{ChannelView.cpp}::TrackPositioner::OnUpdate(), SelectActions::Handler::OnZeroCrossing(), ProjectFileManager::OpenProjectFile(), TimeTrack::PasteInto(), anonymous_namespace{MixerBoard.cpp}::PlayableTracksExistFlag(), TranscriptionToolBar::PlayAtSpeed(), ProjectAudioManager::PlayPlayRegion(), TrackSelectHandle::Preview(), NyquistEffect::Process(), EffectTwoPassSimpleMono::Process(), SpectralDataManager::ProcessTracks(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::ProjectBlocksLock(), WaveTrack::ProjectNyquistFrequency(), ProjectFileManager::ReadProjectFile(), RealtimeEffectPanel::RealtimeEffectPanel(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), LabelDefaultClickHandle::RestoreState(), anonymous_namespace{UndoTracks.cpp}::TrackListRestorer::RestoreUndoRedoState(), ProjectManager::SafeToOpenProjectInto(), ProjectFileIO::SaveCopy(), LabelDefaultClickHandle::SaveState(), Viewport::ScrollToBottom(), Viewport::ScrollToEnd(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), NoteTrackAffordanceHandle::SelectAt(), SelectUtilities::SelectNone(), GetInfoCommand::SendClips(), GetInfoCommand::SendEnvelopes(), GetInfoCommand::SendLabels(), GetInfoCommand::SendTracks(), Viewport::ShowTrack(), Scrubber::StartKeyboardScrubbing(), StereoRequiredFlag(), anonymous_namespace{UndoTracks.cpp}::TrackListRestorer::TrackListRestorer(), TracksExistFlag(), ExportAudioDialog::UpdateLabelExportSettings(), ExportFilePanel::UpdateMaxChannels(), ProjectSettings::UpdatePrefs(), RealtimeEffectPanel::PrefsListenerHelper::UpdatePrefs(), Viewport::UpdateScrollbarsForTracks(), ExportAudioDialog::UpdateTrackExportSettings(), HighlitClipButtonHandle::UpdateTrackSelection(), AffordanceHandle::UpdateTrackSelection(), WaveTracksExistFlag(), WaveTracksSelectedFlag(), ProjectFileIO::WriteXML(), Viewport::ZoomFitHorizontally(), Viewport::ZoomFitHorizontallyAndShowTrack(), Viewport::ZoomFitVertically(), ZoomInAvailableFlag(), and ZoomOutAvailableFlag().

Get() [2/2]

const TrackList & TrackList::Get ( const AudacityProject &  project )

static

Definition at line 319 of file Track.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

getBegin()

TrackNodePointer TrackList::getBegin ( ) const

inlineprivate

Definition at line 1177 of file Track.h.

   { return const_cast<TrackList*>(this)->ListOfTracks::begin(); }

References details::begin().

Referenced by DoAddToHead(), and Permute().

Here is the call graph for this function:

Here is the caller graph for this function:

getEnd()

TrackNodePointer TrackList::getEnd ( ) const

inlineprivate

Definition at line 1175 of file Track.h.

   { return const_cast<TrackList*>(this)->ListOfTracks::end(); }

References details::end().

Referenced by DoAdd(), EmptyRange(), and Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEndTime()

double TrackList::GetEndTime

(

)

const

Return the greatest end time of the tracks, or 0 when no tracks.

Definition at line 784 of file Track.cpp.

{
   return Accumulate(*this, &Track::GetEndTime,
      std::numeric_limits<double>::lowest(), std::max);
}

References anonymous_namespace{Track.cpp}::Accumulate(), and ChannelGroup::GetEndTime().

Referenced by SelectTimeCommand::Apply(), LOFImportFileHandle::doDurationAndScrollOffset(), Scrubber::DoKeyboardScrub(), Scrubber::MaybeStartScrubbing(), ExportAudioDialog::OnExport(), Scrubber::StartKeyboardScrubbing(), and AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetNext()

Track * TrackList::GetNext ( Track &  t, bool  linked = false  ) const

private

Return a track in the list that comes after Track t.

Definition at line 622 of file Track.cpp.

{
   auto node = t.GetNode();
   if (!isNull(node)) {
      if (linked && t.HasLinkedTrack())
         node = getNext(node);
 
      if (!isNull(node))
         node = getNext(node);
 
      if (!isNull(node))
         return node->get();
   }
   return nullptr;
}

References getNext(), Track::GetNode(), Track::HasLinkedTrack(), and isNull().

Referenced by CanMoveDown(), and MoveDown().

Here is the call graph for this function:

Here is the caller graph for this function:

getNext()

TrackNodePointer TrackList::getNext ( TrackNodePointer  p ) const

inlineprivate

Move an iterator to the next node, if any; else stay at end.

Definition at line 1181 of file Track.h.

   {
      if ( isNull(p) )
         return p;
      auto q = p;
      ++q;
      return q;
   }

Referenced by GetNext(), and Remove().

Here is the caller graph for this function:

GetOwner() [1/2]

AudacityProject * TrackList::GetOwner ( )

inline

Definition at line 887 of file Track.h.

{ return mOwner; }

Referenced by PendingTracks::ApplyPendingTracks(), EffectOutputTracks::EffectOutputTracks(), EffectBase::FindProject(), and EffectStereoToMono::ProcessOne().

Here is the caller graph for this function:

GetOwner() [2/2]

const AudacityProject * TrackList::GetOwner ( ) const

inline

Definition at line 888 of file Track.h.

{ return mOwner; }

GetPrev()

Track * TrackList::GetPrev ( Track &  t, bool  linked = false  ) const

private

Definition at line 638 of file Track.cpp.

{
   TrackNodePointer prev;
   auto node = t.GetNode();
   if (!isNull(node)) {
      // linked is true and input track second in team?
      if (linked) {
         prev = getPrev(node);
         if (!isNull(prev) &&
             !t.HasLinkedTrack() && t.GetLinkedTrack())
            // Make it the first
            node = prev;
      }
 
      prev = getPrev(node);
      if (!isNull(prev)) {
         // Back up once
         node = prev;
 
         // Back up twice sometimes when linked is true
         if (linked) {
            prev = getPrev(node);
            if( !isNull(prev) &&
                !(*node)->HasLinkedTrack() &&
               (*node)->GetLinkedTrack())
               node = prev;
         }
 
         return node->get();
      }
   }
   return nullptr;
}

References Track::GetLinkedTrack(), Track::GetNode(), getPrev(), Track::HasLinkedTrack(), and isNull().

Referenced by CanMoveUp(), and MoveUp().

Here is the call graph for this function:

Here is the caller graph for this function:

getPrev()

TrackNodePointer TrackList::getPrev ( TrackNodePointer  p ) const

inlineprivate

Move an iterator to the previous node, if any; else wrap to end.

Definition at line 1191 of file Track.h.

   {
      if (p == getBegin())
         return getEnd();
      else {
         auto q = p;
         --q;
         return q;
      }
   }

Referenced by DoAdd(), GetPrev(), and RecalcPositions().

Here is the caller graph for this function:

GetStartTime()

double TrackList::GetStartTime

(

)

const

Return the least start time of the tracks, or 0 when no tracks.

Definition at line 778 of file Track.cpp.

{
   return Accumulate(*this, &Track::GetStartTime,
      std::numeric_limits<double>::max(), std::min);
}

References anonymous_namespace{Track.cpp}::Accumulate(), ChannelGroup::GetStartTime(), and min().

Referenced by AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

Insert()

void TrackList::Insert	(	const Track *	before,
		const Track::Holder &	pSrc,
		bool	assignIds = false
	)

Moves *pSrc to position where before is located. If before is nullptr the track is appended.

Parameters

assignIds

ignored if this is a temporary list; else if false, suppresses TrackId assignment

Precondition

before == nullptr || (Find(before) != EndIterator<const Track>())

Definition at line 478 of file Track.cpp.

{
   assert(before == nullptr || Find(before) != EndIterator<const Track>());
 
   if(before == nullptr)
   {
      Add(pSrc, assignIds);
      return;
   }
 
   std::vector<Track *> arr;
   arr.reserve(Size() + 1);
   for (const auto track : *this) {
      if (track == before)
         arr.push_back(pSrc.get());
      arr.push_back(track);
   }
   Add(pSrc, assignIds);
   Permute(arr);
}

References Add(), Find(), Permute(), and Size().

Referenced by PendingTracks::ApplyPendingTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

isNull()

bool TrackList::isNull ( TrackNodePointer  p ) const

inlineprivate

Definition at line 1174 of file Track.h.

{ return p == ListOfTracks::end(); }

References details::end().

Referenced by GetNext(), GetPrev(), RecalcPositions(), Remove(), and SwapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

Lock()

template<typename Subclass >

std::shared_ptr< Subclass > TrackList::Lock ( const std::weak_ptr< Subclass > &  wTrack )

inline

Definition at line 1079 of file Track.h.

   {
      auto pTrack = wTrack.lock();
      if (pTrack) {
         auto pList = pTrack->mList.lock();
         if (pTrack && this == pList.get())
            return pTrack;
      }
      return {};
   }

Referenced by ButtonHandle::Click(), ButtonHandle::Drag(), LabelTextHandle::Drag(), NoteTrackVZoomHandle::Drag(), TimeTrackVZoomHandle::Drag(), SliderHandle::GetSlider(), TrackPanel::ProcessUIHandleResult(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), LabelDefaultClickHandle::RestoreState(), and NoteTrackAffordanceHandle::SelectAt().

Here is the caller graph for this function:

MakeTrackIterator()

template<typename TrackType >

TrackIter< TrackType > TrackList::MakeTrackIterator ( TrackNodePointer  iter ) const

inlineprivate

Definition at line 1157 of file Track.h.

   {
      auto b = const_cast<TrackList*>(this)->getBegin();
      auto e = const_cast<TrackList*>(this)->getEnd();
      return { b, iter, e };
   }

MakeUniqueTrackName()

wxString TrackList::MakeUniqueTrackName

(

const wxString &

baseTrackName

)

const

Returns string that contains baseTrackName, but is guaranteed to be unique among other tracks in that list.

Parameters

baseTrackName

String to be put into the template

Returns

Formatted string: "[baseTrackName] [N]"

Definition at line 369 of file Track.cpp.

{
   int n = 1;
   while(true) {
      auto name = wxString::Format("%s %d", baseTrackName, n++);
 
      bool found {false};
      for(const auto track : Tracks<const Track>()) {
         if(track->GetName() == name) {
            found = true;
            break;
         }
      }
      if(!found)
         return name;
   }
}

References name.

Referenced by LabelTrack::Create().

Here is the caller graph for this function:

Move()

bool TrackList::Move ( Track &  t, bool  up  )

inline

Definition at line 1074 of file Track.h.

{ return up ? MoveUp(t) : MoveDown(t); }

MoveDown()

bool TrackList::MoveDown

(

Track &

t

)

Definition at line 748 of file Track.cpp.

{
   Track *n = GetNext(t, true);
   if (n) {
      SwapNodes(t.GetNode(), n->GetNode());
      return true;
   }
   return false;
}

References GetNext(), Track::GetNode(), and SwapNodes().

Here is the call graph for this function:

MoveUp()

bool TrackList::MoveUp

(

Track &

t

)

Definition at line 738 of file Track.cpp.

{
   Track *p = GetPrev(t, true);
   if (p) {
      SwapNodes(p->GetNode(), t.GetNode());
      return true;
   }
   return false;
}

References Track::GetNode(), GetPrev(), and SwapNodes().

Here is the call graph for this function:

operator=() [1/2]

TrackList & TrackList::operator= ( const TrackList &  )

privatedelete

operator=() [2/2]

TrackList & TrackList::operator= ( TrackList &&  )

privatedelete

PermutationEvent()

void TrackList::PermutationEvent ( TrackNodePointer  node )

private

Definition at line 431 of file Track.cpp.

{
   QueueEvent({ TrackListEvent::PERMUTED, *node });
}

References TrackListEvent::PERMUTED, and QueueEvent().

Referenced by Permute(), and SwapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

Permute()

void TrackList::Permute

(

const std::vector< Track * > &

tracks

)

Precondition

tracks contains pointers only to tracks of this, and each of them exactly once

Definition at line 500 of file Track.cpp.

{
   std::vector<TrackNodePointer> permutation;
   for (const auto pTrack : tracks)
      for (const auto pChannel : Channels(pTrack))
         permutation.push_back(pChannel->GetNode());
   for (const auto iter : permutation) {
      ListOfTracks::value_type track = *iter;
      erase(iter);
      Track *pTrack = track.get();
      pTrack->SetOwner(shared_from_this(), insert(ListOfTracks::end(), track));
   }
   auto n = getBegin();
   RecalcPositions(n);
   PermutationEvent(n);
}

References Channels(), details::end(), getBegin(), PermutationEvent(), RecalcPositions(), Track::SetOwner(), and tracks.

Referenced by Insert().

Here is the call graph for this function:

Here is the caller graph for this function:

QueueEvent()

void TrackList::QueueEvent ( TrackListEvent  event )

private

Definition at line 403 of file Track.cpp.

{
   BasicUI::CallAfter( [wThis = weak_from_this(), event = std::move(event)]{
      if (auto pThis = wThis.lock())
         pThis->Publish(event);
   } );
}

References BasicUI::CallAfter().

Referenced by AdditionEvent(), DataEvent(), DeletionEvent(), PermutationEvent(), ResizingEvent(), and SelectionEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

rbegin() [1/2]

reverse_iterator TrackList::rbegin ( )

inline

Definition at line 915 of file Track.h.

{ return Any().rbegin(); }

Referenced by ChannelView::GetTotalHeight().

Here is the caller graph for this function:

rbegin() [2/2]

const_reverse_iterator TrackList::rbegin ( ) const

inline

Definition at line 917 of file Track.h.

{ return Any().rbegin(); }

RecalcPositions()

void TrackList::RecalcPositions ( TrackNodePointer  node )

private

Definition at line 387 of file Track.cpp.

{
   if (isNull(node))
      return;
 
   Track *t;
 
   auto prev = getPrev(node);
   if (!isNull(prev))
      t = prev->get();
 
   const auto theEnd = End();
   for (auto n = DoFind(node->get()); n != theEnd; ++n)
      t = *n;
}

References DoFind(), End(), getPrev(), and isNull().

Referenced by DoAdd(), DoAddToHead(), Permute(), Remove(), ReplaceOne(), and SwapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

Remove()

std::shared_ptr< Track > TrackList::Remove

(

Track &

track

)

Remove a track and return it.

Definition at line 584 of file Track.cpp.

{
   auto *t = &track;
   auto iter = getEnd();
   auto node = t->GetNode();
   t->SetOwner({}, {});
 
   std::shared_ptr<Track> holder;
   if (!isNull(node)) {
      holder = *node;
 
      iter = getNext(node);
      erase(node);
      if (!isNull(iter))
         RecalcPositions(iter);
 
      DeletionEvent(t->shared_from_this(), false);
   }
   return holder;
}

References DeletionEvent(), getEnd(), getNext(), isNull(), and RecalcPositions().

Referenced by PendingTracks::ClearPendingTracks(), and EffectOutputTracks::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

rend() [1/2]

reverse_iterator TrackList::rend ( )

inline

Definition at line 916 of file Track.h.

{ return Any().rend(); }

rend() [2/2]

const_reverse_iterator TrackList::rend ( ) const

inline

Definition at line 918 of file Track.h.

{ return Any().rend(); }

ReplaceOne()

Track::Holder TrackList::ReplaceOne	(	Track &	t,
		TrackList &&	with
	)

Replace track t with the first track in the given list, return the removed track, modify given list by removing first track

Give the replacements the same ids as the replaced

Precondition

t.GetOwner().get() == this

!with.empty()

Move one track to the temporary list

Redirect the list element of this

Definition at line 560 of file Track.cpp.

{
   assert(t.GetOwner().get() == this);
   assert(!with.empty());
 
   auto save = t.shared_from_this();
 
   auto node = t.GetNode();
   t.SetOwner({}, {});
 
   const auto iter = with.ListOfTracks::begin();
   const auto pTrack = *iter;
   *node = pTrack;
   with.erase(iter);
   pTrack->SetOwner(shared_from_this(), node);
   pTrack->SetId(save->GetId());
   RecalcPositions(node);
   DeletionEvent(save, true);
   AdditionEvent(node);
   return save;
}

References AdditionEvent(), DeletionEvent(), Track::GetNode(), Track::GetOwner(), RecalcPositions(), and Track::SetOwner().

Referenced by PendingTracks::ApplyPendingTracks(), and EffectOutputTracks::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

ResizingEvent()

void TrackList::ResizingEvent ( TrackNodePointer  node )

private

Definition at line 447 of file Track.cpp.

{
   QueueEvent({ TrackListEvent::RESIZING, *node });
}

References QueueEvent(), and TrackListEvent::RESIZING.

Here is the call graph for this function:

Selected() [1/2]

template<typename TrackType = Track>

auto TrackList::Selected ( ) -> TrackIterRange<TrackType>

inline

Definition at line 967 of file Track.h.

   {
      return Tracks<TrackType>(&Track::IsSelected);
   }

References Track::IsSelected().

Referenced by EffectLoudness::AllocBuffers(), AnyTracksSelectedPred(), EditableTracksSelectedPred(), TranscriptionToolBar::EnableDisableButtons(), anonymous_namespace{EditMenus.cpp}::FindCorrespondence(), FrequencyPlotDialog::GetAudio(), ContrastDialog::GetDB(), GetPropertiesOfSelected(), TrackPanel::GetSelectedTrackCount(), CompareAudioCommand::GetSelection(), EffectAmplify::Init(), EffectEqualization::Init(), NyquistEffect::Init(), EffectScienFilter::Init(), EffectCompressor::InitPass1(), anonymous_namespace{EditMenus.cpp}::JoinClipsAvailableFlag(), anonymous_namespace{LabelMenus.cpp}::LabelsSelectedFlag(), LabelTracksExistFlag(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), ProjectAudioManager::OnRecord(), StereoRequiredFlag(), and WaveTracksSelectedFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

Selected() [2/2]

template<typename TrackType = const Track>

auto TrackList::Selected ( ) const -> std::enable_if_t<std::is_const_v<TrackType>, TrackIterRange<TrackType>>

inline

Definition at line 973 of file Track.h.

   {
      return Tracks<TrackType>(&Track::IsSelected);
   }

References Track::IsSelected().

Here is the call graph for this function:

SelectionEvent()

void TrackList::SelectionEvent ( Track &  track )

private

Definition at line 411 of file Track.cpp.

{
   for (auto channel : Channels(&track))
      QueueEvent({
         TrackListEvent::SELECTION_CHANGE, channel->shared_from_this() });
}

References Channels(), QueueEvent(), and TrackListEvent::SELECTION_CHANGE.

Here is the call graph for this function:

SingletonRange()

template<typename TrackType >

static auto TrackList::SingletonRange ( TrackType *  pTrack ) -> TrackIterRange< TrackType >

inlinestatic

Definition at line 981 of file Track.h.

   {
      return pTrack->GetOwner()->template Tracks<TrackType>()
         .StartingWith( pTrack ).EndingAfter( pTrack );
   }

References TrackIterRange< TrackType >::EndingAfter(), and TrackIterRange< TrackType >::StartingWith().

Referenced by EffectTruncSilence::ProcessIndependently(), and SelectionState::SelectTrackLength().

Here is the call graph for this function:

Here is the caller graph for this function:

Size()

size_t TrackList::Size ( ) const

inline

Definition at line 1091 of file Track.h.

{ return Any().size(); }

References Track::Any().

Referenced by Insert().

Here is the call graph for this function:

Here is the caller graph for this function:

Swap()

void TrackList::Swap

(

TrackList &

that

)

Precondition

!GetOwner() && !that.GetOwner()

Definition at line 346 of file Track.cpp.

{
   auto SwapLOTs = [](
      ListOfTracks &a, const std::weak_ptr< TrackList > &aSelf,
      ListOfTracks &b, const std::weak_ptr< TrackList > &bSelf )
   {
      a.swap(b);
      for (auto it = a.begin(), last = a.end(); it != last; ++it)
         (*it)->SetOwner(aSelf, it);
      for (auto it = b.begin(), last = b.end(); it != last; ++it)
         (*it)->SetOwner(bSelf, it);
   };
 
   const auto self = shared_from_this();
   const auto otherSelf = that.shared_from_this();
   SwapLOTs( *this, self, that, otherSelf );
}

SwapNodes()

void TrackList::SwapNodes ( TrackNodePointer  s1, TrackNodePointer  s2  )

private

Definition at line 685 of file Track.cpp.

{
   // if a null pointer is passed in, we want to know about it
   wxASSERT(!isNull(s1));
   wxASSERT(!isNull(s2));
 
   // Safety check...
   if (s1 == s2)
      return;
 
   // Be sure s1 is the earlier iterator
   {
      const auto begin = ListOfTracks::begin();
      auto d1 = std::distance(begin, s1);
      auto d2 = std::distance(begin, s2);
      if (d1 > d2)
         std::swap(s1, s2);
   }
 
   // For saving the removed tracks
   using Saved = ListOfTracks::value_type;
   Saved saved1, saved2;
 
   auto doSave = [&](Saved &saved, TrackNodePointer &s) {
      saved = *s, s = erase(s);
   };
 
   doSave(saved1, s1);
   // The two ranges are assumed to be disjoint but might abut
   const bool same = (s1 == s2);
   doSave(saved2, s2);
   if (same)
      // Careful, we invalidated s1 in the second doSave!
      s1 = s2;
 
   // Reinsert them
   auto doInsert = [&](Saved &saved, TrackNodePointer &s) {
      const auto pTrack = saved.get();
      // Insert before s, and reassign s to point at the new node before
      // old s; which is why we saved pointers in backwards order
      pTrack->SetOwner(shared_from_this(), s = insert(s, saved) );
   };
   // This does not invalidate s2 even when it equals s1:
   doInsert(saved2, s1);
   // Even if s2 was same as s1, this correctly inserts the saved1 range
   // after the saved2 range, when done after:
   doInsert(saved1, s2);
 
   // Now correct the Index in the tracks, and other things
   RecalcPositions(s1);
   PermutationEvent(s1);
}

References begin(), details::begin(), isNull(), PermutationEvent(), RecalcPositions(), and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by MoveDown(), and MoveUp().

Here is the call graph for this function:

Here is the caller graph for this function:

Temporary()

TrackListHolder TrackList::Temporary ( AudacityProject *  pProject, const Track::Holder &  pTrack = {}  )

static

Construct a temporary list owned by pProject (if that is not null) and owning pTrack TrackIds are not changed

Precondition

pTrack == nullptr || pTrack->GetOwner() == nullptr

Definition at line 858 of file Track.cpp.

{
    assert(pTrack == nullptr || pTrack->GetOwner() == nullptr);
   // Make a well formed channel group from these tracks
   auto tempList = Create(pProject);
   if (pTrack)
      tempList->Add(pTrack);
   tempList->mAssignsIds = false;
   return tempList;
}

References Create().

Referenced by PendingTracks::ApplyPendingTracks(), WaveTrackFactory::CreateMany(), ModifiedAnalysisTrack::ModifiedAnalysisTrack(), WaveTrack::MonoToStereo(), BenchmarkDialog::OnRun(), EffectStereoToMono::ProcessOne(), PerTrackEffect::ProcessPass(), and ModifiedAnalysisTrack::~ModifiedAnalysisTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

Tracks() [1/2]

template<typename TrackType = Track, typename Pred = typename TrackIterRange< TrackType >::iterator::FunctionType>

auto TrackList::Tracks ( const Pred &  pred = {} ) -> TrackIterRange< TrackType >

inlineprivate

Definition at line 1129 of file Track.h.

                                      {} )
         -> TrackIterRange< TrackType >
   {
      auto b = getBegin(), e = getEnd();
      return { { b, b, e, pred }, { b, e, e, pred } };
   }

Tracks() [2/2]

template<typename TrackType = const Track, typename Pred = typename TrackIterRange< TrackType >::iterator::FunctionType>

auto TrackList::Tracks ( const Pred &  pred = {} ) const -> std::enable_if_t< std::is_const_v<TrackType>, TrackIterRange< TrackType > >

inlineprivate

Definition at line 1142 of file Track.h.

                                      {} ) const
         -> std::enable_if_t< std::is_const_v<TrackType>,
            TrackIterRange< TrackType >
         >
   {
      auto b = const_cast<TrackList*>(this)->getBegin();
      auto e = const_cast<TrackList*>(this)->getEnd();
      return { { b, b, e, pred }, { b, e, e, pred } };
   }

Friends And Related Function Documentation

Track

friend class Track

friend

Definition at line 1022 of file Track.h.

Member Data Documentation

mAssignsIds

bool TrackList::mAssignsIds { true }

private

Whether the list assigns unique ids to added tracks; false for temporaries

Definition at line 1223 of file Track.h.

Referenced by DoAdd().

mOwner

AudacityProject* TrackList::mOwner

private

Definition at line 1219 of file Track.h.

sCounter

long TrackList::sCounter = -1

staticprivate

Definition at line 1217 of file Track.h.

Referenced by DoAdd(), and DoAddToHead().

---

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

• Track.h
• Track.cpp