cc: Redraw incomplete frames when new texture uploads finish

cc/scheduler_state_machine.cc

 // Copyright 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "cc/scheduler_state_machine.h"
 
 #include "base/logging.h"
 #include "base/stringprintf.h"
 #include "cc/layer_tree_settings.h"
 
 namespace cc {
 
 SchedulerStateMachine::SchedulerStateMachine(const LayerTreeSettings &layerTreeSettings)
     : m_layerTreeSettings(layerTreeSettings)
     , m_commitState(COMMIT_STATE_IDLE)
     , m_currentFrameNumber(0)
     , m_lastFrameNumberWhereDrawWasCalled(-1)
     , m_lastFrameNumberWhereTreeActivationAttempted(-1)
+    , m_lastFrameNumberWhereRedrawOnVisibleTextureUploadAttempted(-1)
     , m_consecutiveFailedDraws(0)
     , m_maximumNumberOfFailedDrawsBeforeDrawIsForced(3)
     , m_needsRedraw(false)
+    , m_needsRedrawOnVisibleTextureUpload(false)
     , m_needsForcedRedraw(false)
     , m_needsForcedRedrawAfterNextCommit(false)
     , m_needsCommit(false)
     , m_needsForcedCommit(false)
     , m_expectImmediateBeginFrame(false)
     , m_mainThreadNeedsLayerTextures(false)
     , m_insideVSync(false)
     , m_visible(false)
     , m_canBeginFrame(false)
     , m_canDraw(false)
     , m_hasPendingTree(false)
     , m_drawIfPossibleFailed(false)
     , m_textureState(LAYER_TEXTURE_STATE_UNLOCKED)
     , m_outputSurfaceState(OUTPUT_SURFACE_ACTIVE)
 {
 }
 
 std::string SchedulerStateMachine::toString()
 {
     std::string str;
     base::StringAppendF(&str, "m_commitState = %d; ", m_commitState);
     base::StringAppendF(&str, "m_currentFrameNumber = %d; ", m_currentFrameNumber);
     base::StringAppendF(&str, "m_lastFrameNumberWhereDrawWasCalled = %d; ", m_lastFrameNumberWhereDrawWasCalled);
     base::StringAppendF(&str, "m_consecutiveFailedDraws = %d; ", m_consecutiveFailedDraws);
     base::StringAppendF(&str, "m_maximumNumberOfFailedDrawsBeforeDrawIsForced = %d; ", m_maximumNumberOfFailedDrawsBeforeDrawIsForced);
     base::StringAppendF(&str, "m_needsRedraw = %d; ", m_needsRedraw);
+    base::StringAppendF(&str, "m_needsRedrawOnVisibleTextureUpload = %d; ", m_needsRedrawOnVisibleTextureUpload);
     base::StringAppendF(&str, "m_needsForcedRedraw = %d; ", m_needsForcedRedraw);
     base::StringAppendF(&str, "m_needsForcedRedrawAfterNextCommit = %d; ", m_needsForcedRedrawAfterNextCommit);
     base::StringAppendF(&str, "m_needsCommit = %d; ", m_needsCommit);
     base::StringAppendF(&str, "m_needsForcedCommit = %d; ", m_needsForcedCommit);
     base::StringAppendF(&str, "m_expectImmediateBeginFrame = %d; ", m_expectImmediateBeginFrame);
     base::StringAppendF(&str, "m_mainThreadNeedsLayerTextures = %d; ", m_mainThreadNeedsLayerTextures);
     base::StringAppendF(&str, "m_insideVSync = %d; ", m_insideVSync);
     base::StringAppendF(&str, "m_visible = %d; ", m_visible);
     base::StringAppendF(&str, "m_canBeginFrame = %d; ", m_canBeginFrame);
     base::StringAppendF(&str, "m_canDraw = %d; ", m_canDraw);
     base::StringAppendF(&str, "m_drawIfPossibleFailed = %d; ", m_drawIfPossibleFailed);
     base::StringAppendF(&str, "m_hasPendingTree = %d; ", m_hasPendingTree);
     base::StringAppendF(&str, "m_textureState = %d; ", m_textureState);
     base::StringAppendF(&str, "m_outputSurfaceState = %d; ", m_outputSurfaceState);
     return str;
 }
 
 bool SchedulerStateMachine::hasDrawnThisFrame() const
 {
     return m_currentFrameNumber == m_lastFrameNumberWhereDrawWasCalled;
 }
 
 bool SchedulerStateMachine::hasAttemptedTreeActivationThisFrame() const
 {
     return m_currentFrameNumber == m_lastFrameNumberWhereTreeActivationAttempted;
 }
 
+bool SchedulerStateMachine::hasAttemptedRedrawOnVisibleTextureUploadThisFrame() const
+{
+    return m_currentFrameNumber ==
+           m_lastFrameNumberWhereRedrawOnVisibleTextureUploadAttempted;
+}
+
 bool SchedulerStateMachine::drawSuspendedUntilCommit() const
 {
     if (!m_canDraw)
         return true;
     if (!m_visible)
         return true;
     if (m_textureState == LAYER_TEXTURE_STATE_ACQUIRED_BY_MAIN_THREAD)
         return true;
     return false;
 }
@@ skipping 18 matching lines @@
         return false;
     if (hasDrawnThisFrame())
         return false;
     if (m_outputSurfaceState != OUTPUT_SURFACE_ACTIVE)
         return false;
     return true;
 }
 
 bool SchedulerStateMachine::shouldAttemptTreeActivation() const
 {
-  return m_hasPendingTree && m_insideVSync && !hasAttemptedTreeActivationThisFrame();
+    return m_hasPendingTree && m_insideVSync && !hasAttemptedTreeActivationThisFrame();
+}
+
+bool SchedulerStateMachine::shouldAttemptRedrawOnVisibleTextureUpload() const
+{
+    return m_needsRedrawOnVisibleTextureUpload &&
+           !hasAttemptedRedrawOnVisibleTextureUploadThisFrame() &&
+           !hasDrawnThisFrame();
 }
 
 bool SchedulerStateMachine::shouldAcquireLayerTexturesForMainThread() const
 {
     if (!m_mainThreadNeedsLayerTextures)
         return false;
     if (m_textureState == LAYER_TEXTURE_STATE_UNLOCKED)
         return true;
     DCHECK(m_textureState == LAYER_TEXTURE_STATE_ACQUIRED_BY_IMPL_THREAD);
     // Transfer the lock from impl thread to main thread immediately if the
@@ skipping 18 matching lines @@
             // TODO(enne): Should probably drop the active tree on force commit
             return m_hasPendingTree ? ACTION_NONE : ACTION_BEGIN_FRAME;
         if (m_outputSurfaceState == OUTPUT_SURFACE_LOST)
             return ACTION_BEGIN_OUTPUT_SURFACE_RECREATION;
         if (m_outputSurfaceState == OUTPUT_SURFACE_RECREATING)
             return ACTION_NONE;
         if (shouldAttemptTreeActivation())
             return ACTION_ACTIVATE_PENDING_TREE_IF_NEEDED;
         if (shouldDraw())
             return m_needsForcedRedraw ? ACTION_DRAW_FORCED : ACTION_DRAW_IF_POSSIBLE;
+        if (shouldAttemptRedrawOnVisibleTextureUpload())
+            return ACTION_CHECK_FOR_NEW_VISIBLE_TEXTURES;
         if (m_needsCommit && ((m_visible && m_canBeginFrame) || m_needsForcedCommit))
             // TODO(enne): Should probably drop the active tree on force commit
             return m_hasPendingTree ? ACTION_NONE : ACTION_BEGIN_FRAME;
         return ACTION_NONE;
 
     case COMMIT_STATE_FRAME_IN_PROGRESS:
         if (shouldAttemptTreeActivation())
             return ACTION_ACTIVATE_PENDING_TREE_IF_NEEDED;
         if (shouldDraw())
             return m_needsForcedRedraw ? ACTION_DRAW_FORCED : ACTION_DRAW_IF_POSSIBLE;
+        if (shouldAttemptRedrawOnVisibleTextureUpload())
+            return ACTION_CHECK_FOR_NEW_VISIBLE_TEXTURES;
         return ACTION_NONE;
 
     case COMMIT_STATE_READY_TO_COMMIT:
         return ACTION_COMMIT;
 
     case COMMIT_STATE_WAITING_FOR_FIRST_DRAW: {
         if (shouldAttemptTreeActivation())
             return ACTION_ACTIVATE_PENDING_TREE_IF_NEEDED;
         if (shouldDraw() || m_outputSurfaceState == OUTPUT_SURFACE_LOST)
             return m_needsForcedRedraw ? ACTION_DRAW_FORCED : ACTION_DRAW_IF_POSSIBLE;
+        if (shouldAttemptRedrawOnVisibleTextureUpload())
+            return ACTION_CHECK_FOR_NEW_VISIBLE_TEXTURES;
         // COMMIT_STATE_WAITING_FOR_FIRST_DRAW wants to enforce a draw. If m_canDraw is false
         // or textures are not available, proceed to the next step (similar as in COMMIT_STATE_IDLE).
         bool canCommit = m_visible || m_needsForcedCommit;
         if (m_needsCommit && canCommit && drawSuspendedUntilCommit())
             return m_hasPendingTree ? ACTION_NONE : ACTION_BEGIN_FRAME;
         return ACTION_NONE;
     }
 
     case COMMIT_STATE_WAITING_FOR_FIRST_FORCED_DRAW:
         if (shouldAttemptTreeActivation())
             return ACTION_ACTIVATE_PENDING_TREE_IF_NEEDED;
         if (m_needsForcedRedraw)
             return ACTION_DRAW_FORCED;
+        if (shouldAttemptRedrawOnVisibleTextureUpload())
+            return ACTION_CHECK_FOR_NEW_VISIBLE_TEXTURES;
         return ACTION_NONE;
     }
     NOTREACHED();
     return ACTION_NONE;
 }
 
 void SchedulerStateMachine::updateState(Action action)
 {
     switch (action) {
     case ACTION_NONE:
         return;
 
     case ACTION_ACTIVATE_PENDING_TREE_IF_NEEDED:
         m_lastFrameNumberWhereTreeActivationAttempted = m_currentFrameNumber;
         return;
 
+    case ACTION_CHECK_FOR_NEW_VISIBLE_TEXTURES:
+        // We set this false here and the caller must actively set this back
+        // to true for each frame that it still needs to check for uploads.
+        m_needsRedrawOnVisibleTextureUpload = false;
+        m_lastFrameNumberWhereRedrawOnVisibleTextureUploadAttempted = m_currentFrameNumber;
+        return;
+
     case ACTION_BEGIN_FRAME:
         DCHECK(!m_hasPendingTree);
         DCHECK(m_visible || m_needsForcedCommit);
         m_commitState = COMMIT_STATE_FRAME_IN_PROGRESS;
         m_needsCommit = false;
         m_needsForcedCommit = false;
         return;
 
     case ACTION_COMMIT:
         if (m_expectImmediateBeginFrame)
@@ skipping 59 matching lines @@
     if (m_hasPendingTree)
         return true;
 
     // If we can't draw, don't tick until we are notified that we can draw again.
     if (!m_canDraw)
         return false;
 
     if (m_needsForcedRedraw)
         return true;
 
+    if (m_visible && m_needsRedrawOnVisibleTextureUpload)
+        return true;
+
     return m_needsRedraw && m_visible && m_outputSurfaceState == OUTPUT_SURFACE_ACTIVE;
 }
 
 void SchedulerStateMachine::didEnterVSync()
 {
     m_insideVSync = true;
 }
 
 void SchedulerStateMachine::didLeaveVSync()
 {
     m_currentFrameNumber++;
     m_insideVSync = false;
 }
 
 void SchedulerStateMachine::setVisible(bool visible)
 {
     m_visible = visible;
 }
 
 void SchedulerStateMachine::setNeedsRedraw()
 {
     m_needsRedraw = true;
 }
 
+void SchedulerStateMachine::setNeedsRedrawOnVisibleTextureUpload()
+{
+    m_needsRedrawOnVisibleTextureUpload = true;
+}
+
 void SchedulerStateMachine::setNeedsForcedRedraw()
 {
     m_needsForcedRedraw = true;
 }
 
 void SchedulerStateMachine::didDrawIfPossibleCompleted(bool success)
 {
     m_drawIfPossibleFailed = !success;
     if (m_drawIfPossibleFailed) {
         m_needsRedraw = true;
@@ skipping 61 matching lines @@
     m_outputSurfaceState = OUTPUT_SURFACE_ACTIVE;
     setNeedsCommit();
 }
 
 void SchedulerStateMachine::setMaximumNumberOfFailedDrawsBeforeDrawIsForced(int numDraws)
 {
     m_maximumNumberOfFailedDrawsBeforeDrawIsForced = numDraws;
 }
 
 }  // namespace cc