Create an AcceleratedWidgetMac

content/browser/compositor/browser_compositor_ca_layer_tree_mac.mm

 // 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.
 
 #include "content/browser/compositor/browser_compositor_ca_layer_tree_mac.h"
 
 #include <map>
 
+#include "cc/output/software_frame_data.h"
 #include "base/debug/trace_event.h"
 #include "base/lazy_instance.h"
 #include "base/message_loop/message_loop.h"
-#include "content/browser/compositor/gpu_process_transport_factory.h"
 #include "content/browser/compositor/io_surface_layer_mac.h"
 #include "content/browser/compositor/software_layer_mac.h"
 #include "content/browser/renderer_host/dip_util.h"
-#include "content/browser/renderer_host/render_widget_resize_helper.h"
 #include "content/common/gpu/surface_handle_types_mac.h"
 #include "content/public/browser/context_factory.h"
 #include "ui/base/cocoa/animation_utils.h"
 #include "ui/gl/scoped_cgl.h"
 
 namespace content {
 namespace {
 
-typedef std::map<gfx::AcceleratedWidget,BrowserCompositorCALayerTreeMac*>
-    WidgetToInternalsMap;
-base::LazyInstance<WidgetToInternalsMap> g_widget_to_internals_map;
+typedef std::map<gfx::AcceleratedWidget,AcceleratedWidgetMac*>
+    WidgetToHelperMap;
+base::LazyInstance<WidgetToHelperMap> g_widget_to_helper_map;
+
+AcceleratedWidgetMac* GetHelperFromAcceleratedWidget(
+    gfx::AcceleratedWidget widget) {
+  WidgetToHelperMap::const_iterator found =
+      g_widget_to_helper_map.Pointer()->find(widget);
+  // This can end up being accessed after the underlying widget has been
+  // destroyed, but while the ui::Compositor is still being destroyed.
+  // Return NULL in these cases.
+  if (found == g_widget_to_helper_map.Pointer()->end())
+    return NULL;
+  return found->second;
+}
 
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-// BrowserCompositorCALayerTreeMac
+// AcceleratedWidgetMac
 
-BrowserCompositorCALayerTreeMac::BrowserCompositorCALayerTreeMac()
-    : view_(NULL),
-      accelerated_output_surface_id_(0) {
+AcceleratedWidgetMac::AcceleratedWidgetMac()
+    : client_(NULL),
+      has_unacknowledged_accelerated_frame_(false) {
   // Disable the fade-in animation as the layers are added.
   ScopedCAActionDisabler disabler;
 
   // Add a flipped transparent layer as a child, so that we don't need to
   // fiddle with the position of sub-layers -- they will always be at the
   // origin.
   flipped_layer_.reset([[CALayer alloc] init]);
   [flipped_layer_ setGeometryFlipped:YES];
   [flipped_layer_ setAnchorPoint:CGPointMake(0, 0)];
   [flipped_layer_
       setAutoresizingMask:kCALayerWidthSizable|kCALayerHeightSizable];
 
   // Use a sequence number as the accelerated widget handle that we can use
   // to look up the internals structure.
   static uintptr_t last_sequence_number = 0;
   last_sequence_number += 1;
   native_widget_ = reinterpret_cast<gfx::AcceleratedWidget>(
       last_sequence_number);
-  g_widget_to_internals_map.Pointer()->insert(
+  g_widget_to_helper_map.Pointer()->insert(
       std::make_pair(native_widget_, this));
-
-  // Create a compositor to draw the contents of this view.
-  compositor_.reset(new ui::Compositor(
-      native_widget_,
-      content::GetContextFactory(),
-      RenderWidgetResizeHelper::Get()->task_runner()));
-  compositor_->SetVisible(false);
 }
 
-BrowserCompositorCALayerTreeMac::~BrowserCompositorCALayerTreeMac() {
-  DCHECK(!view_);
-  g_widget_to_internals_map.Pointer()->erase(native_widget_);
+AcceleratedWidgetMac::~AcceleratedWidgetMac() {
+  DCHECK(!client_);
+  g_widget_to_helper_map.Pointer()->erase(native_widget_);
 }
 
-void BrowserCompositorCALayerTreeMac::SetView(
-    BrowserCompositorViewMac* view) {
-  // Disable the fade-in animation as the view is added.
+void AcceleratedWidgetMac::SetClient(
+    AcceleratedWidgetMacClient* client) {

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

nit: pull up

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

Done.

+  // Disable the fade-in animation as the client is added.
   ScopedCAActionDisabler disabler;
 
-  DCHECK(view && !view_);
-  view_ = view;
-  compositor_->SetRootLayer(view_->ui_root_layer());
+  DCHECK(client && !client_);
+  client_ = client;
 
-  CALayer* background_layer = [view_->native_view() layer];
+  CALayer* background_layer =
+      [client_->AcceleratedWidgetClientGetNSView() layer];
   DCHECK(background_layer);
   [flipped_layer_ setBounds:[background_layer bounds]];
   [background_layer addSublayer:flipped_layer_];
-  compositor_->SetVisible(true);
 }
 
-void BrowserCompositorCALayerTreeMac::ResetView() {
-  if (!view_)
+void AcceleratedWidgetMac::ResetClient() {
+  if (!client_)
     return;
 
-  // Disable the fade-out animation as the view is removed.
+  // Disable the fade-out animation as the client is removed.
   ScopedCAActionDisabler disabler;
 
   [flipped_layer_ removeFromSuperlayer];
   DestroyIOSurfaceLayer(io_surface_layer_);
   DestroyCAContextLayer(ca_context_layer_);
   DestroySoftwareLayer();
 
-  accelerated_output_surface_id_ = 0;
   last_swap_size_dip_ = gfx::Size();
-
-  compositor_->SetVisible(false);
-  compositor_->SetScaleAndSize(1.0, gfx::Size(0, 0));
-  compositor_->SetRootLayer(NULL);
-  view_ = NULL;
+  client_ = NULL;
 }
 
-bool BrowserCompositorCALayerTreeMac::HasFrameOfSize(
+bool AcceleratedWidgetMac::HasFrameOfSize(
     const gfx::Size& dip_size) const {
   return last_swap_size_dip_ == dip_size;
 }
 
-int BrowserCompositorCALayerTreeMac::GetRendererID() const {
+int AcceleratedWidgetMac::GetRendererID() const {
   if (io_surface_layer_)
     return [io_surface_layer_ rendererID];
   return 0;
 }
 
-bool BrowserCompositorCALayerTreeMac::IsRendererThrottlingDisabled() const {
-  if (view_)
-    return view_->client()->BrowserCompositorViewShouldAckImmediately();
+bool AcceleratedWidgetMac::IsRendererThrottlingDisabled() const {
+  if (client_)
+    return client_->AcceleratedWidgetShouldIgnoreBackpressure();
   return false;
 }
 
-void BrowserCompositorCALayerTreeMac::BeginPumpingFrames() {
+void AcceleratedWidgetMac::BeginPumpingFrames() {
   [io_surface_layer_ beginPumpingFrames];
 }
 
-void BrowserCompositorCALayerTreeMac::EndPumpingFrames() {
+void AcceleratedWidgetMac::EndPumpingFrames() {
   [io_surface_layer_ endPumpingFrames];
 }
 
-void BrowserCompositorCALayerTreeMac::GotAcceleratedFrame(
-    uint64 surface_handle, int output_surface_id,
+void AcceleratedWidgetMac::GotAcceleratedFrame(
+    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) {
   // Record the surface and latency info to use when acknowledging this frame.
-  DCHECK(!accelerated_output_surface_id_);
-  accelerated_output_surface_id_ = output_surface_id;
+  DCHECK(!has_unacknowledged_accelerated_frame_);
+  has_unacknowledged_accelerated_frame_ = true;
+  accelerated_frame_drawn_callback_ = drawn_callback;
   accelerated_latency_info_.insert(accelerated_latency_info_.end(),
                                    latency_info.begin(), latency_info.end());
 
-  // If there is no view and therefore no superview to draw into, early-out.
-  if (!view_) {
-    IOSurfaceLayerDidDrawFrame();
+  // If there is no client and therefore no superview to draw into, early-out.
+  if (!client_) {
+    AcknowledgeAcceleratedFrame();
     return;
   }
 
   // Disable the fade-in or fade-out effect if we create or remove layers.
   ScopedCAActionDisabler disabler;
 
   last_swap_size_dip_ = ConvertSizeToDIP(scale_factor, pixel_size);
   switch (GetSurfaceHandleType(surface_handle)) {
     case kSurfaceHandleTypeIOSurface: {
       IOSurfaceID io_surface_id = IOSurfaceIDFromSurfaceHandle(surface_handle);
       GotAcceleratedIOSurfaceFrame(io_surface_id, pixel_size, scale_factor);
       break;
     }
     case kSurfaceHandleTypeCAContext: {
       CAContextID ca_context_id = CAContextIDFromSurfaceHandle(surface_handle);
       GotAcceleratedCAContextFrame(ca_context_id, pixel_size, scale_factor);
       break;
     }
     default:
       LOG(ERROR) << "Unrecognized accelerated frame type.";
       return;
   }
 }
 
-void BrowserCompositorCALayerTreeMac::GotAcceleratedCAContextFrame(
+void AcceleratedWidgetMac::GotAcceleratedCAContextFrame(
     CAContextID ca_context_id,
     gfx::Size pixel_size,
     float scale_factor) {
   // In the layer is replaced, keep the old one around until after the new one
   // is installed to avoid flashes.
   base::scoped_nsobject<CALayerHost> old_ca_context_layer =
       ca_context_layer_;
 
   // Create the layer to host the layer exported by the GPU process with this
   // particular CAContext ID.
   if ([ca_context_layer_ contextId] != ca_context_id) {
     ca_context_layer_.reset([[CALayerHost alloc] init]);
     [ca_context_layer_ setContextId:ca_context_id];
     [ca_context_layer_
         setAutoresizingMask:kCALayerMaxXMargin|kCALayerMaxYMargin];
     [flipped_layer_ addSublayer:ca_context_layer_];
   }
 
   // Acknowledge the frame to unblock the compositor immediately (the GPU
   // process will do any required throttling).
-  IOSurfaceLayerDidDrawFrame();
+  AcknowledgeAcceleratedFrame();
 
   // If this replacing a same-type layer, remove it now that the new layer is
   // in the hierarchy.
   if (old_ca_context_layer != ca_context_layer_)
     DestroyCAContextLayer(old_ca_context_layer);
 
   // Remove any different-type layers that this is replacing.
   DestroyIOSurfaceLayer(io_surface_layer_);
   DestroySoftwareLayer();
 }
 
-void BrowserCompositorCALayerTreeMac::GotAcceleratedIOSurfaceFrame(
+void AcceleratedWidgetMac::GotAcceleratedIOSurfaceFrame(
     IOSurfaceID io_surface_id,
     gfx::Size pixel_size,
     float scale_factor) {
   // In the layer is replaced, keep the old one around until after the new one
   // is installed to avoid flashes.
   base::scoped_nsobject<IOSurfaceLayer> old_io_surface_layer =
       io_surface_layer_;
 
   // Create or re-create an IOSurface layer if needed. If there already exists
   // a layer but it has the wrong scale factor or it was poisoned, re-create the
@@ skipping 49 matching lines @@
   // If this replacing a same-type layer, remove it now that the new layer is
   // in the hierarchy.
   if (old_io_surface_layer != io_surface_layer_)
     DestroyIOSurfaceLayer(old_io_surface_layer);
 
   // Remove any different-type layers that this is replacing.
   DestroyCAContextLayer(ca_context_layer_);
   DestroySoftwareLayer();
 }
 
-void BrowserCompositorCALayerTreeMac::GotSoftwareFrame(
+void AcceleratedWidgetMac::GotSoftwareFrame(
     cc::SoftwareFrameData* frame_data,
     float scale_factor,
     SkCanvas* canvas) {
-  if (!frame_data || !canvas || !view_)
+  if (!frame_data || !canvas || !client_)
     return;
 
   // Disable the fade-in or fade-out effect if we create or remove layers.
   ScopedCAActionDisabler disabler;
 
   // If there is not a layer for software frames, create one.
   if (!software_layer_) {
     software_layer_.reset([[SoftwareLayer alloc] init]);
     [flipped_layer_ addSublayer:software_layer_];
   }
 
   // Set the software layer to draw the provided canvas.
   SkImageInfo info;
   size_t row_bytes;
   const void* pixels = canvas->peekPixels(&info, &row_bytes);
   gfx::Size pixel_size(info.fWidth, info.fHeight);
   [software_layer_ setContentsToData:pixels
                         withRowBytes:row_bytes
                        withPixelSize:pixel_size
                      withScaleFactor:scale_factor];
   last_swap_size_dip_ = ConvertSizeToDIP(scale_factor, pixel_size);
 
   // Remove any different-type layers that this is replacing.
   DestroyCAContextLayer(ca_context_layer_);
   DestroyIOSurfaceLayer(io_surface_layer_);
 }
 
-void BrowserCompositorCALayerTreeMac::DestroyCAContextLayer(
+void AcceleratedWidgetMac::DestroyCAContextLayer(
     base::scoped_nsobject<CALayerHost> ca_context_layer) {
   if (!ca_context_layer)
     return;
   [ca_context_layer removeFromSuperlayer];
   if (ca_context_layer == ca_context_layer_)
     ca_context_layer_.reset();
 }
 
-void BrowserCompositorCALayerTreeMac::DestroyIOSurfaceLayer(
+void AcceleratedWidgetMac::DestroyIOSurfaceLayer(
     base::scoped_nsobject<IOSurfaceLayer> io_surface_layer) {
   if (!io_surface_layer)
     return;
   [io_surface_layer resetClient];
   [io_surface_layer removeFromSuperlayer];
   if (io_surface_layer == io_surface_layer_)
     io_surface_layer_.reset();
 }
 
-void BrowserCompositorCALayerTreeMac::DestroySoftwareLayer() {
+void AcceleratedWidgetMac::DestroySoftwareLayer() {
   if (!software_layer_)
     return;
   [software_layer_ removeFromSuperlayer];
   software_layer_.reset();
 }
 
-bool BrowserCompositorCALayerTreeMac::IOSurfaceLayerShouldAckImmediately()
+bool AcceleratedWidgetMac::IOSurfaceLayerShouldAckImmediately()
     const {
-  // If there is no view then the accelerated layer is not in the hierarchy
-  // and will never draw.
-  if (!view_)
+  // If there is no client then the accelerated layer is not in the view
+  // hierarchy and will never draw.
+  if (!client_)
     return true;
-  return view_->client()->BrowserCompositorViewShouldAckImmediately();
+  return client_->AcceleratedWidgetShouldIgnoreBackpressure();
 }
 
-void BrowserCompositorCALayerTreeMac::IOSurfaceLayerDidDrawFrame() {
-  if (accelerated_output_surface_id_) {
-    content::ImageTransportFactory::GetInstance()->OnSurfaceDisplayed(
-        accelerated_output_surface_id_);
-    accelerated_output_surface_id_ = 0;
-  }
-
-  if (view_) {
-    view_->client()->BrowserCompositorViewFrameSwapped(
-        accelerated_latency_info_);
-  }
-
-  accelerated_latency_info_.clear();
+void AcceleratedWidgetMac::IOSurfaceLayerDidDrawFrame() {
+  AcknowledgeAcceleratedFrame();
 }
 
-void BrowserCompositorCALayerTreeMac::IOSurfaceLayerHitError() {
+void AcceleratedWidgetMac::AcknowledgeAcceleratedFrame() {
+  if (!has_unacknowledged_accelerated_frame_)
+    return;
+  accelerated_frame_drawn_callback_.Run();
+  if (client_)
+    client_->AcceleratedWidgetSwapCompleted(accelerated_latency_info_);
+  accelerated_latency_info_.clear();
+  has_unacknowledged_accelerated_frame_ = false;
+}
+
+void AcceleratedWidgetMac::IOSurfaceLayerHitError() {
   // Perform all acks that would have been done if the frame had succeeded, to
   // un-block the compositor and renderer.
-  IOSurfaceLayerDidDrawFrame();
+  AcknowledgeAcceleratedFrame();
 
   // Poison the context being used and request a mulligan.
   [io_surface_layer_ poisonContextAndSharegroup];
-  compositor_->ScheduleFullRedraw();
+
+  if (client_)
+    client_->AcceleratedWidgetHitError();
 }
 
-// static
-BrowserCompositorCALayerTreeMac* BrowserCompositorCALayerTreeMac::
-    FromAcceleratedWidget(gfx::AcceleratedWidget widget) {
-  WidgetToInternalsMap::const_iterator found =
-      g_widget_to_internals_map.Pointer()->find(widget);
-  // This can end up being accessed after the underlying widget has been
-  // destroyed, but while the ui::Compositor is still being destroyed.
-  // Return NULL in these cases.
-  if (found == g_widget_to_internals_map.Pointer()->end())
-    return NULL;
-  return found->second;
-}
-
-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) {
-  BrowserCompositorCALayerTreeMac* ca_layer_tree =
-      BrowserCompositorCALayerTreeMac::FromAcceleratedWidget(widget);
-  if (ca_layer_tree) {
-    ca_layer_tree->GotAcceleratedFrame(
-        surface_handle, surface_id, latency_info, pixel_size, scale_factor);
-    *disable_throttling = ca_layer_tree->IsRendererThrottlingDisabled();
-    *renderer_id = ca_layer_tree->GetRendererID();
+  AcceleratedWidgetMac* accelerated_widget_mac =
+      GetHelperFromAcceleratedWidget(widget);
+  if (accelerated_widget_mac) {
+    accelerated_widget_mac->GotAcceleratedFrame(
+        surface_handle, latency_info, pixel_size, scale_factor, drawn_callback);
+    *disable_throttling =
+        accelerated_widget_mac->IsRendererThrottlingDisabled();
+    *renderer_id = accelerated_widget_mac->GetRendererID();
   } else {
     *disable_throttling = false;
     *renderer_id = 0;
   }
 }
 
-void BrowserCompositorCALayerTreeMacGotSoftwareFrame(
+void AcceleratedWidgetMacGotSoftwareFrame(
     gfx::AcceleratedWidget widget,
     cc::SoftwareFrameData* frame_data, float scale_factor, SkCanvas* canvas) {
-  BrowserCompositorCALayerTreeMac* ca_layer_tree =
-      BrowserCompositorCALayerTreeMac::FromAcceleratedWidget(widget);
-  if (ca_layer_tree)
-    ca_layer_tree->GotSoftwareFrame(frame_data, scale_factor, canvas);
+  AcceleratedWidgetMac* accelerated_widget_mac =
+      GetHelperFromAcceleratedWidget(widget);
+  if (accelerated_widget_mac)
+    accelerated_widget_mac->GotSoftwareFrame(frame_data, scale_factor, canvas);
 }
 
 }  // namespace content