exo: Implement presentation interface.

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_id_allocator.h"
 #include "components/exo/compositor_frame_sink.h"
 #include "components/exo/compositor_frame_sink_holder.h"
 #include "third_party/skia/include/core/SkBlendMode.h"
 #include "third_party/skia/include/core/SkRegion.h"
 #include "ui/aura/window.h"
 #include "ui/aura/window_observer.h"
+#include "ui/compositor/compositor_vsync_manager.h"
 #include "ui/gfx/geometry/rect.h"
 
 namespace base {
 namespace trace_event {
 class TracedValue;
 }
 }
 
 namespace cc {
 class SurfaceIdAllocator;
@@ skipping 16 matching lines @@
 namespace subtle {
 class PropertyHelper;
 }
 
 // The pointer class is currently the only cursor provider class but this can
 // change in the future when better hardware cursor support is added.
 using CursorProvider = Pointer;
 
 // 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, public aura::WindowObserver {
+class Surface : public ui::ContextFactoryObserver,
+                public aura::WindowObserver,
+                public ui::CompositorVSyncManager::Observer {
  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(); }
 
   cc::SurfaceId GetSurfaceId() const;
 
   CompositorFrameSinkHolder* compositor_frame_sink_holder() {
     return compositor_frame_sink_holder_.get();
   }
 
   // Set a buffer as the content of this surface. A buffer can only be attached
   // to one surface at a time.
   void Attach(Buffer* buffer);
 
   // Describe the regions where the pending buffer is different from the
   // current surface contents, and where the surface therefore needs to be
   // repainted.
   void Damage(const gfx::Rect& rect);
 
+  // Request notification when it's a good time to produce a new frame. Useful
+  // for throttling redrawing operations, and driving animations.
+  using FrameCallback = base::Callback<void(base::TimeTicks frame_time)>;
+  void RequestFrameCallback(const FrameCallback& callback);
+
   // Request notification when the next frame is displayed. Useful for
   // throttling redrawing operations, and driving animations.
-  using FrameCallback = base::Callback<void(base::TimeTicks frame_time)>;
-  void RequestFrameCallback(const FrameCallback& callback);
+  using PresentationCallback =
+      base::Callback<void(base::TimeTicks presentation_time,
+                          base::TimeDelta refresh)>;
+  void RequestPresentationCallback(const PresentationCallback& callback);
 
   // This sets the region of the surface that contains opaque content.
   void SetOpaqueRegion(const SkRegion& region);
 
   // This sets the region of the surface that can receive pointer and touch
   // events.
   void SetInputRegion(const SkRegion& region);
 
   // This sets the scaling factor used to interpret the contents of the buffer
   // attached to the surface. Note that if the scale is larger than 1, then you
@@ skipping 68 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;
 
-  // Called when surface is being scheduled for a draw.
+  // Call this to indicate that surface is being scheduled for a draw.
   void WillDraw();
 
-  // Called when the begin frame source has changed.
-  void SetBeginFrameSource(cc::BeginFrameSource* begin_frame_source);
+  // Returns true when there's an active frame callback that requires a
+  // BeginFrame() call.
+  bool NeedsBeginFrame() const;
+
+  // Call this to indicate that it's a good time to start producing a new frame.
+  void BeginFrame(base::TimeTicks frame_time);
 
   // 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 ui::CompositorVSyncManager::Observer:
+  void OnUpdateVSyncParameters(base::TimeTicks timebase,
+                               base::TimeDelta interval) 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;
@@ skipping 113 matching lines @@
   // 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 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_;
+
+  // These lists contains the callbacks to notify the client when surface
+  // contents have been presented. These callbacks move to
+  // |presentation_callbacks_| when Commit() is called. Later they are moved to
+  // |swapping_presentation_callbacks_| when the effect of the Commit() is
+  // scheduled to be drawn and then moved to |swapped_presentation_callbacks_|
+  // after receiving VSync parameters update for the previous frame. They fire
+  // at the next VSync parameters update after that.
+  std::list<PresentationCallback> pending_presentation_callbacks_;
+  std::list<PresentationCallback> presentation_callbacks_;
+  std::list<PresentationCallback> swapping_presentation_callbacks_;
+  std::list<PresentationCallback> swapped_presentation_callbacks_;
 
   // This is the state that has yet to be committed.
   State pending_state_;
 
   // This is the state that has been committed.
   State state_;
 
   // The stack of sub-surfaces to take effect when Commit() is called.
   // Bottom-most sub-surface at the front of the list and top-most sub-surface
   // at the back.
@@ skipping 39 matching lines @@
   // ui::Layer::SetShowSurface because the layer needs to know how to add
   // references to surfaces.
   scoped_refptr<cc::SurfaceReferenceFactory> surface_reference_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(Surface);
 };
 
 }  // namespace exo
 
 #endif  // COMPONENTS_EXO_SURFACE_H_