From 52910f4f07d41904e5f8cc5fdc5e7f8484468a00 Mon Sep 17 00:00:00 2001
From: Paul Licameli <paul.licameli@audacityteam.org>
Date: Fri, 13 May 2016 19:15:29 -0400
Subject: [PATCH] Less scrub lag: don't poll for available data, get woken up
 directly

---
 src/AudioIO.cpp | 45 +++++++++++++++++++++++++++++++++++++--------
 src/AudioIO.h   |  2 +-
 2 files changed, 38 insertions(+), 9 deletions(-)

diff --git a/src/AudioIO.cpp b/src/AudioIO.cpp
index d757e4da3..e5de776be 100644
--- a/src/AudioIO.cpp
+++ b/src/AudioIO.cpp
@@ -405,18 +405,28 @@ struct AudioIO::ScrubQueue
    double LastTimeInQueue() const
    {
       // Needed by the main thread sometimes
-      wxCriticalSectionLocker locker(mUpdating);
+      wxMutexLocker locker(mUpdating);
       const Entry &previous = mEntries[(mLeadingIdx + Size - 1) % Size];
       return previous.mS1 / mRate;
    }
 
+   void PoisonPill()
+   {
+      // Main thread is shutting down the scrubbing
+      wxMutexLocker locker(mUpdating);
+      mPoisoned = true;
+      mAvailable.Signal();
+   }
+
    bool Producer(double end, double maxSpeed, bool bySpeed, bool maySkip)
    {
+      wxASSERT(!mPoisoned);
+
       // Main thread indicates a scrubbing interval
 
       // MAY ADVANCE mLeadingIdx, BUT IT NEVER CATCHES UP TO mTrailingIdx.
 
-      wxCriticalSectionLocker locker(mUpdating);
+      wxMutexLocker locker(mUpdating);
       const unsigned next = (mLeadingIdx + 1) % Size;
       if (next != mTrailingIdx)
       {
@@ -429,8 +439,10 @@ struct AudioIO::ScrubQueue
          const bool success =
             (InitEntry(mEntries[mLeadingIdx], startTime, end, maxSpeed,
                        bySpeed, &previous, maySkip));
-         if (success)
+         if (success) {
             mLeadingIdx = next;
+            mAvailable.Signal();
+         }
          return success;
       }
       else
@@ -450,7 +462,10 @@ struct AudioIO::ScrubQueue
 
       // MAY ADVANCE mMiddleIdx, WHICH MAY EQUAL mLeadingIdx, BUT DOES NOT PASS IT.
 
-      wxCriticalSectionLocker locker(mUpdating);
+      wxMutexLocker locker(mUpdating);
+      while(!mPoisoned && mMiddleIdx == mLeadingIdx)
+         mAvailable.Wait();
+
       if (mMiddleIdx != mLeadingIdx)
       {
          // There is work in the queue
@@ -463,7 +478,8 @@ struct AudioIO::ScrubQueue
       }
       else
       {
-         // next entry is not yet ready
+         wxASSERT(mPoisoned);
+         // We got the shut-down signal
          startSample = endSample = duration = -1L;
       }
    }
@@ -475,7 +491,7 @@ struct AudioIO::ScrubQueue
 
       // MAY ADVANCE mTrailingIdx, BUT IT NEVER CATCHES UP TO mMiddleIdx.
 
-      wxCriticalSectionLocker locker(mUpdating);
+      wxMutexLocker locker(mUpdating);
 
       // Mark entries as partly or fully "consumed" for
       // purposes of mTime update.  It should not happen that
@@ -678,7 +694,9 @@ private:
    const double mRate;
    const long mMinStutter;
    wxLongLong mLastScrubTimeMillis;
-   mutable wxCriticalSection mUpdating;
+   mutable wxMutex mUpdating;
+   mutable wxCondition mAvailable { mUpdating };
+   bool mPoisoned { false };
 };
 #endif
 
@@ -2166,6 +2184,8 @@ void AudioIO::StopStream()
    //
 
    mAudioThreadFillBuffersLoopRunning = false;
+   if (mScrubQueue)
+      mScrubQueue->PoisonPill();
 
    // Audacity can deadlock if it tries to update meters while
    // we're stopping PortAudio (because the meter updating code
@@ -2821,7 +2841,16 @@ AudioThread::ExitCode AudioThread::Entry()
       }
       gAudioIO->mAudioThreadFillBuffersLoopActive = false;
 
-      Sleep(10);
+      if (gAudioIO->mPlayMode == AudioIO::PLAY_SCRUB) {
+         // Rely on the Wait() in ScrubQueue::Transformer()
+         // This allows the scrubbing update interval to be made very short without
+         // playback becoming intermittent.
+      }
+      else {
+         // Perhaps this too could use a condition variable, for available space in the
+         // ring buffer, instead of a polling loop?  But no harm in doing it this way.
+         Sleep(10);
+      }
    }
 
    return 0;
diff --git a/src/AudioIO.h b/src/AudioIO.h
index c57501276..00cce0056 100644
--- a/src/AudioIO.h
+++ b/src/AudioIO.h
@@ -650,7 +650,7 @@ private:
    bool                mInputMixerWorks;
    float               mMixerOutputVol;
 
-   enum {
+   volatile enum {
       PLAY_STRAIGHT,
       PLAY_LOOPED,
 #ifdef EXPERIMENTAL_SCRUBBING_SUPPORT