WaveChannel Class Reference

#include <WaveTrack.h>

Inheritance diagram for WaveChannel:

Collaboration diagram for WaveChannel:

Public Member Functions
	~WaveChannel () override
WaveTrack &	GetTrack ()
const WaveTrack &	GetTrack () const
auto	GetInterval (size_t iInterval)
auto	GetInterval (size_t iInterval) const
auto	Intervals ()
auto	Intervals () const
bool	GetFloats (float *buffer, sampleCount start, size_t len, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
	"narrow" overload fetches from the unique channel More...
ChannelSampleView	GetSampleView (double t0, double t1, bool mayThrow) const
	Request channel samples within [t0, t1), not knowing in advance how many this will be. More...
bool	Set (constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len, sampleFormat effectiveFormat=widestSampleFormat)
	Random-access assignment of a range of samples. More...
bool	AppendBuffer (constSamplePtr buffer, sampleFormat format, size_t len, unsigned stride, sampleFormat effectiveFormat)
bool	Append (constSamplePtr buffer, sampleFormat format, size_t len)
std::pair< float, float >	GetMinMax (double t0, double t1, bool mayThrow=true) const
float	GetRMS (double t0, double t1, bool mayThrow=true) const
	Get root-mean-square. More...
size_t	GetBestBlockSize (sampleCount t) const
	A hint for sizing of well aligned fetches. More...
size_t	GetIdealBlockSize ()
	A hint for sizing of well aligned fetches. More...
size_t	GetMaxBlockSize () const
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 Channel
virtual	~Channel ()
ChannelGroup &	GetChannelGroup ()
	Channel object's lifetime is assumed to be nested in its Track's. More...
const ChannelGroup &	GetChannelGroup () const
	Channel object's lifetime is assumed to be nested in its Track's. More...
size_t	GetChannelIndex () const
size_t	ReallyGetChannelIndex () const
size_t	NIntervals () const
	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 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...

Additional Inherited Members
Public Types inherited from Channel
using	Interval = ChannelInterval
Protected Member Functions inherited from Channel
virtual ChannelGroup &	DoGetChannelGroup () const =0
	Subclass must override. More...
virtual ChannelGroup &	ReallyDoGetChannelGroup () const
	This is temporary! It defaults to call the above. More...

Detailed Description

Definition at line 131 of file WaveTrack.h.

Constructor & Destructor Documentation

~WaveChannel()

WaveChannel::~WaveChannel ( )

overridedefault

Member Function Documentation

Append()

bool WaveChannel::Append	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len
	)

If there is an existing WaveClip in the WaveTrack that owns the channel, then the data are appended to that clip. If there are no WaveClips in the track, then a new one is created.

Returns

true if at least one complete block was created

Exception safety guarantee:

Partial – Some prefix (maybe none) of the buffer is appended, and no content already flushed to disk is lost.

Definition at line 2656 of file WaveTrack.cpp.

{
   return GetTrack().Append(buffer, format, len, 1, widestSampleFormat);
}

References WaveTrack::Append(), anonymous_namespace{ExportPCM.cpp}::format, GetTrack(), and widestSampleFormat.

Referenced by EffectEqualization::Task::AccumulateSamples(), WaveTrackSink::DoConsume(), TrackSpectrumTransformer::DoOutput(), EffectSBSMS::Process(), EffectPaulstretch::ProcessOne(), EffectChangeSpeed::ProcessOne(), and EffectTwoPassSimpleMono::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

AppendBuffer()

bool WaveChannel::AppendBuffer	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len,
		unsigned	stride,
		sampleFormat	effectiveFormat
	)

Exception safety guarantee:

Partial – Some prefix (maybe none) of the buffer is appended, and no content already flushed to disk is lost.

Definition at line 2647 of file WaveTrack.cpp.

{
   return GetTrack().Append(buffer, format, len, stride, effectiveFormat);
}

References WaveTrack::Append(), anonymous_namespace{ExportPCM.cpp}::format, and GetTrack().

Here is the call graph for this function:

GetBestBlockSize()

size_t WaveChannel::GetBestBlockSize ( sampleCount  t ) const

inline

A hint for sizing of well aligned fetches.

Definition at line 1216 of file WaveTrack.h.

                                                        {
   return GetTrack().GetBestBlockSize(t);
}

References WaveTrack::GetBestBlockSize(), and GetTrack().

Referenced by EffectNormalize::AnalyseTrackData(), TrackSpectrumTransformer::Process(), EffectChangeSpeed::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), EffectNormalize::ProcessOne(), EffectLoudness::ProcessOne(), and resampleCB().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFloats() [1/2]

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

inline

"narrow" overload fetches from the unique channel

Definition at line 154 of file WaveTrack.h.

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

Referenced by EffectNormalize::AnalyseTrackData(), EffectAutoDuck::ApplyDuckFade(), TrackSpectrumTransformer::Process(), EffectPaulstretch::ProcessOne(), EffectChangeSpeed::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectRepair::ProcessOne(), EffectFindClipping::ProcessOne(), EffectEqualization::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), EffectNormalize::ProcessOne(), and resampleCB().

Here is the caller 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;
}

GetIdealBlockSize()

size_t WaveChannel::GetIdealBlockSize ( )

inline

A hint for sizing of well aligned fetches.

Definition at line 1220 of file WaveTrack.h.

                                      {
   return GetTrack().GetIdealBlockSize();
}

References WaveTrack::GetIdealBlockSize(), and GetTrack().

Here is the call graph for this function:

GetInterval() [1/2]

auto WaveChannel::GetInterval ( size_t  iInterval )

inline

Definition at line 142 of file WaveTrack.h.

                                      { return
      ::Channel::GetInterval<WaveChannelInterval>(iInterval); }

GetInterval() [2/2]

auto WaveChannel::GetInterval ( size_t  iInterval ) const

inline

Definition at line 144 of file WaveTrack.h.

                                            { return
      ::Channel::GetInterval<const WaveChannelInterval>(iInterval); }

GetMaxBlockSize()

size_t WaveChannel::GetMaxBlockSize ( ) const

inline

A hint for maximum returned by either of GetBestBlockSize, GetIdealBlockSize

Definition at line 1224 of file WaveTrack.h.

                                          {
   return GetTrack().GetMaxBlockSize();
}

References WaveTrack::GetMaxBlockSize(), and GetTrack().

Referenced by EffectNormalize::AnalyseTrackData(), TrackSpectrumTransformer::Process(), EffectChangeSpeed::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), and EffectNormalize::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMinMax()

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

Precondition

t0 <= t1

Definition at line 3060 of file WaveTrack.cpp.

{
   std::pair<float, float> results {
      // we need these at extremes to make sure we find true min and max
      FLT_MAX, -FLT_MAX
   };
   bool clipFound = false;
 
   if (t0 > t1) {
      if (mayThrow)
         THROW_INCONSISTENCY_EXCEPTION;
      return results;
   }
 
   if (t0 == t1)
      return results;
 
   for (const auto &clip: GetTrack().mClips)
   {
      if (t1 >= clip->GetPlayStartTime() && t0 <= clip->GetPlayEndTime())
      {
         clipFound = true;
         // TODO wide wave tracks -- choose correct channel
         auto clipResults = clip->GetMinMax(0, t0, t1, mayThrow);
         if (clipResults.first < results.first)
            results.first = clipResults.first;
         if (clipResults.second > results.second)
            results.second = clipResults.second;
      }
   }
 
   if(!clipFound)
   {
      results = { 0.f, 0.f }; // sensible defaults if no clips found
   }
 
   return results;
}

References GetTrack(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by EffectNormalize::AnalyseTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRMS()

float WaveChannel::GetRMS	(	double	t0,
		double	t1,
		bool	mayThrow = true
	)		const

Get root-mean-square.

Precondition

t0 <= t1

Definition at line 3100 of file WaveTrack.cpp.

{
   if (t0 > t1) {
      if (mayThrow)
         THROW_INCONSISTENCY_EXCEPTION;
      return 0.f;
   }
 
   if (t0 == t1)
      return 0.f;
 
   double sumsq = 0.0;
   double duration = 0;
 
   for (const auto &clip: GetTrack().mClips)
   {
      // If t1 == clip->GetStartTime() or t0 == clip->GetEndTime(), then the clip
      // is not inside the selection, so we don't want it.
      // if (t1 >= clip->GetStartTime() && t0 <= clip->GetEndTime())
      if (t1 >= clip->GetPlayStartTime() && t0 <= clip->GetPlayEndTime())
      {
         const auto clipStart = std::max(t0, clip->GetPlayStartTime());
         const auto clipEnd = std::min(t1, clip->GetPlayEndTime());
 
         // TODO wide wave tracks -- choose correct channel
         float cliprms = clip->GetRMS(0, t0, t1, mayThrow);
 
         sumsq += cliprms * cliprms * (clipEnd - clipStart);
         duration += (clipEnd - clipStart);
      }
   }
   return duration > 0 ? sqrt(sumsq / duration) : 0.0;
}

References GetTrack(), min(), staffpad::audio::simd::sqrt(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by EffectLoudness::GetTrackRMS().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleView()

ChannelSampleView WaveChannel::GetSampleView	(	double	t0,
		double	t1,
		bool	mayThrow
	)		const

Request channel samples within [t0, t1), not knowing in advance how many this will be.

The stretching of intersecting intervals 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.

Precondition

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

Definition at line 3462 of file WaveTrack.cpp.

{
   std::vector<std::shared_ptr<const WaveChannelInterval>>
      intersectingIntervals;
   for (const auto& interval : Intervals())
      if (interval->Intersects(t0, t1))
         intersectingIntervals.push_back(interval);
   if (intersectingIntervals.empty())
      return { AudioSegmentSampleView {
         (TimeToLongSamples(t1) - TimeToLongSamples(t0)).as_size_t() } };
   std::sort(
      intersectingIntervals.begin(), intersectingIntervals.end(),
      [](const auto& a, const auto& b) { return a->Start() < b->Start(); });
   std::vector<AudioSegmentSampleView> segments;
   segments.reserve(2 * intersectingIntervals.size() + 1);
   for (auto i = 0u; i < intersectingIntervals.size();++i)
   {
      const auto& interval = intersectingIntervals[i];
      const auto intervalStartTime = interval->Start();
      if (t0 < intervalStartTime)
      {
         const auto numSamples = TimeToLongSamples(intervalStartTime - t0);
         segments.push_back(AudioSegmentSampleView{numSamples.as_size_t()});
         t0 = intervalStartTime;
      }
      const auto intervalT0 = t0 - intervalStartTime;
      const auto intervalT1 = std::min(t1, interval->End()) - intervalStartTime;
      if(intervalT1 > intervalT0)
      {
         auto newSegment =
            interval->GetSampleView(intervalT0, intervalT1, mayThrow);
         t0 += intervalT1 - intervalT0;
         segments.push_back(std::move(newSegment));
      }
      if (t0 == t1)
         break;
   }
   if (t0 < t1)
      segments.push_back(AudioSegmentSampleView {
         (TimeToLongSamples(t1) - TimeToLongSamples(t0)).as_size_t() });
   return segments;
}

References Intervals(), min(), and WideSampleSequence::TimeToLongSamples().

Here is the call graph for this function:

GetTrack() [1/2]

WaveTrack & WaveChannel::GetTrack ( )

inline

Definition at line 1202 of file WaveTrack.h.

                                 {
   auto &result = static_cast<WaveTrack&>(DoGetChannelGroup());
   // TODO wide wave tracks -- remove assertion
   assert(&result == this);
   return result;
}

References Channel::DoGetChannelGroup().

Referenced by Append(), AppendBuffer(), GetBestBlockSize(), GetIdealBlockSize(), GetMaxBlockSize(), GetMinMax(), GetRMS(), EffectLoudness::LoadBufferBlock(), EffectPaulstretch::ProcessOne(), SpectralDataManager::Worker::ProcessOvertones(), SpectralDataManager::Worker::ProcessSnapping(), Set(), and EffectLoudness::StoreBufferBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrack() [2/2]

const WaveTrack & WaveChannel::GetTrack ( ) const

inline

Definition at line 1209 of file WaveTrack.h.

                                             {
   auto &result = static_cast<const WaveTrack&>(DoGetChannelGroup());
   // TODO wide wave tracks -- remove assertion
   assert(&result == this);
   return result;
}

References Channel::DoGetChannelGroup().

Here is the call graph for this function:

Intervals() [1/2]

auto WaveChannel::Intervals ( )

inline

Definition at line 147 of file WaveTrack.h.

{ return ::Channel::Intervals<WaveChannelInterval>(); }

Referenced by GetSampleView().

Here is the caller graph for this function:

Intervals() [2/2]

auto WaveChannel::Intervals ( ) const

inline

Definition at line 148 of file WaveTrack.h.

                          {
      return ::Channel::Intervals<const WaveChannelInterval>(); }

Set()

bool WaveChannel::Set	(	constSamplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		sampleFormat	effectiveFormat = widestSampleFormat
	)

Random-access assignment of a range of samples.

Exception safety guarantee:

Weak

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 3506 of file WaveTrack.cpp.

{
   for (const auto &clip: GetTrack().mClips)
   {
      auto clipStart = clip->GetPlayStartSample();
      auto clipEnd = clip->GetPlayEndSample();
 
      if (clipEnd > start && clipStart < start+len)
      {
         // Test as also in WaveTrack::GetOne()
         if (clip->GetStretchRatio() != 1.0)
            return false;
 
         // Clip sample region and Get/Put sample region overlap
         auto samplesToCopy =
            std::min( start+len - clipStart, clip->GetVisibleSampleCount() );
         auto startDelta = clipStart - start;
         decltype(startDelta) inclipDelta = 0;
         if (startDelta < 0)
         {
            inclipDelta = -startDelta; // make positive value
            samplesToCopy -= inclipDelta;
            // samplesToCopy is now either len or
            //    (clipEnd - clipStart) - (start - clipStart)
            //    == clipEnd - start > 0
            // samplesToCopy is not more than len
            //
            startDelta = 0;
            // startDelta is zero
         }
         else {
            // startDelta is nonnegative and less than len
            // samplesToCopy is positive and not more than len
         }
 
         clip->SetSamples(0,
            buffer + startDelta.as_size_t() * SAMPLE_SIZE(format),
            format, inclipDelta, samplesToCopy.as_size_t(), effectiveFormat );
         clip->MarkChanged();
      }
   }
   return true;
}

References anonymous_namespace{ExportPCM.cpp}::format, GetTrack(), min(), and SAMPLE_SIZE.

Referenced by EffectAutoDuck::ApplyDuckFade(), WaveTrackSink::DoConsume(), WaveTrackMenuTable::OnSwapChannels(), EffectClickRemoval::ProcessOne(), EffectRepair::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), EffectNormalize::ProcessOne(), and WaveTrack::ReverseOneClip().

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:

• WaveTrack.h
• WaveTrack.cpp