anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy Class Reference

Inheritance diagram for anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy:

Collaboration diagram for anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy:

Public Member Functions
	CutPreviewPlaybackPolicy (double gapLeft, double gapLength)
	~CutPreviewPlaybackPolicy () override
void	Initialize (PlaybackSchedule &schedule, double rate) override
	Called before starting an audio stream. More...
bool	Done (PlaybackSchedule &schedule, unsigned long) override
	Returns true if schedule.GetSequenceTime() has reached the end of playback. More...
double	OffsetSequenceTime (PlaybackSchedule &schedule, double offset) override
	Called when the play head needs to jump a certain distance. More...
PlaybackSlice	GetPlaybackSlice (PlaybackSchedule &schedule, size_t available) override
	Choose length of one fetch of samples from tracks in a call to AudioIO::FillPlayBuffers. More...
std::pair< double, double >	AdvancedTrackTime (PlaybackSchedule &schedule, double trackTime, size_t nSamples) override
	Compute a new point in a track's timeline from an old point and a real duration. More...
bool	RepositionPlayback (PlaybackSchedule &schedule, const Mixers &playbackMixers, size_t frames, size_t available) override
	AudioIO::FillPlayBuffers calls this to update its cursors into tracks for changes of position or speed. More...
Public Member Functions inherited from PlaybackPolicy
virtual	~PlaybackPolicy ()=0
virtual void	Initialize (PlaybackSchedule &schedule, double rate)
	Called before starting an audio stream. More...
virtual void	Finalize (PlaybackSchedule &schedule)
	Called after stopping of an audio stream or an unsuccessful start. More...
virtual Mixer::WarpOptions	MixerWarpOptions (PlaybackSchedule &schedule)
	Options to use when constructing mixers for each playback track. More...
virtual BufferTimes	SuggestedBufferTimes (PlaybackSchedule &schedule)
	Provide hints for construction of playback RingBuffer objects. More...
virtual bool	AllowSeek (PlaybackSchedule &schedule)
	Whether repositioning commands are allowed during playback. More...
virtual bool	Done (PlaybackSchedule &schedule, unsigned long outputFrames)
	Returns true if schedule.GetSequenceTime() has reached the end of playback. More...
virtual double	OffsetSequenceTime (PlaybackSchedule &schedule, double offset)
	Called when the play head needs to jump a certain distance. More...
virtual std::chrono::milliseconds	SleepInterval (PlaybackSchedule &schedule)
	How long to wait between calls to AudioIO::SequenceBufferExchange. More...
virtual PlaybackSlice	GetPlaybackSlice (PlaybackSchedule &schedule, size_t available)
	Choose length of one fetch of samples from tracks in a call to AudioIO::FillPlayBuffers. More...
virtual std::pair< double, double >	AdvancedTrackTime (PlaybackSchedule &schedule, double trackTime, size_t nSamples)
	Compute a new point in a track's timeline from an old point and a real duration. More...
virtual bool	RepositionPlayback (PlaybackSchedule &schedule, const Mixers &playbackMixers, size_t frames, size_t available)
	AudioIO::FillPlayBuffers calls this to update its cursors into tracks for changes of position or speed. More...
virtual bool	Looping (const PlaybackSchedule &schedule) const

Private Member Functions
double	GapStart () const
double	GapEnd () const
bool	AtOrBefore (double trackTime1, double trackTime2) const

Private Attributes
const double	mGapLeft
	Fixed at construction time; these are a track time and duration. More...
const double	mGapLength
double	mStart = 0
	Starting and ending track times set in Initialize() More...
double	mEnd = 0
double	mDuration1 = 0
double	mDuration2 = 0
double	mInitDuration1 = 0
double	mInitDuration2 = 0
bool	mDiscontinuity { false }
bool	mReversed { false }

Additional Inherited Members
Public Types inherited from PlaybackPolicy
using	Duration = std::chrono::duration< double >
using	Mixers = std::vector< std::unique_ptr< Mixer > >
Protected Attributes inherited from PlaybackPolicy
double	mRate = 0

Detailed Description

Definition at line 107 of file ProjectAudioManager.cpp.

Constructor & Destructor Documentation

CutPreviewPlaybackPolicy()

anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::CutPreviewPlaybackPolicy	(	double	gapLeft,
		double	gapLength
	)

Parameters

gapLeft	Lower bound track time of of elision
gapLength	Non-negative track duration

Definition at line 153 of file ProjectAudioManager.cpp.

: mGapLeft{ gapLeft }, mGapLength{ gapLength }
{
   wxASSERT(gapLength >= 0.0);
}

~CutPreviewPlaybackPolicy()

anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::~CutPreviewPlaybackPolicy ( )

overridedefault

Member Function Documentation

AdvancedTrackTime()

std::pair< double, double > anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::AdvancedTrackTime ( PlaybackSchedule &  schedule, double  trackTime, size_t  nSamples  )

overridevirtual

Compute a new point in a track's timeline from an old point and a real duration.

Needed because playback might be at non-unit speed.

Called one or more times between GetPlaybackSlice and RepositionPlayback, until the sum of the nSamples values equals the most recent playback slice (including any trailing silence).

Returns

a pair, which indicates a discontinuous jump when its members are not equal, or specially the end of playback when the second member is infinite

Reimplemented from PlaybackPolicy.

Definition at line 254 of file ProjectAudioManager.cpp.

{
   auto realDuration = nSamples / mRate;
   if (mDuration1 > 0) {
      mDuration1 = std::max(0.0, mDuration1 - realDuration);
      if (sampleCount(mDuration1 * mRate) == 0) {
         mDuration1 = 0;
         mDiscontinuity = true;
         return { GapStart(), GapEnd() };
      }
   }
   else
      mDuration2 = std::max(0.0, mDuration2 - realDuration);
   if (mReversed)
      realDuration *= -1;
   const double time = schedule.SolveWarpedLength(trackTime, realDuration);
 
   if ( mReversed ? time <= mEnd : time >= mEnd )
      return {mEnd, std::numeric_limits<double>::infinity()};
   else
      return {time, time};
}

References GapEnd(), GapStart(), mDiscontinuity, mDuration1, mDuration2, mEnd, PlaybackPolicy::mRate, mReversed, and PlaybackSchedule::SolveWarpedLength().

Here is the call graph for this function:

AtOrBefore()

bool anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::AtOrBefore ( double  trackTime1, double  trackTime2  ) const

inlineprivate

Definition at line 136 of file ProjectAudioManager.cpp.

   { return mReversed ? trackTime1 >= trackTime2 : trackTime1 <= trackTime2; }

Done()

bool anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::Done ( PlaybackSchedule &  schedule, unsigned long  outputFrames  )

overridevirtual

Returns true if schedule.GetSequenceTime() has reached the end of playback.

Called in the PortAudio thread

Parameters

outputFrames

how many playback frames were taken from RingBuffers

Reimplemented from PlaybackPolicy.

Definition at line 187 of file ProjectAudioManager.cpp.

{
   auto diff = schedule.GetSequenceTime() - mEnd;
   if (mReversed)
      diff *= -1;
   return sampleCount(diff * mRate) >= 0;
}

References PlaybackSchedule::GetSequenceTime(), mEnd, PlaybackPolicy::mRate, and mReversed.

Here is the call graph for this function:

GapEnd()

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::GapEnd ( ) const

inlineprivate

Definition at line 134 of file ProjectAudioManager.cpp.

   { return mReversed ? mGapLeft : mGapLeft + mGapLength; }

Referenced by AdvancedTrackTime(), and RepositionPlayback().

Here is the caller graph for this function:

GapStart()

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::GapStart ( ) const

inlineprivate

Definition at line 132 of file ProjectAudioManager.cpp.

   { return mReversed ? mGapLeft + mGapLength : mGapLeft; }

Referenced by AdvancedTrackTime().

Here is the caller graph for this function:

GetPlaybackSlice()

PlaybackSlice anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::GetPlaybackSlice ( PlaybackSchedule &  schedule, size_t  available  )

overridevirtual

Choose length of one fetch of samples from tracks in a call to AudioIO::FillPlayBuffers.

Parameters

available

upper bound for the length of the fetch

Reimplemented from PlaybackPolicy.

Definition at line 233 of file ProjectAudioManager.cpp.

{
   size_t frames = available;
   size_t toProduce = frames;
   sampleCount samples1(mDuration1 * mRate + 0.5);
   if (samples1 > 0 && samples1 < frames)
      // Shorter slice than requested, up to the discontinuity
      toProduce = frames = samples1.as_size_t();
   else if (samples1 == 0) {
      sampleCount samples2(mDuration2 * mRate + 0.5);
      if (samples2 < frames) {
         toProduce = samples2.as_size_t();
         // Produce some extra silence so that the time queue consumer can
         // satisfy its end condition
         frames = std::min(available, toProduce + TimeQueueGrainSize + 1);
      }
   }
   return { available, frames, toProduce };
}

References sampleCount::as_size_t(), mDuration1, mDuration2, min(), PlaybackPolicy::mRate, and TimeQueueGrainSize.

Here is the call graph for this function:

Initialize()

void anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::Initialize ( PlaybackSchedule &  schedule, double  rate  )

overridevirtual

Called before starting an audio stream.

Reimplemented from PlaybackPolicy.

Definition at line 162 of file ProjectAudioManager.cpp.

{
   PlaybackPolicy::Initialize(schedule, rate);
 
   // Examine mT0 and mT1 in the schedule only now; ignore changes during play
   double left = mStart = schedule.mT0;
   double right = mEnd = schedule.mT1;
   mReversed = left > right;
   if (mReversed)
      std::swap(left, right);
 
   if (left < mGapLeft)
      mDuration1 = schedule.ComputeWarpedLength(left, mGapLeft);
   const auto gapEnd = mGapLeft + mGapLength;
   if (gapEnd < right)
      mDuration2 = schedule.ComputeWarpedLength(gapEnd, right);
   if (mReversed)
      std::swap(mDuration1, mDuration2);
   if (sampleCount(mDuration2 * rate) == 0)
      mDuration2 = mDuration1, mDuration1 = 0;
   mInitDuration1 = mDuration1;
   mInitDuration2 = mDuration2;
}

References PlaybackSchedule::ComputeWarpedLength(), PlaybackPolicy::Initialize(), mDuration1, mDuration2, mEnd, mGapLeft, mGapLength, mInitDuration1, mInitDuration2, mReversed, mStart, PlaybackSchedule::mT0, PlaybackSchedule::mT1, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

OffsetSequenceTime()

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::OffsetSequenceTime ( PlaybackSchedule &  schedule, double  offset  )

overridevirtual

Called when the play head needs to jump a certain distance.

Parameters

offset

signed amount requested to be added to schedule::GetSequenceTime()

Returns

the new value that will be set as the schedule's track time

Reimplemented from PlaybackPolicy.

RepositionPlayback()

bool anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::RepositionPlayback ( PlaybackSchedule &  schedule, const Mixers &  playbackMixers, size_t  frames, size_t  available  )

overridevirtual

AudioIO::FillPlayBuffers calls this to update its cursors into tracks for changes of position or speed.

Returns

if true, AudioIO::FillPlayBuffers stops producing samples even if space remains

Parameters

frames	how many samples were just now buffered for play
available	how many more samples may be buffered

Reimplemented from PlaybackPolicy.

Definition at line 278 of file ProjectAudioManager.cpp.

{
   if (mDiscontinuity) {
      mDiscontinuity = false;
      auto newTime = GapEnd();
      for (auto &pMixer : playbackMixers)
         pMixer->Reposition(newTime, true);
      // Tell SequenceBufferExchange that we aren't done yet
      return false;
   }
   return true;
}

References GapEnd(), and mDiscontinuity.

Here is the call graph for this function:

Member Data Documentation

mDiscontinuity

bool anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mDiscontinuity { false }

private

Definition at line 149 of file ProjectAudioManager.cpp.

Referenced by AdvancedTrackTime(), and RepositionPlayback().

mDuration1

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mDuration1 = 0

private

Definition at line 146 of file ProjectAudioManager.cpp.

Referenced by AdvancedTrackTime(), GetPlaybackSlice(), and Initialize().

mDuration2

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mDuration2 = 0

private

Definition at line 146 of file ProjectAudioManager.cpp.

Referenced by AdvancedTrackTime(), GetPlaybackSlice(), and Initialize().

mEnd

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mEnd = 0

private

Definition at line 143 of file ProjectAudioManager.cpp.

Referenced by AdvancedTrackTime(), Done(), and Initialize().

mGapLeft

const double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mGapLeft

private

Fixed at construction time; these are a track time and duration.

Definition at line 140 of file ProjectAudioManager.cpp.

Referenced by Initialize().

mGapLength

const double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mGapLength

private

Definition at line 140 of file ProjectAudioManager.cpp.

Referenced by Initialize().

mInitDuration1

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mInitDuration1 = 0

private

Definition at line 147 of file ProjectAudioManager.cpp.

Referenced by Initialize().

mInitDuration2

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mInitDuration2 = 0

private

Definition at line 147 of file ProjectAudioManager.cpp.

Referenced by Initialize().

mReversed

bool anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mReversed { false }

private

Definition at line 150 of file ProjectAudioManager.cpp.

Referenced by AdvancedTrackTime(), Done(), and Initialize().

mStart

double anonymous_namespace{ProjectAudioManager.cpp}::CutPreviewPlaybackPolicy::mStart = 0

private

Starting and ending track times set in Initialize()

Definition at line 143 of file ProjectAudioManager.cpp.

Referenced by Initialize().

---

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

• ProjectAudioManager.cpp