SampleTrack Class Reference

#include <SampleTrack.h>

Inheritance diagram for SampleTrack:

Collaboration diagram for SampleTrack:

Public Member Functions
	SampleTrack ()
	SampleTrack (const SampleTrack &other, ProtectedCreationArg &&)
	~SampleTrack () override
const TypeInfo &	GetTypeInfo () const override
virtual sampleFormat	GetSampleFormat () const =0
bool	GetFloats (float *buffer, sampleCount start, size_t len, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
	"narrow" overload fetches first channel only More...
double	GetStartTime () const
	Get the minimum of Start() values of intervals, or 0 when none. More...
double	GetEndTime () const
	Get the maximum of End() values of intervals, or 0 when none. More...
bool	IsLeader () const override
bool	GetFloats (size_t iChannel, size_t nBuffers, float *const buffers[], sampleCount start, size_t len, bool backwards=false, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
Public Member Functions inherited from PlayableTrack
	PlayableTrack ()
	PlayableTrack (const PlayableTrack &orig, ProtectedCreationArg &&)
bool	GetMute () const
bool	GetSolo () const
bool	GetNotMute () const
bool	GetNotSolo () const
void	SetMute (bool m)
void	SetSolo (bool s)
void	WriteXMLAttributes (XMLWriter &xmlFile) const
bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &value)
Public Member Functions inherited from AudioTrack
	AudioTrack ()
	AudioTrack (const Track &orig, ProtectedCreationArg &&a)
void	WriteXMLAttributes (XMLWriter &WXUNUSED(xmlFile)) const
bool	HandleXMLAttribute (const std::string_view &, const XMLAttributeValueView &)
Public Member Functions inherited from Track
TrackId	GetId () const
template<typename Subclass = Track>
std::shared_ptr< Subclass >	SharedPointer ()
template<typename Subclass = const Track>
auto	SharedPointer () const -> std::enable_if_t< std::is_const_v< Subclass >, std::shared_ptr< Subclass > >
std::shared_ptr< Track >	SubstitutePendingChangedTrack ()
std::shared_ptr< const Track >	SubstitutePendingChangedTrack () const
std::shared_ptr< const Track >	SubstituteOriginalTrack () const
virtual const TypeInfo &	GetTypeInfo () const =0
virtual const TypeNames &	GetTypeNames () const
virtual bool	SupportsBasicEditing () const
	Whether this track type implements cut-copy-paste; by default, true. More...
virtual Holder	PasteInto (AudacityProject &project, TrackList &list) const =0
virtual bool	LinkConsistencyFix (bool doFix=true)
	Check consistency of channel groups, and maybe fix it. More...
bool	LinkConsistencyCheck ()
	Do the non-mutating part of consistency fix only and return status. More...
bool	HasOwner () const
std::shared_ptr< TrackList >	GetOwner () const
TrackList *	GetHolder () const
LinkType	GetLinkType () const noexcept
ChannelGroupData &	GetGroupData ()
const ChannelGroupData &	GetGroupData () const
	May make group data on demand, but consider that logically const. More...
	Track ()
	Track (const Track &orig, ProtectedCreationArg &&)
Track &	operator= (const Track &orig)=delete
virtual	~Track ()
void	Init (const Track &orig)
virtual TrackListHolder	Duplicate () const
	public nonvirtual duplication function that invokes Clone() More...
const wxString &	GetName () const
	Name is always the same for all channels of a group. More...
void	SetName (const wxString &n)
bool	GetSelected () const
	Selectedness is always the same for all channels of a group. More...
virtual void	SetSelected (bool s)
void	OnProjectTempoChange (double newTempo)
	method to set project tempo on track More...
virtual TrackListHolder	Cut (double t0, double t1)=0
	Create tracks and modify this track. More...
virtual TrackListHolder	Copy (double t0, double t1, bool forClipboard=true) const =0
	Create new tracks and don't modify this track. More...
virtual void	Clear (double t0, double t1)=0
virtual void	Paste (double t, const Track &src)=0
	Weak precondition allows overrides to replicate one channel into many. More...
void	Paste (double t, const TrackList &src)
virtual void	SyncLockAdjust (double oldT1, double newT1)
virtual void	Silence (double t0, double t1, ProgressReporter reportProgress={})=0
virtual void	InsertSilence (double t, double len)=0
bool	SameKindAs (const Track &track) const
template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions)
template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions) const
virtual void	WriteXML (XMLWriter &xmlFile) const =0
virtual std::optional< TranslatableString >	GetErrorOpening () const
void	Notify (bool allChannels, int code=-1)
bool	Any () const
bool	IsSelected () const
bool	IsLeader () const override
bool	IsSelectedLeader () const
void	AdjustPositions ()
void	WriteCommonXMLAttributes (XMLWriter &xmlFile, bool includeNameAndSelected=true) const
bool	HandleCommonXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)
const std::optional< double > &	GetProjectTempo () const
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0
virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))
virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)
Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
	~Site ()
	Site ()
	Site (const Site &other)
Site &	operator= (const Site &other)
	Site (Site &&other)
Site &	operator= (Site &&other)
size_t	size () const
	How many attachment pointers are in the Site. More...
template<typename Subclass = ClientData>
Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...
template<typename Subclass = const ClientData>
auto	Get (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass & >
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...
template<typename Subclass = ClientData>
Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...
template<typename Subclass = const ClientData>
auto	Find (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass * >
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...
template<typename ReplacementPointer >
void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...
Public Member Functions inherited from ChannelGroup
virtual	~ChannelGroup ()
double	GetStartTime () const
	Get the minimum of Start() values of intervals, or 0 when none. More...
double	GetEndTime () const
	Get the maximum of End() values of intervals, or 0 when none. More...
void	ShiftBy (double t)
	Change start time by given duration. More...
virtual void	MoveTo (double o)=0
	Change start time to given time point. More...
virtual bool	IsLeader () const =0
ChannelGroupData &	GetGroupData ()
	Make attachment site on demand as needed. More...
const ChannelGroupData &	GetGroupData () const
ChannelGroupData *	FindGroupData ()
	Do not make attachment site on demand if absent. More...
const ChannelGroupData *	FindGroupData () const
	Do not make attachment site on demand if absent. More...
void	Init (const ChannelGroup &other)
	Copy, including cloning of attached objects. More...
void	DestroyGroupData ()
	Leave all attachments null. More...
std::unique_ptr< ChannelGroupData >	DetachGroupData ()
	Move attachments out. More...
void	AssignGroupData (std::unique_ptr< ChannelGroupData > pGroupData)
	Replace any previous attachments. More...
virtual size_t	NChannels () const =0
	Report the number of channels. More...
template<typename ChannelType = Channel>
std::shared_ptr< ChannelType >	GetChannel (size_t iChannel)
	Retrieve a channel, cast to the given type. More...
template<typename ChannelType = const Channel>
auto	GetChannel (size_t iChannel) const -> std::enable_if_t< std::is_const_v< ChannelType >, std::shared_ptr< ChannelType > >
template<typename ChannelType = Channel>
IteratorRange< ChannelIterator< ChannelType > >	Channels ()
	Get range of channels with mutative access. More...
template<typename ChannelType = const Channel>
auto	Channels () const -> std::enable_if_t< std::is_const_v< ChannelType >, IteratorRange< ChannelIterator< ChannelType > > >
	Get range of channels with read-only access. More...
virtual size_t	NIntervals () const =0
	Report the number of intervals. More...
template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...
template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >
template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...
template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...
Public Member Functions inherited from PlayableSequence
	~PlayableSequence () override
virtual const ChannelGroup *	FindChannelGroup () const =0
	Find associated ChannelGroup if any. More...
virtual bool	GetSolo () const =0
	May vary asynchronously. More...
virtual bool	GetMute () const =0
	May vary asynchronously. More...
Public Member Functions inherited from WideSampleSequence
virtual	~WideSampleSequence ()
virtual size_t	NChannels () const =0
	A constant property. More...
virtual float	GetChannelGain (int channel) const =0
bool	GetFloats (size_t iChannel, size_t nBuffers, float *const buffers[], sampleCount start, size_t len, bool backwards=false, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
virtual bool	DoGet (size_t iChannel, size_t nBuffers, const samplePtr buffers[], sampleFormat format, sampleCount start, size_t len, bool backward, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const =0
virtual double	GetStartTime () const =0
virtual double	GetEndTime () const =0
virtual double	GetRate () const =0
sampleCount	TimeToLongSamples (double t0) const
double	LongSamplesToTime (sampleCount pos) const
double	SnapToSample (double t) const
virtual sampleFormat	WidestEffectiveFormat () const =0
virtual bool	HasTrivialEnvelope () const =0
virtual void	GetEnvelopeValues (double *buffer, size_t bufferLen, double t0, bool backwards) const =0
Public Member Functions inherited from AudioGraph::Channel
virtual	~Channel ()
virtual ChannelType	GetChannelType () const =0
	Classify this channel. More...

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

Additional Inherited Members
Public Types inherited from Track
using	AttachedObjects = ::AttachedTrackObjects
	Alias for my base type. More...
using	Holder = std::shared_ptr< Track >
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 Types inherited from ChannelGroup
enum class	LinkType : int { None = 0 , Group = 2 , Aligned }
	For two tracks describes the type of the linkage. More...
using	Attachments = ClientData::Site< ChannelGroupData, ClientData::Cloneable<>, ClientData::DeepCopying >
using	Interval = WideChannelGroupInterval
Protected Member Functions inherited from PlayableTrack
bool	DoGetMute () const
void	DoSetMute (bool value)
bool	DoGetSolo () const
void	DoSetSolo (bool value)
Protected Member Functions inherited from Track
void	SetLinkType (LinkType linkType, bool completeList=true)
virtual void	DoOnProjectTempoChange (const std::optional< double > &oldTempo, double newTempo)=0
Protected Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
template<typename Function >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in this. More...
template<typename Function >
void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in this. More...
template<typename Function >
ClientData *	FindIf (const Function &function)
	Return pointer to first attachment in this that is not null and satisfies a predicate, or nullptr. More...
template<typename Function >
const ClientData *	FindIf (const Function &function) const
	Return pointer to first attachment in this that is not null and satisfies a predicate, or nullptr. More...
void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in this, build and store it. More...
Protected Member Functions inherited from ChannelGroup
virtual std::shared_ptr< Channel >	DoGetChannel (size_t iChannel)=0
	Retrieve a channel. More...
virtual std::shared_ptr< Interval >	DoGetInterval (size_t iInterval)=0
	Retrieve an interval. More...
Protected Attributes inherited from Track
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...

Detailed Description

Definition at line 24 of file SampleTrack.h.

Constructor & Destructor Documentation

SampleTrack() [1/2]

SampleTrack::SampleTrack ( )

default

SampleTrack() [2/2]

SampleTrack::SampleTrack	(	const SampleTrack &	other,
		ProtectedCreationArg &&	a
	)

Definition at line 17 of file SampleTrack.cpp.

   : PlayableTrack(other, std::move(a))
{
}

~SampleTrack()

SampleTrack::~SampleTrack ( )

overridedefault

Member Function Documentation

ClassTypeInfo()

auto SampleTrack::ClassTypeInfo ( )

static

Definition at line 32 of file SampleTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Referenced by typeInfo2().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEndTime()

double ChannelGroup::GetEndTime ( ) const

virtual

Get the maximum of End() values of intervals, or 0 when none.

Implements WideSampleSequence.

Definition at line 311 of file Channel.cpp.

{
   auto range = Intervals();
   if (range.empty())
      return 0;
   return std::accumulate(range.first, range.second,
      std::numeric_limits<double>::lowest(),
      [](double acc, const auto &pInterval){
         return std::max(acc, pInterval->End()); });
}

GetFloats() [1/2]

bool SampleTrack::GetFloats ( float *  buffer, sampleCount  start, size_t  len, fillFormat  fill = FillFormat::fillZero, bool  mayThrow = true, sampleCount *  pNumWithinClips = nullptr  ) const

inline

"narrow" overload fetches first channel only

Definition at line 46 of file SampleTrack.h.

   {
      constexpr auto backwards = false;
      return GetFloats(
         0, 1, &buffer, start, len, backwards, fill, mayThrow, pNumWithinClips);
   }

References WideSampleSequence::GetFloats().

Here is the call graph for this function:

GetFloats() [2/2]

bool WideSampleSequence::GetFloats	(	size_t	iChannel,
		size_t	nBuffers,
		float *const	buffers[],
		sampleCount	start,
		size_t	len,
		bool	backwards = false,
		fillFormat	fill = FillFormat::fillZero,
		bool	mayThrow = true,
		sampleCount *	pNumWithinClips = nullptr
	)		const

Retrieve samples from a sequence in floating-point format, regardless of the storage format

Parameters

	iChannel	index of first channel to fetch
	nBuffers	counts buffers
	buffers	receive the samples
	start	starting sample, relative to absolute time zero
	len	how many samples to get. buffers are assumed sufficiently large
	fill	how to assign values for sample positions between clips
	mayThrow	if false, fill buffer with zeros when there is failure to retrieve samples; else throw
[out]	pNumWithinClips	Report how many samples were copied from within clips, rather than filled according to fillFormat; but these were not necessarily one contiguous range.

Precondition

iChannel + nBuffers <= NChannels()

Returns

false when mayThrow is false and not all samples could be retrieved

Postcondition

if return value is false, buffers are zero-filled

Definition at line 58 of file WideSampleSequence.cpp.

{
   // Cast the pointers to pass them to DoGet() which handles multiple
   // destination formats
   const auto castBuffers = reinterpret_cast<const samplePtr*>(buffers);
   const auto result = DoGet(
      iChannel, nBuffers, castBuffers,
      floatSample, start, len, backwards, fill, mayThrow, pNumWithinClips);
   if (!result)
      while (nBuffers--)
         ClearSamples(castBuffers[nBuffers], floatSample, 0, len);
   return result;
}

GetSampleFormat()

virtual sampleFormat SampleTrack::GetSampleFormat ( ) const

pure virtual

Implemented in WaveTrack.

GetStartTime()

double ChannelGroup::GetStartTime ( ) const

virtual

Get the minimum of Start() values of intervals, or 0 when none.

Implements WideSampleSequence.

Definition at line 309 of file Channel.cpp.

{
   auto range = Intervals();
   if (range.empty())
      return 0;
   return std::accumulate(range.first, range.second,
      std::numeric_limits<double>::max(),
      [](double acc, const auto &pInterval){
         return std::min(acc, pInterval->Start()); });
}

GetTypeInfo()

auto SampleTrack::GetTypeInfo ( ) const

overridevirtual

Implements Track.

Reimplemented in WritableSampleTrack, and WaveTrack.

Definition at line 37 of file SampleTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Here is the call graph for this function:

IsLeader()

bool Track::IsLeader ( ) const

overridevirtual

Reimplemented from Track.

Reimplemented in WritableSampleTrack.

Definition at line 460 of file Track.cpp.

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

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

Referenced by anonymous_namespace{RealtimeEffectPanel.cpp}::VisitRealtimeEffectStateUIs().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• SampleTrack.h
• SampleTrack.cpp