cc: Implement unified BeginFrame on aura

ui/compositor/compositor.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 UI_COMPOSITOR_COMPOSITOR_H_
 #define UI_COMPOSITOR_COMPOSITOR_H_
 
 #include <string>
 
 #include "base/containers/hash_tables.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/single_thread_task_runner.h"
 #include "base/time/time.h"
+#include "cc/output/begin_frame_args.h"
 #include "cc/surfaces/surface_sequence.h"
 #include "cc/trees/layer_tree_host_client.h"
 #include "cc/trees/layer_tree_host_single_thread_client.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/compositor/compositor_animation_observer.h"
 #include "ui/compositor/compositor_export.h"
 #include "ui/compositor/compositor_observer.h"
 #include "ui/compositor/layer_animator_collection.h"
 #include "ui/gfx/geometry/size.h"
 #include "ui/gfx/geometry/vector2d.h"
@@ skipping 20 matching lines @@
 }
 
 namespace gpu {
 class GpuMemoryBufferManager;
 struct Mailbox;
 }
 
 namespace ui {
 
 class Compositor;
-class CompositorVSyncManager;
 class Layer;
 class Reflector;
 class Texture;
 struct LatencyInfo;
 
 // This class abstracts the creation of the 3D context for the compositor. It is
 // a global object.
 class COMPOSITOR_EXPORT ContextFactory {
  public:
   virtual ~ContextFactory() {}
@@ skipping 54 matching lines @@
 
   explicit CompositorLock(Compositor* compositor);
   ~CompositorLock();
 
   void CancelLock();
 
   Compositor* compositor_;
   DISALLOW_COPY_AND_ASSIGN(CompositorLock);
 };
 
+// This class observes BeginFrame notification from LayerTreeHost.
+class COMPOSITOR_EXPORT CompositorBeginFrameObserver {
+ public:
+  virtual ~CompositorBeginFrameObserver() {}
+
+  virtual void OnSendBeginFrame(const cc::BeginFrameArgs& args) = 0;
+};
+
 // Compositor object to take care of GPU painting.
 // A Browser compositor object is responsible for generating the final
 // displayable form of pixels comprising a single widget's contents. It draws an
 // appropriately transformed texture for each transformed view in the widget's
 // view hierarchy.
 class COMPOSITOR_EXPORT Compositor
     : NON_EXPORTED_BASE(public cc::LayerTreeHostClient),
       NON_EXPORTED_BASE(public cc::LayerTreeHostSingleThreadClient) {
  public:
   Compositor(gfx::AcceleratedWidget widget,
@@ skipping 53 matching lines @@
   // Sets the background color used for areas that aren't covered by
   // the |root_layer|.
   void SetBackgroundColor(SkColor color);
 
   // Sets the visibility of the underlying compositor.
   void SetVisible(bool visible);
 
   // Gets the visibility of the underlying compositor.
   bool IsVisible();
 
+  // The "authoritative" vsync interval, if provided, will override interval
+  // reported from 3D context. This is typically the value reported by a more
+  // reliable source, e.g, the platform display configuration.
+  // In the particular case of ChromeOS -- this is the value queried through
+  // XRandR, which is more reliable than the value queried through the 3D
+  // context.
+  void SetAuthoritativeVSyncInterval(const base::TimeDelta& interval);
+
   // Returns the widget for this compositor.
   gfx::AcceleratedWidget widget() const { return widget_; }
 
-  // Returns the vsync manager for this compositor.
-  scoped_refptr<CompositorVSyncManager> vsync_manager() const;
-
   // Returns the main thread task runner this compositor uses. Users of the
   // compositor generally shouldn't use this.
   scoped_refptr<base::SingleThreadTaskRunner> task_runner() const {
     return task_runner_;
   }
 
   // Compositor does not own observers. It is the responsibility of the
   // observer to remove itself when it is done observing.
   void AddObserver(CompositorObserver* observer);
   void RemoveObserver(CompositorObserver* observer);
   bool HasObserver(const CompositorObserver* observer) const;
 
   void AddAnimationObserver(CompositorAnimationObserver* observer);
   void RemoveAnimationObserver(CompositorAnimationObserver* observer);
   bool HasAnimationObserver(const CompositorAnimationObserver* observer) const;
 
+  void AddBeginFrameObserver(
+      CompositorBeginFrameObserver* observer,
+      const cc::BeginFrameArgs& last_begin_frame_args_sent_to_observer);
+  void RemoveBeginFrameObserver(CompositorBeginFrameObserver* observer);
+
   // Creates a compositor lock. Returns NULL if it is not possible to lock at
   // this time (i.e. we're waiting to complete a previous unlock).
   scoped_refptr<CompositorLock> GetCompositorLock();
 
   // Internal functions, called back by command-buffer contexts on swap buffer
   // events.
 
   // Signals swap has been posted.
   void OnSwapBuffersPosted();
 
@@ skipping 18 matching lines @@
                            float page_scale,
                            float top_controls_delta) override {}
   void RequestNewOutputSurface() override;
   void DidInitializeOutputSurface() override;
   void DidFailToInitializeOutputSurface() override;
   void WillCommit() override {}
   void DidCommit() override;
   void DidCommitAndDrawFrame() override;
   void DidCompleteSwapBuffers() override;
   void DidCompletePageScaleAnimation() override {}
+  void SendBeginFramesToChildren(const cc::BeginFrameArgs& args) override;
 
   // cc::LayerTreeHostSingleThreadClient implementation.
   void DidPostSwapBuffers() override;
   void DidAbortSwapBuffers() override;
 
   bool IsLocked() { return compositor_lock_ != NULL; }
 
   const cc::LayerTreeDebugState& GetLayerTreeDebugState() const;
   void SetLayerTreeDebugState(const cc::LayerTreeDebugState& debug_state);
   const cc::RendererSettings& GetRendererSettings() const;
 
   LayerAnimatorCollection* layer_animator_collection() {
     return &layer_animator_collection_;
   }
 
   cc::SurfaceIdAllocator* surface_id_allocator() {
     return surface_id_allocator_.get();
   }
 
  private:
   friend class base::RefCounted<Compositor>;
   friend class CompositorLock;
+  friend class CompositorTestAPI;

[brianderson, 2015/03/06 20:36:59]

Instead of adding a CompositorTestAPI as a friend, can you:
1) Make this section protected.
2) Create a TestCompositor (to replace CompositorTestAPI) that inherits from
ui::Compositor in compositor_unittest.cc.
3) Delete compositor_test_api.h and compositor_test_api.cc

It's a pattern that's used often in Chrome. It helps avoid putting test-specific
code in the production code.

 
   // Called by CompositorLock.
   void UnlockCompositor();
 
   // Called to release any pending CompositorLock
   void CancelCompositorLock();
 
+  // Request scheduling of next BeginFrame to LayerTreeHost.
+  void SetChildrenNeedBeginFrames(bool need_begin_frame);
+
   gfx::Size size_;
 
   ui::ContextFactory* context_factory_;
 
   // The root of the Layer tree drawn by this compositor.
   Layer* root_layer_;
 
   ObserverList<CompositorObserver, true> observer_list_;
   ObserverList<CompositorAnimationObserver> animation_observer_list_;
+  ObserverList<CompositorBeginFrameObserver> begin_frame_observer_list_;
 
   gfx::AcceleratedWidget widget_;
   scoped_ptr<cc::SurfaceIdAllocator> surface_id_allocator_;
   scoped_refptr<cc::Layer> root_web_layer_;
   scoped_ptr<cc::LayerTreeHost> host_;
   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
 
-  // The manager of vsync parameters for this compositor.
-  scoped_refptr<CompositorVSyncManager> vsync_manager_;
-
   // The device scale factor of the monitor that this compositor is compositing
   // layers on.
   float device_scale_factor_;
 
   int last_started_frame_;
   int last_ended_frame_;
 
   bool disable_schedule_composite_;
 
   CompositorLock* compositor_lock_;
 
   LayerAnimatorCollection layer_animator_collection_;
 
+  // Used to send to any new CompositorBeginFrameObserver immediately.
+  cc::BeginFrameArgs missed_begin_frame_args_;
+
   base::WeakPtrFactory<Compositor> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(Compositor);
 };
 
 }  // namespace ui
 
 #endif  // UI_COMPOSITOR_COMPOSITOR_H_