#include <PlaybackSchedule.h>

Inheritance diagram for NewDefaultPlaybackPolicy:

Collaboration diagram for NewDefaultPlaybackPolicy:

Classes
struct	SlotData

Public Member Functions
	NewDefaultPlaybackPolicy (AudacityProject &project, double trackEndTime, double loopEndTime, bool loopEnabled, bool variableSpeed)

	~NewDefaultPlaybackPolicy () override

void	Initialize (PlaybackSchedule &schedule, double rate) override
	Called before starting an audio stream. More...

Mixer::WarpOptions	MixerWarpOptions (PlaybackSchedule &schedule) override
	Options to use when constructing mixers for each playback track. More...

BufferTimes	SuggestedBufferTimes (PlaybackSchedule &schedule) override
	Provide hints for construction of playback RingBuffer objects. More...

bool	Done (PlaybackSchedule &schedule, unsigned long) override
	Returns true if schedule.GetTrackTime() has reached the end of playback. 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...

bool	Looping (const PlaybackSchedule &) const override

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.GetTrackTime() has reached the end of playback. More...

virtual double	OffsetTrackTime (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::TrackBufferExchange. 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
bool	RevertToOldDefault (const PlaybackSchedule &schedule) const

void	WriteMessage ()

double	GetPlaySpeed ()

Private Attributes
AudacityProject &	mProject

MessageBuffer< SlotData >	mMessageChannel

Observer::Subscription	mRegionSubscription

Observer::Subscription	mSpeedSubscription

double	mLastPlaySpeed { 1.0 }

const double	mTrackEndTime

double	mLoopEndTime

size_t	mRemaining { 0 }

bool	mProgress { true }

bool	mLoopEnabled { true }

bool	mVariableSpeed { 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 329 of file PlaybackSchedule.h.

Constructor & Destructor Documentation

◆ NewDefaultPlaybackPolicy()

NewDefaultPlaybackPolicy::NewDefaultPlaybackPolicy	(	AudacityProject &	project,
		double	trackEndTime,
		double	loopEndTime,
		bool	loopEnabled,
		bool	variableSpeed
	)

Definition at line 169 of file PlaybackSchedule.cpp.

   : mProject{ project }
   , mTrackEndTime{ trackEndTime }
   , mLoopEndTime{ loopEndTime }
   , mLoopEnabled{ loopEnabled }
   , mVariableSpeed{ variableSpeed }
{}

◆ ~NewDefaultPlaybackPolicy()

NewDefaultPlaybackPolicy::~NewDefaultPlaybackPolicy ( )

overridedefault

Member Function Documentation

◆ AdvancedTrackTime()

std::pair< double, double > NewDefaultPlaybackPolicy::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 274 of file PlaybackSchedule.cpp.

{
   bool revert = RevertToOldDefault(schedule);
   if (!mVariableSpeed && revert)
      return PlaybackPolicy::AdvancedTrackTime(schedule, trackTime, nSamples);
 
   mRemaining -= std::min(mRemaining, nSamples);
   if ( mRemaining == 0 && !revert )
      // Wrap to start
      return { schedule.mT1, schedule.mT0 };
 
   // Defense against cases that might cause loops not to terminate
   if ( fabs(schedule.mT0 - schedule.mT1) < 1e-9 )
      return {schedule.mT0, schedule.mT0};
 
   auto realDuration = (nSamples / mRate) * mLastPlaySpeed;
   if (schedule.ReversedTime())
      realDuration *= -1.0;
 
   if (schedule.mEnvelope)
      trackTime =
         schedule.SolveWarpedLength(trackTime, realDuration);
   else
      trackTime += realDuration;
 
   return { trackTime, trackTime };
}

References PlaybackPolicy::AdvancedTrackTime(), PlaybackSchedule::mEnvelope, min(), mLastPlaySpeed, PlaybackPolicy::mRate, mRemaining, PlaybackSchedule::mT0, PlaybackSchedule::mT1, mVariableSpeed, PlaybackSchedule::ReversedTime(), RevertToOldDefault(), and PlaybackSchedule::SolveWarpedLength().

Here is the call graph for this function:

◆ Done()

bool NewDefaultPlaybackPolicy::Done	(	PlaybackSchedule &	schedule,
		unsigned long	outputFrames
	)

overridevirtual

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

Parameters

outputFrames how many playback frames were taken from RingBuffers

Reimplemented from PlaybackPolicy.

Definition at line 222 of file PlaybackSchedule.cpp.

{
   if (RevertToOldDefault(schedule)) {
      auto diff = schedule.GetTrackTime() - schedule.mT1;
      if (schedule.ReversedTime())
         diff *= -1;
      return sampleCount(floor(diff * mRate + 0.5)) >= 0;
   }
   return false;
}

References PlaybackSchedule::GetTrackTime(), PlaybackPolicy::mRate, PlaybackSchedule::mT1, PlaybackSchedule::ReversedTime(), and RevertToOldDefault().

Here is the call graph for this function:

◆ GetPlaybackSlice()

PlaybackSlice NewDefaultPlaybackPolicy::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 235 of file PlaybackSchedule.cpp.

{
   // How many samples to produce for each channel.
   const auto realTimeRemaining = std::max(0.0, schedule.RealTimeRemaining());
   mRemaining = realTimeRemaining * mRate / mLastPlaySpeed;
 
   auto frames = available;
   auto toProduce = frames;
   double deltat = (frames / mRate) * mLastPlaySpeed;
 
   if (deltat > realTimeRemaining) {
      toProduce = frames = 0.5 + (realTimeRemaining * mRate) / mLastPlaySpeed;
      auto realTime = realTimeRemaining;
      double extra = 0;
      if (RevertToOldDefault(schedule)) {
         // Produce some extra silence so that the time queue consumer can
         // satisfy its end condition
         const double extraRealTime =
            ((TimeQueueGrainSize + 1) / mRate) * mLastPlaySpeed;
         extra = std::min( extraRealTime, deltat - realTimeRemaining );
         frames = ((realTimeRemaining + extra) * mRate) / mLastPlaySpeed;
      }
      schedule.RealTimeAdvance( realTimeRemaining + extra );
   }
   else
      schedule.RealTimeAdvance( deltat );
 
   // Don't fall into an infinite loop, if loop-playing a selection
   // that is so short, it has no samples: detect that case
   if (frames == 0) {
      bool progress = (schedule.mWarpedTime != 0.0);
      if (!progress)
         // Cause FillPlayBuffers to make progress, filling all available with 0
         frames = available, toProduce = 0;
   }
   return { available, frames, toProduce };
}

References min(), mLastPlaySpeed, PlaybackPolicy::mRate, mRemaining, PlaybackSchedule::mWarpedTime, PlaybackSchedule::RealTimeAdvance(), PlaybackSchedule::RealTimeRemaining(), RevertToOldDefault(), and TimeQueueGrainSize.

Here is the call graph for this function:

◆ GetPlaySpeed()

double NewDefaultPlaybackPolicy::GetPlaySpeed ( )

private

Definition at line 413 of file PlaybackSchedule.cpp.

{
   return mVariableSpeed
      ? ProjectAudioIO::Get(mProject).GetPlaySpeed()
      : 1.0;
}

References ProjectAudioIO::Get(), ProjectAudioIO::GetPlaySpeed(), mProject, and mVariableSpeed.

Referenced by Initialize(), MixerWarpOptions(), and WriteMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize()

void NewDefaultPlaybackPolicy::Initialize	(	PlaybackSchedule &	schedule,
		double	rate
	)

overridevirtual

Called before starting an audio stream.

Reimplemented from PlaybackPolicy.

Definition at line 181 of file PlaybackSchedule.cpp.

{
   PlaybackPolicy::Initialize(schedule, rate);
   mLastPlaySpeed = GetPlaySpeed();
   mMessageChannel.Write( { mLastPlaySpeed,
      schedule.mT0, mLoopEndTime, mLoopEnabled } );
 
   auto callback = [this](auto&){ WriteMessage(); };
   mRegionSubscription =
       ViewInfo::Get(mProject).playRegion.Subscribe(callback);
   if (mVariableSpeed)
      mSpeedSubscription = ProjectAudioIO::Get(mProject).Subscribe(callback);
}

References ViewInfo::Get(), ProjectAudioIO::Get(), GetPlaySpeed(), PlaybackPolicy::Initialize(), mLastPlaySpeed, mLoopEnabled, mLoopEndTime, mMessageChannel, mProject, mRegionSubscription, mSpeedSubscription, PlaybackSchedule::mT0, mVariableSpeed, ViewInfo::playRegion, Observer::Publisher< Message, NotifyAll >::Subscribe(), and WriteMessage().

Here is the call graph for this function:

◆ Looping()

bool NewDefaultPlaybackPolicy::Looping ( const PlaybackSchedule & schedule ) const

overridevirtual

be removed

Reimplemented from PlaybackPolicy.

Definition at line 400 of file PlaybackSchedule.cpp.

{
   return mLoopEnabled;
}

References mLoopEnabled.

◆ MixerWarpOptions()

Mixer::WarpOptions NewDefaultPlaybackPolicy::MixerWarpOptions ( PlaybackSchedule & schedule )

overridevirtual

Options to use when constructing mixers for each playback track.

Reimplemented from PlaybackPolicy.

Definition at line 196 of file PlaybackSchedule.cpp.

{
   if (mVariableSpeed)
      // Enable variable rate mixing
      return Mixer::WarpOptions(0.01, 32.0, GetPlaySpeed());
   else
      return PlaybackPolicy::MixerWarpOptions(schedule);
}

References GetPlaySpeed(), PlaybackPolicy::MixerWarpOptions(), and mVariableSpeed.

Here is the call graph for this function:

◆ RepositionPlayback()

bool NewDefaultPlaybackPolicy::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 303 of file PlaybackSchedule.cpp.

{
   // This executes in the TrackBufferExchange thread
   auto data = mMessageChannel.Read();
 
   bool speedChange = false;
   if (mVariableSpeed) {
      speedChange = (mLastPlaySpeed != data.mPlaySpeed);
      mLastPlaySpeed = data.mPlaySpeed;
   }
 
   bool empty = (data.mT0 >= data.mT1);
   bool kicked = false;
 
   // Amount in seconds by which right boundary can be moved left of the play
   // head, yet loop play in progress will still capture the head
   constexpr auto allowance = 0.5;
 
   // Looping may become enabled if the main thread said so, but require too
   // that the loop region is non-empty and the play head is not far to its
   // right
   bool loopWasEnabled = !RevertToOldDefault(schedule);
   mLoopEnabled = data.mLoopEnabled && !empty &&
      schedule.mTimeQueue.GetLastTime() <= data.mT1 + allowance;
 
   // Four cases:  looping transitions off, or transitions on, or stays on,
   // or stays off.
   // Besides which, the variable speed slider may have changed.
 
   // If looping transitions on, or remains on and the region changed,
   // adjust the schedule...
   auto mine = std::tie(schedule.mT0, mLoopEndTime);
   auto theirs = std::tie(data.mT0, data.mT1);
   if ( mLoopEnabled ? (mine != theirs) : loopWasEnabled ) {
      kicked = true;
      if (!empty) {
         mine = theirs;
         schedule.mT1 = data.mT1;
      }
      if (!mLoopEnabled)
         // Continue play to the end
         schedule.mT1 = std::max(schedule.mT0, mTrackEndTime);
      schedule.mWarpedLength = schedule.RealDuration(schedule.mT1);
 
      auto newTime = schedule.mTimeQueue.GetLastTime();
#if 0
      // This would make play jump forward or backward into the adjusted
      // looping region if not already in it
      newTime = std::clamp(newTime, schedule.mT0, schedule.mT1);
#endif
 
      if (newTime >= schedule.mT1 && mLoopEnabled)
         newTime = schedule.mT0;
 
      // So that the play head will redraw in the right place:
      schedule.mTimeQueue.SetLastTime(newTime);
 
      schedule.RealTimeInit(newTime);
      const auto realTimeRemaining = std::max(0.0, schedule.RealTimeRemaining());
      mRemaining = realTimeRemaining * mRate / mLastPlaySpeed;
   }
   else if (speedChange)
      // Don't return early
      kicked = true;
   else {
      // ... else the region did not change, or looping is now off, in
      // which case we have nothing special to do
      if (RevertToOldDefault(schedule))
         return PlaybackPolicy::RepositionPlayback( schedule, playbackMixers,
            frames, available);
   }
 
   // msmeyer: If playing looped, check if we are at the end of the buffer
   // and if yes, restart from the beginning.
   if (mRemaining <= 0)
   {
      // Looping jumps left
      for (auto &pMixer : playbackMixers)
         pMixer->SetTimesAndSpeed(
            schedule.mT0, schedule.mT1, mLastPlaySpeed, true );
      schedule.RealTimeRestart();
   }
   else if (kicked)
   {
      // Play bounds need redefinition
      const auto time = schedule.mTimeQueue.GetLastTime();
      for (auto &pMixer : playbackMixers) {
         // So that the mixer will fetch the next samples from the right place:
         pMixer->SetTimesAndSpeed( time, schedule.mT1, mLastPlaySpeed );
         pMixer->Reposition(time, true);
      }
   }
   return false;
}

References PlaybackSchedule::TimeQueue::GetLastTime(), mLastPlaySpeed, mLoopEnabled, mLoopEndTime, mMessageChannel, PlaybackPolicy::mRate, mRemaining, PlaybackSchedule::mT0, PlaybackSchedule::mT1, PlaybackSchedule::mTimeQueue, mTrackEndTime, mVariableSpeed, PlaybackSchedule::mWarpedLength, PlaybackSchedule::RealDuration(), PlaybackSchedule::RealTimeInit(), PlaybackSchedule::RealTimeRemaining(), PlaybackSchedule::RealTimeRestart(), PlaybackPolicy::RepositionPlayback(), RevertToOldDefault(), and PlaybackSchedule::TimeQueue::SetLastTime().

Here is the call graph for this function:

◆ RevertToOldDefault()

bool NewDefaultPlaybackPolicy::RevertToOldDefault ( const PlaybackSchedule & schedule ) const

private

Definition at line 215 of file PlaybackSchedule.cpp.

{
   return !mLoopEnabled ||
      // Even if loop is enabled, ignore it if right of looping region
      schedule.mTimeQueue.GetLastTime() > mLoopEndTime;
}

References PlaybackSchedule::TimeQueue::GetLastTime(), mLoopEnabled, mLoopEndTime, and PlaybackSchedule::mTimeQueue.

Referenced by AdvancedTrackTime(), Done(), GetPlaybackSlice(), and RepositionPlayback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SuggestedBufferTimes()

PlaybackPolicy::BufferTimes NewDefaultPlaybackPolicy::SuggestedBufferTimes ( PlaybackSchedule & schedule )

overridevirtual

Provide hints for construction of playback RingBuffer objects.

Reimplemented from PlaybackPolicy.

Definition at line 207 of file PlaybackSchedule.cpp.

{
   // Shorter times than in the default policy so that responses to changes of
   // loop region or speed slider don't lag too much
   using namespace std::chrono;
   return { 0.05s, 0.05s, 0.25s };
}

◆ WriteMessage()

void NewDefaultPlaybackPolicy::WriteMessage ( )

private

Definition at line 405 of file PlaybackSchedule.cpp.

{
   const auto &region = ViewInfo::Get( mProject ).playRegion;
   mMessageChannel.Write( { GetPlaySpeed(),
      region.GetStart(), region.GetEnd(), region.Active()
   } );
}

References ViewInfo::Get(), GetPlaySpeed(), mMessageChannel, mProject, and ViewInfo::playRegion.

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mLastPlaySpeed

double NewDefaultPlaybackPolicy::mLastPlaySpeed { 1.0 }

private

Definition at line 380 of file PlaybackSchedule.h.

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

◆ mLoopEnabled

bool NewDefaultPlaybackPolicy::mLoopEnabled { true }

private

Definition at line 385 of file PlaybackSchedule.h.

Referenced by Initialize(), Looping(), RepositionPlayback(), and RevertToOldDefault().

◆ mLoopEndTime

double NewDefaultPlaybackPolicy::mLoopEndTime

private

Definition at line 382 of file PlaybackSchedule.h.

Referenced by Initialize(), RepositionPlayback(), and RevertToOldDefault().

◆ mMessageChannel

MessageBuffer<SlotData> NewDefaultPlaybackPolicy::mMessageChannel

private

Definition at line 375 of file PlaybackSchedule.h.

Referenced by Initialize(), RepositionPlayback(), and WriteMessage().

◆ mProgress

bool NewDefaultPlaybackPolicy::mProgress { true }

private

Definition at line 384 of file PlaybackSchedule.h.

◆ mProject

AudacityProject& NewDefaultPlaybackPolicy::mProject

private

Definition at line 365 of file PlaybackSchedule.h.

Referenced by GetPlaySpeed(), Initialize(), and WriteMessage().

◆ mRegionSubscription

Observer::Subscription NewDefaultPlaybackPolicy::mRegionSubscription

private

Definition at line 377 of file PlaybackSchedule.h.

Referenced by Initialize().

◆ mRemaining

size_t NewDefaultPlaybackPolicy::mRemaining { 0 }

private

Definition at line 383 of file PlaybackSchedule.h.

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

◆ mSpeedSubscription

Observer::Subscription NewDefaultPlaybackPolicy::mSpeedSubscription

private

Definition at line 378 of file PlaybackSchedule.h.

Referenced by Initialize().

◆ mTrackEndTime

const double NewDefaultPlaybackPolicy::mTrackEndTime

private

Definition at line 381 of file PlaybackSchedule.h.

Referenced by RepositionPlayback().

◆ mVariableSpeed

bool NewDefaultPlaybackPolicy::mVariableSpeed { false }

private

Definition at line 386 of file PlaybackSchedule.h.

Referenced by AdvancedTrackTime(), GetPlaySpeed(), Initialize(), MixerWarpOptions(), and RepositionPlayback().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NewDefaultPlaybackPolicy()

◆ ~NewDefaultPlaybackPolicy()

Member Function Documentation

◆ AdvancedTrackTime()

◆ Done()

◆ GetPlaybackSlice()

◆ GetPlaySpeed()

◆ Initialize()

◆ Looping()

be removed

◆ MixerWarpOptions()

◆ RepositionPlayback()

◆ RevertToOldDefault()

◆ SuggestedBufferTimes()

◆ WriteMessage()

Member Data Documentation

◆ mLastPlaySpeed

◆ mLoopEnabled

◆ mLoopEndTime

◆ mMessageChannel

◆ mProgress

◆ mProject

◆ mRegionSubscription

◆ mRemaining

◆ mSpeedSubscription

◆ mTrackEndTime

◆ mVariableSpeed