Use a separate NSView to draw browser composited content

content/browser/renderer_host/render_widget_host_view_mac.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_
 
 #import <Cocoa/Cocoa.h>
 #include <list>
 #include <map>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/mac/scoped_nsobject.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/time/time.h"
 #include "content/browser/compositor/delegated_frame_host.h"
+#include "content/browser/renderer_host/compositing_iosurface_layer_mac.h"
 #include "content/browser/renderer_host/display_link_mac.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/browser/renderer_host/software_frame_manager.h"
 #include "content/common/content_export.h"
 #include "content/common/cursors/webcursor.h"
 #include "content/common/edit_command.h"
 #import "content/public/browser/render_widget_host_view_mac_base.h"
 #include "ipc/ipc_sender.h"
 #include "third_party/WebKit/public/web/WebCompositionUnderline.h"
 #include "ui/base/cocoa/base_view.h"
 
 namespace content {
 class CompositingIOSurfaceMac;
 class CompositingIOSurfaceContext;
 class RenderWidgetHostViewMac;
 class RenderWidgetHostViewMacEditCommandHelper;
 class WebContents;
 }
 
 namespace ui {
 class Compositor;
 class Layer;
 }
 
+@class BrowserCompositorViewMac;
 @class CompositingIOSurfaceLayer;
 @class FullscreenWindowManager;
 @protocol RenderWidgetHostViewMacDelegate;
+@class SoftwareLayer;
 @class ToolTip;
 
 @protocol RenderWidgetHostViewMacOwner
 - (content::RenderWidgetHostViewMac*)renderWidgetHostViewMac;
 @end
 
 // This is the view that lives in the Cocoa view hierarchy. In Windows-land,
 // RenderWidgetHostViewWin is both the view and the delegate. We split the roles
 // but that means that the view needs to own the delegate and will dispose of it
 // when it's removed from the view system.
@@ skipping 122 matching lines @@
 // Updates the current plugin focus state.
 - (void)pluginFocusChanged:(BOOL)focused forPlugin:(int)pluginId;
 // Evaluates the event in the context of plugin IME, if plugin IME is enabled.
 // Returns YES if the event was handled.
 - (BOOL)postProcessEventForPluginIme:(NSEvent*)event;
 - (void)updateCursor:(NSCursor*)cursor;
 - (NSRect)firstViewRectForCharacterRange:(NSRange)theRange
                              actualRange:(NSRangePointer)actualRange;
 @end
 
-@interface SoftwareLayer : CALayer
-
-- (id)init;
-
-- (void)setContentsToData:(const void *)data
-             withRowBytes:(size_t)rowBytes
-            withPixelSize:(gfx::Size)pixelSize
-          withScaleFactor:(float)scaleFactor;
-
-// Remove the layer from the layer hierarchy.
-- (void)disableRendering;
-
-@end
-
 namespace content {
 class RenderWidgetHostImpl;
 
 ///////////////////////////////////////////////////////////////////////////////
 // RenderWidgetHostViewMac
 //
 //  An object representing the "View" of a rendered web page. This object is
 //  responsible for displaying the content of the web page, and integrating with
 //  the Cocoa view system. It is the implementation of the RenderWidgetHostView
 //  that the cross-platform RenderWidgetHost object uses
 //  to display the data.
 //
 //  Comment excerpted from render_widget_host.h:
 //
 //    "The lifetime of the RenderWidgetHost* is tied to the render process.
 //     If the render process dies, the RenderWidgetHost* goes away and all
 //     references to it must become NULL."
 //
 // RenderWidgetHostView class hierarchy described in render_widget_host_view.h.
 class CONTENT_EXPORT RenderWidgetHostViewMac
     : public RenderWidgetHostViewBase,
       public DelegatedFrameHostClient,
       public IPC::Sender,
-      public SoftwareFrameManagerClient {
+      public SoftwareFrameManagerClient,
+      public CompositingIOSurfaceLayerClient {
  public:
   // The view will associate itself with the given widget. The native view must
   // be hooked up immediately to the view hierarchy, or else when it is
   // deleted it will delete this out from under the caller.
   explicit RenderWidgetHostViewMac(RenderWidgetHost* widget);
   virtual ~RenderWidgetHostViewMac();
 
   RenderWidgetHostViewCocoa* cocoa_view() const { return cocoa_view_; }
 
   // |delegate| is used to separate out the logic from the NSResponder delegate.
@@ skipping 109 matching lines @@
   // IPC::Sender implementation.
   virtual bool Send(IPC::Message* message) OVERRIDE;
 
   // SoftwareFrameManagerClient implementation:
   virtual void SoftwareFrameWasFreed(
       uint32 output_surface_id, unsigned frame_id) OVERRIDE;
   virtual void ReleaseReferencesToSoftwareFrame() OVERRIDE;
 
   virtual SkBitmap::Config PreferredReadbackFormat() OVERRIDE;
 
+  // CompositingIOSurfaceLayerClient implementation.
+  virtual void AcceleratedLayerDidDrawFrame(bool succeeded) OVERRIDE;
+  virtual bool AcceleratedLayerHasNotAckedPendingFrame() const OVERRIDE;
+
   // Forwards the mouse event to the renderer.
   void ForwardMouseEvent(const blink::WebMouseEvent& event);
 
   void KillSelf();
 
   void SetTextInputActive(bool active);
 
   // Sends completed plugin IME notification and text back to the renderer.
   void PluginImeCompositionCompleted(const base::string16& text, int plugin_id);
 
   const std::string& selected_text() const { return selected_text_; }
 
   // Update the IOSurface to be drawn and call setNeedsDisplay on
   // |cocoa_view_|.
   void CompositorSwapBuffers(uint64 surface_handle,
                              const gfx::Size& size,
                              float scale_factor,
                              const std::vector<ui::LatencyInfo>& latency_info);
 
-  void GotBrowserCompositorSoftwareFrame(cc::SoftwareFrameData* frame_data,
-                                         float scale_factor,
-                                         SkCanvas* canvas);
-
   // Draw the IOSurface by making its context current to this view.
   void DrawIOSurfaceWithoutCoreAnimation();
 
   // Called when a GPU error is detected. Posts a task to destroy all
   // compositing state.
   void GotAcceleratedCompositingError();
 
   // Sets the overlay view, which should be drawn in the same IOSurface
   // atop of this view, if both views are drawing accelerated content.
   // Overlay is stored as a weak ptr.
@@ skipping 55 matching lines @@
   // The compositing or software layers will be added as sublayers to this.
   base::scoped_nsobject<CALayer> background_layer_;
 
   // The CoreAnimation layer for software compositing. This should be NULL
   // when software compositing is not in use.
   base::scoped_nsobject<SoftwareLayer> software_layer_;
 
   // Accelerated compositing structures. These may be dynamically created and
   // destroyed together in Create/DestroyCompositedIOSurfaceAndLayer.
   base::scoped_nsobject<CompositingIOSurfaceLayer> compositing_iosurface_layer_;
-  scoped_ptr<CompositingIOSurfaceMac> compositing_iosurface_;
+  scoped_refptr<CompositingIOSurfaceMac> compositing_iosurface_;
   scoped_refptr<CompositingIOSurfaceContext> compositing_iosurface_context_;
 
-  // Timer used to dynamically transition the compositing layer in and out of
-  // asynchronous mode.
-  base::DelayTimer<RenderWidgetHostViewMac>
-      compositing_iosurface_layer_async_timer_;
-
   // Delegated frame management and compositior.
+  base::scoped_nsobject<BrowserCompositorViewMac> browser_compositor_view_;
   scoped_ptr<DelegatedFrameHost> delegated_frame_host_;
-  scoped_ptr<ui::Compositor> compositor_;
   scoped_ptr<ui::Layer> root_layer_;
 
   // This holds the current software compositing framebuffer, if any.
   scoped_ptr<SoftwareFrameManager> software_frame_manager_;
 
   // Whether to allow overlapping views.
   bool allow_overlapping_views_;
 
   // Whether to use the CoreAnimation path to draw content.
   bool use_core_animation_;
@@ skipping 46 matching lines @@
   void SendPendingSwapAck();
 
   void PauseForPendingResizeOrRepaintsAndDraw();
 
   // The geometric arrangement of the layers depends on cocoa_view's size, the
   // compositing IOSurface's rounded size, and the software frame size. Update
   // all of them using this function when any of those parameters changes. Also
   // update the scale factor of the layers.
   void LayoutLayers();
 
-  bool HasPendingSwapAck() const { return pending_swap_ack_; }
-
   // DelegatedFrameHostClient implementation.
   virtual ui::Compositor* GetCompositor() const OVERRIDE;
   virtual ui::Layer* GetLayer() OVERRIDE;
   virtual RenderWidgetHostImpl* GetHost() OVERRIDE;
   virtual void SchedulePaintInRect(
       const gfx::Rect& damage_rect_in_dip) OVERRIDE;
   virtual bool IsVisible() OVERRIDE;
   virtual scoped_ptr<ResizeLock> CreateResizeLock(
       bool defer_compositor_lock) OVERRIDE;
   virtual gfx::Size DesiredFrameSize() OVERRIDE;
@@ skipping 45 matching lines @@
 
   // Unbind the GL context (if any) that is bound to |cocoa_view_|.
   void ClearBoundContextDrawable();
 
   // Called when a GPU SwapBuffers is received.
   void GotAcceleratedFrame();
 
   // Called when a software DIB is received.
   void GotSoftwareFrame();
 
-  // Called if it has been a quarter-second since a GPU SwapBuffers has been
-  // received. In this case, switch from polling for frames to pushing them.
-  void TimerSinceGotAcceleratedFrameFired();
-
   // IPC message handlers.
   void OnPluginFocusChanged(bool focused, int plugin_id);
   void OnStartPluginIme();
   void OnDidChangeScrollbarsForMainFrame(bool has_horizontal_scrollbar,
                                          bool has_vertical_scrollbar);
 
   // Convert |rect| from the views coordinate (upper-left origin) into
   // the OpenGL coordinate (lower-left origin) and scale for HiDPI displays.
   gfx::Rect GetScaledOpenGLPixelRect(const gfx::Rect& rect);
 
@@ skipping 61 matching lines @@
   scoped_ptr<RenderWidgetHostViewFrameSubscriber> frame_subscriber_;
 
   base::WeakPtrFactory<RenderWidgetHostViewMac>
       software_frame_weak_ptr_factory_;
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewMac);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_