Unified BeginFrame scheduling

ui/compositor/compositor.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 "ui/compositor/compositor.h"
 
 #include <algorithm>
 #include <deque>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/strings/string_util.h"
 #include "base/sys_info.h"
 #include "cc/base/latency_info_swap_promise.h"
 #include "cc/base/switches.h"
 #include "cc/input/input_handler.h"
 #include "cc/layers/layer.h"
 #include "cc/output/begin_frame_args.h"
 #include "cc/output/context_provider.h"
 #include "cc/trees/layer_tree_host.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "ui/compositor/compositor_observer.h"
 #include "ui/compositor/compositor_switches.h"
-#include "ui/compositor/compositor_vsync_manager.h"
 #include "ui/compositor/dip_util.h"
 #include "ui/compositor/layer.h"
 #include "ui/compositor/layer_animator_collection.h"
 #include "ui/gfx/frame_time.h"
 #include "ui/gl/gl_context.h"
 #include "ui/gl/gl_switches.h"
 
 namespace {
 
 const double kDefaultRefreshRate = 60.0;
@@ skipping 19 matching lines @@
 
 void CompositorLock::CancelLock() {
   if (!compositor_)
     return;
   compositor_->UnlockCompositor();
   compositor_ = NULL;
 }
 
 }  // namespace ui
 
-namespace {}  // namespace
-
 namespace ui {
 
 Compositor::Compositor(gfx::AcceleratedWidget widget,
                        ui::ContextFactory* context_factory,
                        scoped_refptr<base::SingleThreadTaskRunner> task_runner)
     : context_factory_(context_factory),
       root_layer_(NULL),
       widget_(widget),
       compositor_thread_loop_(context_factory->GetCompositorMessageLoop()),
       task_runner_(task_runner),
-      vsync_manager_(new CompositorVSyncManager()),
       device_scale_factor_(0.0f),
       last_started_frame_(0),
       last_ended_frame_(0),
       disable_schedule_composite_(false),
       compositor_lock_(NULL),
       defer_draw_scheduling_(false),
       waiting_on_compositing_end_(false),
       draw_on_compositing_end_(false),
       swap_state_(SWAP_NONE),
       layer_animator_collection_(this),
-      schedule_draw_factory_(this) {
+      schedule_draw_factory_(this),
+      output_surface_lost_(true) {
   root_web_layer_ = cc::Layer::Create();
 
   CommandLine* command_line = CommandLine::ForCurrentProcess();
 
   cc::LayerTreeSettings settings;
   settings.refresh_rate =
       context_factory_->DoesCreateTestContexts()
       ? kTestRefreshRate
       : kDefaultRefreshRate;
   settings.main_frame_before_draw_enabled = false;
   settings.main_frame_before_activation_enabled = false;
   settings.throttle_frame_production =
       !command_line->HasSwitch(switches::kDisableGpuVsync);
 #if !defined(OS_MACOSX)
   settings.partial_swap_enabled =
       !command_line->HasSwitch(cc::switches::kUIDisablePartialSwap);
+  settings.begin_frame_publisher =
+      command_line->HasSwitch(cc::switches::kEnableBeginFrameScheduling);
 #endif
 #if defined(OS_CHROMEOS)
   settings.per_tile_painting_enabled = true;
 #endif
 
   // These flags should be mirrored by renderer versions in content/renderer/.
   settings.initial_debug_state.show_debug_borders =
       command_line->HasSwitch(cc::switches::kUIShowCompositedLayerBorders);
   settings.initial_debug_state.show_fps_counter =
       command_line->HasSwitch(cc::switches::kUIShowFPSCounter);
@@ skipping 16 matching lines @@
 
   settings.initial_debug_state.SetRecordRenderingStats(
       command_line->HasSwitch(cc::switches::kEnableGpuBenchmarking));
 
   settings.impl_side_painting = IsUIImplSidePaintingEnabled();
   settings.use_zero_copy = IsUIZeroCopyEnabled();
   settings.single_thread_proxy_scheduler = false;
 
   base::TimeTicks before_create = base::TimeTicks::Now();
   if (compositor_thread_loop_.get()) {
+    // Unified BeginFrame scheduling is not used with threaded compositing.
+    DCHECK(!settings.begin_frame_publisher);
     host_ = cc::LayerTreeHost::CreateThreaded(
         this,
         context_factory_->GetSharedBitmapManager(),
         settings,
         task_runner_,
         compositor_thread_loop_);
   } else {
     host_ = cc::LayerTreeHost::CreateSingleThreaded(
         this,
         this,
         context_factory_->GetSharedBitmapManager(),
         settings,
         task_runner_);
   }
   UMA_HISTOGRAM_TIMES("GPU.CreateBrowserCompositor",
                       base::TimeTicks::Now() - before_create);
   host_->SetRootLayer(root_web_layer_);
   host_->SetLayerTreeHostClientReady();
 }
 
 Compositor::~Compositor() {
   TRACE_EVENT0("shutdown", "Compositor::destructor");
 
   CancelCompositorLock();
   DCHECK(!compositor_lock_);
 
+  DCHECK(!begin_frame_observer_list_.might_have_observers());
+
   if (root_layer_)
     root_layer_->SetCompositor(NULL);
 
   // Stop all outstanding draws before telling the ContextFactory to tear
   // down any contexts that the |host_| may rely upon.
   host_.reset();
 
   context_factory_->RemoveCompositor(this);
 }
 
@@ skipping 93 matching lines @@
 
 void Compositor::SetBackgroundColor(SkColor color) {
   host_->set_background_color(color);
   ScheduleDraw();
 }
 
 void Compositor::SetVisible(bool visible) {
   host_->SetVisible(visible);
 }
 
-scoped_refptr<CompositorVSyncManager> Compositor::vsync_manager() const {
-  return vsync_manager_;
+void Compositor::SetAuthoritativeVSyncInterval(base::TimeDelta interval) const {
+  host_->SetAuthoritativeVSyncInterval(interval);
+}
+
+void Compositor::StartBeginFrame(const cc::BeginFrameArgs& args) const {
+  if (output_surface_lost_)
+    return;
+  task_runner_->PostTask(
+      FROM_HERE,
+      base::Bind(
+          &cc::OutputSurface::BeginFrame, output_surface_weak_ptr_, args));
 }
 
 void Compositor::AddObserver(CompositorObserver* observer) {
 #if defined(OS_MACOSX)
   // Debugging instrumentation for crbug.com/401630.
   // TODO(ccameron): remove this.
   CHECK(observer);
   if (!observer_list_.HasObserver(observer))
     observer->observing_count_ += 1;
 #endif
@@ skipping 23 matching lines @@
 
 void Compositor::RemoveAnimationObserver(
     CompositorAnimationObserver* observer) {
   animation_observer_list_.RemoveObserver(observer);
 }
 
 bool Compositor::HasAnimationObserver(CompositorAnimationObserver* observer) {
   return animation_observer_list_.HasObserver(observer);
 }
 
+void Compositor::AddBeginFrameObserver(
+    CompositorBeginFrameObserver* observer,
+    const cc::BeginFrameArgs& last_begin_frame_args_sent_to_observer) {
+  bool need_begin_frame = false;
+  if (!begin_frame_observer_list_.might_have_observers()) {
+    need_begin_frame = true;
+  }
+
+  begin_frame_observer_list_.AddObserver(observer);
+
+  if (need_begin_frame) {
+    task_runner_->PostTask(FROM_HERE,
+                           base::Bind(&Compositor::SetChildrenNeedBeginFrames,
+                                      base::Unretained(this),
+                                      true));
+  }
+
+  // If |last_begin_frame_args_| is still effective, send it to the new
+  // |observer| immediately.
+  if (!last_begin_frame_args_sent_to_observer.deadline.is_null() &&
+      last_begin_frame_args_sent_to_observer != last_begin_frame_args_ &&
+      last_begin_frame_args_.deadline > base::TimeTicks::Now())
+    observer->OnSendBeginFrame(last_begin_frame_args_);
+}
+
+void Compositor::RemoveBeginFrameObserver(
+    CompositorBeginFrameObserver* observer) {
+  DCHECK(begin_frame_observer_list_.might_have_observers());
+
+  begin_frame_observer_list_.RemoveObserver(observer);
+
+  if (!begin_frame_observer_list_.might_have_observers()) {
+    task_runner_->PostTask(FROM_HERE,
+                           base::Bind(&Compositor::SetChildrenNeedBeginFrames,
+                                      base::Unretained(this),
+                                      false));
+  }
+}
+
 void Compositor::BeginMainFrame(const cc::BeginFrameArgs& args) {
   FOR_EACH_OBSERVER(CompositorAnimationObserver,
                     animation_observer_list_,
                     OnAnimationStep(args.frame_time));
   if (animation_observer_list_.might_have_observers())
     host_->SetNeedsAnimate();
 }
 
 void Compositor::Layout() {
   // We're sending damage that will be addressed during this composite
   // cycle, so we don't need to schedule another composite to address it.
   disable_schedule_composite_ = true;
   if (root_layer_)
     root_layer_->SendDamagedRects();
   disable_schedule_composite_ = false;
 }
 
 scoped_ptr<cc::OutputSurface> Compositor::CreateOutputSurface(bool fallback) {
-  return context_factory_->CreateOutputSurface(this, fallback);
+  scoped_ptr<cc::OutputSurface> output_surface =
+      context_factory_->CreateOutputSurface(this, fallback);
+  // Keep this here, but can be used when DidInitializeOutputSurface() is false.
+  DCHECK(!output_surface_weak_ptr_);
+  output_surface_weak_ptr_ = output_surface->GetWeakPtr();
+  return output_surface.Pass();
+}
+
+void Compositor::DidInitializeOutputSurface() {
+  DCHECK(output_surface_weak_ptr_);
+  output_surface_lost_ = false;
+}
+
+void Compositor::DidLoseOutputSurface() {
+  output_surface_lost_ = true;
+  output_surface_weak_ptr_.reset();
 }
 
 void Compositor::DidCommit() {
   DCHECK(!IsLocked());
   FOR_EACH_OBSERVER(CompositorObserver,
                     observer_list_,
                     OnCompositingDidCommit(this));
 }
 
 void Compositor::DidCommitAndDrawFrame() {
@@ skipping 15 matching lines @@
 
 void Compositor::ScheduleComposite() {
   if (!disable_schedule_composite_)
     ScheduleDraw();
 }
 
 void Compositor::ScheduleAnimation() {
   ScheduleComposite();
 }
 
+void Compositor::SendBeginFrameToChildren(const cc::BeginFrameArgs& args) {
+  FOR_EACH_OBSERVER(CompositorBeginFrameObserver,
+                    begin_frame_observer_list_,
+                    OnSendBeginFrame(args));
+  last_begin_frame_args_ = args;
+}
+
 void Compositor::DidPostSwapBuffers() {
   DCHECK(!compositor_thread_loop_.get());
   DCHECK_EQ(swap_state_, SWAP_NONE);
   swap_state_ = SWAP_POSTED;
 }
 
 void Compositor::DidAbortSwapBuffers() {
   if (!compositor_thread_loop_.get()) {
     if (swap_state_ == SWAP_POSTED) {
       NotifyEnd();
@@ skipping 51 matching lines @@
 
     // Call ScheduleDraw() instead of Draw() in order to allow other
     // CompositorObservers to be notified before starting another
     // draw cycle.
     ScheduleDraw();
   }
   FOR_EACH_OBSERVER(
       CompositorObserver, observer_list_, OnCompositingEnded(this));
 }
 
+void Compositor::SetChildrenNeedBeginFrames(bool need_begin_frame) {
+  host_->SetChildrenNeedBeginFrames(need_begin_frame);
+}
+
 }  // namespace ui