AudioIOBase::PlaybackSchedule Struct Reference

#include <AudioIOBase.h>

Collaboration diagram for AudioIOBase::PlaybackSchedule:

Public Types
enum	{ PLAY_STRAIGHT, PLAY_LOOPED }

Public Member Functions
void	Init (double t0, double t1, const AudioIOStartStreamOptions &options, const RecordingSchedule *pRecordingSchedule)
bool	ReversedTime () const
	True if the end time is before the start time. More...
double	GetTrackTime () const
	Get current track time value, unadjusted. More...
void	SetTrackTime (double time)
	Set current track time value, unadjusted. More...
double	ClampTrackTime (double trackTime) const
	Clamps argument to be between mT0 and mT1. More...
double	LimitTrackTime () const
	Clamps mTime to be between mT0 and mT1. More...
double	NormalizeTrackTime () const
	Normalizes mTime, clamping it and handling gaps from cut preview. More...
void	ResetMode ()
bool	PlayingStraight () const
bool	Looping () const
bool	Scrubbing () const
bool	PlayingAtSpeed () const
bool	Interactive () const
bool	PassIsComplete () const
bool	Overruns (double trackTime) const
double	AdvancedTrackTime (double trackTime, double realElapsed, double speed) const
void	TrackTimeUpdate (double realElapsed)
double	RealDuration (double trackTime1) const
double	RealTimeRemaining () const
void	RealTimeAdvance (double increment)
void	RealTimeInit (double trackTime)
void	RealTimeRestart ()

Public Attributes
double	mT0
	Playback starts at offset of mT0, which is measured in seconds. More...
double	mT1
	Playback ends at offset of mT1, which is measured in seconds. Note that mT1 may be less than mT0 during scrubbing. More...
std::atomic< double >	mTime
double	mWarpedTime
double	mWarpedLength
const BoundedEnvelope *	mEnvelope
enum AudioIOBase::PlaybackSchedule:: { ... }	PLAY_STRAIGHT
double	mCutPreviewGapStart
double	mCutPreviewGapLen

Detailed Description

Definition at line 328 of file AudioIOBase.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
PLAY_STRAIGHT
PLAY_LOOPED

Definition at line 359 of file AudioIOBase.h.

                    {
         PLAY_STRAIGHT,
         PLAY_LOOPED,
#ifdef EXPERIMENTAL_SCRUBBING_SUPPORT
         PLAY_SCRUB,
         PLAY_AT_SPEED, // a version of PLAY_SCRUB.
         PLAY_KEYBOARD_SCRUB,
#endif
      }                   mPlayMode { PLAY_STRAIGHT };

Member Function Documentation

AdvancedTrackTime()

double AudioIOBase::PlaybackSchedule::AdvancedTrackTime	(	double	trackTime,
		double	realElapsed,
		double	speed
	)		const

Definition at line 1237 of file AudioIOBase.cpp.

{
   if (ReversedTime())
      realElapsed *= -1.0;
 
   // Defense against cases that might cause loops not to terminate
   if ( fabs(mT0 - mT1) < 1e-9 )
      return mT0;
 
   if (mEnvelope) {
       wxASSERT( speed == 1.0 );
 
      double total=0.0;
      bool foundTotal = false;
      do {
         auto oldTime = time;
         if (foundTotal && fabs(realElapsed) > fabs(total))
            // Avoid SolveWarpedLength
            time = mT1;
         else
            time = SolveWarpedLength(*mEnvelope, time, realElapsed);
 
         if (!Looping() || !Overruns( time )) 
            break;
 
         // Bug1922:  The part of the time track outside the loop should not
         // influence the result
         double delta;
         if (foundTotal && oldTime == mT0)
            // Avoid integrating again
            delta = total;
         else {
            delta = ComputeWarpedLength(*mEnvelope, oldTime, mT1);
            if (oldTime == mT0)
               foundTotal = true, total = delta;
         }
         realElapsed -= delta;
         time = mT0;
      } while ( true );
   }
   else {
      time += realElapsed * fabs(speed);
 
      // Wrap to start if looping
      if (Looping()) {
         while ( Overruns( time ) ) {
            // LL:  This is not exactly right, but I'm at my wits end trying to
            //      figure it out.  Feel free to fix it.  :-)
            // MB: it's much easier than you think, mTime isn't warped at all!
            time -= mT1 - mT0;
         }
      }
   }
 
   return time;
}

References anonymous_namespace{AudioIOBase.cpp}::ComputeWarpedLength(), and anonymous_namespace{AudioIOBase.cpp}::SolveWarpedLength().

Referenced by AudioIoCallback::TimeQueue::Producer().

Here is the call graph for this function:

Here is the caller graph for this function:

ClampTrackTime()

double AudioIOBase::PlaybackSchedule::ClampTrackTime

(

double

trackTime

)

const

Clamps argument to be between mT0 and mT1.

Returns the bound if the value is out of bounds; does not wrap. Returns a time in seconds.

Definition at line 457 of file AudioIOBase.cpp.

{
   if (ReversedTime())
      return std::max(mT1, std::min(mT0, trackTime));
   else
      return std::max(mT0, std::min(mT1, trackTime));
}

References min().

Referenced by AudioIoCallback::CallbackDoSeek(), and AudioIO::StartStream().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrackTime()

double AudioIOBase::PlaybackSchedule::GetTrackTime ( ) const

inline

Get current track time value, unadjusted.

Returns a time in seconds.

Definition at line 386 of file AudioIOBase.h.

      { return mTime.load(std::memory_order_relaxed); }

Referenced by AudioIoCallback::CallbackDoSeek(), AudioIoCallback::FillInputBuffers(), AudioIO::IsCapturing(), and AudioIO::StartStream().

Here is the caller graph for this function:

Init()

void AudioIOBase::PlaybackSchedule::Init	(	double	t0,
		double	t1,
		const AudioIOStartStreamOptions &	options,
		const RecordingSchedule *	pRecordingSchedule
	)

Definition at line 382 of file AudioIOBase.cpp.

{
   if ( pRecordingSchedule )
      // It does not make sense to apply the time warp during overdub recording,
      // which defeats the purpose of making the recording synchronized with
      // the existing audio.  (Unless we figured out the inverse warp of the
      // captured samples in real time.)
      // So just quietly ignore the time track.
      mEnvelope = nullptr;
   else
      mEnvelope = options.envelope;
 
   mT0      = t0;
   if (pRecordingSchedule)
      mT0 -= pRecordingSchedule->mPreRoll;
 
   mT1      = t1;
   if (pRecordingSchedule)
      // adjust mT1 so that we don't give paComplete too soon to fill up the
      // desired length of recording
      mT1 -= pRecordingSchedule->mLatencyCorrection;
 
   // Main thread's initialization of mTime
   SetTrackTime( mT0 );
 
   mPlayMode = options.playLooped
      ? PlaybackSchedule::PLAY_LOOPED
      : PlaybackSchedule::PLAY_STRAIGHT;
   mCutPreviewGapStart = options.cutPreviewGapStart;
   mCutPreviewGapLen = options.cutPreviewGapLen;
 
#ifdef EXPERIMENTAL_SCRUBBING_SUPPORT
   bool scrubbing = (options.pScrubbingOptions != nullptr);
 
   // Scrubbing is not compatible with looping or recording or a time track!
   if (scrubbing)
   {
      const auto &scrubOptions = *options.pScrubbingOptions;
      if (pRecordingSchedule ||
          Looping() ||
          mEnvelope ||
          scrubOptions.maxSpeed < ScrubbingOptions::MinAllowedScrubSpeed()) {
         wxASSERT(false);
         scrubbing = false;
      }
      else {
         if (scrubOptions.isPlayingAtSpeed)
            mPlayMode = PLAY_AT_SPEED;
         else if (scrubOptions.isKeyboardScrubbing)
            mPlayMode = PLAY_KEYBOARD_SCRUB;
         else
            mPlayMode = PLAY_SCRUB;
      }
   }
#endif
 
   mWarpedTime = 0.0;
#ifdef EXPERIMENTAL_SCRUBBING_SUPPORT
   if (Scrubbing())
      mWarpedLength = 0.0f;
   else
#endif
      mWarpedLength = RealDuration(mT1);
}

References AudioIOStartStreamOptions::cutPreviewGapLen, AudioIOStartStreamOptions::cutPreviewGapStart, AudioIOStartStreamOptions::envelope, Looping(), mCutPreviewGapLen, mCutPreviewGapStart, mEnvelope, ScrubbingOptions::MinAllowedScrubSpeed(), AudioIOBase::RecordingSchedule::mLatencyCorrection, AudioIOBase::RecordingSchedule::mPreRoll, mT0, mT1, mWarpedLength, mWarpedTime, PLAY_LOOPED, PLAY_STRAIGHT, AudioIOStartStreamOptions::playLooped, RealDuration(), Scrubbing(), and SetTrackTime().

Referenced by AudioIO::StartStream().

Here is the call graph for this function:

Here is the caller graph for this function:

Interactive()

bool AudioIOBase::PlaybackSchedule::Interactive ( ) const

inline

Definition at line 421 of file AudioIOBase.h.

{ return Scrubbing() || PlayingAtSpeed(); }

Referenced by AudioThread::Entry(), AudioIO::FillBuffers(), AudioIoCallback::FillOutputBuffers(), AudioIO::StartStream(), and AudioIoCallback::UpdateTimePosition().

Here is the caller graph for this function:

LimitTrackTime()

double AudioIOBase::PlaybackSchedule::LimitTrackTime

(

)

const

Clamps mTime to be between mT0 and mT1.

Returns the bound if the value is out of bounds; does not wrap. Returns a time in seconds.

Definition at line 450 of file AudioIOBase.cpp.

{
   // Track time readout for the main thread
   // Allows for forward or backward play
   return ClampTrackTime( GetTrackTime() );
}

Looping()

bool AudioIOBase::PlaybackSchedule::Looping ( ) const

inline

Definition at line 418 of file AudioIOBase.h.

{ return mPlayMode == PLAY_LOOPED; }

Referenced by AudioIO::FillBuffers(), and Init().

Here is the caller graph for this function:

NormalizeTrackTime()

double AudioIOBase::PlaybackSchedule::NormalizeTrackTime

(

)

const

Normalizes mTime, clamping it and handling gaps from cut preview.

Clamps the time (unless scrubbing), and skips over the cut section. Returns a time in seconds.

Definition at line 465 of file AudioIOBase.cpp.

{
   // Track time readout for the main thread
 
   // dmazzoni: This function is needed for two reasons:
   // One is for looped-play mode - this function makes sure that the
   // position indicator keeps wrapping around.  The other reason is
   // more subtle - it's because PortAudio can query the hardware for
   // the current stream time, and this query is not always accurate.
   // Sometimes it's a little behind or ahead, and so this function
   // makes sure that at least we clip it to the selection.
   //
   // msmeyer: There is also the possibility that we are using "cut preview"
   //          mode. In this case, we should jump over a defined "gap" in the
   //          audio.
 
   double absoluteTime;
 
#ifdef EXPERIMENTAL_SCRUBBING_SUPPORT
   // Limit the time between t0 and t1 if not scrubbing.
   // Should the limiting be necessary in any play mode if there are no bugs?
   if (Interactive())
      absoluteTime = GetTrackTime();
   else
#endif
      absoluteTime = LimitTrackTime();
 
   if (mCutPreviewGapLen > 0)
   {
      // msmeyer: We're in cut preview mode, so if we are on the right
      // side of the gap, we jump over it.
      if (absoluteTime > mCutPreviewGapStart)
         absoluteTime += mCutPreviewGapLen;
   }
 
   return absoluteTime;
}

Referenced by AudioIOBase::GetStreamTime().

Here is the caller graph for this function:

Overruns()

bool AudioIOBase::PlaybackSchedule::Overruns

(

double

trackTime

)

const

Definition at line 1203 of file AudioIOBase.cpp.

{
   return (ReversedTime() ? trackTime <= mT1 : trackTime >= mT1);
}

PassIsComplete()

bool AudioIOBase::PlaybackSchedule::PassIsComplete

(

)

const

Definition at line 1195 of file AudioIOBase.cpp.

{
   // Test mTime within the PortAudio callback
   if (Scrubbing())
      return false; // but may be true if playing at speed
   return Overruns( GetTrackTime() );
}

Referenced by AudioIoCallback::CallbackCheckCompletion(), and AudioIoCallback::FillInputBuffers().

Here is the caller graph for this function:

PlayingAtSpeed()

bool AudioIOBase::PlaybackSchedule::PlayingAtSpeed ( ) const

inline

Definition at line 420 of file AudioIOBase.h.

{ return mPlayMode == PLAY_AT_SPEED; }

Referenced by AudioIoCallback::CallbackCheckCompletion().

Here is the caller graph for this function:

PlayingStraight()

bool AudioIOBase::PlaybackSchedule::PlayingStraight ( ) const

inline

Definition at line 417 of file AudioIOBase.h.

{ return mPlayMode == PLAY_STRAIGHT; }

Referenced by AudioIoCallback::CallbackCheckCompletion(), and AudioIO::FillBuffers().

Here is the caller graph for this function:

RealDuration()

double AudioIOBase::PlaybackSchedule::RealDuration

(

double

trackTime1

)

const

Definition at line 1307 of file AudioIOBase.cpp.

{
   double duration;
   if (mEnvelope)
      duration = ComputeWarpedLength(*mEnvelope, mT0, trackTime1);
   else
      duration = trackTime1 - mT0;
   return fabs(duration);
}

References anonymous_namespace{AudioIOBase.cpp}::ComputeWarpedLength().

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

RealTimeAdvance()

void AudioIOBase::PlaybackSchedule::RealTimeAdvance

(

double

increment

)

Definition at line 1322 of file AudioIOBase.cpp.

{
   mWarpedTime += increment;
}

Referenced by AudioIO::FillBuffers().

Here is the caller graph for this function:

RealTimeInit()

void AudioIOBase::PlaybackSchedule::RealTimeInit

(

double

trackTime

)

Definition at line 1327 of file AudioIOBase.cpp.

{
   if (Scrubbing())
      mWarpedTime = 0.0;
   else
      mWarpedTime = RealDuration( trackTime );
}

Referenced by AudioIoCallback::CallbackDoSeek(), and AudioIO::StartStream().

Here is the caller graph for this function:

RealTimeRemaining()

double AudioIOBase::PlaybackSchedule::RealTimeRemaining

(

)

const

Definition at line 1317 of file AudioIOBase.cpp.

{
   return mWarpedLength - mWarpedTime;
}

Referenced by AudioIO::FillBuffers().

Here is the caller graph for this function:

RealTimeRestart()

void AudioIOBase::PlaybackSchedule::RealTimeRestart

(

)

Definition at line 1335 of file AudioIOBase.cpp.

{
   mWarpedTime = 0;
}

Referenced by AudioIO::FillBuffers().

Here is the caller graph for this function:

ResetMode()

void AudioIOBase::PlaybackSchedule::ResetMode ( )

inline

Definition at line 415 of file AudioIOBase.h.

{ mPlayMode = PLAY_STRAIGHT; }

Referenced by AudioIO::StartStream(), and AudioIO::StopStream().

Here is the caller graph for this function:

ReversedTime()

bool AudioIOBase::PlaybackSchedule::ReversedTime ( ) const

inline

True if the end time is before the start time.

Definition at line 377 of file AudioIOBase.h.

      {
         return mT1 < mT0;
      }

Scrubbing()

bool AudioIOBase::PlaybackSchedule::Scrubbing ( ) const

inline

Definition at line 419 of file AudioIOBase.h.

{ return mPlayMode == PLAY_SCRUB || mPlayMode == PLAY_KEYBOARD_SCRUB; }

Referenced by Init().

Here is the caller graph for this function:

SetTrackTime()

void AudioIOBase::PlaybackSchedule::SetTrackTime ( double  time )

inline

Set current track time value, unadjusted.

Definition at line 391 of file AudioIOBase.h.

      { mTime.store(time, std::memory_order_relaxed); }

Referenced by AudioIoCallback::CallbackDoSeek(), Init(), AudioIO::StartStream(), and AudioIoCallback::UpdateTimePosition().

Here is the caller graph for this function:

TrackTimeUpdate()

void AudioIOBase::PlaybackSchedule::TrackTimeUpdate

(

double

realElapsed

)

Definition at line 1295 of file AudioIOBase.cpp.

{
   // Update mTime within the PortAudio callback
 
   if (Interactive())
      return;
 
   auto time = GetTrackTime();
   auto newTime = AdvancedTrackTime( time, realElapsed, 1.0 );
   SetTrackTime( newTime );
}

Referenced by AudioIoCallback::UpdateTimePosition().

Here is the caller graph for this function:

Member Data Documentation

mCutPreviewGapLen

double AudioIOBase::PlaybackSchedule::mCutPreviewGapLen

Definition at line 369 of file AudioIOBase.h.

Referenced by Init().

mCutPreviewGapStart

double AudioIOBase::PlaybackSchedule::mCutPreviewGapStart

Definition at line 368 of file AudioIOBase.h.

Referenced by Init().

mEnvelope

const BoundedEnvelope* AudioIOBase::PlaybackSchedule::mEnvelope

Definition at line 357 of file AudioIOBase.h.

Referenced by AudioIO::AllocateBuffers(), and Init().

mT0

double AudioIOBase::PlaybackSchedule::mT0

Playback starts at offset of mT0, which is measured in seconds.

Definition at line 330 of file AudioIOBase.h.

Referenced by AudioIO::AllocateBuffers(), AudioIoCallback::ComputeMidiTimings(), Init(), AudioIO::IsCapturing(), and AudioIO::StartStream().

mT1

double AudioIOBase::PlaybackSchedule::mT1

Playback ends at offset of mT1, which is measured in seconds. Note that mT1 may be less than mT0 during scrubbing.

Definition at line 332 of file AudioIOBase.h.

Referenced by Init().

mTime

std::atomic<double> AudioIOBase::PlaybackSchedule::mTime

Current track time position during playback, in seconds. Initialized by the main thread but updated by worker threads during playback or recording, and periodically reread by the main thread for purposes such as display update.

Definition at line 337 of file AudioIOBase.h.

mWarpedLength

double AudioIOBase::PlaybackSchedule::mWarpedLength

Real length to be played (if looping, for each pass) after warping via a time track, computed just once when starting the stream. Length in real seconds between mT0 and mT1. Always positive.

Definition at line 347 of file AudioIOBase.h.

Referenced by Init().

mWarpedTime

double AudioIOBase::PlaybackSchedule::mWarpedTime

Accumulated real time (not track position), starting at zero (unlike mTime), and wrapping back to zero each time around looping play. Thus, it is the length in real seconds between mT0 and mTime.

Definition at line 342 of file AudioIOBase.h.

Referenced by AudioIO::FillBuffers(), and Init().

PLAY_STRAIGHT

enum { ... } AudioIOBase::PlaybackSchedule::PLAY_STRAIGHT

Referenced by Init().

---

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

• AudioIOBase.h
• AudioIOBase.cpp