android_webview/browser/browser_view_renderer.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef ANDROID_WEBVIEW_BROWSER_BROWSER_VIEW_RENDERER_H_
   6 #define ANDROID_WEBVIEW_BROWSER_BROWSER_VIEW_RENDERER_H_
   7
   8 #include "android_webview/browser/global_tile_manager.h"
   9 #include "android_webview/browser/global_tile_manager_client.h"
  10 #include "android_webview/browser/shared_renderer_state.h"
  11 #include "base/android/scoped_java_ref.h"
  12 #include "base/callback.h"
  13 #include "base/cancelable_callback.h"
  14 #include "base/values.h"
  15 #include "content/public/browser/android/synchronous_compositor.h"
  16 #include "content/public/browser/android/synchronous_compositor_client.h"
  17 #include "skia/ext/refptr.h"
  18 #include "ui/gfx/rect.h"
  19 #include "ui/gfx/vector2d_f.h"
  20
  21 class SkCanvas;
  22 class SkPicture;
  23 struct AwDrawGLInfo;
  24 struct AwDrawSWFunctionTable;
  25
  26 namespace content {
  27 class ContentViewCore;
  28 struct SynchronousCompositorMemoryPolicy;
  29 class WebContents;
  30 }
  31
  32 namespace android_webview {
  33
  34 class BrowserViewRendererClient;
  35
  36 // Delegate to perform rendering actions involving Java objects.
  37 class BrowserViewRendererJavaHelper {
  38  public:
  39   static BrowserViewRendererJavaHelper* GetInstance();
  40
  41   typedef base::Callback<bool(SkCanvas*)> RenderMethod;
  42
  43   // Try obtaining the native SkCanvas from |java_canvas| and call
  44   // |render_source| with it. If that fails, allocate an auxilary bitmap
  45   // for |render_source| to render into, then copy the bitmap into
  46   // |java_canvas|.
  47   virtual bool RenderViaAuxilaryBitmapIfNeeded(
  48       jobject java_canvas,
  49       const gfx::Vector2d& scroll_correction,
  50       const gfx::Rect& clip,
  51       RenderMethod render_source) = 0;
  52
  53  protected:
  54   virtual ~BrowserViewRendererJavaHelper() {}
  55 };
  56
  57 // Interface for all the WebView-specific content rendering operations.
  58 // Provides software and hardware rendering and the Capture Picture API.
  59 class BrowserViewRenderer : public content::SynchronousCompositorClient,
  60                             public GlobalTileManagerClient {
  61  public:
  62   static void CalculateTileMemoryPolicy();
  63
  64   BrowserViewRenderer(
  65       BrowserViewRendererClient* client,
  66       SharedRendererState* shared_renderer_state,
  67       content::WebContents* web_contents,
  68       const scoped_refptr<base::SingleThreadTaskRunner>& ui_task_runner);
  69
  70   virtual ~BrowserViewRenderer();
  71
  72   // Main handler for view drawing: performs a SW draw immediately, or sets up
  73   // a subsequent GL Draw (via BrowserViewRendererClient::RequestDrawGL) and
  74   // returns true. A false return value indicates nothing was or will be drawn.
  75   // |java_canvas| is the target of the draw. |is_hardware_canvas| indicates
  76   // a GL Draw maybe possible on this canvas. |scroll| if the view's current
  77   // scroll offset. |clip| is the canvas's clip bounds. |global_visible_rect|
  78   // is the intersection of the view size and the window in window coordinates.
  79   bool OnDraw(jobject java_canvas,
  80               bool is_hardware_canvas,
  81               const gfx::Vector2d& scroll,
  82               const gfx::Rect& global_visible_rect,
  83               const gfx::Rect& clip);
  84   void DidDrawDelegated();
  85
  86   // CapturePicture API methods.
  87   skia::RefPtr<SkPicture> CapturePicture(int width, int height);
  88   void EnableOnNewPicture(bool enabled);
  89
  90   void ClearView();
  91
  92   // View update notifications.
  93   void SetIsPaused(bool paused);
  94   void SetViewVisibility(bool visible);
  95   void SetWindowVisibility(bool visible);
  96   void OnSizeChanged(int width, int height);
  97   void OnAttachedToWindow(int width, int height);
  98   void OnDetachedFromWindow();
  99
 100   // Sets the scale for logical<->physical pixel conversions.
 101   void SetDipScale(float dip_scale);
 102
 103   // Set the root layer scroll offset to |new_value|.
 104   void ScrollTo(gfx::Vector2d new_value);
 105
 106   // Android views hierarchy gluing.
 107   bool IsAttachedToWindow() const;
 108   bool IsVisible() const;
 109   gfx::Rect GetScreenRect() const;
 110
 111   // Set the memory policy in shared renderer state and request the tiles from
 112   // GlobalTileManager. The actually amount of memory allowed by
 113   // GlobalTileManager may not be equal to what's requested in |policy|.
 114   void RequestMemoryPolicy(content::SynchronousCompositorMemoryPolicy& policy);
 115
 116   void TrimMemory(const int level, const bool visible);
 117
 118   // SynchronousCompositorClient overrides
 119   virtual void DidInitializeCompositor(
 120       content::SynchronousCompositor* compositor) OVERRIDE;
 121   virtual void DidDestroyCompositor(content::SynchronousCompositor* compositor)
 122       OVERRIDE;
 123   virtual void SetContinuousInvalidate(bool invalidate) OVERRIDE;
 124   virtual void DidUpdateContent() OVERRIDE;
 125   virtual gfx::Vector2dF GetTotalRootLayerScrollOffset() OVERRIDE;
 126   virtual void UpdateRootLayerState(
 127       const gfx::Vector2dF& total_scroll_offset_dip,
 128       const gfx::Vector2dF& max_scroll_offset_dip,
 129       const gfx::SizeF& scrollable_size_dip,
 130       float page_scale_factor,
 131       float min_page_scale_factor,
 132       float max_page_scale_factor) OVERRIDE;
 133   virtual bool IsExternalFlingActive() const OVERRIDE;
 134   virtual void DidOverscroll(gfx::Vector2dF accumulated_overscroll,
 135                              gfx::Vector2dF latest_overscroll_delta,
 136                              gfx::Vector2dF current_fling_velocity) OVERRIDE;
 137
 138   // GlobalTileManagerClient overrides
 139   virtual size_t GetNumTiles() const OVERRIDE;
 140   virtual void SetNumTiles(size_t num_tiles,
 141                            bool effective_immediately) OVERRIDE;
 142
 143  private:
 144   void SetTotalRootLayerScrollOffset(gfx::Vector2dF new_value_dip);
 145   // Checks the continuous invalidate and block invalidate state, and schedule
 146   // invalidates appropriately. If |force_invalidate| is true, then send a view
 147   // invalidate regardless of compositor expectation.
 148   void EnsureContinuousInvalidation(bool force_invalidate);
 149   bool DrawSWInternal(jobject java_canvas, const gfx::Rect& clip_bounds);
 150   bool CompositeSW(SkCanvas* canvas);
 151   void DidComposite();
 152   scoped_ptr<base::Value> RootLayerStateAsValue(
 153       const gfx::Vector2dF& total_scroll_offset_dip,
 154       const gfx::SizeF& scrollable_size_dip);
 155
 156   bool OnDrawHardware(jobject java_canvas);
 157   void ReturnResources();
 158
 159   // If we call up view invalidate and OnDraw is not called before a deadline,
 160   // then we keep ticking the SynchronousCompositor so it can make progress.
 161   void FallbackTickFired();
 162
 163   // Force invoke the compositor to run produce a 1x1 software frame that is
 164   // immediately discarded. This is a hack to force invoke parts of the
 165   // compositor that are not directly exposed here.
 166   void ForceFakeCompositeSW();
 167
 168   void EnforceMemoryPolicyImmediately(
 169       content::SynchronousCompositorMemoryPolicy policy);
 170
 171   gfx::Vector2d max_scroll_offset() const;
 172
 173   content::SynchronousCompositorMemoryPolicy CalculateDesiredMemoryPolicy();
 174   // For debug tracing or logging. Return the string representation of this
 175   // view renderer's state and the |draw_info| if provided.
 176   std::string ToString(AwDrawGLInfo* draw_info) const;
 177
 178   BrowserViewRendererClient* client_;
 179   SharedRendererState* shared_renderer_state_;
 180   content::WebContents* web_contents_;
 181   // TODO(boliu): This class should only be used on the UI thread. However in
 182   // short term to supporting HardwareRenderer, some callbacks on
 183   // SynchronousCompositorClient may be called on non-UI thread. These are
 184   // used to detect this and post them back to UI thread.
 185   base::WeakPtrFactory<BrowserViewRenderer> weak_factory_on_ui_thread_;
 186   base::WeakPtr<BrowserViewRenderer> ui_thread_weak_ptr_;
 187   scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
 188
 189   content::SynchronousCompositor* compositor_;
 190
 191   bool is_paused_;
 192   bool view_visible_;
 193   bool window_visible_;  // Only applicable if |attached_to_window_| is true.
 194   bool attached_to_window_;
 195   bool hardware_enabled_;
 196   float dip_scale_;
 197   float page_scale_factor_;
 198   bool on_new_picture_enable_;
 199   bool clear_view_;
 200
 201   gfx::Vector2d last_on_draw_scroll_offset_;
 202   gfx::Rect last_on_draw_global_visible_rect_;
 203
 204   // When true, we should continuously invalidate and keep drawing, for example
 205   // to drive animation. This value is set by the compositor and should always
 206   // reflect the expectation of the compositor and not be reused for other
 207   // states.
 208   bool compositor_needs_continuous_invalidate_;
 209
 210   // Used to block additional invalidates while one is already pending.
 211   bool block_invalidates_;
 212
 213   // Holds a callback to FallbackTickFired while it is pending.
 214   base::CancelableClosure fallback_tick_;
 215
 216   int width_;
 217   int height_;
 218
 219   // Current scroll offset in CSS pixels.
 220   gfx::Vector2dF scroll_offset_dip_;
 221
 222   // Max scroll offset in CSS pixels.
 223   gfx::Vector2dF max_scroll_offset_dip_;
 224
 225   // Used to prevent rounding errors from accumulating enough to generate
 226   // visible skew (especially noticeable when scrolling up and down in the same
 227   // spot over a period of time).
 228   gfx::Vector2dF overscroll_rounding_error_;
 229
 230   GlobalTileManager::Key tile_manager_key_;
 231   content::SynchronousCompositorMemoryPolicy memory_policy_;
 232
 233   // The following 2 are used to construct a memory policy and set the memory
 234   // policy on the shared_renderer_state_ atomically.
 235   size_t num_tiles_;
 236   size_t num_bytes_;
 237
 238   DISALLOW_COPY_AND_ASSIGN(BrowserViewRenderer);
 239 };
 240
 241 }  // namespace android_webview
 242
 243 #endif  // ANDROID_WEBVIEW_BROWSER_BROWSER_VIEW_RENDERER_H_