WaveClipChannel Class Reference

#include <WaveClip.h>

Inheritance diagram for WaveClipChannel:

Collaboration diagram for WaveClipChannel:

Public Member Functions
	WaveClipChannel (WaveClip &clip, size_t iChannel)
	~WaveClipChannel () override
WaveClip &	GetClip ()
const WaveClip &	GetClip () const
size_t	GetChannelIndex () const
Envelope &	GetEnvelope ()
const Envelope &	GetEnvelope () 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...
bool	WithinPlayRegion (double t) const
	t ∈ [...) More...
double	SamplesToTime (sampleCount s) const noexcept
bool	HasPitchOrSpeed () const
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
const BlockArray *	GetSequenceBlockArray () const
std::pair< float, float >	GetMinMax (double t0, double t1, bool mayThrow) const
float	GetRMS (double t0, double t1, bool mayThrow) const
sampleCount	GetPlayStartSample () const
	Real start time of the clip, quantized to raw sample rate (track's rate) More...
sampleCount	GetPlayEndSample () const
	Real end time of the clip, quantized to raw sample rate (track's rate) More...
void	SetSamples (constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len, sampleFormat effectiveFormat)
void	WriteXML (XMLWriter &xmlFile) const
sampleCount	GetVisibleSampleCount () const override
int	GetRate () const override
double	GetPlayStartTime () const override
double	GetPlayEndTime () const override
double	GetPlayDuration () const
sampleCount	TimeToSamples (double time) const override
double	GetStretchRatio () const override
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 Attributes
WaveClip &	mClip
const size_t	miChannel

Friends
bool	operator== (const WaveClipChannel &a, const WaveClipChannel &b)
bool	operator!= (const WaveClipChannel &a, const WaveClipChannel &b)

Detailed Description

Definition at line 85 of file WaveClip.h.

Constructor & Destructor Documentation

WaveClipChannel()

WaveClipChannel::WaveClipChannel ( WaveClip &  clip, size_t  iChannel  )

inline

Definition at line 90 of file WaveClip.h.

      : mClip{ clip }
      , miChannel{ iChannel }
   {}

~WaveClipChannel()

WaveClipChannel::~WaveClipChannel ( )

overridedefault

Member Function Documentation

End()

double WaveClipChannel::End

(

)

const

Definition at line 84 of file WaveClip.cpp.

{
   return GetClip().GetPlayEndTime();
}

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

Here is the call graph for this function:

GetAppendBuffer()

constSamplePtr WaveClipChannel::GetAppendBuffer

(

)

const

Definition at line 135 of file WaveClip.cpp.

{
   return GetClip().GetAppendBuffer(miChannel);
}

References WaveClip::GetAppendBuffer(), GetClip(), and miChannel.

Here is the call graph for this function:

GetAppendBufferLen()

size_t WaveClipChannel::GetAppendBufferLen

(

)

const

Definition at line 140 of file WaveClip.cpp.

{
   return GetClip().GetAppendBufferLen(miChannel);
}

References WaveClip::GetAppendBufferLen(), GetClip(), and miChannel.

Here is the call graph for this function:

GetChannelIndex()

size_t WaveClipChannel::GetChannelIndex ( ) const

inline

Definition at line 99 of file WaveClip.h.

{ return miChannel; }

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawWaveform(), WaveChannelUtilities::GetFloatAtTime(), and WaveClipSpectrumCache::GetSpectrogram().

Here is the caller graph for this function:

GetClip() [1/2]

WaveClip & WaveClipChannel::GetClip ( )

inline

Definition at line 96 of file WaveClip.h.

{ return mClip; }

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform(), End(), WaveClipSpectrumCache::Get(), WaveColorAttachment::Get(), GetAppendBuffer(), GetAppendBufferLen(), GetEnvelope(), WaveChannelUtilities::GetFloatAtTime(), GetMinMax(), GetPlayEndSample(), GetPlayEndTime(), GetPlayStartSample(), GetPlayStartTime(), GetRate(), GetRMS(), GetSamples(), GetSampleView(), GetSequence(), GetSequenceBlockArray(), GetStretchRatio(), GetTrimLeft(), GetTrimRight(), GetVisibleSampleCount(), HasPitchOrSpeed(), Intersects(), SetSamples(), Start(), TimeToSamples(), WithinPlayRegion(), and WriteXML().

Here is the caller graph for this function:

GetClip() [2/2]

const WaveClip & WaveClipChannel::GetClip ( ) const

inline

Definition at line 97 of file WaveClip.h.

{ return mClip; }

GetEnvelope() [1/2]

Envelope & WaveClipChannel::GetEnvelope

(

)

Definition at line 64 of file WaveClip.cpp.

{
   return GetClip().GetEnvelope();
}

References GetClip(), and WaveClip::GetEnvelope().

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:

GetEnvelope() [2/2]

const Envelope & WaveClipChannel::GetEnvelope

(

)

const

Definition at line 69 of file WaveClip.cpp.

{
   return GetClip().GetEnvelope();
}

References GetClip(), and WaveClip::GetEnvelope().

Here is the call graph for this function:

GetMinMax()

std::pair< float, float > WaveClipChannel::GetMinMax	(	double	t0,
		double	t1,
		bool	mayThrow
	)		const

Getting high-level data for one channel for screen display and clipping calculations and Contrast

Definition at line 151 of file WaveClip.cpp.

{
   return GetClip().GetMinMax(miChannel, t0, t1, mayThrow);
}

References GetClip(), WaveClip::GetMinMax(), and miChannel.

Here is the call graph for this function:

GetPlayDuration()

double WaveClipChannel::GetPlayDuration

(

)

const

Definition at line 208 of file WaveClip.cpp.

{
   return GetPlayEndTime() - GetPlayStartTime();
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by anonymous_namespace{WaveChannelUtilities.cpp}::GetSampleAccessArgs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPlayEndSample()

sampleCount WaveClipChannel::GetPlayEndSample

(

)

const

Real end time of the clip, quantized to raw sample rate (track's rate)

Definition at line 166 of file WaveClip.cpp.

{
   return GetClip().GetPlayEndSample();
}

References GetClip(), and WaveClip::GetPlayEndSample().

Here is the call graph for this function:

GetPlayEndTime()

double WaveClipChannel::GetPlayEndTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 203 of file WaveClip.cpp.

{
   return GetClip().GetPlayEndTime();
}

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

Referenced by GetPlayDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPlayStartSample()

sampleCount WaveClipChannel::GetPlayStartSample

(

)

const

Real start time of the clip, quantized to raw sample rate (track's rate)

Definition at line 161 of file WaveClip.cpp.

{
   return GetClip().GetPlayStartSample();
}

References GetClip(), and WaveClip::GetPlayStartSample().

Here is the call graph for this function:

GetPlayStartTime()

double WaveClipChannel::GetPlayStartTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 198 of file WaveClip.cpp.

{
   return GetClip().GetPlayStartTime();
}

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

Referenced by WaveChannelUtilities::CompareClipsByPlayStartTime(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), WaveChannelUtilities::GetFloatAtTime(), GetPlayDuration(), anonymous_namespace{WaveChannelUtilities.cpp}::GetSampleAccessArgs(), anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices(), and anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRate()

int WaveClipChannel::GetRate ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 193 of file WaveClip.cpp.

{
   return GetClip().GetRate();
}

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

Referenced by SpecCache::CalculateOneSpectrum(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), anonymous_namespace{WaveChannelUtilities.cpp}::GetSampleAccessArgs(), WaveClipSpectrumCache::GetSpectrogram(), SpecCache::Populate(), and anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRMS()

float WaveClipChannel::GetRMS	(	double	t0,
		double	t1,
		bool	mayThrow
	)		const

Getting high-level data for one channel for screen display and clipping calculations and Contrast

Definition at line 156 of file WaveClip.cpp.

{
   return GetClip().GetRMS(miChannel, t0, t1, mayThrow);
}

References GetClip(), WaveClip::GetRMS(), and miChannel.

Here is the call graph for this function:

GetSamples()

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

Definition at line 115 of file WaveClip.cpp.

{
   return GetClip().GetSamples(miChannel, buffer, format, start, len, mayThrow);
}

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

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 WaveClipChannel::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 WaveClip.cpp.

{
   return GetClip().GetSampleView(miChannel, t0, t1, mayThrow);
}

References GetClip(), WaveClip::GetSampleView(), and miChannel.

Referenced by SpecCache::CalculateOneSpectrum().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleView() [2/2]

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

Definition at line 121 of file WaveClip.cpp.

{
   return GetClip().GetSampleView(miChannel, start, length, mayThrow);
}

References GetClip(), WaveClip::GetSampleView(), and miChannel.

Here is the call graph for this function:

GetSequence()

const Sequence & WaveClipChannel::GetSequence

(

)

const

Definition at line 127 of file WaveClip.cpp.

{
   const auto pSequence = GetClip().GetSequence(miChannel);
   // Assume sufficiently wide clip
   assert(pSequence);
   return *pSequence;
}

References GetClip(), WaveClip::GetSequence(), and miChannel.

Referenced by SpecCache::CalculateOneSpectrum().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSequenceBlockArray()

const BlockArray * WaveClipChannel::GetSequenceBlockArray

(

)

const

Definition at line 145 of file WaveClip.cpp.

{
   return GetClip().GetSequenceBlockArray(miChannel);
}

References GetClip(), WaveClip::GetSequenceBlockArray(), and miChannel.

Here is the call graph for this function:

GetStretchRatio()

double WaveClipChannel::GetStretchRatio ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 218 of file WaveClip.cpp.

{
   return GetClip().GetStretchRatio();
}

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

Referenced by SpecCache::CalculateOneSpectrum(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), anonymous_namespace{WaveChannelUtilities.cpp}::GetSampleAccessArgs(), WaveClipSpectrumCache::GetSpectrogram(), SpecCache::Populate(), and anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrimLeft()

double WaveClipChannel::GetTrimLeft

(

)

const

Definition at line 110 of file WaveClip.cpp.

{
   return GetClip().GetTrimLeft();
}

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

Referenced by WaveClipSpectrumCache::GetSpectrogram().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrimRight()

double WaveClipChannel::GetTrimRight

(

)

const

Definition at line 183 of file WaveClip.cpp.

{
   return GetClip().GetTrimRight();
}

References GetClip(), 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 WaveClipChannel::GetVisibleSampleCount ( ) const

overridevirtual

The number of raw audio samples not hidden by trimming.

Implements ClipTimes.

Definition at line 188 of file WaveClip.cpp.

{
   return GetClip().GetVisibleSampleCount();
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

HasPitchOrSpeed()

bool WaveClipChannel::HasPitchOrSpeed

(

)

const

Definition at line 105 of file WaveClip.cpp.

{
   return GetClip().HasPitchOrSpeed();
}

References GetClip(), and WaveClip::HasPitchOrSpeed().

Here is the call graph for this function:

Intersects()

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

Definition at line 74 of file WaveClip.cpp.

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

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

Here is the call graph for this function:

SamplesToTime()

double WaveClipChannel::SamplesToTime ( sampleCount  s ) const

noexcept

Definition at line 100 of file WaveClip.cpp.

{
   return GetClip().SamplesToTime(s);
}

SetSamples()

void WaveClipChannel::SetSamples	(	constSamplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		sampleFormat	effectiveFormat
	)

Parameters

start

relative to clip play start sample

Parameters

effectiveFormat

Make the effective format of the data at least the minumum of this value and `format`. (Maybe wider, if merging with preexistent data.) If the data are later narrowed from stored format, but not narrower than the effective, then no dithering will occur.

Definition at line 171 of file WaveClip.cpp.

{
   return GetClip().SetSamples(miChannel,
      buffer, format, start, len, effectiveFormat);
}

References anonymous_namespace{ExportPCM.cpp}::format, GetClip(), miChannel, and WaveClip::SetSamples().

Here is the call graph for this function:

Start()

double WaveClipChannel::Start

(

)

const

Definition at line 79 of file WaveClip.cpp.

{
   return GetClip().GetPlayStartTime();
}

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

Here is the call graph for this function:

TimeToSamples()

sampleCount WaveClipChannel::TimeToSamples ( double  time ) const

overridevirtual

Implements ClipTimes.

Definition at line 213 of file WaveClip.cpp.

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

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

Referenced by anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

WithinPlayRegion()

bool WaveClipChannel::WithinPlayRegion

(

double

t

)

const

t ∈ [...)

Definition at line 95 of file WaveClip.cpp.

{
   return GetClip().WithinPlayRegion(t);
}

References GetClip(), and WaveClip::WithinPlayRegion().

Here is the call graph for this function:

WriteXML()

void WaveClipChannel::WriteXML

(

XMLWriter &

xmlFile

)

const

Definition at line 178 of file WaveClip.cpp.

{
   GetClip().WriteXML(miChannel, xmlFile);
}

References GetClip(), miChannel, and WaveClip::WriteXML().

Here is the call graph for this function:

Friends And Related Function Documentation

operator!=

bool operator!= ( const WaveClipChannel &  a, const WaveClipChannel &  b  )

friend

Definition at line 188 of file WaveClip.h.

   { return !(a == b); }

operator==

bool operator== ( const WaveClipChannel &  a, const WaveClipChannel &  b  )

friend

Definition at line 185 of file WaveClip.h.

   { return &a.mClip == &b.mClip && a.miChannel == b.miChannel; }

Member Data Documentation

mClip

WaveClip& WaveClipChannel::mClip

private

Definition at line 193 of file WaveClip.h.

miChannel

const size_t WaveClipChannel::miChannel

private

Definition at line 194 of file WaveClip.h.

Referenced by GetAppendBuffer(), GetAppendBufferLen(), GetMinMax(), GetRMS(), GetSamples(), GetSampleView(), GetSequence(), GetSequenceBlockArray(), SetSamples(), and WriteXML().

---

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

• WaveClip.h
• WaveClip.cpp