WaveChannelInterval Class Reference

#include <WaveTrack.h>

Inheritance diagram for WaveChannelInterval:

Collaboration diagram for WaveChannelInterval:

Public Member Functions
	WaveChannelInterval (WaveClip &wideClip, WaveClip &narrowClip, size_t iChannel)
	Assume lifetime of this object nests in those of arguments. More...
	~WaveChannelInterval () override
const WaveClip &	GetClip () const
const Envelope &	GetEnvelope () const
size_t	GetChannelIndex () const
bool	Intersects (double t0, double t1) const
double	Start () const
double	End () const
AudioSegmentSampleView	GetSampleView (double t0, double t1, bool mayThrow) const
	Request interval samples within [t0, t1). t0 and t1 are truncated to the interval start and end. Stretching influences the number of samples fitting into [t0, t1), i.e., half as many for twice as large a stretch ratio, due to a larger spacing of the raw samples. The actual number of samples available from the returned view is queried through AudioSegmentSampleView::GetSampleCount(). More...
sampleCount	GetVisibleSampleCount () const override
int	GetRate () const override
double	GetPlayStartTime () const override
double	GetPlayEndTime () const override
sampleCount	TimeToSamples (double time) const override
double	GetStretchRatio () const override
double	GetTrimLeft () const
double	GetTrimRight () const
bool	GetSamples (samplePtr buffer, sampleFormat format, sampleCount start, size_t len, bool mayThrow=true) const
AudioSegmentSampleView	GetSampleView (sampleCount start, size_t length, bool mayThrow) const
const Sequence &	GetSequence () const
constSamplePtr	GetAppendBuffer () const
size_t	GetAppendBufferLen () const
int	GetColourIndex () const
Public Member Functions inherited from ChannelInterval
virtual	~ChannelInterval ()
Public Member Functions inherited from ClipTimes
virtual	~ClipTimes ()
virtual sampleCount	GetVisibleSampleCount () const =0
virtual int	GetRate () const =0
virtual double	GetPlayStartTime () const =0
virtual double	GetPlayEndTime () const =0
virtual sampleCount	TimeToSamples (double time) const =0
virtual double	GetStretchRatio () const =0

Private Member Functions
const WaveClip &	GetNarrowClip () const

Private Attributes
WaveClip &	mWideClip
WaveClip &	mNarrowClip
const size_t	miChannel

Detailed Description

Definition at line 66 of file WaveTrack.h.

Constructor & Destructor Documentation

WaveChannelInterval()

WaveChannelInterval::WaveChannelInterval ( WaveClip &  wideClip, WaveClip &  narrowClip, size_t  iChannel  )

inline

Assume lifetime of this object nests in those of arguments.

Definition at line 72 of file WaveTrack.h.

      : mWideClip{ wideClip }
      , mNarrowClip{ narrowClip }
      , miChannel{ iChannel }
   {}

~WaveChannelInterval()

WaveChannelInterval::~WaveChannelInterval ( )

overridedefault

Member Function Documentation

End()

double WaveChannelInterval::End

(

)

const

Definition at line 84 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetPlayEndTime();
}

References GetNarrowClip(), and WaveClip::GetPlayEndTime().

Here is the call graph for this function:

GetAppendBuffer()

constSamplePtr WaveChannelInterval::GetAppendBuffer

(

)

const

Definition at line 168 of file WaveTrack.cpp.

{
   // TODO wide wave tracks -- use miChannel
   return GetNarrowClip().GetAppendBuffer(0);
}

References WaveClip::GetAppendBuffer(), and GetNarrowClip().

Referenced by WaveClipWaveformCache::GetWaveDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAppendBufferLen()

size_t WaveChannelInterval::GetAppendBufferLen

(

)

const

Definition at line 174 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetAppendBufferLen();
}

References WaveClip::GetAppendBufferLen(), and GetNarrowClip().

Referenced by WaveClipWaveformCache::GetWaveDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetChannelIndex()

size_t WaveChannelInterval::GetChannelIndex ( ) const

inline

Definition at line 81 of file WaveTrack.h.

{ return miChannel; }

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), WaveClipSpectrumCache::GetSpectrogram(), and WaveClipWaveformCache::GetWaveDisplay().

Here is the caller graph for this function:

GetClip()

const WaveClip & WaveChannelInterval::GetClip ( ) const

inline

Definition at line 79 of file WaveTrack.h.

{ return mWideClip; }

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), and anonymous_namespace{WaveformView.cpp}::DrawClipWaveform().

Here is the caller graph for this function:

GetColourIndex()

int WaveChannelInterval::GetColourIndex

(

)

const

Definition at line 179 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetColourIndex();
}

References WaveClip::GetColourIndex(), and GetNarrowClip().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEnvelope()

const Envelope & WaveChannelInterval::GetEnvelope

(

)

const

Definition at line 97 of file WaveTrack.cpp.

{
   // Always the left clip's envelope
   return *mWideClip.GetEnvelope();
}

References WaveClip::GetEnvelope(), and mWideClip.

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), and anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

GetNarrowClip()

const WaveClip & WaveChannelInterval::GetNarrowClip ( ) const

inlineprivate

Definition at line 124 of file WaveTrack.h.

{ return mNarrowClip; }

Referenced by End(), GetAppendBuffer(), GetAppendBufferLen(), GetColourIndex(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSamples(), GetSampleView(), GetSequence(), GetStretchRatio(), GetTrimLeft(), GetTrimRight(), GetVisibleSampleCount(), Intersects(), Start(), and TimeToSamples().

Here is the caller graph for this function:

GetPlayEndTime()

double WaveChannelInterval::GetPlayEndTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 118 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetPlayEndTime();
}

References GetNarrowClip(), and WaveClip::GetPlayEndTime().

Here is the call graph for this function:

GetPlayStartTime()

double WaveChannelInterval::GetPlayStartTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 113 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetPlayStartTime();
}

References GetNarrowClip(), and WaveClip::GetPlayStartTime().

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), and anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRate()

int WaveChannelInterval::GetRate ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 108 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetRate();
}

References GetNarrowClip(), and WaveClip::GetRate().

Referenced by SpecCache::CalculateOneSpectrum(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), WaveClipSpectrumCache::GetSpectrogram(), WaveClipWaveformCache::GetWaveDisplay(), and SpecCache::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSamples()

bool WaveChannelInterval::GetSamples	(	samplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	mayThrow = true
	)		const

Definition at line 143 of file WaveTrack.cpp.

{
   // Not just a pass-through, but supply the first argument
   // TODO wide wave tracks -- pass miChannel not 0
   return GetNarrowClip().GetSamples(0, buffer, format, start, len, mayThrow);
}

References anonymous_namespace{ExportPCM.cpp}::format, GetNarrowClip(), and WaveClip::GetSamples().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleView() [1/2]

AudioSegmentSampleView WaveChannelInterval::GetSampleView	(	double	t0,
		double	t1,
		bool	mayThrow
	)		const

Request interval samples within [t0, t1). t0 and t1 are truncated to the interval start and end. Stretching influences the number of samples fitting into [t0, t1), i.e., half as many for twice as large a stretch ratio, due to a larger spacing of the raw samples. The actual number of samples available from the returned view is queried through AudioSegmentSampleView::GetSampleCount().

Precondition

samples in [t0, t1) can be counted with size_t

Definition at line 90 of file WaveTrack.cpp.

{
   constexpr auto iChannel = 0u;
   // TODO wide wave tracks: use the real channel number.
   return GetNarrowClip().GetSampleView(iChannel, t0, t1, mayThrow);
}

References GetNarrowClip(), WaveClip::GetSampleView(), and anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel.

Referenced by SpecCache::CalculateOneSpectrum().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleView() [2/2]

AudioSegmentSampleView WaveChannelInterval::GetSampleView	(	sampleCount	start,
		size_t	length,
		bool	mayThrow
	)		const

Definition at line 151 of file WaveTrack.cpp.

{
   // Not just a pass-through, but supply the first argument
   // TODO wide wave tracks -- pass miChannel not 0
   return GetNarrowClip().GetSampleView(0, start, length, mayThrow);
}

References GetNarrowClip(), and WaveClip::GetSampleView().

Here is the call graph for this function:

GetSequence()

const Sequence & WaveChannelInterval::GetSequence

(

)

const

Definition at line 159 of file WaveTrack.cpp.

{
   // TODO wide wave tracks -- use miChannel
   const auto pSequence = GetNarrowClip().GetSequence(0);
   // Assume sufficiently wide clip
   assert(pSequence);
   return *pSequence;
}

References GetNarrowClip(), and WaveClip::GetSequence().

Referenced by SpecCache::CalculateOneSpectrum(), and WaveClipWaveformCache::GetWaveDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetStretchRatio()

double WaveChannelInterval::GetStretchRatio ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 128 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetStretchRatio();
}

References GetNarrowClip(), and WaveClip::GetStretchRatio().

Referenced by SpecCache::CalculateOneSpectrum(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), WaveClipSpectrumCache::GetSpectrogram(), WaveClipWaveformCache::GetWaveDisplay(), and SpecCache::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrimLeft()

double WaveChannelInterval::GetTrimLeft

(

)

const

Definition at line 133 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetTrimLeft();
}

References GetNarrowClip(), and WaveClip::GetTrimLeft().

Referenced by WaveClipSpectrumCache::GetSpectrogram(), and WaveClipWaveformCache::GetWaveDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrimRight()

double WaveChannelInterval::GetTrimRight

(

)

const

Definition at line 138 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetTrimRight();
}

References GetNarrowClip(), and WaveClip::GetTrimRight().

Referenced by WaveClipSpectrumCache::GetSpectrogram().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVisibleSampleCount()

sampleCount WaveChannelInterval::GetVisibleSampleCount ( ) const

overridevirtual

The number of raw audio samples not hidden by trimming.

Implements ClipTimes.

Definition at line 103 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetVisibleSampleCount();
}

References GetNarrowClip(), and WaveClip::GetVisibleSampleCount().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), and anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

Intersects()

bool WaveChannelInterval::Intersects	(	double	t0,
		double	t1
	)		const

Definition at line 74 of file WaveTrack.cpp.

{
   return GetNarrowClip().IntersectsPlayRegion(t0, t1);
}

References GetNarrowClip(), and WaveClip::IntersectsPlayRegion().

Here is the call graph for this function:

Start()

double WaveChannelInterval::Start

(

)

const

Definition at line 79 of file WaveTrack.cpp.

{
   return GetNarrowClip().GetPlayStartTime();
}

References GetNarrowClip(), and WaveClip::GetPlayStartTime().

Here is the call graph for this function:

TimeToSamples()

sampleCount WaveChannelInterval::TimeToSamples ( double  time ) const

overridevirtual

Implements ClipTimes.

Definition at line 123 of file WaveTrack.cpp.

{
   return GetNarrowClip().TimeToSamples(time);
}

References GetNarrowClip(), and WaveClip::TimeToSamples().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), and anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

miChannel

const size_t WaveChannelInterval::miChannel

private

Definition at line 128 of file WaveTrack.h.

mNarrowClip

WaveClip& WaveChannelInterval::mNarrowClip

private

Definition at line 127 of file WaveTrack.h.

mWideClip

WaveClip& WaveChannelInterval::mWideClip

private

Definition at line 126 of file WaveTrack.h.

Referenced by GetEnvelope().

---

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

• WaveTrack.h
• WaveTrack.cpp