#include <StretchingSequence.h>

Inheritance diagram for StretchingSequence:

Collaboration diagram for StretchingSequence:

Public Member Functions
	StretchingSequence (const PlayableSequence &, int sampleRate, size_t numChannels, std::unique_ptr< AudioSegmentFactoryInterface >)

size_t	NChannels () const override
	A constant property. More...

float	GetChannelVolume (int channel) const override

double	GetStartTime () const override

double	GetEndTime () const override

double	GetRate () const override

sampleFormat	WidestEffectiveFormat () const override

bool	HasTrivialEnvelope () const override

void	GetEnvelopeValues (double *buffer, size_t bufferLen, double t0, bool backwards) const override

bool	DoGet (size_t iChannel, size_t nBuffers, const samplePtr buffers[], sampleFormat format, sampleCount start, size_t len, bool backwards, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const override

const ChannelGroup *	FindChannelGroup () const override
	Find associated ChannelGroup if any. More...

bool	GetSolo () const override
	May vary asynchronously. More...

bool	GetMute () const override
	May vary asynchronously. More...

AudioGraph::ChannelType	GetChannelType () const override
	Classify this channel. More...

bool	GetFloats (float *buffers[], sampleCount start, size_t len, bool backwards) const

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	GetChannelVolume (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 std::shared_ptr< StretchingSequence >	Create (const PlayableSequence &, const ClipConstHolders &clips)

Private Types
using	AudioSegments = std::vector< std::shared_ptr< AudioSegment > >

Private Member Functions
void	ResetCursor (double t, PlaybackDirection)

bool	GetNext (float *const buffers[], size_t numChannels, size_t numSamples)

bool	MutableGet (size_t iChannel, size_t nBuffers, const samplePtr buffers[], sampleFormat format, sampleCount start, size_t len, bool backwards)

Private Attributes
const PlayableSequence &	mSequence

const std::unique_ptr< AudioSegmentFactoryInterface >	mAudioSegmentFactory

AudioSegments	mAudioSegments

AudioSegments::const_iterator	mActiveAudioSegmentIt = mAudioSegments.end()

std::optional< sampleCount >	mExpectedStart

PlaybackDirection	mPlaybackDirection = PlaybackDirection::forward

Detailed Description

Definition at line 27 of file StretchingSequence.h.

Member Typedef Documentation

◆ AudioSegments

using StretchingSequence::AudioSegments = std::vector<std::shared_ptr<AudioSegment> >

private

Definition at line 67 of file StretchingSequence.h.

Constructor & Destructor Documentation

◆ StretchingSequence()

StretchingSequence::StretchingSequence	(	const PlayableSequence &	sequence,
		int	sampleRate,
		size_t	numChannels,
		std::unique_ptr< AudioSegmentFactoryInterface >	factory
	)

Definition at line 29 of file StretchingSequence.cpp.

    : mSequence { sequence }
    , mAudioSegmentFactory { std::move(factory) }
{
}

Member Function Documentation

◆ Create()

std::shared_ptr< StretchingSequence > StretchingSequence::Create	(	const PlayableSequence &	sequence,
		const ClipConstHolders &	clips
	)

static

Definition at line 189 of file StretchingSequence.cpp.

{
   const int sampleRate = sequence.GetRate();
   return std::make_shared<StretchingSequence>(
      sequence, sampleRate, sequence.NChannels(),
      std::make_unique<AudioSegmentFactory>(
         sampleRate, sequence.NChannels(), clips));
}

References WideSampleSequence::GetRate(), WideSampleSequence::NChannels(), and anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Referenced by ExportPluginHelpers::CreateMixer(), MakeTransportTracks(), MixAndRender(), and TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGet()

bool StretchingSequence::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

overridevirtual

Retrieve samples of one of the channels from a sequence in a specified format

Parameters

format	sample format of the destination buffer
backward	retrieves samples from `start` (inclusive) to `start + len` if false, else from `start` (exclusive) to `start - len` in reverse order.

Returns: whether successful; if not, assume nothing about buffer contents

Implements WideSampleSequence.

Definition at line 97 of file StretchingSequence.cpp.

{
   return const_cast<StretchingSequence&>(*this).MutableGet(
      iChannel, nBuffers, buffers, format, start, len, backwards);
}

References anonymous_namespace{ExportPCM.cpp}::format, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and MutableGet().

Referenced by GetFloats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindChannelGroup()

const ChannelGroup * StretchingSequence::FindChannelGroup ( ) const

overridevirtual

Find associated ChannelGroup if any.

Implements PlayableSequence.

Definition at line 106 of file StretchingSequence.cpp.

{
   return mSequence.FindChannelGroup();
}

References PlayableSequence::FindChannelGroup(), and mSequence.

Here is the call graph for this function:

◆ GetChannelType()

AudioGraph::ChannelType StretchingSequence::GetChannelType ( ) const

overridevirtual

Classify this channel.

Implements AudioGraph::Channel.

Definition at line 152 of file StretchingSequence.cpp.

{
   return mSequence.GetChannelType();
}

References AudioGraph::Channel::GetChannelType(), and mSequence.

Here is the call graph for this function:

◆ GetChannelVolume()

float StretchingSequence::GetChannelVolume ( int channel ) const

overridevirtual

Extra gain factor to apply to a channel when mixing, may change asynchronously

Implements WideSampleSequence.

Definition at line 92 of file StretchingSequence.cpp.

{
   return mSequence.GetChannelVolume(channel);
}

References WideSampleSequence::GetChannelVolume(), and mSequence.

Here is the call graph for this function:

◆ GetEndTime()

double StretchingSequence::GetEndTime ( ) const

overridevirtual

Implements WideSampleSequence.

Definition at line 126 of file StretchingSequence.cpp.

{
   return mSequence.GetEndTime();
}

References WideSampleSequence::GetEndTime(), and mSequence.

Here is the call graph for this function:

◆ GetEnvelopeValues()

void StretchingSequence::GetEnvelopeValues	(	double *	buffer,
		size_t	bufferLen,
		double	t0,
		bool	backwards
	)		const

overridevirtual

Fetch envelope values corresponding to uniformly separated sample times starting at the given time

Parameters

backwards if true, fetch values in reverse order, from t0 to t0 - bufferLen / rate

Implements WideSampleSequence.

Definition at line 146 of file StretchingSequence.cpp.

{
   mSequence.GetEnvelopeValues(buffer, bufferLen, t0, backwards);
}

References WideSampleSequence::GetEnvelopeValues(), and mSequence.

Here is the call graph for this function:

◆ GetFloats()

bool StretchingSequence::GetFloats	(	float *	buffers[],
		sampleCount	start,
		size_t	len,
		bool	backwards
	)		const

Definition at line 157 of file StretchingSequence.cpp.

{
   std::vector<samplePtr> charBuffers;
   const auto nChannels = NChannels();
   charBuffers.reserve(nChannels);
   for (auto i = 0u; i < nChannels; ++i)
      charBuffers.push_back(reinterpret_cast<samplePtr>(buffers[i]));
   constexpr auto iChannel = 0u;
   return DoGet(
      iChannel, nChannels, charBuffers.data(), sampleFormat::floatSample, start,
      len, backwards);
}

References DoGet(), floatSample, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and NChannels().

Here is the call graph for this function:

◆ GetMute()

bool StretchingSequence::GetMute ( ) const

overridevirtual

May vary asynchronously.

Implements PlayableSequence.

Definition at line 116 of file StretchingSequence.cpp.

{
   return mSequence.GetMute();
}

References PlayableSequence::GetMute(), and mSequence.

Here is the call graph for this function:

◆ GetNext()

bool StretchingSequence::GetNext	(	float *const	buffers[],
		size_t	numChannels,
		size_t	numSamples
	)

private

Definition at line 46 of file StretchingSequence.cpp.

{
   if (!mExpectedStart.has_value())
      ResetCursor(0., PlaybackDirection::forward);
   auto numProcessedSamples = 0u;
   while (numProcessedSamples < numSamples &&
          mActiveAudioSegmentIt != mAudioSegments.end())
   {
      const auto& segment = *mActiveAudioSegmentIt;
      // More-than-stereo isn't supported
      assert(mSequence.NChannels() <= 2);
      float* offsetBuffers[2] {};
      GetOffsetBuffer(
         offsetBuffers, buffers, mSequence.NChannels(), numProcessedSamples);
      numProcessedSamples += segment->GetFloats(
         offsetBuffers,
         numSamples - numProcessedSamples); // No need to reverse, we feed the
                                            // time-stretching algorithm with
                                            // reversed samples already.
      if (segment->Empty())
         ++mActiveAudioSegmentIt;
   }
   const auto remaining = numSamples - numProcessedSamples;
   if (remaining > 0u)
   {
      // More-than-stereo isn't supported
      assert(mSequence.NChannels() <= 2);
      float* offsetBuffers[2] {};
      GetOffsetBuffer(
         offsetBuffers, buffers, mSequence.NChannels(), numProcessedSamples);
      for (auto i = 0u; i < mSequence.NChannels(); ++i)
         std::fill(offsetBuffers[i], offsetBuffers[i] + remaining, 0.f);
   }
   mExpectedStart =
      mPlaybackDirection == PlaybackDirection::forward ?
         *mExpectedStart + numSamples :
         *mExpectedStart - static_cast<sampleCount::type>(numSamples);
   return true;
}

References forward, anonymous_namespace{StretchingSequence.cpp}::GetOffsetBuffer(), mActiveAudioSegmentIt, mAudioSegments, mExpectedStart, mPlaybackDirection, mSequence, WideSampleSequence::NChannels(), and ResetCursor().

Referenced by MutableGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRate()

double StretchingSequence::GetRate ( ) const

overridevirtual

Implements WideSampleSequence.

Definition at line 131 of file StretchingSequence.cpp.

{
   return mSequence.GetRate();
}

References WideSampleSequence::GetRate(), and mSequence.

Here is the call graph for this function:

◆ GetSolo()

bool StretchingSequence::GetSolo ( ) const

overridevirtual

May vary asynchronously.

Implements PlayableSequence.

Definition at line 111 of file StretchingSequence.cpp.

{
   return mSequence.GetSolo();
}

References PlayableSequence::GetSolo(), and mSequence.

Here is the call graph for this function:

◆ GetStartTime()

double StretchingSequence::GetStartTime ( ) const

overridevirtual

Implements WideSampleSequence.

Definition at line 121 of file StretchingSequence.cpp.

{
   return mSequence.GetStartTime();
}

References WideSampleSequence::GetStartTime(), and mSequence.

Here is the call graph for this function:

◆ HasTrivialEnvelope()

bool StretchingSequence::HasTrivialEnvelope ( ) const

overridevirtual

Returns: whether envelope values are all unit

Implements WideSampleSequence.

Definition at line 141 of file StretchingSequence.cpp.

{
   return mSequence.HasTrivialEnvelope();
}

References WideSampleSequence::HasTrivialEnvelope(), and mSequence.

Here is the call graph for this function:

◆ MutableGet()

bool StretchingSequence::MutableGet	(	size_t	iChannel,
		size_t	nBuffers,
		const samplePtr	buffers[],
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	backwards
	)

private

Definition at line 171 of file StretchingSequence.cpp.

{
   // StretchingSequence is not expected to be used for any other case.
   assert(iChannel == 0u);
   if (
      !mExpectedStart.has_value() || *mExpectedStart != start ||
      (mPlaybackDirection == PlaybackDirection::backward != backwards))
   {
      const auto t = start.as_double() / mSequence.GetRate();
      ResetCursor(
         t,
         backwards ? PlaybackDirection::backward : PlaybackDirection::forward);
   }
   return GetNext(reinterpret_cast<float* const*>(buffers), nBuffers, len);
}

References sampleCount::as_double(), backward, forward, GetNext(), WideSampleSequence::GetRate(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, mExpectedStart, mPlaybackDirection, mSequence, and ResetCursor().

Referenced by DoGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NChannels()

size_t StretchingSequence::NChannels ( ) const

overridevirtual

A constant property.

Postcondition: result: result > 0

Implements WideSampleSequence.

Definition at line 87 of file StretchingSequence.cpp.

{
   return mSequence.NChannels();
}

References mSequence, and WideSampleSequence::NChannels().

Referenced by GetFloats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetCursor()

void StretchingSequence::ResetCursor	(	double	t,
		PlaybackDirection	direction
	)

private

Definition at line 37 of file StretchingSequence.cpp.

{
   mAudioSegments =
      mAudioSegmentFactory->CreateAudioSegmentSequence(t, direction);
   mActiveAudioSegmentIt = mAudioSegments.begin();
   mPlaybackDirection = direction;
   mExpectedStart = TimeToLongSamples(t);
}

References mActiveAudioSegmentIt, mAudioSegmentFactory, mAudioSegments, mExpectedStart, mPlaybackDirection, and WideSampleSequence::TimeToLongSamples().

Referenced by GetNext(), and MutableGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WidestEffectiveFormat()

sampleFormat StretchingSequence::WidestEffectiveFormat ( ) const

overridevirtual

Returns: widest effective SampleFormat in any part of the track

Implements WideSampleSequence.

Definition at line 136 of file StretchingSequence.cpp.

{
   return mSequence.WidestEffectiveFormat();
}

References mSequence, and WideSampleSequence::WidestEffectiveFormat().

Here is the call graph for this function:

Member Data Documentation

◆ mActiveAudioSegmentIt

AudioSegments::const_iterator StretchingSequence::mActiveAudioSegmentIt = mAudioSegments.end()

private

Definition at line 78 of file StretchingSequence.h.

Referenced by GetNext(), and ResetCursor().

◆ mAudioSegmentFactory

const std::unique_ptr<AudioSegmentFactoryInterface> StretchingSequence::mAudioSegmentFactory

private

Definition at line 76 of file StretchingSequence.h.

Referenced by ResetCursor().

◆ mAudioSegments

AudioSegments StretchingSequence::mAudioSegments

private

Definition at line 77 of file StretchingSequence.h.

Referenced by GetNext(), and ResetCursor().

◆ mExpectedStart

std::optional<sampleCount> StretchingSequence::mExpectedStart

private

Definition at line 79 of file StretchingSequence.h.

Referenced by GetNext(), MutableGet(), and ResetCursor().

◆ mPlaybackDirection

PlaybackDirection StretchingSequence::mPlaybackDirection = PlaybackDirection::forward

private

Definition at line 80 of file StretchingSequence.h.

Referenced by GetNext(), MutableGet(), and ResetCursor().

◆ mSequence

const PlayableSequence& StretchingSequence::mSequence

private

Definition at line 75 of file StretchingSequence.h.

Referenced by FindChannelGroup(), GetChannelType(), GetChannelVolume(), GetEndTime(), GetEnvelopeValues(), GetMute(), GetNext(), GetRate(), GetSolo(), GetStartTime(), HasTrivialEnvelope(), MutableGet(), NChannels(), and WidestEffectiveFormat().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AudioSegments

Constructor & Destructor Documentation

◆ StretchingSequence()

Member Function Documentation

◆ Create()

◆ DoGet()

◆ FindChannelGroup()

◆ GetChannelType()

◆ GetChannelVolume()

◆ GetEndTime()

◆ GetEnvelopeValues()

◆ GetFloats()

◆ GetMute()

◆ GetNext()

◆ GetRate()

◆ GetSolo()

◆ GetStartTime()

◆ HasTrivialEnvelope()

◆ MutableGet()

◆ NChannels()

◆ ResetCursor()

◆ WidestEffectiveFormat()

Member Data Documentation

◆ mActiveAudioSegmentIt

◆ mAudioSegmentFactory

◆ mAudioSegments

◆ mExpectedStart

◆ mPlaybackDirection

◆ mSequence