Create an AcceleratedWidgetMac

content/browser/compositor/browser_compositor_ca_layer_tree_mac.h

 // Copyright 2014 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 CONTENT_BROWSER_COMPOSITOR_BROWSER_COMPOSITOR_CA_LAYER_TREE_MAC_H_
-#define CONTENT_BROWSER_COMPOSITOR_BROWSER_COMPOSITOR_CA_LAYER_TREE_MAC_H_
+#ifndef CONTENT_BROWSER_COMPOSITOR_ACCELERATED_WIDGET_HELPER_MAC_H_
+#define CONTENT_BROWSER_COMPOSITOR_ACCELERATED_WIDGET_HELPER_MAC_H_
 
 #include <IOSurface/IOSurfaceAPI.h>
+#include <vector>
 
-#include "content/browser/compositor/browser_compositor_view_mac.h"
+#include "skia/ext/platform_canvas.h"
+#include "ui/events/latency_info.h"
+#include "ui/gfx/geometry/size.h"
+#include "ui/gfx/native_widget_types.h"
 
 #if defined(__OBJC__)
 #include <Cocoa/Cocoa.h>
 #include "base/mac/scoped_nsobject.h"
 #include "content/browser/compositor/io_surface_layer_mac.h"
 #include "content/browser/compositor/software_layer_mac.h"
 #include "ui/base/cocoa/remote_layer_api.h"
 #endif  // __OBJC__
 
+namespace cc {
+class SoftwareFrameData;
+}
+
 namespace content {
 
+class AcceleratedWidgetMac;
+
+// The client for an AcceleratedWidgetHelper. This client provides the actual
+// NSView that the AcceleratedWidgetHelper draws. An AcceleratedWidgetHelper
+// may be bound to multiple different clients throughout its lifetime (one at
+// a time, though).

[ccameron, 2014/11/20 04:37:20]

Oh, I was thinking to call this AcceleratedWidgetViewMac instead of "client" --
would that be more clear?

[tapted, 2014/11/20 05:38:53]

Hm. Both have merit. I was leaning towards `Client`. Since `View` gets
overloaded somewhat. e.g. would the client typically own a separate [NS]View
rather than be one itself?  `Container` also crossed my mind. 

[ccameron, 2014/11/20 21:33:50]

Yeah, view is getting too much use -- I just called it
AcceleratedWidgetMacNSView -- that seems unambiguous enough.

+class AcceleratedWidgetMacClient {
+ public:
+  virtual NSView* AcceleratedWidgetClientGetNSView() const = 0;
+  virtual bool AcceleratedWidgetShouldIgnoreBackpressure() const = 0;
+  virtual void AcceleratedWidgetSwapCompleted(
+      const std::vector<ui::LatencyInfo>& latency_info) = 0;
+  virtual void AcceleratedWidgetHitError() = 0;
+};
+
 #if defined(__OBJC__)
 
-// BrowserCompositorCALayerTreeMac owns tree of CALayer and a ui::Compositor
-// that is used to draw the layers. The CALayer tree can be attached to the
-// NSView of a BrowserCompositorViewMac
-class BrowserCompositorCALayerTreeMac
+// AcceleratedWidgetMac owns a tree of CALayers. The widget may be passed
+// to a ui::Compositor, which will cause, through its output surface, calls to
+// GotAcceleratedFrame and GotSoftwareFrame. The CALayers may be installed
+// in an NSView by setting the AcceleratedWidgetMacClient for the helper.
+class AcceleratedWidgetMac
     : public IOSurfaceLayerClient {

[tapted, 2014/11/20 05:38:53]

nit: pull up

[ccameron, 2014/11/20 21:33:50]

Done.

  public:
-  BrowserCompositorCALayerTreeMac();
-  virtual ~BrowserCompositorCALayerTreeMac();
-  static BrowserCompositorCALayerTreeMac* FromAcceleratedWidget(
-      gfx::AcceleratedWidget widget);
+  AcceleratedWidgetMac();
+  virtual ~AcceleratedWidgetMac();
 
-  void SetView(BrowserCompositorViewMac* view);
-  void ResetView();
+  gfx::AcceleratedWidget accelerated_widget() { return native_widget_; }
 
-  ui::Compositor* compositor() const { return compositor_.get(); }
+  void SetClient(AcceleratedWidgetMacClient* client);
+  void ResetClient();
 
   // Return true if the last frame swapped has a size in DIP of |dip_size|.
   bool HasFrameOfSize(const gfx::Size& dip_size) const;
 
   // Return the CGL renderer ID for the surface, if one is available.
   int GetRendererID() const;
 
   // Return true if the renderer should not be throttled by GPU back-pressure.
   bool IsRendererThrottlingDisabled() const;
 
   // Mark a bracket in which new frames are being pumped in a restricted nested
   // run loop.
   void BeginPumpingFrames();
   void EndPumpingFrames();
 
   void GotAcceleratedFrame(
-      uint64 surface_handle, int output_surface_id,
+      uint64 surface_handle,
       const std::vector<ui::LatencyInfo>& latency_info,
-      gfx::Size pixel_size, float scale_factor);
+      gfx::Size pixel_size,
+      float scale_factor,
+      const base::Closure& drawn_callback);
 
   void GotSoftwareFrame(
       cc::SoftwareFrameData* frame_data, float scale_factor, SkCanvas* canvas);
 
 private:
   // IOSurfaceLayerClient implementation:
- bool IOSurfaceLayerShouldAckImmediately() const override;
- void IOSurfaceLayerDidDrawFrame() override;
- void IOSurfaceLayerHitError() override;
+  bool IOSurfaceLayerShouldAckImmediately() const override;
+  void IOSurfaceLayerDidDrawFrame() override;
+  void IOSurfaceLayerHitError() override;
 
   void GotAcceleratedCAContextFrame(
       CAContextID ca_context_id, gfx::Size pixel_size, float scale_factor);
 
   void GotAcceleratedIOSurfaceFrame(
       IOSurfaceID io_surface_id, gfx::Size pixel_size, float scale_factor);
 
+  void AcknowledgeAcceleratedFrame();
+
   // Remove a layer from the heirarchy and destroy it. Because the accelerated
   // layer types may be replaced by a layer of the same type, the layer to
   // destroy is parameterized, and, if it is the current layer, the current
   // layer is reset.
   void DestroyCAContextLayer(
       base::scoped_nsobject<CALayerHost> ca_context_layer);
   void DestroyIOSurfaceLayer(
       base::scoped_nsobject<IOSurfaceLayer> io_surface_layer);
   void DestroySoftwareLayer();
 
-  // The BrowserCompositorViewMac that is using this as its internals.
-  BrowserCompositorViewMac* view_;
+  // The AcceleratedWidgetMacClient that is using this as its internals.
+  AcceleratedWidgetMacClient* client_;
 
   // A phony NSView handle used to identify this.
   gfx::AcceleratedWidget native_widget_;
 
-  // The compositor drawing the contents of this view.
-  scoped_ptr<ui::Compositor> compositor_;
-
   // A flipped layer, which acts as the parent of the compositing and software
   // layers. This layer is flipped so that the we don't need to recompute the
   // origin for sub-layers when their position changes (this is impossible when
   // using remote layers, as their size change cannot be synchronized with the
   // window). This indirection is needed because flipping hosted layers (like
   // |background_layer_| of RenderWidgetHostViewCocoa) leads to unpredictable
   // behavior.
   base::scoped_nsobject<CALayer> flipped_layer_;
 
   // The accelerated CoreAnimation layer hosted by the GPU process.
   base::scoped_nsobject<CALayerHost> ca_context_layer_;
 
   // The locally drawn accelerated CoreAnimation layer.
   base::scoped_nsobject<IOSurfaceLayer> io_surface_layer_;
 
   // The locally drawn software layer.
   base::scoped_nsobject<SoftwareLayer> software_layer_;
 
   // The output surface and latency info of the last accelerated surface that
   // was swapped. Sent back to the renderer when the accelerated surface is
   // drawn.
-  int accelerated_output_surface_id_;
+  bool has_unacknowledged_accelerated_frame_;
+  base::Closure accelerated_frame_drawn_callback_;
   std::vector<ui::LatencyInfo> accelerated_latency_info_;
 
   // The size in DIP of the last swap received from |compositor_|.
   gfx::Size last_swap_size_dip_;
 };
 
 #endif  // __OBJC__
 
-void BrowserCompositorCALayerTreeMacGotAcceleratedFrame(
-    gfx::AcceleratedWidget widget,
-    uint64 surface_handle, int surface_id,
+void AcceleratedWidgetMacGotAcceleratedFrame(
+    gfx::AcceleratedWidget widget, uint64 surface_handle,
     const std::vector<ui::LatencyInfo>& latency_info,
     gfx::Size pixel_size, float scale_factor,
+    const base::Closure& drawn_callback,
     bool* disable_throttling, int* renderer_id);
 
-void BrowserCompositorCALayerTreeMacGotSoftwareFrame(
+void AcceleratedWidgetMacGotSoftwareFrame(
     gfx::AcceleratedWidget widget,
     cc::SoftwareFrameData* frame_data, float scale_factor, SkCanvas* canvas);
 
 }  // namespace content
 
-#endif  // CONTENT_BROWSER_COMPOSITOR_BROWSER_COMPOSITOR_CA_LAYER_TREE_MAC_H_
+#endif  // CONTENT_BROWSER_COMPOSITOR_ACCELERATED_WIDGET_HELPER_MAC_H_