Make delegated software renderer work on Mac

content/browser/renderer_host/render_widget_host_view_mac.mm

 // Copyright (c) 2012 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/renderer_host/render_widget_host_view_mac.h"
 
 #import <objc/runtime.h>
 #include <QuartzCore/QuartzCore.h>
 
 #include "base/basictypes.h"
@@ skipping 593 matching lines @@
   }
 
   return true;
 }
 
 void RenderWidgetHostViewMac::EnsureSoftwareLayer() {
   TRACE_EVENT0("browser", "RenderWidgetHostViewMac::EnsureSoftwareLayer");
   if (software_layer_ || !use_core_animation_)
     return;
 
-  software_layer_.reset([[SoftwareLayer alloc]
-      initWithRenderWidgetHostViewMac:this]);
+  software_layer_.reset([[SoftwareLayer alloc] init]);
   DCHECK(software_layer_);
 
   // Disable the fade-in animation as the layer is added.
   ScopedCAActionDisabler disabler;
   [background_layer_ addSublayer:software_layer_];
 }
 
 void RenderWidgetHostViewMac::DestroySoftwareLayer() {
   if (!software_layer_)
     return;
@@ skipping 239 matching lines @@
 
   if (web_contents_switch_paint_time_.is_null())
     web_contents_switch_paint_time_ = base::TimeTicks::Now();
   render_widget_host_->WasShown();
   software_frame_manager_->SetVisibility(true);
   if (delegated_frame_host_)
     delegated_frame_host_->WasShown();
 
   // Call setNeedsDisplay before pausing for new frames to come in -- if any
   // do, and are drawn, then the needsDisplay bit will be cleared.
-  [software_layer_ setNeedsDisplay];
   [compositing_iosurface_layer_ setNeedsDisplay];
   PauseForPendingResizeOrRepaintsAndDraw();
 
   // We're messing with the window, so do this to ensure no flashes.
   if (!use_core_animation_)
     [[cocoa_view_ window] disableScreenUpdatesUntilFlush];
 }
 
 void RenderWidgetHostViewMac::WasHidden() {
   if (render_widget_host_->is_hidden())
@@ skipping 681 matching lines @@
 
   // Try to finish previous copy requests after draw to get better pipelining.
   if (compositing_iosurface_)
     compositing_iosurface_->CheckIfAllCopiesAreFinished(false);
 
   // The IOSurface's size may have changed, so re-layout the layers to take
   // this into account. This may force an immediate draw.
   LayoutLayers();
 }
 
+void RenderWidgetHostViewMac::GotBrowserCompositorSoftwareFrame(
+    cc::SoftwareFrameData* frame_data,
+    float scale_factor,
+    SkCanvas* canvas) {
+  if (!frame_data || !canvas)
+    return;
+
+  // Disable animating the contents change or the scale factor change.
+  ScopedCAActionDisabler disabler;
+  EnsureSoftwareLayer();
+
+  // Set the contents of the software CALayer to be a CGImage with the provided
+  // pixel data.
+  SkImageInfo info;
+  size_t row_bytes;
+  const void* pixels = canvas->peekPixels(&info, &row_bytes);
+  base::ScopedCFTypeRef<CGDataProviderRef> data_provider(
+      CGDataProviderCreateWithData(
+          NULL, pixels, 4 * info.fWidth * info.fHeight, NULL));

[piman, 2014/05/20 07:04:17]

Doesn't this assume that CoreAnimation won't look at the pixels after this
function returns? Is it a valid assumption?

After the function returns, pixels may become invalid at any point, e.g. if
canvas gets resized.

Do you want to keep a reference on |canvas| maybe?

[ccameron, 2014/05/20 19:15:50]

The documentation is very unclear, but this does appear to be the case.

Actually, we need to make a copy of the data, because the we may re-use the data
while the compositor is scribbling on the buffer for the next frame (we get the
same buffer every frame).

Coalesced these calls into a single method on SoftwareLayer.

+  base::ScopedCFTypeRef<CGImageRef> image(
+      CGImageCreate(info.fWidth,
+                    info.fHeight,
+                    8,
+                    32,
+                    row_bytes,
+                    base::mac::GetSystemColorSpace(),
+                    kCGImageAlphaPremultipliedFirst | kCGBitmapByteOrder32Host,
+                    data_provider,
+                    NULL,
+                    false,
+                    kCGRenderingIntentDefault));
+  [software_layer_ setContents:(id)image.get()];
+
+  // Set the contents scale of the software CALayer.
+  if ([software_layer_ respondsToSelector:(@selector(contentsScale))] &&
+      [software_layer_ respondsToSelector:(@selector(setContentsScale:))] &&
+      [software_layer_ contentsScale] != scale_factor) {
+    [software_layer_ setContentsScale:scale_factor];
+  }
+
+  LayoutLayers();
+  DestroyCompositedIOSurfaceAndLayer(kDestroyContext);
+}
+
 void RenderWidgetHostViewMac::DrawIOSurfaceWithoutCoreAnimation() {
   CHECK(!use_core_animation_);
   CHECK(compositing_iosurface_);
 
   // If there is a pending frame, it should be acked by the end of this
   // function. Note that the ack should happen only after all drawing is
   // complete, so that the ack happens after any blocking due to vsync.
   base::ScopedClosureRunner scoped_ack(
       base::Bind(&RenderWidgetHostViewMac::SendPendingSwapAck,
                  weak_factory_.GetWeakPtr()));
@@ skipping 303 matching lines @@
     return (software_frame_manager_->HasCurrentFrame() &&
            (desired_size.IsEmpty() ||
                software_frame_manager_->GetCurrentFrameSizeInDIP() ==
                    desired_size));
   }
   return false;
 }
 
 void RenderWidgetHostViewMac::OnSwapCompositorFrame(
     uint32 output_surface_id, scoped_ptr<cc::CompositorFrame> frame) {
+  TRACE_EVENT0("browser", "RenderWidgetHostViewMac::OnSwapCompositorFrame");
+
   if (frame->delegated_frame_data) {
     if (!compositor_) {
       compositor_.reset(new ui::Compositor(cocoa_view_));
       root_layer_.reset(new ui::Layer(ui::LAYER_TEXTURED));
       delegated_frame_host_.reset(new DelegatedFrameHost(this));
     }
 
     // TODO(ccameron): Having the root layer set while swapping the frame will
     // result in frames not appearing. Fix this.
     compositor_->SetRootLayer(NULL);
@@ skipping 19 matching lines @@
             frame->metadata.device_scale_factor,
             render_widget_host_->GetProcess()->GetHandle())) {
       render_widget_host_->GetProcess()->ReceivedBadMessage();
       return;
     }
 
     // Add latency info to report when the frame finishes drawing.
     AddPendingLatencyInfo(frame->metadata.latency_info);
     GotSoftwareFrame();
 
+    if (use_core_animation_) {
+      // Disable animating the contents change or the scale factor change.
+      ScopedCAActionDisabler disabler;
+      EnsureSoftwareLayer();
+
+      // Set the contents of the software CALayer to be a CGImage with the
+      // provided pixel data.
+      gfx::Size size_in_pixels =
+          software_frame_manager_->GetCurrentFrameSizeInPixels();
+      base::ScopedCFTypeRef<CGDataProviderRef> data_provider(
+          CGDataProviderCreateWithData(
+              NULL,
+              software_frame_manager_->GetCurrentFramePixels(),
+              4 * size_in_pixels.width() * size_in_pixels.height(),
+              NULL));
+      base::ScopedCFTypeRef<CGImageRef> image(CGImageCreate(
+          size_in_pixels.width(),
+          size_in_pixels.height(),
+          8,
+          32,
+          4 * size_in_pixels.width(),
+          base::mac::GetSystemColorSpace(),
+          kCGImageAlphaPremultipliedFirst | kCGBitmapByteOrder32Host,
+          data_provider,
+          NULL,
+          false,
+          kCGRenderingIntentDefault));
+      [software_layer_ setContents:(id)image.get()];
+
+      // Set the contents scale of the software CALayer.
+      if ([software_layer_ respondsToSelector:(@selector(contentsScale))] &&
+          [software_layer_ respondsToSelector:(@selector(setContentsScale:))] &&
+          [software_layer_ contentsScale] !=
+              frame->metadata.device_scale_factor) {
+        [software_layer_ setContentsScale:frame->metadata.device_scale_factor];
+      }
+
+      // Send latency information to the host immediately, as there will be no
+      // subsequent draw call in which to do so.
+      SendPendingLatencyInfoToHost();
+    }
+
     cc::CompositorFrameAck ack;
     RenderWidgetHostImpl::SendSwapCompositorFrameAck(
         render_widget_host_->GetRoutingID(),
         software_frame_manager_->GetCurrentFrameOutputSurfaceId(),
         render_widget_host_->GetProcess()->GetID(),
         ack);
     software_frame_manager_->SwapToNewFrameComplete(
         !render_widget_host_->is_hidden());
 
     // Notify observers, tab capture observers in particular, that a new
@@ skipping 121 matching lines @@
       [cocoa_view_ setNeedsDisplay:YES];
     }
 
     // Delete software backingstore and layer.
     software_frame_manager_->DiscardCurrentFrame();
     DestroySoftwareLayer();
   }
 }
 
 void RenderWidgetHostViewMac::GotSoftwareFrame() {
+  TRACE_EVENT0("browser", "RenderWidgetHostViewMac::GotSoftwareFrame");
+
   if (!render_widget_host_)
     return;
 
   EnsureSoftwareLayer();
   LayoutLayers();
   SendVSyncParametersToRenderer();
 
   // Draw the contents of the frame immediately. It is critical that this
   // happen before the frame be acked, otherwise the new frame will likely be
   // ready before the drawing is complete, thrashing the browser main thread.
   if (use_core_animation_) {
-    [software_layer_ setNeedsDisplay];
     [software_layer_ displayIfNeeded];
   } else {
     [cocoa_view_ setNeedsDisplay:YES];
     [cocoa_view_ displayIfNeeded];
   }
 
   if (last_frame_was_accelerated_) {
     last_frame_was_accelerated_ = false;
 
     // If overlapping views are allowed, then don't unbind the context
@@ skipping 224 matching lines @@
   if (compositing_iosurface_layer_) {
     // Keep calling gotNewFrame in a loop until enough display calls come in.
     // Each call will be separated by about a vsync.
     base::MessageLoop::current()->PostTask(
         FROM_HERE,
         base::Bind(&RenderWidgetHostViewMac::TickPendingLatencyInfoDelay,
                    pending_latency_info_delay_weak_ptr_factory_.GetWeakPtr()));
     [compositing_iosurface_layer_ gotNewFrame];
   }
   if (software_layer_) {
-    // In software mode, setNeedsDisplay will almost immediately result in the
-    // layer's draw function being called, so manually insert a pretend-vsync
-    // at 60 Hz.
+    // In software mode there is not an explicit setNeedsDisplay/display loop,
+    // so just wait a pretend-vsync at 60 Hz.
     base::MessageLoop::current()->PostDelayedTask(
         FROM_HERE,
         base::Bind(&RenderWidgetHostViewMac::TickPendingLatencyInfoDelay,
                    pending_latency_info_delay_weak_ptr_factory_.GetWeakPtr()),
         base::TimeDelta::FromMilliseconds(1000/60));
-    [software_layer_ setNeedsDisplay];
+    SendPendingLatencyInfoToHost();
   }
 }
 
 void RenderWidgetHostViewMac::AddPendingSwapAck(
     int32 route_id, int gpu_host_id, int32 renderer_id) {
   // Note that multiple un-acked swaps can come in the event of a GPU process
   // loss. Drop the old acks.
   pending_swap_ack_.reset(new PendingSwapAck(
       route_id, gpu_host_id, renderer_id));
 
@@ skipping 85 matching lines @@
       // Also, sometimes, especially when infobars are being removed, the
       // setNeedsDisplay calls are dropped on the floor, and stale content is
       // displayed. Calling displayIfNeeded will ensure that the right size
       // frame is drawn to the screen.
       // http://crbug.com/350817
       [compositing_iosurface_layer_ setNeedsDisplay];
       [compositing_iosurface_layer_ displayIfNeeded];
     }
   }
 
-  // Dynamically update the software layer's contents scale to match the
-  // software frame.
-  if (software_frame_manager_->HasCurrentFrame() &&
-      [software_layer_ respondsToSelector:(@selector(contentsScale))] &&
-      [software_layer_ respondsToSelector:(@selector(setContentsScale:))]) {
-    if (software_frame_manager_->GetCurrentFrameDeviceScaleFactor() !=
-        [software_layer_ contentsScale]) {
-      [software_layer_ setContentsScale:
-          software_frame_manager_->GetCurrentFrameDeviceScaleFactor()];
-    }
-  }
   // Changing the software layer's bounds and position doesn't always result
   // in the layer being anchored to the top-left. Set the layer's frame
   // explicitly, since this is more reliable in practice.
   if (software_layer_) {
     bool frame_changed = !CGRectEqualToRect(
         new_background_frame, [software_layer_ frame]);
     if (frame_changed) {
       [software_layer_ setFrame:new_background_frame];
-      [software_layer_ setNeedsDisplay];
     }
   }
 }
 
 SkBitmap::Config RenderWidgetHostViewMac::PreferredReadbackFormat() {
   return SkBitmap::kARGB_8888_Config;
 }
 
 }  // namespace content
 
@@ skipping 832 matching lines @@
 - (void)onNativeSurfaceBuffersSwappedWithParams:
       (GpuHostMsg_AcceleratedSurfaceBuffersSwapped_Params)params {
 
   renderWidgetHostView_->CompositorSwapBuffers(
       params.surface_handle,
       params.size,
       params.scale_factor,
       params.latency_info);
 }
 
+- (void)gotSoftwareFrame:(cc::SoftwareFrameData*)frame_data
+         withScaleFactor:(float)scale_factor
+              withCanvas:(SkCanvas*)canvas {
+  renderWidgetHostView_->GotBrowserCompositorSoftwareFrame(
+      frame_data, scale_factor, canvas);
+}
+
 - (void)drawRect:(NSRect)dirtyRect {
   TRACE_EVENT0("browser", "RenderWidgetHostViewCocoa::drawRect");
   DCHECK(!renderWidgetHostView_->use_core_animation_);
 
   if (!renderWidgetHostView_->render_widget_host_) {
     // When using CoreAnimation, this path is used to paint the contents area
     // white before any frames come in. When layers to draw frames exist, this
     // is not hit.
     [[NSColor whiteColor] set];
     NSRectFill(dirtyRect);
@@ skipping 1050 matching lines @@
 // native_app_window_cocoa.mm). This requires the render host view to be
 // draggable by default.
 - (BOOL)mouseDownCanMoveWindow {
   return YES;
 }
 
 @end
 
 @implementation SoftwareLayer
 
-- (id)initWithRenderWidgetHostViewMac:(content::RenderWidgetHostViewMac*)r {
+- (id)init {
   if (self = [super init]) {
-    renderWidgetHostView_ = r;
-
     [self setBackgroundColor:CGColorGetConstantColor(kCGColorWhite)];
     [self setAnchorPoint:CGPointMake(0, 0)];
     // Setting contents gravity is necessary to prevent the layer from being
     // scaled during dyanmic resizes (especially with devtools open).
     [self setContentsGravity:kCAGravityTopLeft];
-    if (renderWidgetHostView_->software_frame_manager_->HasCurrentFrame() &&
-        [self respondsToSelector:(@selector(setContentsScale:))]) {
-      [self setContentsScale:renderWidgetHostView_->software_frame_manager_->
-          GetCurrentFrameDeviceScaleFactor()];
-    }
-
-    // Ensure that the transition between frames not be animated.
-    [self setActions:@{ @"contents" : [NSNull null] }];
   }
   return self;
 }
 
-- (void)drawInContext:(CGContextRef)context {
-  TRACE_EVENT0("browser", "SoftwareLayer::drawInContext");
-
-  CGRect clipRect = CGContextGetClipBoundingBox(context);
-  if (renderWidgetHostView_) {
-    [renderWidgetHostView_->cocoa_view() drawWithDirtyRect:clipRect
-                                                 inContext:context];
-  } else {
-    CGContextSetFillColorWithColor(context,
-                                   CGColorGetConstantColor(kCGColorWhite));
-    CGContextFillRect(context, clipRect);
-  }
-}
-
 - (void)disableRendering {
   // Disable the fade-out animation as the layer is removed.
   ScopedCAActionDisabler disabler;
   [self removeFromSuperlayer];
-  renderWidgetHostView_ = nil;
 }
 
 @end  // implementation SoftwareLayer