exo: Connect frame callbacks with UI compositor begin frames.

components/exo/surface.h

 // Copyright 2015 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 COMPONENTS_EXO_SURFACE_H_
 #define COMPONENTS_EXO_SURFACE_H_
 
 #include <list>
 #include <memory>
 #include <set>
 #include <utility>
 
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "cc/resources/transferable_resource.h"
+#include "cc/scheduler/begin_frame_source.h"
 #include "cc/surfaces/surface_factory_client.h"
 #include "third_party/skia/include/core/SkRegion.h"
 #include "third_party/skia/include/core/SkXfermode.h"
 #include "ui/aura/window.h"
-#include "ui/compositor/compositor.h"
+#include "ui/aura/window_observer.h"
 #include "ui/gfx/geometry/rect.h"
 
 namespace base {
 namespace trace_event {
 class TracedValue;
 }
 }
 
 namespace cc {
 class SurfaceFactory;
@@ skipping 47 matching lines @@
                      std::unique_ptr<cc::SingleReleaseCallback>>>
       release_callbacks_;
   cc::FrameSinkId frame_sink_id_;
   std::unique_ptr<cc::SurfaceIdAllocator> id_allocator_;
   std::unique_ptr<cc::SurfaceFactory> surface_factory_;
   Surface* surface_ = nullptr;
 };
 
 // This class represents a rectangular area that is displayed on the screen.
 // It has a location, size and pixel contents.
-class Surface : public ui::ContextFactoryObserver {
+class Surface : public ui::ContextFactoryObserver,
+                public aura::WindowObserver,
+                public cc::BeginFrameObserver {
  public:
   using PropertyDeallocator = void (*)(int64_t value);
 
   Surface();
   ~Surface() override;
 
   // Type-checking downcast routine.
   static Surface* AsSurface(const aura::Window* window);
 
   aura::Window* window() { return window_.get(); }
@@ skipping 95 matching lines @@
 
   // Surface does not own observers. It is the responsibility of the observer
   // to remove itself when it is done observing.
   void AddSurfaceObserver(SurfaceObserver* observer);
   void RemoveSurfaceObserver(SurfaceObserver* observer);
   bool HasSurfaceObserver(const SurfaceObserver* observer) const;
 
   // Returns a trace value representing the state of the surface.
   std::unique_ptr<base::trace_event::TracedValue> AsTracedValue() const;
 
-  bool HasPendingDamageForTesting(const gfx::Rect& damage) const {
-    return pending_damage_.contains(gfx::RectToSkIRect(damage));
-  }
+  // Called when surface is being scheduled for a draw.
+  void WillDraw();
 
-  // Overridden from ui::ContextFactoryObserver.
-  void OnLostResources() override;
-
-  void WillDraw(const cc::LocalFrameId& local_frame_id);
+  // Called when the begin frame source has changed.
+  void SetBeginFrameSource(cc::BeginFrameSource* begin_frame_source);
 
   // Check whether this Surface and its children need to create new cc::Surface
   // IDs for their contents next time they get new buffer contents.
   void CheckIfSurfaceHierarchyNeedsCommitToNewSurfaces();
 
+  // Returns the active contents size.
   gfx::Size content_size() const { return content_size_; }
 
+  // Overridden from ui::ContextFactoryObserver:
+  void OnLostResources() override;
+
+  // Overridden from aura::WindowObserver:
+  void OnWindowAddedToRootWindow(aura::Window* window) override;
+  void OnWindowRemovingFromRootWindow(aura::Window* window,
+                                      aura::Window* new_root) override;
+
+  // Overridden from cc::BeginFrameObserver:
+  void OnBeginFrame(const cc::BeginFrameArgs& args) override;
+  const cc::BeginFrameArgs& LastUsedBeginFrameArgs() const override;
+  void OnBeginFrameSourcePausedChanged(bool paused) override {}
+
   // Sets the |value| of the given surface |property|. Setting to the default
   // value (e.g., NULL) removes the property. The caller is responsible for the
   // lifetime of any object set as a property on the Surface.
   template <typename T>
   void SetProperty(const SurfaceProperty<T>* property, T value);
 
   // Returns the value of the given surface |property|.  Returns the
   // property-specific default value if the property was not previously set.
   template <typename T>
   T GetProperty(const SurfaceProperty<T>* property) const;
 
   // Sets the |property| to its default value. Useful for avoiding a cast when
   // setting to NULL.
   template <typename T>
   void ClearProperty(const SurfaceProperty<T>* property);
 
+  bool HasPendingDamageForTesting(const gfx::Rect& damage) const {
+    return pending_damage_.contains(gfx::RectToSkIRect(damage));
+  }
+
  private:
   struct State {
     State();
     ~State();
 
     bool operator==(const State& other);
     bool operator!=(const State& other) { return !(*this == other); }
 
     SkRegion opaque_region;
     SkRegion input_region;
@@ skipping 40 matching lines @@
   // Updates current_resource_ with a new resource id corresponding to the
   // contents of the attached buffer (or id 0, if no buffer is attached).
   // UpdateSurface must be called afterwards to ensure the release callback
   // will be called.
   void UpdateResource(bool client_usage);
 
   // Updates the current Surface with a new frame referring to the resource in
   // current_resource_.
   void UpdateSurface(bool full_damage);
 
+  // Adds/Removes begin frame observer based on state.
+  void UpdateNeedsBeginFrame();
+
   int64_t SetPropertyInternal(const void* key,
                               const char* name,
                               PropertyDeallocator deallocator,
                               int64_t value,
                               int64_t default_value);
   int64_t GetPropertyInternal(const void* key, int64_t default_value) const;
 
   // This returns true when the surface has some contents assigned to it.
   bool has_contents() const { return !!current_buffer_.buffer(); }
 
@@ skipping 29 matching lines @@
 
   // The next resource id the buffer will be attached to.
   int next_resource_id_ = 1;
 
   // The damage region to schedule paint for when Commit() is called.
   SkRegion pending_damage_;
 
   // These lists contains the callbacks to notify the client when it is a good
   // time to start producing a new frame. These callbacks move to
   // |frame_callbacks_| when Commit() is called. Later they are moved to
-  // |active_frame_callbacks_| when the effect of the Commit() is reflected in
-  // the compositor's active layer tree. The callbacks fire once we're notified
-  // that the compositor started drawing that active layer tree.
+  // |active_frame_callbacks_| when the effect of the Commit() is scheduled to
+  // be drawn. They fire at the first begin frame notification after this.
   std::list<FrameCallback> pending_frame_callbacks_;
   std::list<FrameCallback> frame_callbacks_;
   std::list<FrameCallback> active_frame_callbacks_;
 
   // This is the state that has yet to be committed.
   State pending_state_;
 
   // This is the state that has been committed.
   State state_;
 
@@ skipping 19 matching lines @@
   base::TimeTicks last_compositing_start_time_;
 
   // Cursor providers. Surface does not own the cursor providers.
   std::set<CursorProvider*> cursor_providers_;
 
   // This can be set to have some functions delegated. E.g. ShellSurface class
   // can set this to handle Commit() and apply any double buffered state it
   // maintains.
   SurfaceDelegate* delegate_ = nullptr;
 
+  // The begin frame source being observed.
+  cc::BeginFrameSource* begin_frame_source_ = nullptr;
+  cc::BeginFrameArgs last_begin_frame_args_;
+  bool needs_begin_frame_ = false;
+
   struct Value {
     const char* name;
     int64_t value;
     PropertyDeallocator deallocator;
   };
 
   std::map<const void*, Value> prop_map_;
 
   // Surface observer list. Surface does not own the observers.
   base::ObserverList<SurfaceObserver, true> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(Surface);
 };
 
 }  // namespace exo
 
 #endif  // COMPONENTS_EXO_SURFACE_H_