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	Updater = std::function< void(Track &dest, const Track &src) >
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
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
template<typename TrackType = Track>
auto	Find (Track *pTrack) -> TrackIter< TrackType >
	Turn a pointer into a TrackIter (constant time); get end iterator if this does not own the track. More...
template<typename TrackType = const Track>
auto	Find (const Track *pTrack) const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIter< TrackType > >
	Turn a pointer into a TrackIter (constant time); get end iterator if this does not own the track. More...
TrackIter< Track >	FindLeader (Track *pTrack)
TrackIter< const Track >	FindLeader (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 > >
template<typename TrackType = Track>
auto	Leaders () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	Leaders () const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIterRange< TrackType > >
template<typename TrackType = Track>
auto	SelectedLeaders () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	SelectedLeaders () const -> std::enable_if_t< std::is_const_v< TrackType >, TrackIterRange< TrackType > >
void	Permute (const std::vector< TrackNodePointer > &permutation)
	For use in sorting: assume each iterator points into this list, no duplications. More...
Track *	FindById (TrackId id)
template<typename TrackKind >
TrackKind *	AddToHead (const std::shared_ptr< TrackKind > &t)
	Add a Track, giving it a fresh id. More...
template<typename TrackKind >
TrackKind *	Add (const std::shared_ptr< TrackKind > &t)
void	UnlinkChannels (Track &track)
	Removes linkage if track belongs to a group. More...
bool	MakeMultiChannelTrack (Track &first, int nChannels, bool aligned)
	Converts channels to a multichannel track. More...
ListOfTracks::value_type	Replace (Track *t, const ListOfTracks::value_type &with)
TrackNodePointer	Remove (Track *t)
	Remove the Track and return an iterator to what followed 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)
bool	Contains (const Track *t) const
	Mainly a test function. Uses a linear search, so could be slow. More...
template<typename Subclass >
std::shared_ptr< Subclass >	Lock (const std::weak_ptr< Subclass > &wTrack)
bool	empty () const
size_t	size () const
double	GetStartTime () const
double	GetEndTime () const
double	GetMinOffset () const
std::shared_ptr< Track >	RegisterPendingChangedTrack (Updater updater, Track *src)
void	RegisterPendingNewTrack (const std::shared_ptr< Track > &pTrack)
void	UpdatePendingTracks ()
void	ClearPendingTracks (ListOfTracks *pAdded=nullptr)
bool	ApplyPendingTracks ()
bool	HasPendingTracks () const
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 std::shared_ptr< TrackList >	Create (AudacityProject *pOwner)
template<typename TrackType >
static auto	SingletonRange (TrackType *pTrack) -> TrackIterRange< TrackType >
template<typename TrackType >
static auto	Channels (TrackType *pTrack) -> TrackIterRange< TrackType >

Private Member Functions
	TrackList (const TrackList &that)=delete
TrackList &	operator= (const TrackList &)=delete
	TrackList (TrackList &&that)=delete
TrackList &	operator= (TrackList &&)=delete
void	clear ()=delete
Track *	DoAddToHead (const std::shared_ptr< Track > &t)
Track *	DoAdd (const std::shared_ptr< Track > &t)
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 *t, bool linked=false) const
Track *	GetNext (Track *t, 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 (const std::shared_ptr< Track > &pTrack)
void	PermutationEvent (TrackNodePointer node)
void	DataEvent (const std::shared_ptr< Track > &pTrack, int code)
void	EnsureVisibleEvent (const std::shared_ptr< Track > &pTrack, bool modifyState)
void	DeletionEvent (TrackNodePointer node={})
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
ListOfTracks	mPendingUpdates
	Shadow tracks holding append-recording in progress; need to put them into a list so that GetLink() works. More...
std::vector< Updater >	mUpdaters
	This is in correspondence with mPendingUpdates. More...

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

Member Typedef Documentation

const_iterator

using TrackList::const_iterator = TrackIter<const Track>

Definition at line 1330 of file Track.h.

iterator

using TrackList::iterator = TrackIter<Track>

Definition at line 1329 of file Track.h.

Updater

using TrackList::Updater = std::function< void(Track &dest, const Track &src) >

Definition at line 1664 of file Track.h.

value_type

using TrackList::value_type = Track *

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

   : mOwner{ pOwner }
{
}

~TrackList()

TrackList::~TrackList ( )

virtual

Definition at line 429 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 )

inline

Definition at line 1502 of file Track.h.

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

Referenced by Effect::AddedAnalysisTrack::AddedAnalysisTrack(), ApplyPendingTracks(), Effect::DoEffect(), anonymous_namespace{EditMenus.cpp}::FinishCopy(), AUPImportFileHandle::HandleLabelTrack(), AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::HandleWaveTrack(), Effect::Preview(), Effect::ReplaceProcessedTracks(), and LabelDialog::TransferDataFromWindow().

Here is the caller graph for this function:

AdditionEvent()

void TrackList::AdditionEvent ( TrackNodePointer  node )

private

Definition at line 498 of file Track.cpp.

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

References TrackListEvent::ADDITION, and QueueEvent().

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

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.

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

   {
      return Tracks< TrackType >();
   }

Referenced by anonymous_namespace{Track.cpp}::Accumulate(), ImportCommand::Apply(), LabelDefaultClickHandle::Click(), Effect::CopyInputTracks(), ExportMultipleDialog::CountTracksAndLabels(), ExportPlugin::CreateMixer(), CutCopyAvailableFlag(), LabelTrackView::DoKeyDown(), TrackPanel::DrawTracks(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), GetInfoCommand::ExploreTrackPanel(), ExportMultipleDialog::ExportMultipleByTrack(), LabelDialog::FindAllLabels(), anonymous_namespace{Snap.cpp}::FindCandidates(), anonymous_namespace{TimeShiftHandle.cpp}::FindCorrespondence(), ProjectAudioManager::GetAllPlaybackTracks(), GetAllSeqBlocks(), GetNumExportChannels(), TrackView::GetTotalHeight(), MixerBoard::HasSolo(), ClipMoveState::Init(), LabelTracksExistFlag(), anonymous_namespace{FileMenus.cpp}::NoteTracksExistFlag(), AudacityPrintout::OnPrintPage(), ProjectAudioManager::OnRecord(), LabelDialog::OnSelectCell(), ScreenshotBigDialog::OnShortTracks(), TransportActions::Handler::OnTimerRecord(), TranscriptionToolBar::PlayAtSpeed(), ProjectHistory::PopState(), Effect::Preview(), EffectFindClipping::Process(), SelectionState::SelectNone(), SelectionState::SelectRangeOfTracks(), TracksExistFlag(), LabelDialog::TransferDataFromWindow(), LyricsPanel::UpdateLyrics(), TrackPanel::UpdateVRulerSize(), VisitBlocks(), WaveTracksExistFlag(), ZoomInAvailableFlag(), ZoomOutAvailableFlag(), and SelectionStateChanger::~SelectionStateChanger().

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

   {
      return Tracks< TrackType >();
   }

ApplyPendingTracks()

bool TrackList::ApplyPendingTracks

(

)

Exception safety guarantee:

Strong

Definition at line 989 of file Track.cpp.

{
   bool result = false;
 
   ListOfTracks additions;
   ListOfTracks updates;
   {
      // Always clear, even if one of the update functions throws
      auto cleanup = finally( [&] { ClearPendingTracks( &additions ); } );
      UpdatePendingTracks();
      updates.swap( mPendingUpdates );
   }
 
   // Remaining steps must be No-fail-guarantee so that this function
   // gives Strong-guarantee
 
   std::vector< std::shared_ptr<Track> > reinstated;
 
   for (auto &pendingTrack : updates) {
      if (pendingTrack) {
         pendingTrack->AttachedTrackObjects::ForEach([&](auto &attachment){
            attachment.Reparent( pendingTrack );
         });
         auto src = FindById( pendingTrack->GetId() );
         if (src)
            this->Replace(src, pendingTrack), result = true;
         else
            // Perhaps a track marked for pending changes got deleted by
            // some other action.  Recreate it so we don't lose the
            // accumulated changes.
            reinstated.push_back(pendingTrack);
      }
   }
 
   // If there are tracks to reinstate, append them to the list.
   for (auto &pendingTrack : reinstated)
      if (pendingTrack)
         this->Add( pendingTrack ), result = true;
 
   // Put the pending added tracks back into the list, preserving their
   // positions.
   bool inserted = false;
   ListOfTracks::iterator first;
   for (auto &pendingTrack : additions) {
      if (pendingTrack) {
         auto iter = ListOfTracks::begin();
         std::advance( iter, pendingTrack->GetIndex() );
         iter = ListOfTracks::insert( iter, pendingTrack );
         pendingTrack->SetOwner( shared_from_this(), {iter, this} );
         pendingTrack->SetId( TrackId{ ++sCounter } );
         if (!inserted) {
            first = iter;
            inserted = true;
         }
      }
   }
   if (inserted) {
      TrackNodePointer node{first, this};
      RecalcPositions(node);
      AdditionEvent(node);
      result = true;
   }
 
   return result;
}

References Add(), AdditionEvent(), ClearPendingTracks(), FindById(), mPendingUpdates, RecalcPositions(), Replace(), sCounter, and UpdatePendingTracks().

Referenced by ProjectAudioManager::OnCommitRecording().

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

{ return Any().begin(); }

Referenced by TimeShiftHandle::DoSlideVertical(), empty(), HasPendingTracks(), and EffectTruncSilence::ProcessAll().

Here is the caller graph for this function:

begin() [2/2]

const_iterator TrackList::begin ( ) const

inline

Definition at line 1334 of file Track.h.

{ return Any().begin(); }

CanMoveDown()

bool TrackList::CanMoveDown

(

Track *

t

)

const

Definition at line 755 of file Track.cpp.

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

References GetNext().

Here is the call graph for this function:

CanMoveUp()

bool TrackList::CanMoveUp

(

Track *

t

)

const

Definition at line 750 of file Track.cpp.

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

References GetPrev().

Here is the call graph for this function:

cbegin()

const_iterator TrackList::cbegin ( ) const

inline

Definition at line 1336 of file Track.h.

{ return begin(); }

cend()

const_iterator TrackList::cend ( ) const

inline

Definition at line 1337 of file Track.h.

{ return end(); }

Channels()

template<typename TrackType >

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

inlinestatic

Definition at line 1483 of file Track.h.

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

Referenced by AppendItem(), SelectTracksCommand::Apply(), SetTrackBase::Apply(), WaveTrackView::CaptureKey(), anonymous_namespace{ClipMenus.cpp}::ChannelsHaveDifferentClipBoundaries(), anonymous_namespace{TrackPanel.cpp}::ResizingChannelGroup::Children(), anonymous_namespace{TrackPanel.cpp}::Subgroup::Children(), anonymous_namespace{TrackPanel.cpp}::ChannelGroup::Children(), ProjectAudioManager::ChooseExistingRecordingTracks(), TrackPanelResizeHandle::Click(), CutlineHandle::Click(), EnvelopeHandle::Click(), WaveformPrefs::Commit(), MinimizeButtonHandle::CommitChanges(), TrackShifter::CommonMayMigrateTo(), WaveTrackView::CopySelectedText(), WaveTrackView::CutSelectedText(), anonymous_namespace{TrackMenus.cpp}::DoAlign(), anonymous_namespace{ClipMenus.cpp}::DoClipMove(), WaveformVRulerControls::DoHandleWheelRotation(), SpectrumVRulerControls::DoHandleWheelRotation(), ClipMoveState::DoHorizontalOffset(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), TrackUtilities::DoRemoveTrack(), anonymous_namespace{TrackMenus.cpp}::DoSortTracks(), TrackUtilities::DoTrackMute(), TrackUtilities::DoTrackSolo(), SpectrumVZoomHandle::DoZoom(), WaveformVZoomHandle::DoZoom(), TrackPanelResizeHandle::Drag(), anonymous_namespace{TrackPanel.cpp}::ChannelGroup::Draw(), TrackPanelResizerCell::Draw(), SpectrumView::Draw(), WaveformView::Draw(), ExportMultipleDialog::ExportMultipleByTrack(), anonymous_namespace{TrackPanel.cpp}::FindAdjustedChannelHeights(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), anonymous_namespace{WaveClipTrimHandle.cpp}::FindClipsInChannels(), TrackView::GetChannelGroupHeight(), ContrastDialog::GetDB(), CommonTrackView::GetMinimizedHeight(), MixerTrackCluster::GetRight(), VampEffect::Init(), ClipMoveState::Init(), TrackPanelAx::IsFocused(), LOFImportFileHandle::lofOpenFiles(), MixAndRender(), TrackPanel::OnEnsureVisible(), FormatMenuTable::OnFormatChange(), WaveTrackMenuTable::OnMultiView(), EditActions::Handler::OnPaste(), WaveTrackMenuTable::OnSetDisplay(), TrackMenuTable::OnSetName(), SpectrumVRulerMenuTable::OnSpectrumScaleType(), EditActions::Handler::OnSplit(), WaveTrackMenuTable::OnSwapChannels(), WaveColorMenuTable::OnWaveColorChange(), WaveformVRulerMenuTable::OnWaveformScaleType(), WaveTrackView::PasteText(), SpectrumPrefs::Preview(), EffectLoudness::Process(), EffectNormalize::Process(), NyquistEffect::Process(), EffectSBSMS::Process(), EffectStereoToMono::Process(), VampEffect::Process(), EffectTruncSilence::ProcessIndependently(), NyquistEffect::ProcessOne(), Effect::ProcessPass(), TrackPanel::RefreshTrack(), SpectrumPrefs::Rollback(), WaveTrackView::SelectAllText(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::SelectedClipOfFocusedTrack(), SelectionState::SelectTrack(), SelectionState::SelectTrackLength(), GetInfoCommand::SendTracks(), TrackView::SetMinimized(), RateMenuTable::SetRate(), anonymous_namespace{TrackMenus.cpp}::SetTrackGain(), anonymous_namespace{TrackMenus.cpp}::SetTrackPan(), GainSliderHandle::SetValue(), PanSliderHandle::SetValue(), ScreenshotBigDialog::SizeTracks(), WaveTrackMenuTable::SplitStereo(), AudioIO::StartStream(), anonymous_namespace{WaveTrackControls.cpp}::Status1DrawFunction(), SwapNodes(), UnlinkChannels(), and TrackPanel::UpdateTrackVRuler().

Channels_()

template<typename TrackType , typename InTrackType >

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

inlinestaticprivate

Definition at line 1461 of file Track.h.

   {
      // Assume iterator filters leader tracks
      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 672 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: *this )
      pTrack->SetOwner( {}, {} );
   for ( auto pTrack: mPendingUpdates )
      pTrack->SetOwner( {}, {} );
 
   ListOfTracks tempList;
   tempList.swap( *this );
 
   ListOfTracks updating;
   updating.swap( mPendingUpdates );
 
   mUpdaters.clear();
 
   if (sendEvent)
      DeletionEvent();
}

References DeletionEvent(), mPendingUpdates, and mUpdaters.

Referenced by ~TrackList().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearPendingTracks()

void TrackList::ClearPendingTracks

(

ListOfTracks *

pAdded = nullptr

)

Exception safety guarantee:

No-fail

Definition at line 948 of file Track.cpp.

{
   for (const auto &pTrack: mPendingUpdates)
      pTrack->SetOwner( {}, {} );
   mPendingUpdates.clear();
   mUpdaters.clear();
 
   if (pAdded)
      pAdded->clear();
 
   // To find the first node that remains after the first deleted one
   TrackNodePointer node;
   bool foundNode = false;
 
   for (auto it = ListOfTracks::begin(), stop = ListOfTracks::end();
        it != stop;) {
      if (it->get()->GetId() == TrackId{}) {
         do {
            if (pAdded)
               pAdded->push_back( *it );
            (*it)->SetOwner( {}, {} );
            it = erase( it );
         }
         while (it != stop && it->get()->GetId() == TrackId{});
 
         if (!foundNode && it != stop) {
            node = (*it)->GetNode();
            foundNode = true;
         }
      }
      else
         ++it;
   }
 
   if (!empty()) {
      RecalcPositions(getBegin());
      DeletionEvent( node );
   }
}

References DeletionEvent(), empty(), getBegin(), mPendingUpdates, mUpdaters, and RecalcPositions().

Referenced by ApplyPendingTracks(), ProjectAudioManager::CancelRecording(), and AudacityApp::OnExceptionInMainLoop().

Here is the call graph for this function:

Here is the caller graph for this function:

Contains()

bool TrackList::Contains

(

const Track *

t

)

const

Mainly a test function. Uses a linear search, so could be slow.

Definition at line 849 of file Track.cpp.

{
   return make_iterator_range( *this ).contains( t );
}

References make_iterator_range().

Here is the call graph for this function:

Create()

std::shared_ptr< TrackList > TrackList::Create ( AudacityProject *  pOwner )

static

Definition at line 393 of file Track.cpp.

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

Referenced by Clipboard::Clipboard(), Effect::CopyInputTracks(), ProjectFileManager::DoSave(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), UndoManager::ModifyState(), EditActions::Handler::OnCopy(), EditActions::Handler::OnCut(), EditActions::Handler::OnSplitCut(), Effect::Preview(), EffectTwoPassSimpleMono::Process(), UndoManager::PushState(), ProjectFileManager::ReadProjectFile(), and ProjectFileIO::SaveProject().

Here is the caller graph for this function:

DataEvent()

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

private

Definition at line 470 of file Track.cpp.

{
   QueueEvent({
      TrackListEvent::TRACK_DATA_CHANGE, pTrack, code });
}

References QueueEvent(), and TrackListEvent::TRACK_DATA_CHANGE.

Here is the call graph for this function:

DeletionEvent()

void TrackList::DeletionEvent ( TrackNodePointer  node = {} )

private

Definition at line 488 of file Track.cpp.

{
   QueueEvent({
      TrackListEvent::DELETION,
      node.second && node.first != node.second->end()
         ? *node.first
         : nullptr
   });
}

References TrackListEvent::DELETION, and QueueEvent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

DoAdd()

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

private

Definition at line 564 of file Track.cpp.

{
   push_back(t);
 
   auto n = getPrev( getEnd() );
 
   t->SetOwner(shared_from_this(), n);
   t->SetId( TrackId{ ++sCounter } );
   RecalcPositions(n);
   AdditionEvent(n);
   return back().get();
}

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

Here is the call graph for this function:

DoAddToHead()

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

private

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

empty()

bool TrackList::empty

(

)

const

Definition at line 854 of file Track.cpp.

{
   return begin() == end();
}

References begin(), and end().

Referenced by anonymous_namespace{Track.cpp}::Accumulate(), ClearPendingTracks(), ProjectFileManager::Import(), ApplyMacroDialog::OnApplyToFiles(), and size().

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

{ return Any().end(); }

Referenced by TimeShiftHandle::DoSlideVertical(), empty(), HasPendingTracks(), MakeMultiChannelTrack(), and RecalcPositions().

Here is the caller graph for this function:

end() [2/2]

const_iterator TrackList::end ( ) const

inline

Definition at line 1335 of file Track.h.

{ return Any().end(); }

EndIterator()

template<typename TrackType >

TrackIter< TrackType > TrackList::EndIterator ( ) const

inlineprivate

Definition at line 1605 of file Track.h.

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

EnsureVisibleEvent()

void TrackList::EnsureVisibleEvent ( const std::shared_ptr< Track > &  pTrack, bool  modifyState  )

private

Definition at line 476 of file Track.cpp.

{
   QueueEvent({ TrackListEvent::TRACK_REQUEST_VISIBLE,
      pTrack, static_cast<int>(modifyState) });
}

References QueueEvent(), and TrackListEvent::TRACK_REQUEST_VISIBLE.

Here is the call graph for this function:

Find() [1/2]

template<typename TrackType = const Track>

auto TrackList::Find ( const Track *  pTrack ) const -> std::enable_if_t< std::is_const_v<TrackType>, TrackIter< TrackType > >

inline

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

const overload will only produce iterators over const TrackType

Definition at line 1353 of file Track.h.

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

Find() [2/2]

template<typename TrackType = Track>

auto TrackList::Find ( Track *  pTrack ) -> TrackIter< TrackType >

inline

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

Definition at line 1341 of file Track.h.

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

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

Here is the caller graph for this function:

FindById()

Track * TrackList::FindById

(

TrackId

id

)

Definition at line 541 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();
}

Referenced by ApplyPendingTracks(), TrackPanelAx::IsFocused(), and UpdatePendingTracks().

Here is the caller graph for this function:

FindLeader() [1/2]

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

inline

Definition at line 1371 of file Track.h.

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

FindLeader() [2/2]

auto TrackList::FindLeader

(

Track *

pTrack

)

Definition at line 518 of file Track.cpp.

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

References ActiveProjects::Find(), and Track::IsLeader().

Referenced by TrackPanel::FindTrackRect(), TrackPanel::RefreshTrack(), TrackFocus::Set(), and SwapNodes().

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

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

References key.

Referenced by SelectUtilities::ActivatePlayRegion(), ProjectFileManager::AddImportedTracks(), SelectHandle::AdjustSelection(), AdornedRulerPanel::AdornedRulerPanel(), AnyTracksSelectedPred(), AppendItem(), ImportCommand::Apply(), ScreenshotCommand::Apply(), SelectTimeCommand::Apply(), SelectTracksCommand::Apply(), SetLabelCommand::Apply(), SetTrackBase::Apply(), BrushHandleHitTest(), TrackSelectHandle::CalculateRearrangingThresholds(), TrackPanelResizeHandle::Cancel(), ProjectAudioManager::CancelRecording(), Exporter::CheckMix(), ProjectAudioManager::ChooseExistingRecordingTracks(), ButtonHandle::Click(), TrackPanelResizeHandle::Click(), LabelDefaultClickHandle::Click(), LabelGlyphHandle::Click(), BrushHandle::Click(), SelectHandle::Click(), TimeShiftHandle::Click(), BackgroundHandle::Click(), CutCopyAvailableFlag(), DefaultPlayOptions(), 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(), DoImportMIDI(), LabelTrackView::DoKeyDown(), SelectUtilities::DoListSelection(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel(), TrackUtilities::DoMoveTrack(), anonymous_namespace{SelectMenus.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(), ProjectWindow::DoZoomFit(), anonymous_namespace{ViewMenus.cpp}::DoZoomFitV(), ButtonHandle::Drag(), TrackPanelResizeHandle::Drag(), LabelTextHandle::Drag(), NoteTrackVZoomHandle::Drag(), SpectrumVZoomHandle::Drag(), WaveformVZoomHandle::Drag(), TimeTrackVZoomHandle::Drag(), BrushHandle::Drag(), SelectHandle::Drag(), TimeShiftHandle::Drag(), TrackSelectHandle::Drag(), EditableTracksSelectedPred(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), UndoManager::EstimateRemovedBlocks(), Exporter::ExamineTracks(), TimerRecordDialog::ExecutePostRecordActions(), GetInfoCommand::ExploreTrackPanel(), ExportCL::Export(), ExportFFmpeg::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), ProjectWindow::FixScrollbars(), SpectrumView::ForAll(), ProjectFileIO::GenerateDoc(), Get(), GetAllSeqBlocks(), FrequencyPlotDialog::GetAudio(), ContrastDialog::GetDB(), GetPropertiesOfSelected(), CompareAudioCommand::GetSelection(), SliderHandle::GetSlider(), ScreenshotCommand::GetTrackRect(), TrackPanelAx::GetTracks(), ProjectWindow::GetZoomOfToFit(), LabelGlyphHandle::HandleGlyphDragRelease(), AUPImportFileHandle::HandleImport(), AUPImportFileHandle::HandleLabelTrack(), AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::HandleWaveTrack(), SelectHandle::HitTest(), ProjectFileManager::Import(), AUPImportFileHandle::Import(), anonymous_namespace{ProjectFileManager.cpp}::ImportProject(), EffectEqualization::Init(), NyquistEffect::Init(), ProjectHistory::InitialState(), anonymous_namespace{LabelMenus.cpp}::LabelsSelectedFlag(), LabelTracksExistFlag(), LOFImportFileHandle::lofOpenFiles(), MixerBoard::MixerBoard(), ProjectHistory::ModifyState(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), TrackActions::Handler::MuteTracks(), anonymous_namespace{SelectMenus.cpp}::NearestZeroCrossing(), LabelTrack::New(), NoteTrack::New(), TimeTrack::New(), WaveTrack::New(), anonymous_namespace{FileMenus.cpp}::NoteTracksExistFlag(), ApplyMacroDialog::OnApplyToFiles(), ProjectManager::OnCloseWindow(), ViewActions::Handler::OnCollapseAllTracks(), ProjectAudioManager::OnCommitRecording(), EditActions::Handler::OnCopy(), LabelEditActions::Handler::OnCopyLabels(), SelectActions::Handler::OnCursorTrackEnd(), SelectActions::Handler::OnCursorTrackStart(), EditActions::Handler::OnCut(), LabelEditActions::Handler::OnCutLabels(), EditActions::Handler::OnDelete(), LabelEditActions::Handler::OnDeleteLabels(), EditActions::Handler::OnDisjoin(), LabelEditActions::Handler::OnDisjoinLabels(), EditActions::Handler::OnDuplicate(), AudacityApp::OnExceptionInMainLoop(), ViewActions::Handler::OnExpandAllTracks(), FileActions::Handler::OnExportLabels(), FileActions::Handler::OnExportMIDI(), NavigationActions::Handler::OnFirstTrack(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), FileActions::Handler::OnImportLabels(), EditActions::Handler::OnJoin(), LabelEditActions::Handler::OnJoinLabels(), NavigationActions::Handler::OnLastTrack(), WaveTrackMenuTable::OnMergeStereo(), LabelEditActions::Handler::OnNewLabelTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::Handler::OnNewStereoTrack(), anonymous_namespace{TimeTrackMenuItems.cpp}::Handler::OnNewTimeTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::Handler::OnNewWaveTrack(), EditActions::Handler::OnPaste(), LabelEditActions::Handler::OnPasteNewLabel(), FileActions::Handler::OnPrint(), ProjectAudioManager::OnRecord(), EditActions::Handler::OnRedo(), TrackActions::Handler::OnResample(), SelectActions::Handler::OnSelectAll(), SelectActions::Handler::OnSelectCursorEnd(), SelectActions::Handler::OnSelectStartCursor(), SelectActions::Handler::OnSelectSyncLockSel(), SelectActions::Handler::OnSelectTrackStartToEnd(), ScreenshotBigDialog::OnShortTracks(), EditActions::Handler::OnSilence(), LabelEditActions::Handler::OnSilenceLabels(), EditActions::Handler::OnSplit(), EditActions::Handler::OnSplitCut(), LabelEditActions::Handler::OnSplitCutLabels(), EditActions::Handler::OnSplitDelete(), LabelEditActions::Handler::OnSplitDeleteLabels(), LabelEditActions::Handler::OnSplitLabels(), EditActions::Handler::OnSplitNew(), WaveTrackMenuTable::OnSwapChannels(), TransportActions::Handler::OnTimerRecord(), TrackActions::Handler::OnTrackMoveBottom(), TrackActions::Handler::OnTrackMoveDown(), TrackActions::Handler::OnTrackMoveTop(), TrackActions::Handler::OnTrackMoveUp(), EditActions::Handler::OnTrim(), EditActions::Handler::OnUndo(), anonymous_namespace{TrackView.cpp}::TrackPositioner::OnUpdate(), ProjectFileManager::OpenProjectFile(), TimeTrack::PasteInto(), anonymous_namespace{MixerBoard.cpp}::PlayableTracksExistFlag(), TranscriptionToolBar::PlayAtSpeed(), ProjectAudioManager::PlayPlayRegion(), ProjectHistory::PopState(), TrackSelectHandle::Preview(), NyquistEffect::Process(), SpectralDataManager::ProcessTracks(), TrackPanel::ProcessUIHandleResult(), ProjectHistory::PushState(), ProjectFileManager::ReadProjectFile(), ProjectHistory::RedoAvailable(), ProjectWindow::RedrawProject(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), SpectrumVZoomHandle::Release(), WaveformVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), AffordanceHandle::Release(), LabelDefaultClickHandle::RestoreState(), ProjectManager::SafeToOpenProjectInto(), ProjectFileIO::SaveCopy(), LabelDefaultClickHandle::SaveState(), ProjectWindow::ScrollingLowerBoundTime(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), NoteTrackAffordanceHandle::SelectAt(), SelectUtilities::SelectNone(), GetInfoCommand::SendClips(), GetInfoCommand::SendEnvelopes(), GetInfoCommand::SendLabels(), GetInfoCommand::SendTracks(), TrackFocus::Set(), ScreenshotBigDialog::SizeTracks(), ProjectWindow::SkipEnd(), WaveTrackMenuTable::SplitStereo(), ProjectSelectionManager::SSBL_GetRate(), StereoRequiredFlag(), TracksExistFlag(), ProjectHistory::UndoAvailable(), LyricsPanel::UpdateLyrics(), ProjectSettings::UpdatePrefs(), WaveTracksExistFlag(), WaveTracksSelectedFlag(), ProjectFileIO::WriteXML(), ProjectWindow::ZoomAfterImport(), ZoomInAvailableFlag(), and ZoomOutAvailableFlag().

Get() [2/2]

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

static

Definition at line 382 of file Track.cpp.

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

References Get().

Here is the call graph for this function:

getBegin()

TrackNodePointer TrackList::getBegin ( ) const

inlineprivate

Definition at line 1619 of file Track.h.

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

Referenced by ClearPendingTracks(), DoAddToHead(), and Permute().

Here is the caller graph for this function:

getEnd()

TrackNodePointer TrackList::getEnd ( ) const

inlineprivate

Definition at line 1616 of file Track.h.

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

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

Here is the caller graph for this function:

GetEndTime()

double TrackList::GetEndTime

(

)

const

Definition at line 897 of file Track.cpp.

{
   return Accumulate(*this, &Track::GetEndTime, -DBL_MAX, std::max);
}

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

Referenced by SelectTimeCommand::Apply(), DefaultPlayOptions(), LOFImportFileHandle::doDurationAndScrollOffset(), ExportMultipleDialog::ExportMultipleByLabel(), AudacityPrintout::OnPrintPage(), and AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMinOffset()

double TrackList::GetMinOffset

(

)

const

Definition at line 887 of file Track.cpp.

{
   return Accumulate(*this, &Track::GetOffset, DBL_MAX, std::min);
}

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

Here is the call 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 695 of file Track.cpp.

{
   if (t) {
      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.first->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 1624 of file Track.h.

   {
      if ( isNull(p) )
         return p;
      auto q = p;
      ++q.first;
      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 1323 of file Track.h.

{ return mOwner; }

Referenced by Effect::FindProject(), and Effect::Preview().

Here is the caller graph for this function:

GetOwner() [2/2]

const AudacityProject* TrackList::GetOwner ( ) const

inline

Definition at line 1324 of file Track.h.

{ return mOwner; }

GetPrev()

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

private

Definition at line 714 of file Track.cpp.

{
   if (t) {
      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.first)->HasLinkedTrack() && (*node.first)->GetLinkedTrack() )
                  node = prev;
            }
 
            return node.first->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 1634 of file Track.h.

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

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

Here is the caller graph for this function:

GetStartTime()

double TrackList::GetStartTime

(

)

const

Definition at line 892 of file Track.cpp.

{
   return Accumulate(*this, &Track::GetStartTime, DBL_MAX, std::min);
}

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

Referenced by AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

HasPendingTracks()

bool TrackList::HasPendingTracks

(

)

const

Definition at line 1181 of file Track.cpp.

{
   if ( !mPendingUpdates.empty() )
      return true;
   if (end() != std::find_if(begin(), end(), [](const Track *t){
      return t->GetId() == TrackId{};
   }))
      return true;
   return false;
}

References begin(), end(), Track::GetId(), and mPendingUpdates.

Here is the call graph for this function:

isNull()

bool TrackList::isNull ( TrackNodePointer  p ) const

inlineprivate

Definition at line 1613 of file Track.h.

   { return (p.second == this && p.first == ListOfTracks::end())
      || (p.second == &mPendingUpdates && p.first == mPendingUpdates.end()); }

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

Here is the caller graph for this function:

Leaders() [1/2]

template<typename TrackType = Track>

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

inline

Definition at line 1413 of file Track.h.

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

References Track::IsLeader().

Referenced by ExportMultipleDialog::CountTracksAndLabels(), ExportMultipleDialog::ExportMultipleByTrack(), ScreenshotCommand::GetTrackRect(), TrackSelectHandle::Preview(), NyquistEffect::Process(), and MixerBoard::UpdateTrackClusters().

Here is the call graph for this function:

Here is the caller graph for this function:

Leaders() [2/2]

template<typename TrackType = const Track>

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

inline

Definition at line 1420 of file Track.h.

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

References Track::IsLeader().

Here is the call graph for this function:

Lock()

template<typename Subclass >

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

inline

Definition at line 1541 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 SelectHandle::AdjustSelection(), SelectionState::ChangeSelectionOnShiftClick(), ButtonHandle::Click(), BrushHandle::Click(), SelectHandle::Click(), ButtonHandle::Drag(), LabelTextHandle::Drag(), NoteTrackVZoomHandle::Drag(), SpectrumVZoomHandle::Drag(), WaveformVZoomHandle::Drag(), TimeTrackVZoomHandle::Drag(), BrushHandle::Drag(), SelectHandle::Drag(), SliderHandle::GetSlider(), TrackPanel::ProcessUIHandleResult(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), SpectrumVZoomHandle::Release(), WaveformVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), LabelDefaultClickHandle::RestoreState(), and NoteTrackAffordanceHandle::SelectAt().

Here is the caller graph for this function:

MakeMultiChannelTrack()

bool TrackList::MakeMultiChannelTrack	(	Track &	first,
		int	nChannels,
		bool	aligned
	)

Converts channels to a multichannel track.

Parameters

first	and the following must be in this list. Tracks should not be a part of another group (not linked)
nChannels	number of channels, for now only 2 channels supported
aligned	if true, the link type will be set to Track::LinkType::Aligned, or Track::LinkType::Group otherwise

Returns

true on success, false if some prerequisites do not met

Definition at line 615 of file Track.cpp.

{
   if (nChannels != 2)
      return false;
 
   auto list = track.mList.lock();
   if (list.get() == this)
   {
      if (*list->FindLeader(&track) != &track)
         return false;
 
      auto first = list->Find(&track);
      auto canLink = [&]() -> bool {
         int count = nChannels;
         for (auto it = first, end = TrackList::end(); it != end && count; ++it)
         {
            if ((*it)->HasLinkedTrack())
               return false;
            --count;
         }
         return count == 0;
      }();
 
      if (!canLink)
         return false;
 
      (*first)->SetLinkType(aligned ? Track::LinkType::Aligned : Track::LinkType::Group);
      (*first)->SetChannel(Track::LeftChannel);
      auto second = std::next(first);
      (*second)->SetChannel(Track::RightChannel);
   }
   else
      THROW_INCONSISTENCY_EXCEPTION;
   return true;
}

References Track::Aligned, end(), Track::Group, Track::LeftChannel, Track::mList, Track::RightChannel, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by ProjectAudioManager::DoRecord(), and Effect::Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeTrackIterator()

template<typename TrackType >

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

inlineprivate

Definition at line 1596 of file Track.h.

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

Move()

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

inline

Definition at line 1533 of file Track.h.

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

MoveDown()

bool TrackList::MoveDown

(

Track *

t

)

Definition at line 836 of file Track.cpp.

{
   if (t) {
      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 823 of file Track.cpp.

{
   if (t) {
      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 483 of file Track.cpp.

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

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< TrackNodePointer > &

permutation

)

For use in sorting: assume each iterator points into this list, no duplications.

Definition at line 527 of file Track.cpp.

{
   for (const auto iter : permutation) {
      ListOfTracks::value_type track = *iter.first;
      erase(iter.first);
      Track *pTrack = track.get();
      pTrack->SetOwner(shared_from_this(),
         { insert(ListOfTracks::end(), track), this });
   }
   auto n = getBegin();
   RecalcPositions(n);
   PermutationEvent(n);
}

References getBegin(), PermutationEvent(), RecalcPositions(), and Track::SetOwner().

Here is the call graph for this function:

QueueEvent()

void TrackList::QueueEvent ( TrackListEvent  event )

private

Definition at line 457 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(), EnsureVisibleEvent(), PermutationEvent(), ResizingEvent(), and SelectionEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

RecalcPositions()

void TrackList::RecalcPositions ( TrackNodePointer  node )

private

Definition at line 434 of file Track.cpp.

{
   if ( isNull( node ) )
      return;
 
   Track *t;
   int i = 0;
 
   auto prev = getPrev( node );
   if ( !isNull( prev ) ) {
      t = prev.first->get();
      i = t->GetIndex() + 1;
   }
 
   const auto theEnd = end();
   for (auto n = Find( node.first->get() ); n != theEnd; ++n) {
      t = *n;
      t->SetIndex(i++);
   }
 
   UpdatePendingTracks();
}

References end(), Find(), Track::GetIndex(), getPrev(), isNull(), Track::SetIndex(), and UpdatePendingTracks().

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

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterPendingChangedTrack()

std::shared_ptr< Track > TrackList::RegisterPendingChangedTrack	(	Updater	updater,
		Track *	src
	)

Definition at line 903 of file Track.cpp.

{
   std::shared_ptr<Track> pTrack;
   if (src) {
      pTrack = src->Clone(); // not duplicate
      // Share the satellites with the original, though they do not point back
      // to the pending track
      ((AttachedTrackObjects&)*pTrack) = *src; // shallow copy
   }
 
   if (pTrack) {
      mUpdaters.push_back( updater );
      mPendingUpdates.push_back( pTrack );
      auto n = mPendingUpdates.end();
      --n;
      pTrack->SetOwner(shared_from_this(), {n, &mPendingUpdates});
   }
 
   return pTrack;
}

References Track::Clone(), mPendingUpdates, mUpdaters, and Track::SetOwner().

Referenced by ProjectAudioManager::DoRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterPendingNewTrack()

void TrackList::RegisterPendingNewTrack

(

const std::shared_ptr< Track > &

pTrack

)

Definition at line 924 of file Track.cpp.

{
   Add<Track>( pTrack );
   pTrack->SetId( TrackId{} );
}

References Track::SetId().

Referenced by ProjectAudioManager::DoRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Remove()

TrackNodePointer TrackList::Remove

(

Track *

t

)

Remove the Track and return an iterator to what followed it.

Definition at line 651 of file Track.cpp.

{
   auto result = getEnd();
   if (t) {
      auto node = t->GetNode();
      t->SetOwner({}, {});
 
      if ( !isNull( node ) ) {
         ListOfTracks::value_type holder = *node.first;
 
         result = getNext( node );
         erase(node.first);
         if ( !isNull( result ) )
            RecalcPositions(result);
 
         DeletionEvent(result);
      }
   }
   return result;
}

References DeletionEvent(), getEnd(), getNext(), Track::GetNode(), isNull(), RecalcPositions(), and Track::SetOwner().

Referenced by Effect::DoEffect(), and Effect::ReplaceProcessedTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

Replace()

auto TrackList::Replace	(	Track *	t,
		const ListOfTracks::value_type &	with
	)

Replace first track with second track, give back a holder Give the replacement the same id as the replaced

Definition at line 577 of file Track.cpp.

{
   ListOfTracks::value_type holder;
   if (t && with) {
      auto node = t->GetNode();
      t->SetOwner({}, {});
 
      holder = *node.first;
 
      Track *pTrack = with.get();
      *node.first = with;
      pTrack->SetOwner(shared_from_this(), node);
      pTrack->SetId( t->GetId() );
      RecalcPositions(node);
 
      DeletionEvent(node);
      AdditionEvent(node);
   }
   return holder;
}

References Track::SetId(), and Track::SetOwner().

Referenced by ApplyPendingTracks(), Effect::ModifiedAnalysisTrack::ModifiedAnalysisTrack(), and Effect::ReplaceProcessedTracks().

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

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

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

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

References Track::IsSelected().

Referenced by AnyTracksSelectedPred(), SelectionState::ChangeSelectionOnShiftClick(), Effect::CountWaveTracks(), EditableTracksSelectedPred(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), TranscriptionToolBar::EnableDisableButtons(), ExportMultipleDialog::ExportMultipleByTrack(), EffectTruncSilence::FindSilences(), FrequencyPlotDialog::GetAudio(), GetPropertiesOfSelected(), anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel(), CompareAudioCommand::GetSelection(), EffectEqualization::Init(), NyquistEffect::Init(), EffectScienFilter::Init(), EffectCompressor::InitPass1(), anonymous_namespace{LabelMenus.cpp}::LabelsSelectedFlag(), MixAndRender(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), EffectFindClipping::Process(), EffectNoiseReduction::Worker::Process(), EffectTruncSilence::ProcessAll(), 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 1403 of file Track.h.

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

References Track::IsSelected().

Here is the call graph for this function:

SelectedLeaders() [1/2]

template<typename TrackType = Track>

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

inline

Definition at line 1430 of file Track.h.

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

References Track::IsSelectedLeader().

Referenced by Effect::CountWaveTracks(), ContrastDialog::GetDB(), and TrackPanel::GetSelectedTrackCount().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectedLeaders() [2/2]

template<typename TrackType = const Track>

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

inline

Definition at line 1437 of file Track.h.

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

References Track::IsSelectedLeader().

Here is the call graph for this function:

SelectionEvent()

void TrackList::SelectionEvent ( const std::shared_ptr< Track > &  pTrack )

private

Definition at line 465 of file Track.cpp.

{
   QueueEvent({ TrackListEvent::SELECTION_CHANGE, pTrack });
}

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

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

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

Referenced by anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), EffectLoudness::Process(), and EffectNormalize::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

size()

size_t TrackList::size

(

)

const

Definition at line 859 of file Track.cpp.

{
   int cnt = 0;
 
   if (!empty())
      cnt = getPrev( getEnd() ).first->get()->GetIndex() + 1;
 
   return cnt;
}

References empty(), getEnd(), and getPrev().

Referenced by ScreenshotCommand::Apply(), and ProjectSettings::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Swap()

void TrackList::Swap

(

TrackList &

that

)

Definition at line 409 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, &a});
      for (auto it = b.begin(), last = b.end(); it != last; ++it)
         (*it)->SetOwner(bSelf, {it, &b});
   };
 
   const auto self = shared_from_this();
   const auto otherSelf = that.shared_from_this();
   SwapLOTs( *this, self, that, otherSelf );
   SwapLOTs( this->mPendingUpdates, self, that.mPendingUpdates, otherSelf );
   mUpdaters.swap(that.mUpdaters);
}

SwapNodes()

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

private

Definition at line 764 of file Track.cpp.

{
   // if a null pointer is passed in, we want to know about it
   wxASSERT(!isNull(s1));
   wxASSERT(!isNull(s2));
 
   // Deal with first track in each team
   s1 = ( * FindLeader( s1.first->get() ) )->GetNode();
   s2 = ( * FindLeader( s2.first->get() ) )->GetNode();
 
   // Safety check...
   if (s1 == s2)
      return;
 
   // Be sure s1 is the earlier iterator
   if ((*s1.first)->GetIndex() >= (*s2.first)->GetIndex())
      std::swap(s1, s2);
 
   // For saving the removed tracks
   using Saved = std::vector< ListOfTracks::value_type >;
   Saved saved1, saved2;
 
   auto doSave = [&] ( Saved &saved, TrackNodePointer &s ) {
      size_t nn = Channels( s.first->get() ).size();
      saved.resize( nn );
      // Save them in backwards order
      while( nn-- )
         saved[nn] = *s.first, s.first = erase(s.first);
   };
 
   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 ) {
      Track *pTrack;
      for (auto & pointer : saved)
         pTrack = pointer.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.first, pointer), this } );
   };
   // 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 Channels(), FindLeader(), isNull(), PermutationEvent(), RecalcPositions(), Track::SetOwner(), 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:

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 1568 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 1581 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 } };
   }

UnlinkChannels()

void TrackList::UnlinkChannels

(

Track &

track

)

Removes linkage if track belongs to a group.

Definition at line 599 of file Track.cpp.

{
   auto list = track.mList.lock();
   if (list.get() == this)
   {
      auto channels = TrackList::Channels(&track);
      for (auto c : channels)
      {
          c->SetLinkType(Track::LinkType::None);
          c->SetChannel(Track::ChannelType::MonoChannel);
      }
   }
   else
      THROW_INCONSISTENCY_EXCEPTION;
}

References Channels(), Track::mList, Track::None, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by WaveTrackMenuTable::SplitStereo().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePendingTracks()

void TrackList::UpdatePendingTracks

(

)

Definition at line 930 of file Track.cpp.

{
   auto pUpdater = mUpdaters.begin();
   for (const auto &pendingTrack : mPendingUpdates) {
      // Copy just a part of the track state, according to the update
      // function
      const auto &updater = *pUpdater;
      auto src = FindById( pendingTrack->GetId() );
      if (pendingTrack && src) {
         if (updater)
            updater( *pendingTrack, *src );
         pendingTrack->DoSetLinkType(src->GetLinkType());
      }
      ++pUpdater;
   }
}

References FindById(), mPendingUpdates, mUpdaters, and anonymous_namespace{LogWindow.cpp}::pUpdater.

Referenced by ApplyPendingTracks(), ProjectAudioManager::DoRecord(), TrackPanel::ProcessUIHandleResult(), and RecalcPositions().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

Track

friend class Track

friend

Definition at line 1489 of file Track.h.

Member Data Documentation

mOwner

AudacityProject* TrackList::mOwner

private

Definition at line 1709 of file Track.h.

mPendingUpdates

ListOfTracks TrackList::mPendingUpdates

private

Shadow tracks holding append-recording in progress; need to put them into a list so that GetLink() works.

Beware, they are in a disjoint iteration sequence from ordinary tracks

Definition at line 1713 of file Track.h.

Referenced by ApplyPendingTracks(), Clear(), ClearPendingTracks(), HasPendingTracks(), RegisterPendingChangedTrack(), and UpdatePendingTracks().

mUpdaters

std::vector< Updater > TrackList::mUpdaters

private

This is in correspondence with mPendingUpdates.

Definition at line 1715 of file Track.h.

Referenced by Clear(), ClearPendingTracks(), RegisterPendingChangedTrack(), and UpdatePendingTracks().

sCounter

long TrackList::sCounter = -1

staticprivate

Definition at line 1661 of file Track.h.

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

---

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

• Track.h
• Track.cpp