Android: Decouple animate from vsync

content/browser/renderer_host/compositor_impl_android.cc

 // Copyright (c) 2012 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 "content/browser/renderer_host/compositor_impl_android.h"
 
 #include <android/bitmap.h>
 #include <android/native_window_jni.h>
 
 #include "base/android/jni_android.h"
@@ skipping 39 matching lines @@
 #include "ui/gl/android/surface_texture_tracker.h"
 #include "webkit/common/gpu/context_provider_in_process.h"
 #include "webkit/common/gpu/webgraphicscontext3d_in_process_command_buffer_impl.h"
 
 namespace gfx {
 class JavaBitmap;
 }
 
 namespace {
 
+const unsigned int kMaxSwapBuffers = 2U;
+
 // Used to override capabilities_.adjust_deadline_for_parent to false
 class OutputSurfaceWithoutParent : public cc::OutputSurface {
  public:
   OutputSurfaceWithoutParent(const scoped_refptr<
       content::ContextProviderCommandBuffer>& context_provider)
       : cc::OutputSurface(context_provider) {
     capabilities_.adjust_deadline_for_parent = false;
   }
 
   virtual void SwapBuffers(cc::CompositorFrame* frame) OVERRIDE {
@@ skipping 165 matching lines @@
     : root_layer_(cc::Layer::Create()),
       has_transparent_background_(false),
       device_scale_factor_(1),
       window_(NULL),
       surface_id_(0),
       client_(client),
       root_window_(root_window),
       did_post_swapbuffers_(false),
       ignore_schedule_composite_(false),
       needs_composite_(false),
-      should_composite_on_vsync_(false),
+      needs_animate_(false),
+      will_composite_immediately_(false),
+      will_composite_eventually_(false),
       did_composite_this_frame_(false),
       pending_swapbuffers_(0U),
       weak_factory_(this) {
   DCHECK(client);
   DCHECK(root_window);
   ImageTransportFactoryAndroid::AddObserver(this);
   root_window->AttachCompositor(this);
 }
 
 CompositorImpl::~CompositorImpl() {
   root_window_->DetachCompositor();
   ImageTransportFactoryAndroid::RemoveObserver(this);
   // Clean-up any surface references.
   SetSurface(NULL);
 }
 
-void CompositorImpl::PostComposite(base::TimeDelta delay) {
+void CompositorImpl::PostComposite(CompositingTrigger trigger) {
+  base::TimeDelta delay;
+  switch (trigger) {
+    case COMPOSITE_IMMEDIATELY:
+      if (will_composite_immediately_)
+        return;
+      will_composite_immediately_ = true;
+      break;
+    case COMPOSITE_EVENTUALLY: {
+      if (will_composite_eventually_)

[brianderson, 2014/05/21 17:23:00]

Can we also return early here if will_composite_immediately_ is true?

[no sievers, 2014/05/23 02:49:44]

Good catch. Done.

+        return;
+      will_composite_eventually_ = true;
+      const base::TimeDelta estimated_composite_time = vsync_period_ / 4;
+      const base::TimeTicks now = base::TimeTicks::Now();
+      bool skip_frame =
+          did_composite_this_frame_ || pending_swapbuffers_ == kMaxSwapBuffers;
+
+      if (!last_vsync_.is_null() && (now - last_vsync_) < vsync_period_) {
+        base::TimeTicks next_composite =
+            last_vsync_ + vsync_period_ - estimated_composite_time;
+        if (next_composite < now || skip_frame)
+          next_composite += vsync_period_;
+
+        delay = next_composite - now;
+      } else if (skip_frame) {
+        delay = vsync_period_;
+      }
+    }
+    break;
+  }
+  TRACE_EVENT2("cc", "CompositorImpl::PostComposite",
+               "trigger", trigger,
+               "delay", delay.InMillisecondsF());
   base::MessageLoop::current()->PostDelayedTask(

[brianderson, 2014/05/21 17:23:00]

If will_composite_immediately_ just became true and will_composite_eventually_
was previously true, do we need to cancel the previously posted composite?

[no sievers, 2014/05/23 02:49:44]

I think the early-out in Composite() (!needs_composite_) mostly takes care of
that. Also we should never composite twice per frame. 

It's actually pretty bad and noticeable in traces when we over-composite,
because we still have to do a lot of work in the compositor until we notice
there is no visible damage. I saw it initially with my patch when I had the
skip_frame logic and timing off in the code above.

       FROM_HERE,
-      base::Bind(&CompositorImpl::Composite,
-                 weak_factory_.GetWeakPtr(),
-                 COMPOSITE_IMMEDIATELY),
+      base::Bind(
+          &CompositorImpl::Composite, weak_factory_.GetWeakPtr(), trigger),
       delay);
 }
 
 void CompositorImpl::Composite(CompositingTrigger trigger) {
   if (!host_)
     return;
 
+  will_composite_immediately_ &= trigger != COMPOSITE_IMMEDIATELY;
+  will_composite_eventually_ &= trigger != COMPOSITE_EVENTUALLY;

[brianderson, 2014/05/21 17:23:00]

It is hard to decipher the intention here. Is this equivalent?

if (trigger == COMPOSITE_IMMEDIATELY)
  will_composite_immediately_ = false;
if (trigger == COMPOSITE_EVENTUALLY)
  will_composite_eventually_ = false;

[no sievers, 2014/05/23 02:49:44]

Done. You're right, it's equivalent and more readable.

+
   if (!needs_composite_)
     return;
 
-  if (trigger != COMPOSITE_ON_VSYNC && should_composite_on_vsync_) {
-    TRACE_EVENT0("compositor", "CompositorImpl_DeferCompositeToVSync");
-    root_window_->RequestVSyncUpdate();
+  // Don't Composite more than once in between vsync ticks.
+  if (did_composite_this_frame_) {
+    TRACE_EVENT0("compositor", "CompositorImpl_ThrottleComposite");
+    PostComposite(COMPOSITE_EVENTUALLY);
     return;
   }
 
-  // Don't Composite more than once in between vsync ticks.
-  if (did_composite_this_frame_) {
-    TRACE_EVENT0("compositor", "CompositorImpl_ThrottleComposite");
-    if (should_composite_on_vsync_)
-      root_window_->RequestVSyncUpdate();
-    else
-      PostComposite(vsync_period_);
-    return;
-  }
-
-  const unsigned int kMaxSwapBuffers = 2U;
   DCHECK_LE(pending_swapbuffers_, kMaxSwapBuffers);
   if (pending_swapbuffers_ == kMaxSwapBuffers) {
     TRACE_EVENT0("compositor", "CompositorImpl_SwapLimit");
-    if (should_composite_on_vsync_)
-      root_window_->RequestVSyncUpdate();
-    else
-      PostComposite(vsync_period_);
+    PostComposite(COMPOSITE_EVENTUALLY);

[brianderson, 2014/05/21 17:23:00]

Instead of posting a composite, would it be better to set a flag that
automatically triggers a composite when we get the swap ack?

[no sievers, 2014/05/23 02:49:44]

Ok since Sami suggested this earlier too, will do :)

     return;
   }
 
   // Reset state before Layout+Composite since that might create more
   // requests to Composite that we need to respect.
   needs_composite_ = false;
-  should_composite_on_vsync_ = false;
+  did_composite_this_frame_ = true;
 
-  // Ignore ScheduleComposite() from layer tree changes during Layout.
+  // Ignore ScheduleComposite() from layer tree changes during layout and
+  // animation updates that will already be reflected in the current frame
+  // we are about to draw.
   ignore_schedule_composite_ = true;
   client_->Layout();
+
+  if (needs_animate_) {
+    needs_animate_ = false;
+    root_window_->Animate(gfx::FrameTime::Now());
+  }
   ignore_schedule_composite_ = false;
 
   did_post_swapbuffers_ = false;
   host_->Composite(gfx::FrameTime::Now());
   if (did_post_swapbuffers_)
     pending_swapbuffers_++;
 
-  if (trigger != COMPOSITE_ON_VSYNC) {
-    // Need to track vsync to avoid compositing more than once per frame.
-    root_window_->RequestVSyncUpdate();
-  }
-  did_composite_this_frame_ = true;
+  // Need to track vsync to avoid compositing more than once per frame.
+  root_window_->RequestVSyncUpdate();
 }
 
 void CompositorImpl::SetRootLayer(scoped_refptr<cc::Layer> root_layer) {
   root_layer_->RemoveAllChildren();
   if (root_layer)
     root_layer_->AddChild(root_layer);
 }
 
 void CompositorImpl::SetWindowSurface(ANativeWindow* window) {
   GpuSurfaceTracker* tracker = GpuSurfaceTracker::Get();
@@ skipping 42 matching lines @@
   }
 }
 
 void CompositorImpl::SetVisible(bool visible) {
   if (!visible) {
     ui_resource_map_.clear();
     host_.reset();
     client_->UIResourcesAreInvalid();
   } else if (!host_) {
     needs_composite_ = false;
+    needs_animate_ = false;
     did_composite_this_frame_ = false;
-    should_composite_on_vsync_ = false;
+    will_composite_immediately_ = false;
+    will_composite_eventually_ = false;
     pending_swapbuffers_ = 0;
     cc::LayerTreeSettings settings;
     settings.refresh_rate = 60.0;
     settings.impl_side_painting = false;
     settings.allow_antialiasing = false;
     settings.calculate_top_controls_position = false;
     settings.top_controls_height = 0.f;
     settings.highp_threshold_min = 2048;
 
     CommandLine* command_line = CommandLine::ForCurrentProcess();
@@ skipping 37 matching lines @@
   has_transparent_background_ = flag;
   if (host_)
     host_->set_has_transparent_background(flag);
 }
 
 bool CompositorImpl::CompositeAndReadback(void *pixels, const gfx::Rect& rect) {
   return false;
 }
 
 void CompositorImpl::SetNeedsComposite() {
+  DCHECK(!needs_composite_ || will_composite_immediately_ ||
+         will_composite_eventually_);
   if (!host_.get() || needs_composite_)
     return;
 
   needs_composite_ = true;
-
-  // For explicit requests we try to composite regularly on vsync.
-  should_composite_on_vsync_ = true;
-  root_window_->RequestVSyncUpdate();
+  PostComposite(COMPOSITE_EVENTUALLY);
 }
 
 cc::UIResourceId CompositorImpl::GenerateUIResourceFromUIResourceBitmap(
     const cc::UIResourceBitmap& bitmap,
     bool is_transient) {
   if (!host_)
     return 0;
 
   cc::UIResourceId id = 0;
   scoped_ptr<cc::UIResourceClient> resource;
@@ skipping 109 matching lines @@
 
   return scoped_ptr<cc::OutputSurface>(
       new OutputSurfaceWithoutParent(context_provider));
 }
 
 void CompositorImpl::OnLostResources() {
   client_->DidLoseResources();
 }
 
 void CompositorImpl::ScheduleComposite() {
-  if (needs_composite_ || ignore_schedule_composite_)
+  DCHECK(!needs_composite_ || will_composite_immediately_ ||
+         will_composite_eventually_);
+  if (ignore_schedule_composite_)
     return;
 
   needs_composite_ = true;
-
-  // We currently expect layer tree invalidations at most once per frame
-  // during normal operation and therefore try to composite immediately
-  // to minimize latency.
-  PostComposite(base::TimeDelta());
+  if (did_composite_this_frame_) {
+    PostComposite(COMPOSITE_EVENTUALLY);
+  } else {
+    // We currently expect layer tree invalidations at most once per frame
+    // during normal operation and therefore try to composite immediately
+    // to minimize latency.
+    PostComposite(COMPOSITE_IMMEDIATELY);
+  }
 }
 
 void CompositorImpl::ScheduleAnimation() {
   ScheduleComposite();
 }
 
 void CompositorImpl::DidPostSwapBuffers() {
   TRACE_EVENT0("compositor", "CompositorImpl::DidPostSwapBuffers");
   did_post_swapbuffers_ = true;
 }
@@ skipping 19 matching lines @@
 }
 
 void CompositorImpl::RequestCopyOfOutputOnRootLayer(
     scoped_ptr<cc::CopyOutputRequest> request) {
   root_layer_->RequestCopyOfOutput(request.Pass());
 }
 
 void CompositorImpl::OnVSync(base::TimeTicks frame_time,
                              base::TimeDelta vsync_period) {
   vsync_period_ = vsync_period;
+  last_vsync_ = frame_time;
   did_composite_this_frame_ = false;

[brianderson, 2014/05/21 17:23:00]

If did_composite_this_frame_ is true at this point due to an "eventually
composite" and there is an "immediate composite" pending, can we trigger the
immediate composite right here?

[no sievers, 2014/05/23 02:49:44]

You mean for when there is a ScheduleComposite(), let's say late frame from the
renderer, happening after a previous deadline where we composited? Originally I
thought it's maybe fine to wait until the next deadline since we cannot
composite twice per vsync anyways. But I guess it might be better to unblock the
renderer sooner, rather than later.

+}
 
-  if (should_composite_on_vsync_)
-    Composite(COMPOSITE_ON_VSYNC);
+void CompositorImpl::SetNeedsAnimate() {
+  DCHECK(!needs_animate_ || needs_composite_);
+  DCHECK(!needs_composite_ || will_composite_immediately_ ||
+         will_composite_eventually_);
+  needs_animate_ = true;
+
+  if (needs_composite_)
+    return;
+
+  TRACE_EVENT0("cc", "CompositorImpl::SetNeedsAnimate");
+  needs_composite_ = true;
+  PostComposite(COMPOSITE_EVENTUALLY);
 }
 
 }  // namespace content