Track Class Reference

Abstract base class for an object holding data associated with points on a time axis. More...

#include <Track.h>

Inheritance diagram for Track:

Collaboration diagram for Track:

Classes
struct	Dispatcher
	Helper for recursive case of metafunction implementing Track::TypeSwitch. More...
struct	Executor
	Variadic template implements metafunction with specializations, to dispatch Track::TypeSwitch. More...
struct	Executor< R, ConcreteType >
	Base case of metafunction implementing Track::TypeSwitch generates operator () with nonvoid return. More...
struct	Executor< R, ConcreteType, Function, Functions... >
	Implements Track::TypeSwitch, its operator() invokes the first function that can accept ConcreteType*. More...
struct	Executor< R, const ConcreteType, Function, Functions... >
	Implements const overload of Track::TypeSwitch, its operator() invokes the first function that can accept ConcreteType*. More...
struct	Executor< void, ConcreteType >
	Base case of metafunction implementing Track::TypeSwitch generates operator () with void return. More...

Public Types
using	AttachedObjects = ::AttachedTrackObjects
	Alias for my base type. More...
using	ChannelType = XMLValueChecker::ChannelType
using	IntervalData = TrackIntervalData
using	Interval = TrackInterval
using	Intervals = std::vector< Interval >
using	ConstInterval = ConstTrackInterval
using	ConstIntervals = std::vector< ConstInterval >
using	Holder = std::shared_ptr< Track >
template<typename R = void>
using	Continuation = std::function< R() >
	Type of arguments passed as optional second parameter to TypeSwitch() cases. More...
using	Fallthrough = Continuation<>
	Type of arguments passed as optional second parameter to TypeSwitch<void>() cases. More...
Public Types inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
using	DataType = ClientData
using	DataPointer = Pointer< ClientData >
using	DataFactory = std::function< DataPointer(Host &) >
	Type of function from which RegisteredFactory is constructed; it builds attachments. More...

Public Member Functions
TrackId	GetId () const
template<typename Subclass = Track>
std::shared_ptr< Subclass >	SharedPointer ()
template<typename Subclass = const Track>
auto	SharedPointer () const -> typename std::enable_if< std::is_const< Subclass >::value, std::shared_ptr< Subclass > >::type
std::shared_ptr< Track >	SubstitutePendingChangedTrack ()
std::shared_ptr< const Track >	SubstitutePendingChangedTrack () const
std::shared_ptr< const Track >	SubstituteOriginalTrack () const
virtual bool	SupportsBasicEditing () const
	Whether this track type implements cut-copy-paste; by default, true. More...
virtual Holder	PasteInto (AudacityProject &) const =0
	Find or create the destination track for a paste, maybe in a different project. More...
virtual ConstIntervals	GetIntervals () const
	Report times on the track where important intervals begin and end, for UI to snap to. More...
virtual Intervals	GetIntervals ()
const std::shared_ptr< CommonTrackCell > &	GetTrackView ()
void	SetTrackView (const std::shared_ptr< CommonTrackCell > &pView)
const std::shared_ptr< CommonTrackCell > &	GetTrackControls ()
void	SetTrackControls (const std::shared_ptr< CommonTrackCell > &pControls)
int	GetIndex () const
void	SetIndex (int index)
bool	LinkConsistencyCheck ()
bool	HasOwner () const
std::shared_ptr< TrackList >	GetOwner () const
	Track ()
	Track (const Track &orig)
virtual	~ Track ()
void	Init (const Track &orig)
virtual Holder	Duplicate () const
virtual void	Merge (const Track &orig)
wxString	GetName () const
void	SetName (const wxString &n)
wxString	GetDefaultName () const
void	SetDefaultName (const wxString &n)
bool	GetSelected () const
virtual void	SetSelected (bool s)
void	EnsureVisible (bool modifyState=false)
virtual ChannelType	GetChannel () const
virtual double	GetOffset () const =0
void	Offset (double t)
virtual void	SetOffset (double o)
virtual void	SetPan (float)
virtual void	SetPanFromChannelType ()
virtual Holder	Cut (double WXUNUSED(t0), double WXUNUSED(t1))=0
virtual Holder	Copy (double WXUNUSED(t0), double WXUNUSED(t1), bool forClipboard=true) const =0
virtual void	Clear (double WXUNUSED(t0), double WXUNUSED(t1))=0
virtual void	Paste (double WXUNUSED(t), const Track *WXUNUSED(src))=0
virtual void	SyncLockAdjust (double oldT1, double newT1)
virtual void	Silence (double WXUNUSED(t0), double WXUNUSED(t1))=0
virtual void	InsertSilence (double WXUNUSED(t), double WXUNUSED(len))=0
bool	SameKindAs (const Track &track) const
template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions)
	Use this function rather than testing track type explicitly and making down-casts. More...
template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions) const
	Use this function rather than testing track type explicitly and making down-casts. More...
virtual void	WriteXML (XMLWriter &xmlFile) const =0
virtual bool	GetErrorOpening ()
virtual double	GetStartTime () const =0
virtual double	GetEndTime () const =0
bool	IsSyncLockSelected () const
void	Notify (int code=-1)
bool	Any () const
bool	IsSelected () const
bool	IsSelectedOrSyncLockSelected () const
bool	IsLeader () const
bool	IsSelectedLeader () const
void	AdjustPositions ()
void	WriteCommonXMLAttributes (XMLWriter &xmlFile, bool includeNameAndSelected=true) const
bool	HandleCommonXMLAttribute (const wxChar *attr, const wxChar *value)
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const wxChar *tag, const wxChar **attrs)=0
virtual void	HandleXMLEndTag (const wxChar *WXUNUSED(tag))
virtual void	HandleXMLContent (const wxString &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const wxChar *tag)=0
bool	ReadXMLTag (const char *tag, const char **attrs)
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)
Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
	~Site ()
	Site ()
	Site (const Site &other)
Site &	operator= (const Site &other)
	Site (Site &&other)
Site &	operator= (Site &&other)
size_t	size () const
	How many attachment pointers are in the Site. More...
template<typename Subclass = ClientData>
Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...
template<typename Subclass = const ClientData>
auto	Get (const RegisteredFactory &key) const -> typename std::enable_if< std::is_const< Subclass >::value, Subclass & >::type
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...
template<typename Subclass = ClientData>
Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...
template<typename Subclass = const ClientData>
auto	Find (const RegisteredFactory &key) const -> typename std::enable_if< std::is_const< Subclass >::value, Subclass * >::type
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...
template<typename ReplacementPointer >
void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...

Static Public Member Functions
template<typename Subclass = Track>
static std::shared_ptr< Subclass >	SharedPointer (Track *pTrack)
template<typename Subclass = const Track>
static std::shared_ptr< Subclass >	SharedPointer (const Track *pTrack)
static void	FinishCopy (const Track *n, Track *dest)
Static Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
static size_t	slots ()
	How many static factories have been registered with this specialization of Site. More...

Public Attributes
wxSize	vrulerSize

Static Public Attributes
static const auto	LeftChannel = XMLValueChecker::LeftChannel
static const auto	RightChannel = XMLValueChecker::RightChannel
static const auto	MonoChannel = XMLValueChecker::MonoChannel

Protected Attributes
std::weak_ptr< TrackList >	mList
TrackNodePointer	mNode {}
	Holds iterator to self, so that TrackList::Find can be constant-time. More...
int	mIndex
	0-based position of this track in its TrackList More...
wxString	mName
wxString	mDefaultName
bool	mLinked
ChannelType	mChannel
double	mOffset
std::shared_ptr< CommonTrackCell >	mpView
std::shared_ptr< CommonTrackCell >	mpControls

Private Member Functions
void	SetId (TrackId id)
Track *	GetLink () const
bool	GetLinked () const
void	SetLinked (bool l)
void	SetChannel (ChannelType c)
void	DoSetLinked (bool l)
TrackNodePointer	GetNode () const
	Retrieve mNode with debug checks. More...
void	SetOwner (const std::weak_ptr< TrackList > &list, TrackNodePointer node)
	Update mNode when Track is added to TrackList, or removed from it. More...
virtual Holder	Clone () const =0
virtual TrackKind	GetKind () const

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

Friends
class	TrackList
template<typename T >
std::enable_if< std::is_pointer< T >::value, T >::type	track_cast (Track *track)
	Encapsulate the checked down-casting of track pointers. More...
template<typename T >
std::enable_if< std::is_pointer< T >::value &&std::is_const< typename std::remove_pointer< T >::type >::value, T >::type	track_cast (const Track *track)
	Encapsulate the checked down-casting of track pointers. More...

Additional Inherited Members
Protected Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
template<typename Function >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in this. More...
template<typename Function >
void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in this. More...
template<typename Function >
ClientData *	FindIf (const Function &function)
	Return pointer to first attachment in this that is not null and satisfies a predicate, or nullptr. More...
template<typename Function >
const ClientData *	FindIf (const Function &function) const
	Return pointer to first attachment in this that is not null and satisfies a predicate, or nullptr. More...
void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in this, build and store it. More...

Detailed Description

Abstract base class for an object holding data associated with points on a time axis.

Fundamental data object of Audacity, displayed in the TrackPanel. Classes derived form it include the WaveTrack, NoteTrack, LabelTrack and TimeTrack.

Definition at line 235 of file Track.h.

Member Typedef Documentation

AttachedObjects

using Track::AttachedObjects = ::AttachedTrackObjects

Alias for my base type.

Definition at line 263 of file Track.h.

ChannelType

using Track::ChannelType = XMLValueChecker::ChannelType

Definition at line 264 of file Track.h.

ConstInterval

using Track::ConstInterval = ConstTrackInterval

Definition at line 319 of file Track.h.

ConstIntervals

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

Definition at line 320 of file Track.h.

Continuation

template<typename R = void>

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

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

Definition at line 486 of file Track.h.

Fallthrough

using Track::Fallthrough = Continuation<>

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

Definition at line 488 of file Track.h.

Holder

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

Definition at line 325 of file Track.h.

Interval

using Track::Interval = TrackInterval

Definition at line 317 of file Track.h.

IntervalData

using Track::IntervalData = TrackIntervalData

Definition at line 316 of file Track.h.

Intervals

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

Definition at line 318 of file Track.h.

Constructor & Destructor Documentation

Track() [1/2]

Track::Track

(

)

Definition at line 49 of file Track.cpp.

:  vrulerSize(36,0)
{
   mSelected  = false;
   mLinked    = false;
 
   mIndex = 0;
 
   mOffset = 0.0;
 
   mChannel = MonoChannel;
}

References mChannel, mIndex, mLinked, mOffset, MonoChannel, and mSelected.

Track() [2/2]

Track::Track

(

const Track &

orig

)

Definition at line 62 of file Track.cpp.

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

References Init(), mIndex, and mOffset.

Here is the call graph for this function:

~ Track()

virtual Track::~ Track ( )

virtual

Member Function Documentation

AdjustPositions()

void Track::AdjustPositions

(

)

Definition at line 1278 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList) {
      pList->RecalcPositions(mNode);
      pList->ResizingEvent(mNode);
   }
}

References mList, and mNode.

Any()

bool Track::Any

(

)

const

Definition at line 361 of file Track.cpp.

   { return true; }

Referenced by EffectLoudness::AllocBuffers(), TrackList::Channels_(), ExportPlugin::CreateMixer(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), TrackList::EmptyRange(), Exporter::ExamineTracks(), ExportMixerDialog::ExportMixerDialog(), ProjectAudioManager::GetAllPlaybackTracks(), AUPImportFileHandle::HandleImport(), anonymous_namespace{ProjectFileManager.cpp}::ImportProject(), TrackActions::Handler::MuteTracks(), EditActions::Handler::OnPaste(), LabelEditActions::Handler::OnPasteNewLabel(), PlayableTracksExistFlag(), EffectLoudness::Process(), EffectNormalize::Process(), and ProjectWindow::ZoomAfterImport().

Here is the caller graph for this function:

Clear()

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

pure virtual

Referenced by LabelEditActions::Handler::OnDeleteLabels(), and SyncLockAdjust().

Here is the caller graph for this function:

Clone()

virtual Holder Track::Clone ( ) const

privatepure virtual

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

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

Here is the caller graph for this function:

Copy()

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

pure virtual

Cut()

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

pure virtual

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

DoSetLinked()

void Track::DoSetLinked ( bool  l )

private

Definition at line 194 of file Track.cpp.

{
   mLinked = l;
}

References mLinked.

Referenced by SetLinked().

Here is the caller graph for this function:

Duplicate()

Track::Holder Track::Duplicate ( ) const

virtual

Definition at line 113 of file Track.cpp.

{
   // invoke "virtual constructor" to copy track object proper:
   auto result = Clone();
 
   if (mpView)
      // Copy view state that might be important to undo/redo
      mpView->CopyTo( *result );
 
   return result;
}

References Clone(), and mpView.

Referenced by WaveTrackFactory::DuplicateWaveTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureVisible()

void Track::EnsureVisible

(

bool

modifyState = false

)

Definition at line 101 of file Track.cpp.

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

References mList, and SharedPointer().

Referenced by anonymous_namespace{LabelMenus.cpp}::DoAddLabel(), EffectUI::DoEffect(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), TrackUtilities::DoRemoveTracks(), TrackPanel::OnMouseEvent(), TrackActions::Handler::OnNewLabelTrack(), TrackActions::Handler::OnNewStereoTrack(), TrackActions::Handler::OnNewTimeTrack(), TrackActions::Handler::OnNewWaveTrack(), LabelEditActions::Handler::OnPasteNewLabel(), EditActions::Handler::OnRedo(), NavigationActions::Handler::OnToggle(), EditActions::Handler::OnUndo(), TrackPanel::ProcessUIHandleResult(), and ProjectWindow::ZoomAfterImport().

Here is the call graph for this function:

Here is the caller graph for this function:

FinishCopy()

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

static

Definition at line 376 of file Track.cpp.

{
   if (dest) {
      dest->SetChannel(n->GetChannel());
      dest->SetLinked(n->GetLinked());
      dest->SetName(n->GetName());
   }
}

References GetChannel(), GetLinked(), GetName(), SetChannel(), SetLinked(), and SetName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetChannel()

virtual ChannelType Track::GetChannel ( ) const

inlinevirtual

Reimplemented in WaveTrack.

Definition at line 425 of file Track.h.

{ return mChannel;}

Referenced by FinishCopy(), LinkConsistencyCheck(), and anonymous_namespace{NoteTrackControls.cpp}::MidiControlsDrawFunction().

Here is the caller graph for this function:

GetDefaultName()

wxString Track::GetDefaultName ( ) const

inline

Definition at line 412 of file Track.h.

{ return mDefaultName; }

Referenced by TimeTrack::CleanState(), TimeTrack::Init(), WaveTrack::Init(), LabelTrack::LabelTrack(), NoteTrack::NoteTrack(), and WaveTrack::WaveTrack().

Here is the caller graph for this function:

GetEndTime()

virtual double Track::GetEndTime ( ) const

pure virtual

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

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

Here is the caller graph for this function:

GetErrorOpening()

virtual bool Track::GetErrorOpening ( )

inlinevirtual

Reimplemented in WaveTrack.

Definition at line 783 of file Track.h.

{ return false; }

GetId()

TrackId Track::GetId ( ) const

inline

Definition at line 270 of file Track.h.

{ return mId; }

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

Here is the caller graph for this function:

GetIndex()

int Track::GetIndex

(

)

const

Definition at line 165 of file Track.cpp.

{
   return mIndex;
}

References mIndex.

Referenced by SelectionState::ChangeSelectionOnShiftClick(), TrackList::RecalcPositions(), and SelectionState::SelectRangeOfTracks().

Here is the caller graph for this function:

GetIntervals() [1/2]

auto Track::GetIntervals ( )

virtual

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

Reimplemented in WaveTrack, NoteTrack, and LabelTrack.

Definition at line 1237 of file Track.cpp.

{
   return {};
}

GetIntervals() [2/2]

auto Track::GetIntervals ( ) const

virtual

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

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

Reimplemented in WaveTrack, NoteTrack, and LabelTrack.

Definition at line 1232 of file Track.cpp.

{
   return {};
}

Referenced by TrackShifter::InitIntervals().

Here is the caller graph for this function:

GetKind()

virtual TrackKind Track::GetKind ( ) const

inlineprivatevirtual

Reimplemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

Definition at line 467 of file Track.h.

{ return TrackKind::None; }

References None.

Referenced by SameKindAs(), and track_cast().

Here is the caller graph for this function:

GetLink()

Track * Track::GetLink ( ) const

private

Definition at line 199 of file Track.cpp.

{
   auto pList = mList.lock();
   if (!pList)
      return nullptr;
 
   if (!pList->isNull(mNode)) {
      if (mLinked) {
         auto next = pList->getNext( mNode );
         if ( !pList->isNull( next ) )
            return next.first->get();
      }
 
      if (mNode.first != mNode.second->begin()) {
         auto prev = pList->getPrev( mNode );
         if ( !pList->isNull( prev ) ) {
            auto track = prev.first->get();
            if (track && track->GetLinked())
               return track;
         }
      }
   }
 
   return nullptr;
}

References mLinked, mList, and mNode.

Referenced by GetInfoCommand::ExploreTrackPanel(), TrackList::GetPrev(), IsLeader(), and LinkConsistencyCheck().

Here is the caller graph for this function:

GetLinked()

bool Track::GetLinked ( ) const

inlineprivate

Definition at line 372 of file Track.h.

{ return mLinked; }

Referenced by FinishCopy(), TrackList::GetNext(), TrackList::GetPrev(), IsLeader(), and LinkConsistencyCheck().

Here is the caller graph for this function:

GetName()

wxString Track::GetName ( ) const

inline

Definition at line 410 of file Track.h.

{ return mName; }

Referenced by LabelDialog::AddLabels(), CompareAudioCommand::Apply(), TrackInfo::CloseTitleDrawFunction(), TrackUtilities::DoMoveTrack(), TrackUtilities::DoRemoveTrack(), anonymous_namespace{TrackMenus.cpp}::DoSortTracks(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), FinishCopy(), MixerBoard::GetMusicalInstrumentBitmap(), anonymous_namespace{TrackPanel.cpp}::GetTrackNameExtent(), TimeTrack::Init(), WaveTrack::Init(), LinkConsistencyCheck(), MixAndRender(), WaveTrackMenuTable::OnMergeStereo(), TrackMenuTable::OnSetName(), anonymous_namespace{SpectrumView.cpp}::SpectrogramSettingsHandler::OnSpectrogramSettings(), WaveTrackMenuTable::OnSplitStereo(), WaveTrackMenuTable::OnSplitStereoMono(), WaveTrackMenuTable::OnSwapChannels(), EffectFindClipping::Process(), RateMenuTable::SetRate(), WaveTrackMenuTable::SplitStereo(), and WriteCommonXMLAttributes().

Here is the caller graph for this function:

GetNode()

TrackNodePointer Track::GetNode ( ) const

private

Retrieve mNode with debug checks.

Definition at line 130 of file Track.cpp.

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

References mList, and mNode.

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

Here is the caller graph for this function:

GetOffset()

virtual double Track::GetOffset ( ) const

pure virtual

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

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

Here is the caller graph for this function:

GetOwner()

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

inline

Definition at line 368 of file Track.h.

{ return mList.lock(); }

Referenced by TrackShifter::CommonMayMigrateTo().

Here is the caller graph for this function:

GetSelected()

bool Track::GetSelected ( ) const

inline

Definition at line 415 of file Track.h.

{ return mSelected; }

Referenced by ClipParameters::ClipParameters(), TrackInfo::CloseTitleDrawFunction(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), TrackArt::DrawBackgroundWithSelection(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), TrackInfo::DrawCloseButton(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), AudioIoCallback::FillOutputBuffers(), anonymous_namespace{ClipMenus.cpp}::FindClipBoundaries(), anonymous_namespace{ClipMenus.cpp}::FindClips(), SelectionState::HandleListSelection(), StretchHandle::HitTest(), IsSelected(), IsSelectedOrSyncLockSelected(), IsSyncLockSelected(), TrackInfo::MinimizeSyncLockDrawFunction(), anonymous_namespace{PlayableTrackControls.cpp}::MuteOrSoloDrawFunction(), EditActions::Handler::OnPaste(), NavigationActions::Handler::OnToggle(), EffectChangeSpeed::Process(), Generator::Process(), EffectRepeat::Process(), EffectSBSMS::Process(), Effect::ProcessPass(), TrackPanelAx::SetFocus(), LabelTrack::SetSelected(), and WriteCommonXMLAttributes().

Here is the caller graph for this function:

GetStartTime()

virtual double Track::GetStartTime ( ) const

pure virtual

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

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

Here is the caller graph for this function:

GetTrackControls()

const std::shared_ptr< CommonTrackCell > & Track::GetTrackControls

(

)

Definition at line 155 of file Track.cpp.

{
   return mpControls;
}

References mpControls.

Referenced by CommonTrackControls::TrackControls().

Here is the caller graph for this function:

GetTrackView()

const std::shared_ptr< CommonTrackCell > & Track::GetTrackView

(

)

Definition at line 145 of file Track.cpp.

{
   return mpView;
}

References mpView.

Referenced by TrackView::Get().

Here is the caller graph for this function:

HandleCommonXMLAttribute()

bool Track::HandleCommonXMLAttribute	(	const wxChar *	attr,
		const wxChar *	value
	)

Definition at line 1257 of file Track.cpp.

{
   long nValue = -1;
   wxString strValue( value );
   if ( mpView && mpView->HandleXMLAttribute( attr, value ) )
      ;
   else if ( mpControls && mpControls->HandleXMLAttribute( attr, value ) )
      ;
   else if (!wxStrcmp(attr, wxT("name")) &&
      XMLValueChecker::IsGoodString(strValue)) {
      SetName( strValue );
      return true;
   }
   else if (!wxStrcmp(attr, wxT("isSelected")) &&
         XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue)) {
      this->SetSelected(nValue != 0);
      return true;
   }
   return false;
}

References XMLValueChecker::IsGoodInt(), XMLValueChecker::IsGoodString(), mpControls, mpView, SetName(), and SetSelected().

Referenced by LabelTrack::HandleXMLTag(), NoteTrack::HandleXMLTag(), TimeTrack::HandleXMLTag(), and WaveTrack::HandleXMLTag().

Here is the call graph for this function:

Here is the caller graph for this function:

HasOwner()

bool Track::HasOwner ( ) const

inline

Definition at line 366 of file Track.h.

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

References TrackList::GetOwner().

Here is the call graph for this function:

Init()

void Track::Init

(

const Track &

orig

)

Definition at line 71 of file Track.cpp.

{
   mId = orig.mId;
 
   mDefaultName = orig.mDefaultName;
   mName = orig.mName;
 
   mSelected = orig.mSelected;
   mLinked = orig.mLinked;
   mChannel = orig.mChannel;
}

References mChannel, mDefaultName, mId, mLinked, mName, and mSelected.

Referenced by PlayableTrack::Init(), TimeTrack::Init(), and Track().

Here is the caller graph for this function:

InsertSilence()

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

pure virtual

IsLeader()

bool Track::IsLeader

(

)

const

Definition at line 370 of file Track.cpp.

   { return !GetLink() || GetLinked(); }

References GetLink(), and GetLinked().

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsSelected()

bool Track::IsSelected

(

)

const

Definition at line 364 of file Track.cpp.

   { return GetSelected(); }

References GetSelected().

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsSelectedLeader()

bool Track::IsSelectedLeader

(

)

const

Definition at line 373 of file Track.cpp.

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

References IsLeader(), and IsSelected().

Referenced by TrackList::SelectedLeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

IsSelectedOrSyncLockSelected()

bool Track::IsSelectedOrSyncLockSelected

(

)

const

Definition at line 367 of file Track.cpp.

   { return GetSelected() || IsSyncLockSelected(); }

References GetSelected(), and IsSyncLockSelected().

Referenced by anonymous_namespace{TrackMenus.cpp}::DoAlign(), EffectTruncSilence::DoRemoval(), EditActions::Handler::OnCut(), and EffectReverse::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

IsSyncLockSelected()

bool Track::IsSyncLockSelected

(

)

const

Definition at line 245 of file Track.cpp.

{
#ifdef EXPERIMENTAL_SYNC_LOCK
   auto pList = mList.lock();
   if (!pList)
      return false;
 
   auto p = pList->GetOwner();
   if (!p || !ProjectSettings::Get( *p ).IsSyncLocked())
      return false;
 
   auto shTrack = this->SubstituteOriginalTrack();
   if (!shTrack)
      return false;
 
   const auto pTrack = shTrack.get();
   auto trackRange = TrackList::SyncLockGroup( pTrack );
 
   if (trackRange.size() <= 1) {
      // Not in a sync-locked group.
      // Return true iff selected and of a sync-lockable type.
      return (IsSyncLockableNonLabelTrack( pTrack ) ||
              track_cast<const LabelTrack*>( pTrack )) && GetSelected();
   }
 
   // Return true iff any track in the group is selected.
   return *(trackRange + &Track::IsSelected).begin();
#endif
 
   return false;
}

References ProjectSettings::Get(), GetSelected(), IsSelected(), anonymous_namespace{Track.cpp}::IsSyncLockableNonLabelTrack(), ProjectSettings::IsSyncLocked(), mList, SubstituteOriginalTrack(), and TrackList::SyncLockGroup().

Referenced by ClipParameters::ClipParameters(), TrackArt::DrawBackgroundWithSelection(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), IsSelectedOrSyncLockSelected(), TrackInfo::MinimizeSyncLockDrawFunction(), EditActions::Handler::OnPaste(), SelectActions::Handler::OnSelectSyncLockSel(), EffectChangeSpeed::Process(), EffectRepeat::Process(), and EffectSBSMS::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

LinkConsistencyCheck()

bool Track::LinkConsistencyCheck

(

)

Definition at line 386 of file Track.cpp.

{
   // Sanity checks for linked tracks; unsetting the linked property
   // doesn't fix the problem, but it likely leaves us with orphaned
   // sample blocks instead of much worse problems.
   bool err = false;
   if (GetLinked())
   {
      Track *l = GetLink();
      if (l)
      {
         // A linked track's partner should never itself be linked
         if (l->GetLinked())
         {
            wxLogWarning(
               wxT("Left track %s had linked right track %s with extra right track link.\n   Removing extra link from right track."),
               GetName(), l->GetName());
            err = true;
            l->SetLinked(false);
         }
 
         // Channels should be left and right
         if ( !(  (GetChannel() == Track::LeftChannel &&
                     l->GetChannel() == Track::RightChannel) ||
                  (GetChannel() == Track::RightChannel &&
                     l->GetChannel() == Track::LeftChannel) ) )
         {
            wxLogWarning(
               wxT("Track %s and %s had left/right track links out of order. Setting tracks to not be linked."),
               GetName(), l->GetName());
            err = true;
            SetLinked(false);
         }
      }
      else
      {
         wxLogWarning(
            wxT("Track %s had link to NULL track. Setting it to not be linked."),
            GetName());
         err = true;
         SetLinked(false);
      }
   }
 
   return ! err;
}

References GetChannel(), GetLink(), GetLinked(), GetName(), LeftChannel, RightChannel, and SetLinked().

Here is the call graph for this function:

Merge()

void Track::Merge ( const Track &  orig )

virtual

Reimplemented in WaveTrack, and PlayableTrack.

Definition at line 108 of file Track.cpp.

{
   mSelected = orig.mSelected;
}

References mSelected.

Referenced by PlayableTrack::Merge().

Here is the caller graph for this function:

Notify()

void Track::Notify

(

int

code = -1

)

Definition at line 277 of file Track.cpp.

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

References mList, and SharedPointer().

Referenced by WaveTrack::SetGain(), PlayableTrack::SetMute(), SetName(), WaveTrack::SetPan(), and PlayableTrack::SetSolo().

Here is the call graph for this function:

Here is the caller graph for this function:

Offset()

void Track::Offset ( double  t )

inline

Definition at line 428 of file Track.h.

{ SetOffset(GetOffset() + t); }

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

Here is the caller graph for this function:

Paste()

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

pure virtual

Referenced by SyncLockAdjust().

Here is the caller graph for this function:

PasteInto()

virtual Holder Track::PasteInto ( AudacityProject &  ) const

pure virtual

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

Returns

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

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

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

Here is the caller graph for this function:

SameKindAs()

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

inline

Definition at line 481 of file Track.h.

      { return GetKind() == track.GetKind(); }

References GetKind().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetChannel()

void Track::SetChannel ( ChannelType  c )

inlineprivate

Definition at line 377 of file Track.h.

{ mChannel = c; }

Referenced by FinishCopy().

Here is the caller graph for this function:

SetDefaultName()

void Track::SetDefaultName ( const wxString &  n )

inline

Definition at line 413 of file Track.h.

{ mDefaultName = n; }

Referenced by TimeTrack::CleanState(), TimeTrack::Init(), WaveTrack::Init(), LabelTrack::LabelTrack(), NoteTrack::NoteTrack(), and WaveTrack::WaveTrack().

Here is the caller graph for this function:

SetId()

void Track::SetId ( TrackId  id )

inlineprivate

Definition at line 272 of file Track.h.

{ mId = id; }

References id.

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

Here is the caller graph for this function:

SetIndex()

void Track::SetIndex

(

int

index

)

Definition at line 170 of file Track.cpp.

{
   mIndex = index;
}

References mIndex.

Referenced by TrackList::RecalcPositions().

Here is the caller graph for this function:

SetLinked()

void Track::SetLinked ( bool  l )

private

Definition at line 175 of file Track.cpp.

{
   auto pList = mList.lock();
   if (pList && !pList->mPendingUpdates.empty()) {
      auto orig = pList->FindById( GetId() );
      if (orig && orig != this) {
         orig->SetLinked(l);
         return;
      }
   }
 
   DoSetLinked(l);
 
   if (pList) {
      pList->RecalcPositions(mNode);
      pList->ResizingEvent(mNode);
   }
}

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

Referenced by FinishCopy(), WaveTrack::HandleXMLTag(), and LinkConsistencyCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

SetName()

void Track::SetName

(

const wxString &

n

)

Definition at line 83 of file Track.cpp.

{
   if ( mName != n ) {
      mName = n;
      Notify();
   }
}

References mName, and Notify().

Referenced by Effect::AddedAnalysisTrack::AddedAnalysisTrack(), SetTrackStatusCommand::ApplyInner(), TimeTrack::CleanState(), FinishCopy(), HandleCommonXMLAttribute(), ImportMIDI(), TimeTrack::Init(), WaveTrack::Init(), LabelTrack::LabelTrack(), Effect::ModifiedAnalysisTrack::ModifiedAnalysisTrack(), NoteTrack::NoteTrack(), and WaveTrack::WaveTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

SetOffset()

virtual void Track::SetOffset ( double  o )

inlinevirtual

Reimplemented in TimeTrack, WaveTrack, and LabelTrack.

Definition at line 429 of file Track.h.

{ mOffset = o; }

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

Here is the caller graph for this function:

SetOwner()

void Track::SetOwner ( const std::weak_ptr< TrackList > &  list, TrackNodePointer  node  )

private

Update mNode when Track is added to TrackList, or removed from it.

Definition at line 136 of file Track.cpp.

{
   // BUG: When using this function to clear an owner, we may need to clear
   // focused track too.  Otherwise focus could remain on an invisible (or deleted) track.
   mList = list;
   mNode = node;
}

References mList, and mNode.

Referenced by TrackList::DoAdd(), TrackList::DoAddToHead(), TrackList::Permute(), TrackList::RegisterPendingChangedTrack(), TrackList::Remove(), TrackList::Replace(), and TrackList::SwapNodes().

Here is the caller graph for this function:

SetPan()

virtual void Track::SetPan ( float  )

inlinevirtual

Reimplemented in WaveTrack.

Definition at line 431 of file Track.h.

{ ;}

Referenced by SetTrackAudioCommand::ApplyInner().

Here is the caller graph for this function:

SetPanFromChannelType()

virtual void Track::SetPanFromChannelType ( )

inlinevirtual

Reimplemented in WaveTrack.

Definition at line 432 of file Track.h.

{ ;};

SetSelected()

void Track::SetSelected ( bool  s )

virtual

Reimplemented in LabelTrack.

Definition at line 91 of file Track.cpp.

{
   if (mSelected != s) {
      mSelected = s;
      auto pList = mList.lock();
      if (pList)
         pList->SelectionEvent( SharedPointer() );
   }
}

References mList, mSelected, and SharedPointer().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetTrackControls()

void Track::SetTrackControls

(

const std::shared_ptr< CommonTrackCell > &

pControls

)

Definition at line 160 of file Track.cpp.

{
   mpControls = pControls;
}

References mpControls.

Referenced by CommonTrackControls::TrackControls().

Here is the caller graph for this function:

SetTrackView()

void Track::SetTrackView

(

const std::shared_ptr< CommonTrackCell > &

pView

)

Definition at line 150 of file Track.cpp.

{
   mpView = pView;
}

References mpView.

Referenced by TrackView::Get().

Here is the caller graph for this function:

SharedPointer() [1/4]

template<typename Subclass = Track>

std::shared_ptr<Subclass> Track::SharedPointer ( )

inline

Definition at line 280 of file Track.h.

   {
      // shared_from_this is injected into class scope by base class
      // std::enable_shared_from_this<Track>
      return std::static_pointer_cast<Subclass>( shared_from_this() );
   }

Referenced by SelectHandle::AdjustSelection(), SelectionState::ChangeSelectionOnShiftClick(), CoarseTrackShifter::CoarseTrackShifter(), SpectrumView::DoDraw(), TimeShiftHandle::Drag(), EnsureVisible(), TrackPanelAx::GetFocus(), SelectHandle::HandleCenterFrequencyClick(), ClipMoveState::Init(), LabelTrackShifter::LabelTrackShifter(), SelectHandle::MoveSnappingFreqSelection(), NoteTrackShifter::NoteTrackShifter(), Notify(), TimeTrack::PasteInto(), EffectStereoToMono::ProcessOne(), SelectionState::SelectTrack(), TrackFocus::Set(), TrackPanelAx::SetFocus(), SetSelected(), SharedPointer(), SubstituteOriginalTrack(), SubstitutePendingChangedTrack(), and WaveTrackShifter::WaveTrackShifter().

Here is the caller graph for this function:

SharedPointer() [2/4]

template<typename Subclass = const Track>

auto Track::SharedPointer ( ) const -> typename std::enable_if< std::is_const<Subclass>::value, std::shared_ptr<Subclass> >::type

inline

Definition at line 288 of file Track.h.

   {
      // shared_from_this is injected into class scope by base class
      // std::enable_shared_from_this<Track>
      return std::static_pointer_cast<Subclass>( shared_from_this() );
   }

SharedPointer() [3/4]

template<typename Subclass = const Track>

static std::shared_ptr<Subclass> Track::SharedPointer ( const Track *  pTrack )

inlinestatic

Definition at line 304 of file Track.h.

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

References SharedPointer().

Here is the call graph for this function:

SharedPointer() [4/4]

template<typename Subclass = Track>

static std::shared_ptr<Subclass> Track::SharedPointer ( Track *  pTrack )

inlinestatic

Definition at line 300 of file Track.h.

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

References SharedPointer().

Here is the call graph for this function:

Silence()

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

pure virtual

SubstituteOriginalTrack()

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

(

)

const

Definition at line 1207 of file Track.cpp.

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

References GetId(), id, mList, and SharedPointer().

Referenced by IsSyncLockSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

SubstitutePendingChangedTrack() [1/2]

std::shared_ptr< Track > Track::SubstitutePendingChangedTrack

(

)

Definition at line 1186 of file Track.cpp.

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

References GetId(), mList, and SharedPointer().

Referenced by TrackPanel::DrawTracks(), SubstitutePendingChangedTrack(), and ProjectFileIO::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

SubstitutePendingChangedTrack() [2/2]

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

(

)

const

Definition at line 1202 of file Track.cpp.

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

References SubstitutePendingChangedTrack().

Here is the call graph for this function:

SupportsBasicEditing()

bool Track::SupportsBasicEditing ( ) const

virtual

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

Reimplemented in TimeTrack.

Definition at line 1227 of file Track.cpp.

{
   return true;
}

Referenced by SelectActions::Handler::OnCursorTrackEnd(), SelectActions::Handler::OnCursorTrackStart(), EditActions::Handler::OnCut(), SelectActions::Handler::OnSelectSyncLockSel(), and EditActions::Handler::OnSplitCut().

Here is the caller graph for this function:

SyncLockAdjust()

void Track::SyncLockAdjust ( double  oldT1, double  newT1  )

virtual

Reimplemented in WaveTrack, and LabelTrack.

Definition at line 284 of file Track.cpp.

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

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

Referenced by EditActions::Handler::OnPaste().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeSwitch() [1/2]

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

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

inline

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

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

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

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

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

Template Parameters

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

Parameters

functions

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

Definition at line 693 of file Track.h.

   {
      using WaveExecutor =
         Executor< R, WaveTrack,  Functions... >;
      using NoteExecutor =
         Executor< R, NoteTrack,  Functions... >;
      using LabelExecutor =
         Executor< R, LabelTrack, Functions... >;
      using TimeExecutor =
         Executor< R, TimeTrack,  Functions... >;
      using DefaultExecutor =
         Executor< R, Track >;
      enum { All = sizeof...( functions ) };
 
      static_assert(
         (1u << All) - 1u ==
            (WaveExecutor::SetUsed |
             NoteExecutor::SetUsed |
             LabelExecutor::SetUsed |
             TimeExecutor::SetUsed),
         "Uncallable case in Track::TypeSwitch"
      );
 
      switch (GetKind()) {
         case TrackKind::Wave:
            return WaveExecutor{} (this,  functions...);
#if defined(USE_MIDI)
         case TrackKind::Note:
            return NoteExecutor{} (this,  functions...);
#endif
         case TrackKind::Label:
            return LabelExecutor{}(this, functions...);
         case TrackKind::Time:
            return TimeExecutor{} (this,  functions...);
         default:
            return DefaultExecutor{} (this);
      }
   }

References All, Label, Note, Time, and Wave.

Referenced by SetClipCommand::ApplyInner(), SetEnvelopeCommand::ApplyInner(), WaveTrack::Merge(), LabelEditActions::Handler::OnCopyLabels(), LabelEditActions::Handler::OnCutLabels(), LabelEditActions::Handler::OnDisjoinLabels(), LabelEditActions::Handler::OnJoinLabels(), LabelEditActions::Handler::OnSilenceLabels(), LabelEditActions::Handler::OnSplitCutLabels(), LabelEditActions::Handler::OnSplitDeleteLabels(), LabelEditActions::Handler::OnSplitLabels(), LabelTrack::Paste(), NoteTrack::Paste(), TimeTrack::Paste(), WaveTrack::Paste(), LabelTrack::PasteOver(), NyquistEffect::ProcessOne(), and StretchHandle::Stretch().

Here is the caller graph for this function:

TypeSwitch() [2/2]

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

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

inline

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

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

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

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

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

Template Parameters

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

Parameters

functions

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

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

Definition at line 739 of file Track.h.

   {
      using WaveExecutor =
         Executor< R, const WaveTrack,  Functions... >;
      using NoteExecutor =
         Executor< R, const NoteTrack,  Functions... >;
      using LabelExecutor =
         Executor< R, const LabelTrack, Functions... >;
      using TimeExecutor =
         Executor< R, const TimeTrack,  Functions... >;
      using DefaultExecutor =
         Executor< R, const Track >;
      enum { All = sizeof...( functions ) };
 
      static_assert(
         (1u << All) - 1u ==
            (WaveExecutor::SetUsed |
             NoteExecutor::SetUsed |
             LabelExecutor::SetUsed |
             TimeExecutor::SetUsed),
         "Uncallable case in Track::TypeSwitch"
      );
 
      switch (GetKind()) {
         case TrackKind::Wave:
            return WaveExecutor{} (this,  functions...);
#if defined(USE_MIDI)
         case TrackKind::Note:
            return NoteExecutor{} (this,  functions...);
#endif
         case TrackKind::Label:
            return LabelExecutor{}(this, functions...);
         case TrackKind::Time:
            return TimeExecutor{} (this,  functions...);
         default:
            return DefaultExecutor{} (this);
      }
   }

References All, Label, Note, Time, and Wave.

WriteCommonXMLAttributes()

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

Definition at line 1243 of file Track.cpp.

{
   if (includeNameAndSelected) {
      xmlFile.WriteAttr(wxT("name"), GetName());
      xmlFile.WriteAttr(wxT("isSelected"), this->GetSelected());
   }
   if ( mpView )
      mpView->WriteXMLAttributes( xmlFile );
   if ( mpControls )
      mpControls->WriteXMLAttributes( xmlFile );
}

References GetName(), GetSelected(), mpControls, mpView, and XMLWriter::WriteAttr().

Referenced by LabelTrack::WriteXML(), TimeTrack::WriteXML(), and WaveTrack::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteXML()

virtual void Track::WriteXML ( XMLWriter &  xmlFile ) const

pure virtual

Implemented in WaveTrack, TimeTrack, NoteTrack, and LabelTrack.

Friends And Related Function Documentation

track_cast [1/2]

template<typename T >

std::enable_if< std::is_pointer<T>::value && std::is_const< typename std::remove_pointer< T >::type >::value, T >::type track_cast ( const Track *  track )

friend

Encapsulate the checked down-casting of track pointers.

Eliminates possibility of error – and not quietly casting away const

Typical usage:

if (auto wt = track_cast<const WaveTrack*>(track)) { ... }

This overload for const pointers can cast only to other const pointer types.

Definition at line 893 of file Track.h.

{
   using BareType = typename std::remove_pointer< T >::type;
   if (track &&
       CompatibleTrackKinds( track_kind<BareType>(), track->GetKind() ))
      return reinterpret_cast<T>(track);
   else
      return nullptr;
}

track_cast [2/2]

template<typename T >

std::enable_if< std::is_pointer<T>::value, T >::type track_cast ( Track *  track )

friend

Encapsulate the checked down-casting of track pointers.

Eliminates possibility of error – and not quietly casting away const

Typical usage:

if (auto wt = track_cast<const WaveTrack*>(track)) { ... }

Definition at line 875 of file Track.h.

{
   using BareType = typename std::remove_pointer< T >::type;
   if (track &&
       CompatibleTrackKinds( track_kind<BareType>(), track->GetKind() ))
      return reinterpret_cast<T>(track);
   else
      return nullptr;
}

TrackList

friend class TrackList

friend

Definition at line 240 of file Track.h.

Member Data Documentation

LeftChannel

const auto Track::LeftChannel = XMLValueChecker::LeftChannel

static

Definition at line 266 of file Track.h.

Referenced by Exporter::ExamineTracks(), ExportMixerDialog::ExportMixerDialog(), AudioIoCallback::FillOutputBuffers(), WaveTrack::GetChannel(), GetNumExportChannels(), TrackList::GroupChannels(), LinkConsistencyCheck(), Mixer::Process(), Effect::ProcessPass(), WaveTrack::SetPanFromChannelType(), anonymous_namespace{WaveTrackControls.cpp}::Status1DrawFunction(), and AudioIoCallback::TrackHasBeenFadedOut().

mChannel

ChannelType Track::mChannel

protected

Definition at line 391 of file Track.h.

Referenced by WaveTrack::GetChannel(), WaveTrack::GetChannelIgnoringPan(), WaveTrack::HandleXMLTag(), Init(), WaveTrack::SetPanFromChannelType(), and Track().

mDefaultName

wxString Track::mDefaultName

protected

Definition at line 252 of file Track.h.

Referenced by Init().

mId

TrackId Track::mId

private

Identifies the track only in-session, not persistently.

Definition at line 243 of file Track.h.

Referenced by Init().

mIndex

int Track::mIndex

protected

0-based position of this track in its TrackList

Definition at line 250 of file Track.h.

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

mLinked

bool Track::mLinked

protected

Definition at line 258 of file Track.h.

Referenced by DoSetLinked(), GetLink(), Init(), and Track().

mList

std::weak_ptr<TrackList> Track::mList

protected

Back pointer to owning TrackList

Definition at line 246 of file Track.h.

Referenced by AdjustPositions(), EnsureVisible(), GetLink(), GetNode(), TrackList::GroupChannels(), IsSyncLockSelected(), Notify(), SetLinked(), SetOwner(), SetSelected(), SubstituteOriginalTrack(), and SubstitutePendingChangedTrack().

mName

wxString Track::mName

protected

Definition at line 251 of file Track.h.

Referenced by Init(), and SetName().

mNode

TrackNodePointer Track::mNode {}

protected

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

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

Definition at line 249 of file Track.h.

Referenced by AdjustPositions(), GetLink(), GetNode(), TrackList::GroupChannels(), SetLinked(), and SetOwner().

mOffset

double Track::mOffset

protected

Definition at line 392 of file Track.h.

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

MonoChannel

const auto Track::MonoChannel = XMLValueChecker::MonoChannel

static

Definition at line 268 of file Track.h.

Referenced by Exporter::ExamineTracks(), ExportMultipleDialog::ExportMultipleByTrack(), AudioIoCallback::FillOutputBuffers(), WaveTrack::GetChannel(), GetNumExportChannels(), TrackList::GroupChannels(), MixAndRender(), EffectLoudness::Process(), Mixer::Process(), anonymous_namespace{WaveTrackControls.cpp}::Status1DrawFunction(), Track(), and AudioIoCallback::TrackHasBeenFadedOut().

mpControls

std::shared_ptr<CommonTrackCell> Track::mpControls

protected

Definition at line 817 of file Track.h.

Referenced by GetTrackControls(), HandleCommonXMLAttribute(), TrackList::RegisterPendingChangedTrack(), SetTrackControls(), and WriteCommonXMLAttributes().

mpView

std::shared_ptr<CommonTrackCell> Track::mpView

protected

Definition at line 816 of file Track.h.

Referenced by Duplicate(), GetTrackView(), HandleCommonXMLAttribute(), TrackList::RegisterPendingChangedTrack(), SetTrackView(), and WriteCommonXMLAttributes().

mSelected

bool Track::mSelected

private

Definition at line 255 of file Track.h.

Referenced by Init(), Merge(), SetSelected(), and Track().

RightChannel

const auto Track::RightChannel = XMLValueChecker::RightChannel

static

Definition at line 267 of file Track.h.

Referenced by Exporter::ExamineTracks(), ExportMixerDialog::ExportMixerDialog(), AudioIoCallback::FillOutputBuffers(), WaveTrack::GetChannel(), GetNumExportChannels(), TrackList::GroupChannels(), LinkConsistencyCheck(), Mixer::Process(), Effect::ProcessPass(), WaveTrack::SetPanFromChannelType(), anonymous_namespace{WaveTrackControls.cpp}::Status1DrawFunction(), and AudioIoCallback::TrackHasBeenFadedOut().

vrulerSize

wxSize Track::vrulerSize

mutable

Definition at line 343 of file Track.h.

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

WaveTrack

friend Track::WaveTrack

private

Definition at line 374 of file Track.h.

---

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

• Track.h
• Track.cpp