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   void OnComputeScroll(base::TimeTicks animation_time);
  78
  79   // Sets the scale for logical<->physical pixel conversions.
  80   void SetDipScale(float dip_scale);
  81   float dip_scale() const { return dip_scale_; }
  82
  83   // Set the root layer scroll offset to |new_value|.
  84   void ScrollTo(gfx::Vector2d new_value);
  85
  86   // Android views hierarchy gluing.
  87   bool IsVisible() const;
  88   gfx::Rect GetScreenRect() const;
  89   bool attached_to_window() const { return attached_to_window_; }
  90   bool hardware_enabled() const { return hardware_enabled_; }
  91   gfx::Size size() const { return size_; }
  92   void ReleaseHardware();
  93
  94   void TrimMemory(const int level, const bool visible);
  95
  96   // SynchronousCompositorClient overrides.
  97   void DidInitializeCompositor(
  98       content::SynchronousCompositor* compositor) override;
  99   void DidDestroyCompositor(
 100       content::SynchronousCompositor* compositor) override;
 101   void PostInvalidate() override;
 102   void DidUpdateContent() override;
 103   gfx::Vector2dF GetTotalRootLayerScrollOffset() override;
 104   void UpdateRootLayerState(const gfx::Vector2dF& total_scroll_offset_dip,
 105                             const gfx::Vector2dF& max_scroll_offset_dip,
 106                             const gfx::SizeF& scrollable_size_dip,
 107                             float page_scale_factor,
 108                             float min_page_scale_factor,
 109                             float max_page_scale_factor) override;
 110   bool IsExternalScrollActive() const override;
 111   void SetNeedsAnimateScroll(
 112       const AnimationCallback& scroll_animation) override;
 113   void DidOverscroll(gfx::Vector2dF accumulated_overscroll,
 114                      gfx::Vector2dF latest_overscroll_delta,
 115                      gfx::Vector2dF current_fling_velocity) override;
 116
 117   void UpdateParentDrawConstraints();
 118   void DetachFunctorFromView();
 119
 120  private:
 121   void SetTotalRootLayerScrollOffset(gfx::Vector2dF new_value_dip);
 122   bool CanOnDraw();
 123   // Posts an invalidate with fallback tick. All invalidates posted while an
 124   // invalidate is pending will be posted as a single invalidate after the
 125   // pending invalidate is done.
 126   void PostInvalidateWithFallback();
 127   void CancelFallbackTick();
 128   void UpdateCompositorIsActive();
 129   bool CompositeSW(SkCanvas* canvas);
 130   scoped_refptr<base::trace_event::ConvertableToTraceFormat>
 131   RootLayerStateAsValue(const gfx::Vector2dF& total_scroll_offset_dip,
 132                         const gfx::SizeF& scrollable_size_dip);
 133
 134   bool CompositeHw();
 135   void ReturnUnusedResource(scoped_ptr<ChildFrame> frame);
 136   void ReturnResourceFromParent();
 137
 138   // If we call up view invalidate and OnDraw is not called before a deadline,
 139   // then we keep ticking the SynchronousCompositor so it can make progress.
 140   // Do this in a two stage tick due to native MessageLoop favors delayed task,
 141   // so ensure delayed task is inserted only after the draw task returns.
 142   void PostFallbackTick();
 143   void FallbackTickFired();
 144
 145   // Force invoke the compositor to run produce a 1x1 software frame that is
 146   // immediately discarded. This is a hack to force invoke parts of the
 147   // compositor that are not directly exposed here.
 148   void ForceFakeCompositeSW();
 149
 150   gfx::Vector2d max_scroll_offset() const;
 151
 152   void UpdateMemoryPolicy();
 153
 154   // For debug tracing or logging. Return the string representation of this
 155   // view renderer's state.
 156   std::string ToString() const;
 157
 158   BrowserViewRendererClient* client_;
 159   SharedRendererState shared_renderer_state_;
 160   scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
 161
 162   content::SynchronousCompositor* compositor_;
 163
 164   bool is_paused_;
 165   bool view_visible_;
 166   bool window_visible_;  // Only applicable if |attached_to_window_| is true.
 167   bool attached_to_window_;
 168   bool hardware_enabled_;
 169   float dip_scale_;
 170   float page_scale_factor_;
 171   bool on_new_picture_enable_;
 172   bool clear_view_;
 173
 174   bool offscreen_pre_raster_;
 175
 176   gfx::Vector2d last_on_draw_scroll_offset_;
 177   gfx::Rect last_on_draw_global_visible_rect_;
 178
 179   base::CancelableClosure post_fallback_tick_;
 180   base::CancelableClosure fallback_tick_fired_;
 181   bool fallback_tick_pending_;
 182
 183   gfx::Size size_;
 184
 185   // Used to drive a fling animation as requested by the compositor. This acts
 186   // as a single-shot animation; the compositor will continually post an
 187   // animation callback as long as they're required.
 188   AnimationCallback pending_fling_animation_;
 189
 190   // Current scroll offset in CSS pixels.
 191   gfx::Vector2dF scroll_offset_dip_;
 192
 193   // Max scroll offset in CSS pixels.
 194   gfx::Vector2dF max_scroll_offset_dip_;
 195
 196   // Used to prevent rounding errors from accumulating enough to generate
 197   // visible skew (especially noticeable when scrolling up and down in the same
 198   // spot over a period of time).
 199   gfx::Vector2dF overscroll_rounding_error_;
 200
 201   DISALLOW_COPY_AND_ASSIGN(BrowserViewRenderer);
 202 };
 203
 204 }  // namespace android_webview
 205
 206 #endif  // ANDROID_WEBVIEW_BROWSER_BROWSER_VIEW_RENDERER_H_