Unified BeginFrame scheduling

content/browser/renderer_host/render_widget_host_view_aura.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/render_widget_host_view_aura.h"
 
 #include "base/auto_reset.h"
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/string_number_conversions.h"
 #include "cc/layers/layer.h"
 #include "cc/output/copy_output_request.h"
 #include "cc/output/copy_output_result.h"
 #include "cc/resources/texture_mailbox.h"
-#include "cc/trees/layer_tree_settings.h"
 #include "content/browser/accessibility/browser_accessibility_manager.h"
 #include "content/browser/accessibility/browser_accessibility_state_impl.h"
 #include "content/browser/frame_host/frame_tree.h"
 #include "content/browser/frame_host/frame_tree_node.h"
 #include "content/browser/frame_host/render_frame_host_impl.h"
 #include "content/browser/gpu/compositor_util.h"
 #include "content/browser/renderer_host/compositor_resize_lock_aura.h"
 #include "content/browser/renderer_host/dip_util.h"
 #include "content/browser/renderer_host/input/synthetic_gesture_target_aura.h"
 #include "content/browser/renderer_host/overscroll_controller.h"
@@ skipping 23 matching lines @@
 #include "ui/aura/env.h"
 #include "ui/aura/window.h"
 #include "ui/aura/window_event_dispatcher.h"
 #include "ui/aura/window_observer.h"
 #include "ui/aura/window_tracker.h"
 #include "ui/aura/window_tree_host.h"
 #include "ui/base/clipboard/scoped_clipboard_writer.h"
 #include "ui/base/hit_test.h"
 #include "ui/base/ime/input_method.h"
 #include "ui/base/ui_base_types.h"
-#include "ui/compositor/compositor_vsync_manager.h"
 #include "ui/compositor/dip_util.h"
 #include "ui/events/event.h"
 #include "ui/events/event_utils.h"
 #include "ui/events/gestures/gesture_recognizer.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/display.h"
 #include "ui/gfx/rect_conversions.h"
 #include "ui/gfx/screen.h"
 #include "ui/gfx/size_conversions.h"
 #include "ui/gfx/skia_util.h"
@@ skipping 370 matching lines @@
       last_swapped_software_frame_scale_factor_(1.f),
       paint_canvas_(NULL),
       synthetic_move_sent_(false),
       cursor_visibility_state_in_renderer_(UNKNOWN),
 #if defined(OS_WIN)
       legacy_render_widget_host_HWND_(NULL),
       legacy_window_destroyed_(false),
 #endif
       has_snapped_to_boundary_(false),
       touch_editing_client_(NULL),
+      needs_begin_frame_(false),
+      begin_frame_scheduling_is_enabled_(false),
       weak_ptr_factory_(this) {
   host_->SetView(this);
   window_observer_.reset(new WindowObserver(this));
   aura::client::SetTooltipText(window_, &tooltip_);
   aura::client::SetActivationDelegate(window_, this);
   aura::client::SetActivationChangeObserver(window_, this);
   aura::client::SetFocusChangeObserver(window_, this);
   window_->set_layer_owner_delegate(delegated_frame_host_.get());
   gfx::Screen::GetScreenFor(window_)->AddObserver(this);
 
   bool overscroll_enabled = CommandLine::ForCurrentProcess()->
       GetSwitchValueASCII(switches::kOverscrollHistoryNavigation) != "0";
   SetOverscrollControllerEnabled(overscroll_enabled);
+
+#if !defined(OS_CHROMEOS)
+  begin_frame_scheduling_is_enabled_ = true;

[brianderson, 2014/09/04 18:45:46]

Can we assume this is true for all Aura platforms?

+#endif
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // RenderWidgetHostViewAura, RenderWidgetHostView implementation:
 
+bool RenderWidgetHostViewAura::OnMessageReceived(const IPC::Message& msg) {
+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP(RenderWidgetHostViewAura, msg)
+    IPC_MESSAGE_HANDLER(ViewHostMsg_SetNeedsBeginFrame, OnSetNeedsBeginFrame)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
 void RenderWidgetHostViewAura::InitAsChild(
     gfx::NativeView parent_view) {
   window_->SetType(ui::wm::WINDOW_TYPE_CONTROL);
   window_->Init(aura::WINDOW_LAYER_TEXTURED);
   window_->SetName("RenderWidgetHostViewAura");
 }
 
 void RenderWidgetHostViewAura::InitAsPopup(
     RenderWidgetHostView* parent_host_view,
     const gfx::Rect& bounds_in_screen) {
@@ skipping 369 matching lines @@
 
 void RenderWidgetHostViewAura::RenderProcessGone(base::TerminationStatus status,
                                                  int error_code) {
   UpdateCursorIfOverSelf();
   Destroy();
 }
 
 void RenderWidgetHostViewAura::Destroy() {
   // Beware, this function is not called on all destruction paths. It will
   // implicitly end up calling ~RenderWidgetHostViewAura though, so all
   // destruction/cleanup code should happen there, not here.

[piman, 2014/09/04 20:56:38]

Beware of this comment!

+
+  // Remove observation from Compositor in here because we can't access
+  // to compositor in destructor.
+  if (needs_begin_frame_ && GetCompositor()) {
+    GetCompositor()->RemoveBeginFrameObserver(this);
+    needs_begin_frame_ = false;
+  }
+
   in_shutdown_ = true;
   delete window_;
 }
 
 void RenderWidgetHostViewAura::SetTooltipText(
     const base::string16& tooltip_text) {
   tooltip_ = tooltip_text;
   aura::Window* root_window = window_->GetRootWindow();
   aura::client::TooltipClient* tooltip_client =
       aura::client::GetTooltipClient(root_window);
@@ skipping 1239 matching lines @@
 
 void RenderWidgetHostViewAura::OnHostMoved(const aura::WindowTreeHost* host,
                                            const gfx::Point& new_origin) {
   TRACE_EVENT1("ui", "RenderWidgetHostViewAura::OnHostMoved",
                "new_origin", new_origin.ToString());
 
   UpdateScreenInfo(window_);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
+// ui::CompositorBeginFrameObserver implementation:
+void RenderWidgetHostViewAura::OnSendBeginFrame(
+    const cc::BeginFrameArgs& args) {
+  DCHECK(begin_frame_scheduling_is_enabled_);
+  DCHECK(host_);
+  TRACE_EVENT0("cc", "RenderWidgetHostViewAura::OnSendBeginFrame");
+
+  delegated_frame_host_->UpdateVSyncParameters(args);
+
+  host_->Send(new ViewMsg_BeginFrame(host_->GetRoutingID(), args));
+
+  last_begin_frame_args_ = args;
+}
+
+////////////////////////////////////////////////////////////////////////////////
 // RenderWidgetHostViewAura, private:
 
 RenderWidgetHostViewAura::~RenderWidgetHostViewAura() {
+  // When we are using unified BeginFrame(--enable-begin-frame-scheduling),
+  // |needs_begin_frame_| always be false in here. We can't remove
+  // observation from Compositor in this function because |window_| is already
+  // removed from window tree host.
+  DCHECK(!needs_begin_frame_);
+
   if (touch_editing_client_)
     touch_editing_client_->OnViewDestroyed();
 
   delegated_frame_host_.reset();
   window_observer_.reset();
   if (window_->GetHost())
     window_->GetHost()->RemoveObserver(this);
   UnlockMouse();
   if (popup_parent_host_view_) {
     DCHECK(popup_parent_host_view_->popup_child_host_view_ == NULL ||
@@ skipping 237 matching lines @@
 
 #if defined(OS_WIN)
   // The parent may have changed here. Ensure that the legacy window is
   // reparented accordingly.
   if (legacy_render_widget_host_HWND_)
     legacy_render_widget_host_HWND_->UpdateParent(
         reinterpret_cast<HWND>(GetNativeViewId()));
 #endif
 
   delegated_frame_host_->AddedToWindow();
+
+  // When this RWHV is added to new root window, this RWHV should be added to
+  // the new compositor.
+  if (needs_begin_frame_) {
+    DCHECK(begin_frame_scheduling_is_enabled_);
+    GetCompositor()->AddBeginFrameObserver(this, last_begin_frame_args_);
+  }

[piman, 2014/09/04 20:56:38]

A lot of this logic is common between mac and aura. Can it be moved into
DelegatedFrameHost?

 }
 
 void RenderWidgetHostViewAura::RemovingFromRootWindow() {
   aura::client::CursorClient* cursor_client =
       aura::client::GetCursorClient(window_->GetRootWindow());
   if (cursor_client)
     cursor_client->RemoveObserver(this);
 
   DetachFromInputMethod();
 
   window_->GetHost()->RemoveObserver(this);
   delegated_frame_host_->RemovingFromWindow();
 
 #if defined(OS_WIN)
   // Update the legacy window's parent temporarily to the desktop window. It
   // will eventually get reparented to the right root.
   if (legacy_render_widget_host_HWND_)
     legacy_render_widget_host_HWND_->UpdateParent(::GetDesktopWindow());
 #endif
+
+  // When this RWHV is removed from current root window, this RWHV should be
+  // removed from the current compositor which will be removed.
+  if (needs_begin_frame_) {
+    DCHECK(begin_frame_scheduling_is_enabled_);
+    GetCompositor()->RemoveBeginFrameObserver(this);
+  }
 }
 
 void RenderWidgetHostViewAura::DetachFromInputMethod() {
   ui::InputMethod* input_method = GetInputMethod();
   if (input_method && input_method->GetTextInputClient() == this)
     input_method->SetFocusedTextInputClient(NULL);
 }
 
 void RenderWidgetHostViewAura::ForwardKeyboardEvent(
     const NativeWebKeyboardEvent& event) {
@@ skipping 21 matching lines @@
   }
 #endif
 
   host_->ForwardKeyboardEvent(event);
 }
 
 SkColorType RenderWidgetHostViewAura::PreferredReadbackFormat() {
   return kN32_SkColorType;
 }
 
+void RenderWidgetHostViewAura::OnSetNeedsBeginFrame(bool enabled) {
+  DCHECK(begin_frame_scheduling_is_enabled_);
+  DCHECK(GetCompositor());
+
+  if (needs_begin_frame_ == enabled)
+    return;
+
+  TRACE_EVENT1("cc", "RenderWidgetHostViewAura::OnSetNeedsBeginFrame",
+               "enabled", enabled);
+  if (enabled)
+    GetCompositor()->AddBeginFrameObserver(this, last_begin_frame_args_);
+  else
+    GetCompositor()->RemoveBeginFrameObserver(this);
+
+  needs_begin_frame_ = enabled;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // DelegatedFrameHost, public:
 
 ui::Compositor* RenderWidgetHostViewAura::GetCompositor() const {
   aura::WindowTreeHost* host = window_->GetHost();
   return host ? host->compositor() : NULL;
 }
 
 ui::Layer* RenderWidgetHostViewAura::GetLayer() {
   return window_->layer();
@@ skipping 41 matching lines @@
 
 ////////////////////////////////////////////////////////////////////////////////
 // RenderWidgetHostViewBase, public:
 
 // static
 void RenderWidgetHostViewBase::GetDefaultScreenInfo(WebScreenInfo* results) {
   GetScreenInfoForWindow(results, NULL);
 }
 
 }  // namespace content