Unified BeginFrame scheduling

content/browser/renderer_host/render_widget_host_view_mac.mm

 // 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_mac.h"
 
 #import <objc/runtime.h>
 #include <OpenGL/gl.h>
 #include <QuartzCore/QuartzCore.h>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/debug/crash_logging.h"
 #include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "base/mac/mac_util.h"
 #include "base/mac/scoped_cftyperef.h"
 #import "base/mac/scoped_nsobject.h"
 #include "base/mac/sdk_forward_declarations.h"
 #include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/sys_info.h"
+#include "cc/base/switches.h"
 #import "content/browser/accessibility/browser_accessibility_cocoa.h"
 #include "content/browser/accessibility/browser_accessibility_manager_mac.h"
 #import "content/browser/cocoa/system_hotkey_helper_mac.h"
 #import "content/browser/cocoa/system_hotkey_map.h"
 #include "content/browser/compositor/resize_lock.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/compositing_iosurface_context_mac.h"
@@ skipping 465 matching lines @@
     : render_widget_host_(RenderWidgetHostImpl::From(widget)),
       text_input_type_(ui::TEXT_INPUT_TYPE_NONE),
       can_compose_inline_(true),
       browser_compositor_view_placeholder_(
           new BrowserCompositorViewPlaceholderMac),
       backing_store_scale_factor_(1),
       is_loading_(false),
       allow_pause_for_resize_or_repaint_(true),
       weak_factory_(this),
       fullscreen_parent_host_view_(NULL),
+      needs_begin_frame_(false),
+      begin_frame_scheduling_is_enabled_(false),
       software_frame_weak_ptr_factory_(this) {
   software_frame_manager_.reset(new SoftwareFrameManager(
       software_frame_weak_ptr_factory_.GetWeakPtr()));
   // |cocoa_view_| owns us and we will be deleted when |cocoa_view_|
   // goes away.  Since we autorelease it, our caller must put
   // |GetNativeView()| into the view hierarchy right after calling us.
   cocoa_view_ = [[[RenderWidgetHostViewCocoa alloc]
                   initWithRenderWidgetHostViewMac:this] autorelease];
 
   // Make this view host a solid white layer when there is no content ready to
@@ skipping 16 matching lines @@
   }
 
   if (IsDelegatedRendererEnabled()) {
     root_layer_.reset(new ui::Layer(ui::LAYER_TEXTURED));
     delegated_frame_host_.reset(new DelegatedFrameHost(this));
   }
 
   gfx::Screen::GetScreenFor(cocoa_view_)->AddObserver(this);
 
   render_widget_host_->SetView(this);
+
+  if (CommandLine::ForCurrentProcess()->HasSwitch(
+          cc::switches::kEnableBeginFrameScheduling) &&
+      !CommandLIne::HasSwitch(switches::kDisableGpuVsync))
+    begin_frame_scheduling_is_enabled_ = true;
 }
 
 RenderWidgetHostViewMac::~RenderWidgetHostViewMac() {
+  // |this| should be removed from BeginFrameManger's observer list cleanly.
+  if (begin_frame_scheduling_is_enalbed_) {
+    DCHECK(needs_begin_frame_);
+    display_link_->RemoveObserver(this);
+  }
   gfx::Screen::GetScreenFor(cocoa_view_)->RemoveObserver(this);
 
   // This is being called from |cocoa_view_|'s destructor, so invalidate the
   // pointer.
   cocoa_view_ = nil;
 
   UnlockMouse();
 
   // Make sure that the layer doesn't reach into the now-invalid object.
   DestroyCompositedIOSurfaceAndLayer();
@@ skipping 82 matching lines @@
     return;
   if (browser_compositor_view_)
     return;
 
   TRACE_EVENT0("browser",
                "RenderWidgetHostViewMac::EnsureBrowserCompositorView");
 
   browser_compositor_view_.reset(new BrowserCompositorViewMac(this));
   delegated_frame_host_->AddedToWindow();
   delegated_frame_host_->WasShown();
+
+  if (needs_begin_frame_)
+    GetCompositor()->begin_frame_manager()->AddObserver(this);
 }
 
 void RenderWidgetHostViewMac::DestroyBrowserCompositorView() {
   TRACE_EVENT0("browser",
                "RenderWidgetHostViewMac::DestroyBrowserCompositorView");
   if (!browser_compositor_view_)
     return;
 
+  if (needs_begin_frame_)
+    GetCompositor()->begin_frame_manager()->RemoveObserver(this);
+
   delegated_frame_host_->WasHidden();
   delegated_frame_host_->RemovingFromWindow();
   browser_compositor_view_.reset();
 }
 
 void RenderWidgetHostViewMac::EnsureSoftwareLayer() {
   TRACE_EVENT0("browser", "RenderWidgetHostViewMac::EnsureSoftwareLayer");
   if (software_layer_)
     return;
 
@@ skipping 54 matching lines @@
   DestroyCompositedIOSurfaceLayer(kRemoveLayerFromHierarchy);
   compositing_iosurface_ = NULL;
   compositing_iosurface_context_ = NULL;
 }
 
 bool RenderWidgetHostViewMac::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(RenderWidgetHostViewMac, message)
     IPC_MESSAGE_HANDLER(ViewHostMsg_PluginFocusChanged, OnPluginFocusChanged)
     IPC_MESSAGE_HANDLER(ViewHostMsg_StartPluginIme, OnStartPluginIme)
+    IPC_MESSAGE_HANDLER(ViewHostMsg_SetNeedsBeginFrame, OnSetNeedsBeginFrame)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void RenderWidgetHostViewMac::InitAsChild(
     gfx::NativeView parent_view) {
 }
 
 void RenderWidgetHostViewMac::InitAsPopup(
@@ skipping 105 matching lines @@
   NSDictionary* screen_description = [screen deviceDescription];
   NSNumber* screen_number = [screen_description objectForKey:@"NSScreenNumber"];
   CGDirectDisplayID display_id = [screen_number unsignedIntValue];
 
   display_link_ = DisplayLinkMac::GetForDisplay(display_id);
   if (!display_link_) {
     // Note that on some headless systems, the display link will fail to be
     // created, so this should not be a fatal error.
     LOG(ERROR) << "Failed to create display link.";
   }
+
+  if (begin_frame_scheduling_is_enabled_)
+    display_link_->AddObserver(this);
 }
 
 void RenderWidgetHostViewMac::SendVSyncParametersToRenderer() {
+  if (begin_frame_scheduling_is_enabled_)
+    return;
+
   if (!render_widget_host_ || !display_link_)
     return;
 
   if (!display_link_->GetVSyncParameters(&vsync_timebase_, &vsync_interval_)) {
     vsync_timebase_ = base::TimeTicks();
     vsync_interval_ = base::TimeDelta();
     return;
   }
 
   render_widget_host_->UpdateVSyncParameters(vsync_timebase_, vsync_interval_);
 }
 
+void RenderWidgetHostViewMac::OnSetNeedsBeginFrame(bool enabled) {
+  DCHECK(begin_frame_scheduling_is_enabled_);
+
+  if (needs_begin_frame_ == enabled)
+    return;
+
+  TRACE_EVENT1("cc", "RenderWidgetHostViewMac::OnSetNeedsBeginFrame",
+               "enabled", enabled);
+
+  if (enabled)
+    GetCompositor()->begin_frame_manager()->AddObserver(this,
+                                                        last_begin_frame_args_);
+  else
+    GetCompositor()->begin_frame_manager()->RemoveObserver(this);
+
+  needs_begin_frame_ = enabled;
+}
+
 void RenderWidgetHostViewMac::UpdateBackingStoreScaleFactor() {
   if (!render_widget_host_)
     return;
 
   float new_scale_factor = ui::GetScaleFactorForNativeView(cocoa_view_);
   if (new_scale_factor == backing_store_scale_factor_)
     return;
   backing_store_scale_factor_ = new_scale_factor;
 
   render_widget_host_->NotifyScreenInfoChanged();
@@ skipping 1448 matching lines @@
 
 void RenderWidgetHostViewMac::OnDisplayMetricsChanged(
     const gfx::Display& display, uint32_t metrics) {
   gfx::Screen* screen = gfx::Screen::GetScreenFor(cocoa_view_);
   if (display.id() != screen->GetDisplayNearestWindow(cocoa_view_).id())
     return;
 
   UpdateScreenInfo(cocoa_view_);
 }
 
+void RenderWidgetHostViewMac::OnSendBeginFrame(
+    const cc::BeginFrameArgs& args) {
+  DCHECK(begin_frame_scheduling_is_enabled_);
+  DCHECK(render_widget_host_);
+  TRACE_EVENT0("cc", "RenderWidgetHostViewMac::OnSendBeginFrame");
+
+  cc::BeginFrameArgs adjusted_args(args);
+
+  delegated_frame_host_->UpdateVSyncParameters(adjusted_args);
+
+  // TODO(brianderson): Use adaptive draw-time estimation.
+  base::TimeDelta estimated_browser_composite_time =
+      base::TimeDelta::FromMicroseconds(
+          (1.0f * base::Time::kMicrosecondsPerSecond) / (3.0f * 60));
+
+  adjusted_args.deadline -= estimated_browser_composite_time;
+
+  render_widget_host_->Send(new ViewMsg_BeginFrame(
+                                render_widget_host_->GetRoutingID(),
+                                adjusted_args));
+  last_begin_frame_args_ = args;
+}
+
+void RenderWidgetHostViewMac::OnVSync(base::TimeTicks timebase,
+                                      base::TimeDelta interval) {
+  DCHECK(begin_frame_scheduling_is_enabled_);
+
+  GetCompositor()->begin_frame_manager()->StartBeginFrame(
+      cc::BeginFrameArgs::Create(timebase,
+                                 timebase + interval,
+                                 interval));
+}
+
 }  // namespace content
 
 // RenderWidgetHostViewCocoa ---------------------------------------------------
 
 @implementation RenderWidgetHostViewCocoa
 @synthesize selectedRange = selectedRange_;
 @synthesize suppressNextEscapeKeyUp = suppressNextEscapeKeyUp_;
 @synthesize markedRange = markedRange_;
 
 - (id)initWithRenderWidgetHostViewMac:(RenderWidgetHostViewMac*)r {
@@ skipping 1682 matching lines @@
 
 // "-webkit-app-region: drag | no-drag" is implemented on Mac by excluding
 // regions that are not draggable. (See ControlRegionView in
 // native_app_window_cocoa.mm). This requires the render host view to be
 // draggable by default.
 - (BOOL)mouseDownCanMoveWindow {
   return YES;
 }
 
 @end