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/parent_compositor_draw_constraints.h"
   9 #include "android_webview/browser/shared_renderer_state.h"
  10 #include "base/callback.h"
  11 #include "base/cancelable_callback.h"
  12 #include "base/trace_event/trace_event.h"
  13 #include "content/public/browser/android/synchronous_compositor.h"
  14 #include "content/public/browser/android/synchronous_compositor_client.h"
  15 #include "skia/ext/refptr.h"
  16 #include "ui/gfx/geometry/rect.h"
  17 #include "ui/gfx/geometry/vector2d_f.h"
  18
  19 class SkCanvas;
  20 class SkPicture;
  21
  22 namespace content {
  23 class WebContents;
  24 }
  25
  26 namespace android_webview {
  27
  28 class BrowserViewRendererClient;
  29 class ChildFrame;
  30
  31 // Interface for all the WebView-specific content rendering operations.
  32 // Provides software and hardware rendering and the Capture Picture API.
  33 class BrowserViewRenderer : public content::SynchronousCompositorClient {
  34  public:
  35   static void CalculateTileMemoryPolicy();
  36   static BrowserViewRenderer* FromWebContents(
  37       content::WebContents* web_contents);
  38
  39   BrowserViewRenderer(
  40       BrowserViewRendererClient* client,
  41       const scoped_refptr<base::SingleThreadTaskRunner>& ui_task_runner);
  42
  43   ~BrowserViewRenderer() override;
  44
  45   void RegisterWithWebContents(content::WebContents* web_contents);
  46
  47   SharedRendererState* GetAwDrawGLViewContext();
  48   bool RequestDrawGL(bool wait_for_completion);
  49
  50   // Called before either OnDrawHardware or OnDrawSoftware to set the view
  51   // state of this frame. |scroll| is the view's current scroll offset.
  52   // |global_visible_rect| is the intersection of the view size and the window
  53   // in window coordinates.
  54   void PrepareToDraw(const gfx::Vector2d& scroll,
  55                      const gfx::Rect& global_visible_rect);
  56
  57   // Main handlers for view drawing. A false return value indicates no new
  58   // frame is produced.
  59   bool OnDrawHardware();
  60   bool OnDrawSoftware(SkCanvas* canvas);
  61
  62   // CapturePicture API methods.
  63   skia::RefPtr<SkPicture> CapturePicture(int width, int height);
  64   void EnableOnNewPicture(bool enabled);
  65
  66   void ClearView();
  67
  68   void SetOffscreenPreRaster(bool enabled);
  69
  70   // View update notifications.
  71   void SetIsPaused(bool paused);
  72   void SetViewVisibility(bool visible);
  73   void SetWindowVisibility(bool visible);
  74   void OnSizeChanged(int width, int height);
  75   void OnAttachedToWindow(int width, int height);
  76   void OnDetachedFromWindow();
  77
  78   // Sets the scale for logical<->physical pixel conversions.
  79   void SetDipScale(float dip_scale);
  80   float dip_scale() const { return dip_scale_; }
  81
  82   // Set the root layer scroll offset to |new_value|.
  83   void ScrollTo(gfx::Vector2d new_value);
  84
  85   // Android views hierarchy gluing.
  86   bool IsVisible() const;
  87   gfx::Rect GetScreenRect() const;
  88   bool attached_to_window() const { return attached_to_window_; }
  89   bool hardware_enabled() const { return hardware_enabled_; }
  90   gfx::Size size() const { return size_; }
  91   void ReleaseHardware();
  92
  93   void TrimMemory(const int level, const bool visible);
  94
  95   // SynchronousCompositorClient overrides.
  96   void DidInitializeCompositor(
  97       content::SynchronousCompositor* compositor) override;
  98   void DidDestroyCompositor(
  99       content::SynchronousCompositor* compositor) override;
 100   void PostInvalidate() override;
 101   void DidUpdateContent() override;
 102   gfx::Vector2dF GetTotalRootLayerScrollOffset() override;
 103   void UpdateRootLayerState(const gfx::Vector2dF& total_scroll_offset_dip,
 104                             const gfx::Vector2dF& max_scroll_offset_dip,
 105                             const gfx::SizeF& scrollable_size_dip,
 106                             float page_scale_factor,
 107                             float min_page_scale_factor,
 108                             float max_page_scale_factor) override;
 109   bool IsExternalFlingActive() const override;
 110   void DidOverscroll(gfx::Vector2dF accumulated_overscroll,
 111                      gfx::Vector2dF latest_overscroll_delta,
 112                      gfx::Vector2dF current_fling_velocity) override;
 113
 114   void UpdateParentDrawConstraints();
 115   void DetachFunctorFromView();
 116
 117  private:
 118   void SetTotalRootLayerScrollOffset(gfx::Vector2dF new_value_dip);
 119   bool CanOnDraw();
 120   // Posts an invalidate with fallback tick. All invalidates posted while an
 121   // invalidate is pending will be posted as a single invalidate after the
 122   // pending invalidate is done.
 123   void PostInvalidateWithFallback();
 124   void CancelFallbackTick();
 125   void UpdateCompositorIsActive();
 126   bool CompositeSW(SkCanvas* canvas);
 127   scoped_refptr<base::trace_event::ConvertableToTraceFormat>
 128   RootLayerStateAsValue(const gfx::Vector2dF& total_scroll_offset_dip,
 129                         const gfx::SizeF& scrollable_size_dip);
 130
 131   bool CompositeHw();
 132   void ReturnUnusedResource(scoped_ptr<ChildFrame> frame);
 133   void ReturnResourceFromParent();
 134
 135   // If we call up view invalidate and OnDraw is not called before a deadline,
 136   // then we keep ticking the SynchronousCompositor so it can make progress.
 137   // Do this in a two stage tick due to native MessageLoop favors delayed task,
 138   // so ensure delayed task is inserted only after the draw task returns.
 139   void PostFallbackTick();
 140   void FallbackTickFired();
 141
 142   // Force invoke the compositor to run produce a 1x1 software frame that is
 143   // immediately discarded. This is a hack to force invoke parts of the
 144   // compositor that are not directly exposed here.
 145   void ForceFakeCompositeSW();
 146
 147   gfx::Vector2d max_scroll_offset() const;
 148
 149   void UpdateMemoryPolicy();
 150
 151   // For debug tracing or logging. Return the string representation of this
 152   // view renderer's state.
 153   std::string ToString() const;
 154
 155   BrowserViewRendererClient* client_;
 156   SharedRendererState shared_renderer_state_;
 157   scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
 158
 159   content::SynchronousCompositor* compositor_;
 160
 161   bool is_paused_;
 162   bool view_visible_;
 163   bool window_visible_;  // Only applicable if |attached_to_window_| is true.
 164   bool attached_to_window_;
 165   bool hardware_enabled_;
 166   float dip_scale_;
 167   float page_scale_factor_;
 168   bool on_new_picture_enable_;
 169   bool clear_view_;
 170
 171   bool offscreen_pre_raster_;
 172
 173   gfx::Vector2d last_on_draw_scroll_offset_;
 174   gfx::Rect last_on_draw_global_visible_rect_;
 175
 176   base::CancelableClosure post_fallback_tick_;
 177   base::CancelableClosure fallback_tick_fired_;
 178   bool fallback_tick_pending_;
 179
 180   gfx::Size size_;
 181
 182   // Current scroll offset in CSS pixels.
 183   gfx::Vector2dF scroll_offset_dip_;
 184
 185   // Max scroll offset in CSS pixels.
 186   gfx::Vector2dF max_scroll_offset_dip_;
 187
 188   // Used to prevent rounding errors from accumulating enough to generate
 189   // visible skew (especially noticeable when scrolling up and down in the same
 190   // spot over a period of time).
 191   gfx::Vector2dF overscroll_rounding_error_;
 192
 193   DISALLOW_COPY_AND_ASSIGN(BrowserViewRenderer);
 194 };
 195
 196 }  // namespace android_webview
 197
 198 #endif  // ANDROID_WEBVIEW_BROWSER_BROWSER_VIEW_RENDERER_H_