[ABANDONED] Revert of Change exo::SurfaceFactoryOwner to exo::ExoCompositorFrameSink

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 "cc/surfaces/surface_factory_client.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/gfx/geometry/rect.h"
 
 namespace base {
 namespace trace_event {
 class TracedValue;
 }
 }
 
 namespace cc {
+class SurfaceFactory;
 class SurfaceIdAllocator;
 }
 
 namespace gfx {
 class Path;
 }
 
 namespace exo {
 class Buffer;
 class Pointer;
 class SurfaceDelegate;
 class SurfaceObserver;
 class Surface;
 
 template <typename T>
 struct SurfaceProperty;
 
 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 owns the SurfaceFactory and keeps track of references to the
+// contents of Buffers. It's keeped alive by references from
+// release_callbacks_. It's destroyed when its owning Surface is destroyed and
+// the last outstanding release callback is called.
+class SurfaceFactoryOwner : public base::RefCounted<SurfaceFactoryOwner>,
+                            public cc::SurfaceFactoryClient {
+ public:
+  SurfaceFactoryOwner();
+
+  // Overridden from cc::SurfaceFactoryClient:
+  void ReturnResources(const cc::ReturnedResourceArray& resources) override;
+  void WillDrawSurface(const cc::LocalFrameId& id,
+                       const gfx::Rect& damage_rect) override;
+  void SetBeginFrameSource(cc::BeginFrameSource* begin_frame_source) override;
+
+ private:
+  friend class base::RefCounted<SurfaceFactoryOwner>;
+  friend class Surface;
+
+  ~SurfaceFactoryOwner() override;
+
+  std::map<int,
+           std::pair<scoped_refptr<SurfaceFactoryOwner>,
+                     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, public aura::WindowObserver {
+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(); }
 
+  const cc::LocalFrameId& local_frame_id() const { return local_frame_id_; }
   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 the next frame is displayed. Useful for
@@ skipping 102 matching lines @@
   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;
@@ skipping 60 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 13 matching lines @@
   // This is the size of the last committed contents.
   gfx::Size content_size_;
 
   // This is true when Attach() has been called and new contents should take
   // effect next time Commit() is called.
   bool has_pending_contents_ = false;
 
   // The buffer that will become the content of surface when Commit() is called.
   BufferAttachment pending_buffer_;
 
-  const cc::FrameSinkId frame_sink_id_;
+  cc::SurfaceManager* surface_manager_;
+
+  scoped_refptr<SurfaceFactoryOwner> factory_owner_;
+
+  // The Surface Id currently attached to the window.
   cc::LocalFrameId local_frame_id_;
 
-  scoped_refptr<CompositorFrameSinkHolder> compositor_frame_sink_holder_;
-
-  cc::SurfaceIdAllocator id_allocator_;
-
   // 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 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_;
 
   // 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 16 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_