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 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 -> typename std::enable_if< std::is_const< TrackType >::value, TrackIter< TrackType > >::type
	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 -> typename std::enable_if< std::is_const< TrackType >::value, TrackIterRange< TrackType > >::type
template<typename TrackType = Track>
auto	Selected () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	Selected () const -> typename std::enable_if< std::is_const< TrackType >::value, TrackIterRange< TrackType > >::type
template<typename TrackType = Track>
auto	Leaders () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	Leaders () const -> typename std::enable_if< std::is_const< TrackType >::value, TrackIterRange< TrackType > >::type
template<typename TrackType = Track>
auto	SelectedLeaders () -> TrackIterRange< TrackType >
template<typename TrackType = const Track>
auto	SelectedLeaders () const -> typename std::enable_if< std::is_const< TrackType >::value, TrackIterRange< TrackType > >::type
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	GroupChannels (Track &track, size_t groupSize, bool resetChannels=true)
	Define a group of channels starting at the given 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 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 >
static TrackIterRange< Track >	SyncLockGroup (Track *pTrack)
static TrackIterRange< const Track >	SyncLockGroup (const Track *pTrack)
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 -> typename std::enable_if< std::is_const< TrackType >::value, TrackIterRange< TrackType > >::type
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...
std::pair< Track *, Track * >	FindSyncLockGroup (Track *pMember) const
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	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

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

Member Typedef Documentation

const_iterator

using TrackList::const_iterator = TrackIter<const Track>

Definition at line 1305 of file Track.h.

iterator

using TrackList::iterator = TrackIter<Track>

Definition at line 1304 of file Track.h.

Updater

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

Definition at line 1647 of file Track.h.

value_type

using TrackList::value_type = Track *

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

:  wxEvtHandler()
, mOwner{ pOwner }
{
}

~TrackList()

TrackList::~TrackList ( )

virtual

Definition at line 548 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 1486 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 617 of file Track.cpp.

{
   // wxWidgets will own the event object
   QueueEvent( safenew TrackListEvent{ EVT_TRACKLIST_ADDITION, *node.first } );
}

References safenew.

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

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 1482 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 1354 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(), DefaultPlayOptions(), DefaultSpeedPlayOptions(), 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(), ODTask::IsTaskAssociatedWithProject(), LabelTracksExistFlag(), 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(), Mixer::WarpOptions::WarpOptions(), WaveTracksExistFlag(), ZoomInAvailableFlag(), ZoomOutAvailableFlag(), and SelectionStateChanger::~SelectionStateChanger().

Any() [2/2]

template<typename TrackType = const Track>

auto TrackList::Any ( ) const -> typename std::enable_if< std::is_const<TrackType>::value, TrackIterRange< TrackType > >::type

inline

Definition at line 1361 of file Track.h.

   {
      return Tracks< TrackType >();
   }

ApplyPendingTracks()

bool TrackList::ApplyPendingTracks

(

)

Exception safety guarantee:

Strong

Definition at line 1119 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) {
         if (pendingTrack->mpView)
            pendingTrack->mpView->Reparent( pendingTrack );
         if (pendingTrack->mpControls)
            pendingTrack->mpControls->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 1307 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 1309 of file Track.h.

{ return Any().begin(); }

CanMoveDown()

bool TrackList::CanMoveDown

(

Track *

t

)

const

Definition at line 884 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 879 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 1311 of file Track.h.

{ return begin(); }

cend()

const_iterator TrackList::cend ( ) const

inline

Definition at line 1312 of file Track.h.

{ return end(); }

Channels()

template<typename TrackType >

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

inlinestatic

Definition at line 1467 of file Track.h.

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

Referenced by AppendItem(), SelectTracksCommand::Apply(), SetTrackBase::Apply(), 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(), 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(), TrackPanelResizerCell::Draw(), SpectrumView::Draw(), WaveformView::Draw(), ExportMultipleDialog::ExportMultipleByTrack(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), 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(), WaveTrackMenuTable::OnSwapChannels(), WaveColorMenuTable::OnWaveColorChange(), WaveformVRulerMenuTable::OnWaveformScaleType(), IsVisibleTrack::operator()(), SpectrumPrefs::Preview(), EffectLoudness::Process(), EffectNormalize::Process(), NyquistEffect::Process(), EffectSBSMS::Process(), EffectStereoToMono::Process(), VampEffect::Process(), EffectTruncSilence::ProcessIndependently(), NyquistEffect::ProcessOne(), Effect::ProcessPass(), TrackPanel::RefreshTrack(), SpectrumPrefs::Rollback(), 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(), and TrackPanel::UpdateTrackVRuler().

Channels_()

template<typename TrackType , typename InTrackType >

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

inlinestaticprivate

Definition at line 1445 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 801 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 1078 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 978 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 512 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(), ProjectFileIO::SaveProject(), and ProjectAudioManager::SetupCutPreviewTracks().

Here is the caller graph for this function:

DataEvent()

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

private

Definition at line 583 of file Track.cpp.

{
   // wxWidgets will own the event object
   QueueEvent(
      safenew TrackListEvent{ EVT_TRACKLIST_TRACK_DATA_CHANGE, pTrack, code } );
}

References safenew.

DeletionEvent()

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

private

Definition at line 606 of file Track.cpp.

{
   // wxWidgets will own the event object
   QueueEvent( safenew TrackListEvent{
      EVT_TRACKLIST_DELETION,
      node.second && node.first != node.second->end()
         ? *node.first
         : nullptr
   } );
}

References safenew.

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

Here is the caller graph for this function:

DoAdd()

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

private

Definition at line 694 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 682 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 983 of file Track.cpp.

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

References begin(), and end().

Referenced by anonymous_namespace{Track.cpp}::Accumulate(), ClearPendingTracks(), EVT_MENU_RANGE(), ProjectFileManager::Import(), ApplyMacroDialog::OnApplyToFiles(), ProjectManager::OpenFiles(), anonymous_namespace{ProjectWindow.cpp}::MouseWheelHandler::operator()(), 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 629 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 1308 of file Track.h.

{ return Any().end(); }

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

Here is the caller graph for this function:

end() [2/2]

const_iterator TrackList::end ( ) const

inline

Definition at line 1310 of file Track.h.

{ return Any().end(); }

EndIterator()

template<typename TrackType >

TrackIter< TrackType > TrackList::EndIterator ( ) const

inlineprivate

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

{
   auto pEvent = std::make_unique<TrackListEvent>(
      EVT_TRACKLIST_TRACK_REQUEST_VISIBLE, pTrack, 0 );
   pEvent->SetInt( modifyState ? 1 : 0 );
   // wxWidgets will own the event object
   QueueEvent( pEvent.release() );
}

Find() [1/2]

template<typename TrackType = const Track>

auto TrackList::Find ( const Track *  pTrack ) const -> typename std::enable_if< std::is_const<TrackType>::value, TrackIter< TrackType > >::type

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 1328 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 1316 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 671 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 1346 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 648 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(), GroupChannels(), TrackPanel::RefreshTrack(), TrackFocus::Set(), and SwapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

FindSyncLockGroup()

std::pair< Track *, Track * > TrackList::FindSyncLockGroup ( Track *  pMember ) const

private

Definition at line 433 of file Track.cpp.

{
   if (!pMember)
      return { nullptr, nullptr };
 
   // A non-trivial sync-locked group is a maximal sub-sequence of the tracks
   // consisting of any positive number of audio tracks followed by zero or
   // more label tracks.
 
   // Step back through any label tracks.
   auto member = pMember;
   while (member && ( nullptr != track_cast<const LabelTrack*>(member) )) {
      member = GetPrev(member);
   }
 
   // Step back through the wave and note tracks before the label tracks.
   Track *first = nullptr;
   while (member && IsSyncLockableNonLabelTrack(member)) {
      first = member;
      member = GetPrev(member);
   }
 
   if (!first)
      // Can't meet the criteria described above.  In that case,
      // consider the track to be the sole member of a group.
      return { pMember, pMember };
 
   Track *last = first;
   bool inLabels = false;
 
   while (const auto next = GetNext(last)) {
      if ( ! IsGoodNextSyncLockTrack(next, inLabels) )
         break;
      last = next;
      inLabels = (nullptr != track_cast<const LabelTrack*>(last) );
   }
 
   return { first, last };
}

References GetNext(), GetPrev(), anonymous_namespace{Track.cpp}::IsGoodNextSyncLockTrack(), and anonymous_namespace{Track.cpp}::IsSyncLockableNonLabelTrack().

Here is the call graph for this function:

Get() [1/2]

TrackList & TrackList::Get ( AudacityProject &  project )

static

Definition at line 495 of file Track.cpp.

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

References key.

Referenced by ProjectFileManager::AddImportedTracks(), SelectHandle::AdjustSelection(), AdornedRulerPanel::AdornedRulerPanel(), AnyTracksSelectedPred(), AppendItem(), ImportCommand::Apply(), ScreenshotCommand::Apply(), SelectTimeCommand::Apply(), SelectTracksCommand::Apply(), SetLabelCommand::Apply(), SetTrackBase::Apply(), AudioTracksSelectedFlag(), TrackSelectHandle::CalculateRearrangingThresholds(), TrackPanelResizeHandle::Cancel(), ProjectAudioManager::CancelRecording(), Exporter::CheckMix(), ProjectAudioManager::ChooseExistingRecordingTracks(), ButtonHandle::Click(), TrackPanelResizeHandle::Click(), LabelDefaultClickHandle::Click(), LabelTextHandle::Click(), SelectHandle::Click(), TimeShiftHandle::Click(), BackgroundHandle::Click(), CutCopyAvailableFlag(), DefaultPlayOptions(), DefaultSpeedPlayOptions(), 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(), SelectHandle::Drag(), TimeShiftHandle::Drag(), TrackSelectHandle::Drag(), EditableTracksSelectedPred(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), UndoManager::EstimateRemovedBlocks(), EVT_MENU_RANGE(), 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(), ProjectFileIO::GenerateDoc(), Get(), GetAllSeqBlocks(), FrequencyPlotDialog::GetAudio(), ContrastDialog::GetDB(), GetPropertiesOfSelected(), CompareAudioCommand::GetSelection(), SliderHandle::GetSlider(), ScreenshotCommand::GetTrackRect(), TrackPanelAx::GetTracks(), ProjectWindow::GetZoomOfToFit(), 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(), ODTask::IsTaskAssociatedWithProject(), anonymous_namespace{LabelMenus.cpp}::LabelsSelectedFlag(), LabelTracksExistFlag(), AdornedRulerPanel::LockPlayRegion(), LOFImportFileHandle::lofOpenFiles(), MixerBoard::MixerBoard(), ProjectHistory::ModifyState(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), TrackActions::Handler::MuteTracks(), anonymous_namespace{SelectMenus.cpp}::NearestZeroCrossing(), NoteTracksExistFlag(), NoteTracksSelectedFlag(), ApplyMacroDialog::OnApplyToFiles(), ProjectAudioManager::OnAudioIOStopRecording(), 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(), TrackActions::Handler::OnNewLabelTrack(), TrackActions::Handler::OnNewStereoTrack(), TrackActions::Handler::OnNewTimeTrack(), TrackActions::Handler::OnNewWaveTrack(), EditActions::Handler::OnPaste(), LabelEditActions::Handler::OnPasteNewLabel(), FileActions::Handler::OnPrint(), ProjectAudioManager::OnRecord(), EditActions::Handler::OnRedo(), TrackActions::Handler::OnResample(), 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::OpenFile(), ProjectManager::OpenFiles(), anonymous_namespace{ProjectWindow.cpp}::MouseWheelHandler::operator()(), TimeTrack::PasteInto(), PlayableTracksExistFlag(), TranscriptionToolBar::PlayAtSpeed(), ProjectAudioManager::PlayPlayRegion(), ProjectHistory::PopState(), TrackSelectHandle::Preview(), NyquistEffect::Process(), TrackPanel::ProcessUIHandleResult(), ProjectHistory::PushState(), ProjectFileManager::ReadProjectFile(), ProjectHistory::RedoAvailable(), ProjectWindow::RedrawProject(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), SpectrumVZoomHandle::Release(), WaveformVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), LabelDefaultClickHandle::RestoreState(), ProjectFileIO::SaveCopy(), LabelDefaultClickHandle::SaveState(), ProjectWindow::ScrollingLowerBoundTime(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), SelectUtilities::SelectNone(), GetInfoCommand::SendClips(), GetInfoCommand::SendEnvelopes(), GetInfoCommand::SendLabels(), GetInfoCommand::SendTracks(), TrackFocus::Set(), ProjectAudioManager::SetupCutPreviewTracks(), ScreenshotBigDialog::SizeTracks(), ProjectWindow::SkipEnd(), WaveTrackMenuTable::SplitStereo(), ProjectSelectionManager::SSBL_GetRate(), StereoRequiredFlag(), TracksExistFlag(), ProjectHistory::UndoAvailable(), LyricsPanel::UpdateLyrics(), ProjectSettings::UpdatePrefs(), WaveTracksExistFlag(), WaveTracksSelectedFlag(), ProjectFileIO::WriteXML(), ProjectWindow::ZoomAfterImport(), ZoomInAvailableFlag(), ZoomOutAvailableFlag(), and InvisibleTemporaryProject::~InvisibleTemporaryProject().

Get() [2/2]

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

static

Definition at line 500 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 1603 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 1600 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 1026 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(), LOFImportFileHandle::doDurationAndScrollOffset(), ExportMultipleDialog::ExportMultipleByLabel(), AdornedRulerPanel::HandleQPRelease(), AudacityPrintout::OnPrintPage(), anonymous_namespace{ProjectWindow.cpp}::MouseWheelHandler::operator()(), AdornedRulerPanel::StartQPPlay(), and AdornedRulerPanel::UpdateQuickPlayPos().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMinOffset()

double TrackList::GetMinOffset

(

)

const

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

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

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

Referenced by CanMoveDown(), FindSyncLockGroup(), 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 1608 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 1298 of file Track.h.

{ return mOwner; }

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

Here is the caller graph for this function:

GetOwner() [2/2]

const AudacityProject* TrackList::GetOwner ( ) const

inline

Definition at line 1299 of file Track.h.

{ return mOwner; }

GetPrev()

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

private

Definition at line 843 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->GetLinked() && t->GetLink() )
               // 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)->GetLinked() && (*node.first)->GetLink() )
                  node = prev;
            }
 
            return node.first->get();
         }
      }
   }
 
   return nullptr;
}

References Track::GetLink(), Track::GetLinked(), Track::GetNode(), getPrev(), and isNull().

Referenced by CanMoveUp(), FindSyncLockGroup(), 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 1618 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 1021 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::HandleQPRelease(), and AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

GroupChannels()

void TrackList::GroupChannels	(	Track &	track,
		size_t	groupSize,
		bool	resetChannels = true
	)

Define a group of channels starting at the given track.

Parameters

track	and (groupSize - 1) following tracks must be in this list. They will be disassociated from any groups they already belong to.
groupSize	must be at least 1.
resetChannels	if true, disassociated channels will be marked Mono.

Definition at line 707 of file Track.cpp.

{
   // If group size is exactly two, group as stereo, else mono (bug 2195).
   auto list = track.mList.lock();
   if ( groupSize > 0 && list.get() == this  ) {
      auto iter = track.mNode.first;
      auto after = iter;
      auto end = this->ListOfTracks::end();
      auto count = groupSize;
      for ( ; after != end && count; ++after, --count )
         ;
      if ( count == 0 ) {
         auto unlink = [&] ( Track &tr ) {
            if ( tr.GetLinked() ) {
               if ( resetChannels ) {
                  auto link = tr.GetLink();
                  if ( link )
                     link->SetChannel( Track::MonoChannel );
               }
               tr.SetLinked( false );
            }
            if ( resetChannels )
               tr.SetChannel( Track::MonoChannel );
         };
 
         // Disassociate previous tracks -- at most one
         auto pLeader = this->FindLeader( &track );
         if ( *pLeader && *pLeader != &track )
            unlink( **pLeader );
 
         // First disassociate given and later tracks, then reassociate them
         for ( auto iter2 = iter; iter2 != after; ++iter2 )
             unlink( **iter2 );
 
         if ( groupSize > 1 ) {
            const auto channel = *iter++;
            channel->SetLinked( groupSize == 2 );
            channel->SetChannel( groupSize == 2? Track::LeftChannel : Track::MonoChannel );
            (*iter++)->SetChannel( groupSize == 2? Track::RightChannel : Track::MonoChannel );
            while (iter != after)
               (*iter++)->SetChannel( Track::MonoChannel );
         }
         return;
      }
   }
   // *this does not contain the track or sufficient following channels
   // or group size is zero
   THROW_INCONSISTENCY_EXCEPTION;
}

References end(), FindLeader(), Track::LeftChannel, Track::mList, Track::mNode, Track::MonoChannel, Track::RightChannel, and THROW_INCONSISTENCY_EXCEPTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

HasPendingTracks()

bool TrackList::HasPendingTracks

(

)

const

Definition at line 1289 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 1597 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 1388 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 -> typename std::enable_if< std::is_const<TrackType>::value, TrackIterRange< TrackType > >::type

inline

Definition at line 1395 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 1523 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(), SelectHandle::Click(), ButtonHandle::Drag(), LabelTextHandle::Drag(), NoteTrackVZoomHandle::Drag(), SpectrumVZoomHandle::Drag(), WaveformVZoomHandle::Drag(), TimeTrackVZoomHandle::Drag(), SelectHandle::Drag(), SliderHandle::GetSlider(), TrackPanel::ProcessUIHandleResult(), ButtonHandle::Release(), LabelTextHandle::Release(), NoteTrackButtonHandle::Release(), NoteTrackVZoomHandle::Release(), SpectrumVZoomHandle::Release(), WaveformVZoomHandle::Release(), TimeTrackVZoomHandle::Release(), and LabelDefaultClickHandle::RestoreState().

Here is the caller graph for this function:

MakeTrackIterator()

template<typename TrackType >

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

inlineprivate

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

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

MoveDown()

bool TrackList::MoveDown

(

Track *

t

)

Definition at line 965 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 952 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 600 of file Track.cpp.

{
   // wxWidgets will own the event object
   QueueEvent( safenew TrackListEvent{ EVT_TRACKLIST_PERMUTED, *node.first } );
}

References safenew.

Referenced by Permute(), and SwapNodes().

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 657 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:

RecalcPositions()

void TrackList::RecalcPositions ( TrackNodePointer  node )

private

Definition at line 553 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 1032 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
      pTrack->mpView = src->mpView;
      pTrack->mpControls = src->mpControls;
   }
 
   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(), Track::mpControls, mPendingUpdates, Track::mpView, 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 1054 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 780 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 758 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 623 of file Track.cpp.

{
   // wxWidgets will own the event object
   QueueEvent( safenew TrackListEvent{ EVT_TRACKLIST_RESIZING, *node.first } );
}

References safenew.

Selected() [1/2]

template<typename TrackType = Track>

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

inline

Definition at line 1371 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(), NoteTracksSelectedFlag(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), EffectFindClipping::Process(), EffectNoiseReduction::Worker::Process(), EffectTruncSilence::ProcessAll(), ProjectAudioManager::SetupCutPreviewTracks(), 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 -> typename std::enable_if< std::is_const<TrackType>::value, TrackIterRange< TrackType > >::type

inline

Definition at line 1378 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 1405 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 -> typename std::enable_if< std::is_const<TrackType>::value, TrackIterRange< TrackType > >::type

inline

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

{
   // wxWidgets will own the event object
   QueueEvent(
      safenew TrackListEvent{ EVT_TRACKLIST_SELECTION_CHANGE, pTrack } );
}

References safenew.

SingletonRange()

template<typename TrackType >

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

inlinestatic

Definition at line 1422 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 988 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 528 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 893 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:

SyncLockGroup() [1/2]

static TrackIterRange< const Track > TrackList::SyncLockGroup ( const Track *  pTrack )

inlinestatic

Definition at line 1434 of file Track.h.

   {
      return SyncLockGroup(const_cast<Track*>(pTrack)).Filter<const Track>();
   }

SyncLockGroup() [2/2]

auto TrackList::SyncLockGroup ( Track *  pTrack )

static

Definition at line 639 of file Track.cpp.

{
   auto pList = pTrack->GetOwner();
   auto tracks =
      pList->FindSyncLockGroup( const_cast<Track*>( pTrack ) );
   return pList->Any().StartingWith(tracks.first).EndingAfter(tracks.second);
}

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

Referenced by ClipMoveState::Init(), Track::IsSyncLockSelected(), NyquistEffect::Process(), EffectTruncSilence::ProcessIndependently(), NyquistEffect::ProcessOne(), StretchHandle::Release(), and SelectionState::SelectTrackLength().

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 1550 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 -> typename std::enable_if< std::is_const<TrackType>::value, TrackIterRange< TrackType > >::type

inlineprivate

Definition at line 1563 of file Track.h.

                                      {} ) const
         -> typename std::enable_if< std::is_const<TrackType>::value,
            TrackIterRange< TrackType >
         >::type
   {
      auto b = const_cast<TrackList*>(this)->getBegin();
      auto e = const_cast<TrackList*>(this)->getEnd();
      return { { b, b, e, pred }, { b, e, e, pred } };
   }

UpdatePendingTracks()

void TrackList::UpdatePendingTracks

(

)

Definition at line 1060 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->DoSetLinked(src->GetLinked());
      }
      ++pUpdater;
   }
}

References FindById(), mPendingUpdates, and mUpdaters.

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

Member Data Documentation

mOwner

AudacityProject* TrackList::mOwner

private

Definition at line 1692 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 1696 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 1698 of file Track.h.

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

sCounter

long TrackList::sCounter = -1

staticprivate

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