Implement TextureImageTransportSurface using texture mailbox

content/browser/renderer_host/render_widget_host_view_aura.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_AURA_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_
 
 #include <map>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "content/browser/renderer_host/image_transport_factory.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/common/content_export.h"
+#include "third_party/skia/include/core/SkRegion.h"
 #include "ui/aura/client/activation_delegate.h"
 #include "ui/aura/window_delegate.h"
 #include "ui/base/ime/text_input_client.h"
+#include "ui/compositor/compositor.h"
 #include "ui/compositor/compositor_observer.h"
 #include "ui/gfx/display_observer.h"
 #include "ui/gfx/rect.h"
 #include "webkit/glue/webcursor.h"
 
 namespace aura {
 class WindowTracker;
 }
 
 namespace gfx {
@@ skipping 82 matching lines @@
       skia::PlatformBitmap* output) OVERRIDE;
   virtual void OnAcceleratedCompositingStateChange() OVERRIDE;
   virtual void AcceleratedSurfaceBuffersSwapped(
       const GpuHostMsg_AcceleratedSurfaceBuffersSwapped_Params& params_in_pixel,
       int gpu_host_id) OVERRIDE;
   virtual void AcceleratedSurfacePostSubBuffer(
       const GpuHostMsg_AcceleratedSurfacePostSubBuffer_Params& params_in_pixel,
       int gpu_host_id) OVERRIDE;
   virtual void AcceleratedSurfaceSuspend() OVERRIDE;
   virtual bool HasAcceleratedSurface(const gfx::Size& desired_size) OVERRIDE;
-  virtual void AcceleratedSurfaceNew(
-      int32 width_in_pixel,
-      int32 height_in_pixel,
-      uint64 surface_id) OVERRIDE;
+  virtual void AcceleratedSurfaceNew(int32 width_in_pixel,
+                                     int32 height_in_pixel,
+                                     uint64 surface_id,
+                                     const std::string& mailbox_name) OVERRIDE;
   virtual void AcceleratedSurfaceRelease(uint64 surface_id) OVERRIDE;
   virtual void GetScreenInfo(WebKit::WebScreenInfo* results) OVERRIDE;
   virtual gfx::Rect GetBoundsInRootWindow() OVERRIDE;
   virtual void ProcessAckedTouchEvent(const WebKit::WebTouchEvent& touch,
                                       bool processed) OVERRIDE;
   virtual void SetHasHorizontalScrollbar(
       bool has_horizontal_scrollbar) OVERRIDE;
   virtual void SetScrollOffsetPinning(
       bool is_pinned_to_left, bool is_pinned_to_right) OVERRIDE;
   virtual gfx::GLSurfaceHandle GetCompositingSurface() OVERRIDE;
@@ skipping 84 matching lines @@
   virtual void OnCompositingAborted(ui::Compositor* compositor) OVERRIDE;
   virtual void OnCompositingLockStateChanged(
       ui::Compositor* compositor) OVERRIDE;
 
   // Overridden from ImageTransportFactoryObserver:
   virtual void OnLostResources() OVERRIDE;
 
   virtual ~RenderWidgetHostViewAura();
 
   void UpdateCursorIfOverSelf();
-  bool ShouldFastACK(uint64 surface_id);
+  bool ShouldSkipFrame(const gfx::Size& size);
   void UpdateExternalTexture();
   ui::InputMethod* GetInputMethod() const;
 
   // Returns whether the widget needs an input grab to work properly.
   bool NeedsInputGrab();
 
   // Confirm existing composition text in the webpage and ask the input method
   // to cancel its ongoing composition session.
   void FinishImeCompositionSession();
 
   // This method computes movementX/Y and keeps track of mouse location for
   // mouse lock on all mouse move events.
   void ModifyEventMovementAndCoords(WebKit::WebMouseEvent* event);
 
   // If |clip| is non-empty and and doesn't contain |rect| or |clip| is empty
   // SchedulePaint() is invoked for |rect|.
   void SchedulePaintIfNotInClip(const gfx::Rect& rect, const gfx::Rect& clip);
 
   // Helper method to determine if, in mouse locked mode, the cursor should be
   // moved to center.
   bool ShouldMoveToCenter();
 
   // Run the compositing callbacks.
-  void RunCompositingDidCommitCallbacks(ui::Compositor* compositor);
+  void RunCompositingDidCommitCallbacks();
+
+  struct BufferPresentedParams {
+    BufferPresentedParams(int route_id,
+                          int gpu_host_id,
+                          uint64 surface_handle);
+    ~BufferPresentedParams();
+
+    int32 route_id;
+    int gpu_host_id;
+    uint64 surface_handle;
+    scoped_refptr<ui::Texture> texture_to_produce;
+  };
 
   // Insert a sync point into the compositor's command stream and acknowledge
   // that we have presented the accelerated surface buffer.
-  static void InsertSyncPointAndACK(int32 route_id,
-                                    int gpu_host_id,
-                                    bool presented,
-                                    ui::Compositor* compositor);
+  static void InsertSyncPointAndACK(const BufferPresentedParams& params);
 
   // Called when window_ gets added to a new window tree.
   void AddingToRootWindow();
 
   // Called when window_ is removed from the window tree.
   void RemovingFromRootWindow();
 
-  // After clearing |current_surface_|, and waiting for the compositor to finish
-  // using it, call this to inform the gpu process.
-  void SetSurfaceNotInUseByCompositor(ui::Compositor* compositor);
-
-  // This is called every time |current_surface_| usage changes (by thumbnailer,
-  // compositor draws, and tab visibility). Every time usage of current surface
-  // changes between "may be used" and "certain to not be used" by the ui, we
-  // inform the gpu process.
-  void AdjustSurfaceProtection();
+  // Called after commit for the last reference to the texture going away
+  // after it was released as the frontbuffer.
+  void SetSurfaceNotInUseByCompositor(scoped_refptr<ui::Texture>);
 
   // Called after async thumbnailer task completes.  Used to call
   // AdjustSurfaceProtection.
   static void CopyFromCompositingSurfaceFinished(
       base::WeakPtr<RenderWidgetHostViewAura> render_widget_host_view,
       const base::Callback<void(bool)>& callback,
       bool result);
 
   ui::Compositor* GetCompositor();
 
   // Detaches |this| from the input method object.
   void DetachFromInputMethod();
 
   // Converts |rect| from window coordinate to screen coordinate.
   gfx::Rect ConvertRectToScreen(const gfx::Rect& rect);
 
+  bool SwapBuffersPrepare(const gfx::Rect& surface_rect,
+                          const gfx::Rect& damage_rect,
+                          BufferPresentedParams& params);
+
+  void SwapBuffersCompleted(const BufferPresentedParams& params);
+
   // The model object.
   RenderWidgetHostImpl* host_;
 
   aura::Window* window_;
 
   scoped_ptr<WindowObserver> window_observer_;
 
   // Are we in the process of closing?  Tracked so fullscreen views can avoid
   // sending a second shutdown request to the host when they lose the focus
   // after requesting shutdown for another reason (e.g. Escape key).
@@ skipping 32 matching lines @@
 
   // Indicates if there is onging composition text.
   bool has_composition_text_;
 
   // Current tooltip text.
   string16 tooltip_;
 
   // The scale factor of the display the renderer is currently on.
   float device_scale_factor_;
 
-  std::vector< base::Callback<void(ui::Compositor*)> >
-      on_compositing_did_commit_callbacks_;
+  std::vector<base::Closure> on_compositing_did_commit_callbacks_;
 
-  std::map<uint64, scoped_refptr<ui::Texture> >
-      image_transport_clients_;
+  std::map<uint64, scoped_refptr<ui::Texture> > image_transport_clients_;
 
+  // The identifier of the current frontbuffer.
   uint64 current_surface_;
 
-  // Protected means that the |current_surface_| may be in use by ui and cannot
-  // be safely discarded. Things to consider are thumbnailer, compositor draw,
-  // and tab visibility.
-  bool current_surface_is_protected_;
-  bool current_surface_in_use_by_compositor_;
+  // The damage in the previous buffer.
+  SkRegion previous_damage_;

[jonathan.backer, 2012/11/20 21:21:11]

nit: I think that we can get away with just storing a rect here.

[jonathan.backer, 2012/11/21 05:47:05]

I think I got this wrong.

We have to handle the case where we collect damage, present, collect damage, and
present. Using a region does this. FWIW, I think that a bounding box does too
(for the |previous_damage_| not |skipped_damage_|). But the region is simpler
and obviously correct.

Please ignore previous comment.

[no sievers, 2012/12/01 00:58:38]

yes, i thought about a rect too. I guess it would maybe simplify the math a bit,
but cause us to copy too conservatively. i'll leave it as a region then for now.

+
+  // Pending damage from previous frames that we skipped.
+  SkRegion skipped_damage_;
+
+  // The size of the previously received frame.
+  gfx::Size previous_surface_size_;
 
   int pending_thumbnail_tasks_;
 
-  // This id increments every time surface_is_protected changes. We tag IPC
-  // messages which rely on protection state with this id to stay in sync.
-  uint32 protection_state_id_;
-
-  int32 surface_route_id_;
-
   gfx::GLSurfaceHandle shared_surface_handle_;
 
   // If non-NULL we're in OnPaint() and this is the supplied canvas.
   gfx::Canvas* paint_canvas_;
 
   // Used to record the last position of the mouse.
   // While the mouse is locked, they store the last known position just as mouse
   // lock was entered.
   // Relative to the upper-left corner of the view.
   gfx::Point unlocked_mouse_position_;
@@ skipping 39 matching lines @@
     NO_PENDING_COMMIT,
   };
   CanLockCompositorState can_lock_compositor_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewAura);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_