Unified BeginFrame scheduling

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/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/base/compositor/compositor_begin_frame_observer.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/native_widget_types.h"
 #include "ui/gfx/size.h"
 #include "ui/gfx/vector2d.h"
 
 class SkBitmap;
 
@@ skipping 15 matching lines @@
 class Size;
 }
 
 namespace gpu {
 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 120 matching lines @@
   // Sets the background color used for areas that aren't covered by
   // the |root_layer|.
   void SetBackgroundColor(SkColor color);
 
   // Set the visibility of the underlying compositor.
   void SetVisible(bool visible);
 
   // 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;
+  // 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(base::TimeDelta interval) const;
+
+  // Request BeginFrame scheduling to OutputSurface.
+  void StartBeginFrame(const cc::BeginFrameArgs& args) 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(CompositorObserver* observer);
 
   void AddAnimationObserver(CompositorAnimationObserver* observer);
   void RemoveAnimationObserver(CompositorAnimationObserver* observer);
   bool HasAnimationObserver(CompositorAnimationObserver* observer);
 
+  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();
 
   // Signals swap has completed.
   void OnSwapBuffersComplete();
 
   // Signals swap has aborted (e.g. lost context).
   void OnSwapBuffersAborted();
 
   // LayerTreeHostClient implementation.
   virtual void WillBeginMainFrame(int frame_id) OVERRIDE {}
   virtual void DidBeginMainFrame() OVERRIDE {}
   virtual void BeginMainFrame(const cc::BeginFrameArgs& args) OVERRIDE;
   virtual void Layout() OVERRIDE;
   virtual void ApplyViewportDeltas(
       const gfx::Vector2d& scroll_delta,
       float page_scale,
       float top_controls_delta) OVERRIDE {}
   virtual scoped_ptr<cc::OutputSurface> CreateOutputSurface(bool fallback)
       OVERRIDE;
-  virtual void DidInitializeOutputSurface() OVERRIDE {}
+  virtual void DidInitializeOutputSurface() OVERRIDE;
+  virtual void DidLoseOutputSurface() OVERRIDE;
   virtual void WillCommit() OVERRIDE {}
   virtual void DidCommit() OVERRIDE;
   virtual void DidCommitAndDrawFrame() OVERRIDE;
   virtual void DidCompleteSwapBuffers() OVERRIDE;
+  virtual void SendBeginFrameToChildren(
+      const cc::BeginFrameArgs& args) OVERRIDE;
 
   // cc::LayerTreeHostSingleThreadClient implementation.
   virtual void ScheduleComposite() OVERRIDE;
   virtual void ScheduleAnimation() OVERRIDE;
   virtual void DidPostSwapBuffers() OVERRIDE;
   virtual void DidAbortSwapBuffers() OVERRIDE;
 
   int last_started_frame() { return last_started_frame_; }
   int last_ended_frame() { return last_ended_frame_; }
 
@@ skipping 12 matching lines @@
 
   // Called by CompositorLock.
   void UnlockCompositor();
 
   // Called to release any pending CompositorLock
   void CancelCompositorLock();
 
   // Notifies the compositor that compositing is complete.
   void NotifyEnd();
 
+  // 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> observer_list_;
   ObserverList<CompositorAnimationObserver> animation_observer_list_;
+  ObserverList<CompositorBeginFrameObserver> begin_frame_observer_list_;
 
   gfx::AcceleratedWidget widget_;
   scoped_refptr<cc::Layer> root_web_layer_;
   scoped_ptr<cc::LayerTreeHost> host_;
   scoped_refptr<base::MessageLoopProxy> compositor_thread_loop_;
   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_;
 
   // Prevent more than one draw from being scheduled.
   bool defer_draw_scheduling_;
 
   // Used to prevent Draw()s while a composite is in progress.
   bool waiting_on_compositing_end_;
   bool draw_on_compositing_end_;
   enum SwapState { SWAP_NONE, SWAP_POSTED, SWAP_COMPLETED };
   SwapState swap_state_;
 
   LayerAnimatorCollection layer_animator_collection_;
 
   base::WeakPtrFactory<Compositor> schedule_draw_factory_;
 
+  // Used to send to any new BeginFrame observers immediately.
+  cc::BeginFrameArgs last_begin_frame_args_;
+
+  // Only used to post OutputSurface::BeginFrame to |task_runner_|. because
+  // requesting a BeginFrame from compositor is only used on single threaded
+  // mode.
+  base::WeakPtr<cc::OutputSurface> output_surface_weak_ptr_;
+
+  bool output_surface_lost_;
+
   DISALLOW_COPY_AND_ASSIGN(Compositor);
 };
 
 }  // namespace ui
 
 #endif  // UI_COMPOSITOR_COMPOSITOR_H_