Unified BeginFrame scheduling

content/browser/renderer_host/render_widget_host_view_aura.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_
 
 #include <map>
 #include <set>
 #include <string>
@@ skipping 10 matching lines @@
 #include "content/browser/compositor/image_transport_factory.h"
 #include "content/browser/compositor/owned_mailbox.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/common/content_export.h"
 #include "content/common/cursors/webcursor.h"
 #include "third_party/skia/include/core/SkRegion.h"
 #include "ui/aura/client/cursor_client_observer.h"
 #include "ui/aura/client/focus_change_observer.h"
 #include "ui/aura/window_delegate.h"
 #include "ui/aura/window_tree_host_observer.h"
+#include "ui/base/compositor/begin_frame_manager.h"
 #include "ui/base/ime/text_input_client.h"
 #include "ui/gfx/display_observer.h"
 #include "ui/gfx/insets.h"
 #include "ui/gfx/rect.h"
 #include "ui/wm/public/activation_change_observer.h"
 #include "ui/wm/public/activation_delegate.h"
 
 struct ViewHostMsg_TextInputState_Params;
 
 namespace aura {
@@ skipping 40 matching lines @@
     : public RenderWidgetHostViewBase,
       public DelegatedFrameHostClient,
       public ui::TextInputClient,
       public gfx::DisplayObserver,
       public aura::WindowTreeHostObserver,
       public aura::WindowDelegate,
       public aura::client::ActivationDelegate,
       public aura::client::ActivationChangeObserver,
       public aura::client::FocusChangeObserver,
       public aura::client::CursorClientObserver,
+      public ui::BeginFrameManager::Observer,

[brianderson, 2014/08/21 00:14:00]

Is the plan to land this first as Aura-only and then unify it with all other
platforms as a separate patch?

[simonhong, 2014/08/26 08:24:48]

I'll implement mac and android also in this CL,
then split this CL into other smaller CLs with test codes.

       public base::SupportsWeakPtr<RenderWidgetHostViewAura> {
  public:
   // Displays and controls touch editing elements such as selection handles.
   class TouchEditingClient {
    public:
     TouchEditingClient() {}
 
     // Tells the client to start showing touch editing handles.
     virtual void StartTouchEditing() = 0;
 
@@ skipping 42 matching lines @@
   virtual bool IsSurfaceAvailableForCopy() const OVERRIDE;
   virtual void Show() OVERRIDE;
   virtual void Hide() OVERRIDE;
   virtual bool IsShowing() OVERRIDE;
   virtual gfx::Rect GetViewBounds() const OVERRIDE;
   virtual void SetBackgroundOpaque(bool opaque) OVERRIDE;
   virtual gfx::Size GetVisibleViewportSize() const OVERRIDE;
   virtual void SetInsets(const gfx::Insets& insets) OVERRIDE;
 
   // Overridden from RenderWidgetHostViewBase:
+  virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
   virtual void InitAsPopup(RenderWidgetHostView* parent_host_view,
                            const gfx::Rect& pos) OVERRIDE;
   virtual void InitAsFullscreen(
       RenderWidgetHostView* reference_host_view) OVERRIDE;
   virtual void WasShown() OVERRIDE;
   virtual void WasHidden() OVERRIDE;
   virtual void MovePluginWindows(
       const std::vector<WebPluginGeometry>& moves) OVERRIDE;
   virtual void Focus() OVERRIDE;
   virtual void Blur() OVERRIDE;
@@ skipping 149 matching lines @@
   virtual void OnCursorVisibilityChanged(bool is_visible) OVERRIDE;
 
   // Overridden from aura::client::FocusChangeObserver:
   virtual void OnWindowFocused(aura::Window* gained_focus,
                                aura::Window* lost_focus) OVERRIDE;
 
   // Overridden from aura::WindowTreeHostObserver:
   virtual void OnHostMoved(const aura::WindowTreeHost* host,
                            const gfx::Point& new_origin) OVERRIDE;
 
+  // Overridden from ui::BeginFrameManager::Observer:
+  virtual void OnSendBeginFrame(const cc::BeginFrameArgs& args) OVERRIDE;
+
 #if defined(OS_WIN)
   // Sets the cutout rects from constrained windows. These are rectangles that
   // windowed NPAPI plugins shouldn't paint in. Overwrites any previous cutout
   // rects.
   void UpdateConstrainedWindowRects(const std::vector<gfx::Rect>& rects);
 
   // Updates the cursor clip region. Used for mouse locking.
   void UpdateMouseLockRegion();
 
   // Notification that the LegacyRenderWidgetHostHWND was destroyed.
   void OnLegacyWindowDestroyed();
 #endif
 
   // Method to indicate if this instance is shutting down or closing.
   // TODO(shrikant): Discuss around to see if it makes sense to add this method
   // as part of RenderWidgetHostView.
   bool IsClosing() const { return in_shutdown_; }
 
   // Sets whether the overscroll controller should be enabled for this page.
   void SetOverscrollControllerEnabled(bool enabled);
 
   void SnapToPhysicalPixelBoundary();
 
   OverscrollController* overscroll_controller() const {
     return overscroll_controller_.get();
   }
 
+  // Request next BeginFrame to compositor.
+  void RequestBeginFrame() const;
+
  protected:
   virtual ~RenderWidgetHostViewAura();
 
   // Exposed for tests.
   aura::Window* window() { return window_; }
   virtual SkColorType PreferredReadbackFormat() OVERRIDE;
   virtual DelegatedFrameHost* GetDelegatedFrameHost() const OVERRIDE;
 
  private:
   FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, SetCompositionText);
@@ skipping 97 matching lines @@
 
   // Converts |rect| from window coordinate to screen coordinate.
   gfx::Rect ConvertRectToScreen(const gfx::Rect& rect) const;
 
   // Converts |rect| from screen coordinate to window coordinate.
   gfx::Rect ConvertRectFromScreen(const gfx::Rect& rect) const;
 
   // Helper function to set keyboard focus to the main window.
   void SetKeyboardFocus();
 
+  void OnSetNeedsBeginFrame(bool enabled);
+
   RenderFrameHostImpl* GetFocusedFrame();
 
   // The model object.
   RenderWidgetHostImpl* host_;
 
   aura::Window* window_;
 
   scoped_ptr<DelegatedFrameHost> delegated_frame_host_;
 
   scoped_ptr<WindowObserver> window_observer_;
@@ skipping 113 matching lines @@
   // DestroyWindow for e.g. This flag helps ensure that we don't try to create
   // the LegacyRenderWidgetHostHWND instance again as that would be a futile
   // exercise.
   bool legacy_window_destroyed_;
 #endif
 
   bool has_snapped_to_boundary_;
 
   TouchEditingClient* touch_editing_client_;
 
+  // true when RenderWidget needs a BeginFrame.
+  bool needs_begin_frame_;
+
   scoped_ptr<OverscrollController> overscroll_controller_;
 
   gfx::Insets insets_;
 
   std::vector<ui::LatencyInfo> software_latency_info_;
 
   scoped_ptr<aura::client::ScopedTooltipDisabler> tooltip_disabler_;
 
   base::WeakPtrFactory<RenderWidgetHostViewAura> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewAura);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_