blob: 42c0d30035dd5449e0e1f418429bf9eaf873ccec [file] [log] [blame]
[email protected]ba91a792013-02-06 09:48:281// 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 CONTENT_RENDERER_GPU_RENDER_WIDGET_COMPOSITOR_H_
6#define CONTENT_RENDERER_GPU_RENDER_WIDGET_COMPOSITOR_H_
7
avi1023d012015-12-25 02:39:148#include <stdint.h>
9
[email protected]666d7cf2013-10-12 01:30:2910#include "base/callback.h"
[email protected]200a9c062013-05-20 04:34:3711#include "base/memory/weak_ptr.h"
[email protected]abb522162013-06-28 01:54:1612#include "base/time/time.h"
[email protected]752e2cf2013-10-21 21:41:1513#include "base/values.h"
mdjones2ee41afd2016-10-27 16:50:2014#include "cc/input/browser_controls_state.h"
sohan.jyoti127a06b42015-10-05 08:23:3415#include "cc/output/managed_memory_policy.h"
jamesrf313a212015-03-16 21:27:3716#include "cc/output/swap_promise.h"
[email protected]556fd292013-03-18 08:03:0417#include "cc/trees/layer_tree_host_client.h"
[email protected]943528e2013-11-07 05:01:3218#include "cc/trees/layer_tree_host_single_thread_client.h"
[email protected]556fd292013-03-18 08:03:0419#include "cc/trees/layer_tree_settings.h"
jamesrf313a212015-03-16 21:27:3720#include "cc/trees/swap_promise_monitor.h"
skyostil7759d7a2014-09-05 08:22:2321#include "content/common/content_export.h"
danakj6e3bf8012014-12-16 18:27:5322#include "content/renderer/gpu/compositor_dependencies.h"
[email protected]5c30b5e02013-05-30 03:46:0823#include "third_party/WebKit/public/platform/WebLayerTreeView.h"
tfarina3b0452d2014-12-31 15:20:0924#include "ui/gfx/geometry/rect.h"
[email protected]ba91a792013-02-06 09:48:2825
danakja40dd4482016-06-28 01:14:1026namespace base {
27class CommandLine;
[email protected]4b157662013-05-29 04:05:0528}
29
[email protected]ba91a792013-02-06 09:48:2830namespace cc {
loyso2cb3f32f2016-11-08 07:08:3431
32class AnimationHost;
[email protected]200a9c062013-05-20 04:34:3733class InputHandler;
[email protected]f7837a92013-08-21 03:00:0534class Layer;
danakjc7afae52017-06-20 21:12:4135class LayerTreeFrameSink;
khushalsagar61567792016-09-17 00:13:5836class LayerTreeHost;
loyso6e6efc42017-01-21 02:23:0337class MutatorHost;
danakja40dd4482016-06-28 01:14:1038}
dtrainor5ef644e2015-11-19 00:12:4739
ccameronf408cab2016-09-14 16:54:4240namespace gfx {
41class ColorSpace;
42}
43
danakja40dd4482016-06-28 01:14:1044namespace ui {
45class LatencyInfo;
[email protected]ba91a792013-02-06 09:48:2846}
47
48namespace content {
fsamuel78f86e42016-01-20 04:10:2349
50class RenderWidgetCompositorDelegate;
boliu6f8ab172017-01-10 05:06:3651struct ScreenInfo;
[email protected]ba91a792013-02-06 09:48:2852
skyostil7759d7a2014-09-05 08:22:2353class CONTENT_EXPORT RenderWidgetCompositor
Nico Weber43ddd7a32017-08-15 19:19:2754 : public blink::WebLayerTreeView,
55 public cc::LayerTreeHostClient,
56 public cc::LayerTreeHostSingleThreadClient {
Scott Haseleyc3f876b2017-08-10 00:40:3657 using ReportTimeCallback =
58 base::Callback<void(blink::WebLayerTreeView::SwapResult, double)>;
panicker34797fd2017-05-05 04:09:2659
[email protected]ba91a792013-02-06 09:48:2860 public:
61 // Attempt to construct and initialize a compositor instance for the widget
62 // with the given settings. Returns NULL if initialization fails.
dchengcedca5612016-04-09 01:40:1563 static std::unique_ptr<RenderWidgetCompositor> Create(
fsamuel78f86e42016-01-20 04:10:2364 RenderWidgetCompositorDelegate* delegate,
danakj6e3bf8012014-12-16 18:27:5365 CompositorDependencies* compositor_deps);
[email protected]ba91a792013-02-06 09:48:2866
avi5c77d212015-09-25 20:08:2567 ~RenderWidgetCompositor() override;
[email protected]ba91a792013-02-06 09:48:2868
danakja40dd4482016-06-28 01:14:1069 static cc::LayerTreeSettings GenerateLayerTreeSettings(
70 const base::CommandLine& cmd,
71 CompositorDependencies* compositor_deps,
boliu6f8ab172017-01-10 05:06:3672 float device_scale_factor,
wjmacleana755e302017-04-20 00:43:1673 bool is_for_subframe,
Walter Kormandc3eca652017-08-15 21:00:4574 const ScreenInfo& screen_info,
75 bool is_threaded);
loyso6e6efc42017-01-21 02:23:0376 static std::unique_ptr<cc::LayerTreeHost> CreateLayerTreeHost(
77 cc::LayerTreeHostClient* client,
78 cc::LayerTreeHostSingleThreadClient* single_thread_client,
79 cc::MutatorHost* mutator_host,
80 CompositorDependencies* deps,
81 float device_scale_factor,
82 const ScreenInfo& screen_info);
83
84 void Initialize(std::unique_ptr<cc::LayerTreeHost> layer_tree_host,
85 std::unique_ptr<cc::AnimationHost> animation_host);
86
danakja40dd4482016-06-28 01:14:1087 static cc::ManagedMemoryPolicy GetGpuMemoryPolicy(
Vladimir Levin0375ae82017-07-18 03:06:4088 const cc::ManagedMemoryPolicy& policy,
89 const ScreenInfo& screen_info);
danakja40dd4482016-06-28 01:14:1090
sievers71c62dd52015-10-07 01:44:3991 void SetNeverVisible();
[email protected]200a9c062013-05-20 04:34:3792 const base::WeakPtr<cc::InputHandler>& GetInputHandler();
[email protected]24ed0432013-04-24 07:50:3193 void SetNeedsDisplayOnAllLayers();
[email protected]206a3922013-05-17 06:34:1294 void SetRasterizeOnlyVisibleContent();
[email protected]0bc1f572013-04-17 01:46:3195 void SetNeedsRedrawRect(gfx::Rect damage_rect);
[email protected]7d08a9352013-10-15 08:24:5696 // Like setNeedsRedraw but forces the frame to be drawn, without early-outs.
97 // Redraw will be forced after the next commit
98 void SetNeedsForcedRedraw();
[email protected]6be422b2013-12-08 06:47:3199 // Calling CreateLatencyInfoSwapPromiseMonitor() to get a scoped
100 // LatencyInfoSwapPromiseMonitor. During the life time of the
igsollaeab34cc2015-02-20 11:33:35101 // LatencyInfoSwapPromiseMonitor, if SetNeedsCommit() or
102 // SetNeedsUpdateLayers() is called on LayerTreeHost, the original latency
103 // info will be turned into a LatencyInfoSwapPromise.
dchengcedca5612016-04-09 01:40:15104 std::unique_ptr<cc::SwapPromiseMonitor> CreateLatencyInfoSwapPromiseMonitor(
[email protected]6be422b2013-12-08 06:47:31105 ui::LatencyInfo* latency);
[email protected]8062ab262014-05-27 16:56:43106 // Calling QueueSwapPromise() to directly queue a SwapPromise into
107 // LayerTreeHost.
dchengcedca5612016-04-09 01:40:15108 void QueueSwapPromise(std::unique_ptr<cc::SwapPromise> swap_promise);
[email protected]586871b2014-07-22 17:05:11109 int GetSourceFrameNumber() const;
[email protected]df09e052013-07-31 18:59:50110 void NotifyInputThrottledUntilCommit();
[email protected]f7837a92013-08-21 03:00:05111 const cc::Layer* GetRootLayer() const;
[email protected]67e703e12014-05-30 05:31:51112 int ScheduleMicroBenchmark(
[email protected]666d7cf2013-10-12 01:30:29113 const std::string& name,
dchengcedca5612016-04-09 01:40:15114 std::unique_ptr<base::Value> value,
115 const base::Callback<void(std::unique_ptr<base::Value>)>& callback);
116 bool SendMessageToMicroBenchmark(int id, std::unique_ptr<base::Value> value);
Fady Samueld5c26182017-07-12 02:43:33117 void SetFrameSinkId(const viz::FrameSinkId& frame_sink_id);
oshima750cb4342015-10-31 00:59:01118 void SetPaintedDeviceScaleFactor(float device_scale);
ccameron2c6d2702017-03-08 19:42:42119 void SetRasterColorSpace(const gfx::ColorSpace& color_space);
wjmaclean1d970622017-01-21 22:28:24120 void SetIsForOopif(bool is_for_oopif);
fsamuel4c5c87142017-03-14 03:14:26121 void SetContentSourceId(uint32_t source_id);
Sadrul Habib Chowdhury04d5dd4d2017-08-10 01:59:27122 void SetViewportSize(const gfx::Size& device_viewport_size,
123 const viz::LocalSurfaceId& local_surface_id);
[email protected]9ed83fe2013-02-27 01:52:28124
[email protected]ba91a792013-02-06 09:48:28125 // WebLayerTreeView implementation.
Fady Samueld5c26182017-07-12 02:43:33126 viz::FrameSinkId GetFrameSinkId() override;
Blink Reformat1c4d759e2017-04-09 16:34:54127 void SetRootLayer(const blink::WebLayer& layer) override;
128 void ClearRootLayer() override;
129 cc::AnimationHost* CompositorAnimationHost() override;
Blink Reformat1c4d759e2017-04-09 16:34:54130 blink::WebSize GetViewportSize() const override;
[email protected]180ef242013-11-07 06:50:46131 virtual blink::WebFloatPoint adjustEventPointForPinchZoom(
132 const blink::WebFloatPoint& point) const;
Blink Reformat1c4d759e2017-04-09 16:34:54133 void SetDeviceScaleFactor(float device_scale) override;
134 void SetBackgroundColor(blink::WebColor color) override;
135 void SetVisible(bool visible) override;
136 void SetPageScaleFactorAndLimits(float page_scale_factor,
avi5c77d212015-09-25 20:08:25137 float minimum,
138 float maximum) override;
Blink Reformat1c4d759e2017-04-09 16:34:54139 void StartPageScaleAnimation(const blink::WebPoint& destination,
avi5c77d212015-09-25 20:08:25140 bool use_anchor,
141 float new_page_scale,
142 double duration_sec) override;
Blink Reformat1c4d759e2017-04-09 16:34:54143 bool HasPendingPageScaleAnimation() const override;
144 void HeuristicsForGpuRasterizationUpdated(bool matches_heuristics) override;
145 void SetNeedsBeginFrame() override;
146 void DidStopFlinging() override;
147 void LayoutAndPaintAsync(
avi5c77d212015-09-25 20:08:25148 blink::WebLayoutAndPaintAsyncCallback* callback) override;
Blink Reformat1c4d759e2017-04-09 16:34:54149 void CompositeAndReadbackAsync(
avi5c77d212015-09-25 20:08:25150 blink::WebCompositeAndReadbackAsyncCallback* callback) override;
Blink Reformat1c4d759e2017-04-09 16:34:54151 void SetDeferCommits(bool defer_commits) override;
152 void RegisterViewportLayers(
Chandan Padhi198800bd12017-07-07 08:15:07153 const blink::WebLayerTreeView::ViewportLayers& viewport_layers) override;
Blink Reformat1c4d759e2017-04-09 16:34:54154 void ClearViewportLayers() override;
155 void RegisterSelection(const blink::WebSelection& selection) override;
156 void ClearSelection() override;
157 void SetMutatorClient(
flackrf54e9b42016-05-31 15:20:10158 std::unique_ptr<blink::WebCompositorMutatorClient>) override;
Blink Reformat1c4d759e2017-04-09 16:34:54159 void ForceRecalculateRasterScales() override;
160 void SetEventListenerProperties(
dtapuskaf206a40d2016-02-05 21:36:02161 blink::WebEventListenerClass eventClass,
162 blink::WebEventListenerProperties properties) override;
Blink Reformat1c4d759e2017-04-09 16:34:54163 void UpdateEventRectsForSubframeIfNecessary() override;
164 blink::WebEventListenerProperties EventListenerProperties(
dtapuskaf206a40d2016-02-05 21:36:02165 blink::WebEventListenerClass eventClass) const override;
Blink Reformat1c4d759e2017-04-09 16:34:54166 void SetHaveScrollEventHandlers(bool) override;
167 bool HaveScrollEventHandlers() const override;
168 int LayerTreeId() const override;
169 void SetShowFPSCounter(bool show) override;
170 void SetShowPaintRects(bool show) override;
171 void SetShowDebugBorders(bool show) override;
172 void SetShowScrollBottleneckRects(bool show) override;
panicker34797fd2017-05-05 04:09:26173 void NotifySwapTime(ReportTimeCallback callback) override;
aelias6004fe02015-02-07 21:43:01174
Blink Reformat1c4d759e2017-04-09 16:34:54175 void UpdateBrowserControlsState(blink::WebBrowserControlsState constraints,
mdjones2ee41afd2016-10-27 16:50:20176 blink::WebBrowserControlsState current,
177 bool animate) override;
Matthew Jones7e156182017-07-21 22:21:33178 void SetBrowserControlsHeight(float top_height,
179 float bottom_height,
180 bool shrink) override;
Blink Reformat1c4d759e2017-04-09 16:34:54181 void SetBrowserControlsShownRatio(float) override;
vmpstrbf56d562017-06-06 20:16:38182 void RequestDecode(const PaintImage& image,
vmpstra840c6a2017-06-01 21:50:39183 const base::Callback<void(bool)>& callback) override;
[email protected]ba91a792013-02-06 09:48:28184
185 // cc::LayerTreeHostClient implementation.
caseq7d2f4c92015-02-04 16:43:27186 void WillBeginMainFrame() override;
dcheng6d18e402014-10-21 12:32:52187 void DidBeginMainFrame() override;
Fady Samuelc296f5fb2017-07-21 04:02:19188 void BeginMainFrame(const viz::BeginFrameArgs& args) override;
rmcilroy0a19362a2015-02-18 12:34:25189 void BeginMainFrameNotExpectedSoon() override;
delphick9db74aa2017-05-05 10:20:49190 void BeginMainFrameNotExpectedUntil(base::TimeTicks time) override;
wkorman7265db012015-11-03 04:08:25191 void UpdateLayerTreeHost() override;
miletus7a221752015-02-04 20:44:49192 void ApplyViewportDeltas(const gfx::Vector2dF& inner_delta,
193 const gfx::Vector2dF& outer_delta,
ccameron98be9ac2014-12-09 19:56:32194 const gfx::Vector2dF& elastic_overscroll_delta,
dcheng6d18e402014-10-21 12:32:52195 float page_scale,
196 float top_controls_delta) override;
sahel1b47fda72017-03-28 17:03:07197 void RecordWheelAndTouchScrollingCount(bool has_scrolled_by_wheel,
198 bool has_scrolled_by_touch) override;
danakjc7afae52017-06-20 21:12:41199 void RequestNewLayerTreeFrameSink() override;
200 void DidInitializeLayerTreeFrameSink() override;
201 void DidFailToInitializeLayerTreeFrameSink() override;
dcheng6d18e402014-10-21 12:32:52202 void WillCommit() override;
203 void DidCommit() override;
204 void DidCommitAndDrawFrame() override;
danakj9d124422016-10-14 03:15:08205 void DidReceiveCompositorFrameAck() override;
rouslanf7ebd8832015-01-22 01:54:14206 void DidCompletePageScaleAnimation() override;
wjmacleana755e302017-04-20 00:43:16207 bool IsForSubframe() override;
[email protected]ba91a792013-02-06 09:48:28208
[email protected]943528e2013-11-07 05:01:32209 // cc::LayerTreeHostSingleThreadClient implementation.
danakj53eccbc2016-03-02 22:51:07210 void RequestScheduleAnimation() override;
danakj6c872fc02016-10-22 04:29:49211 void DidSubmitCompositorFrame() override;
danakjc7afae52017-06-20 21:12:41212 void DidLoseLayerTreeFrameSink() override;
Dan Elphick95929fd52017-06-13 09:15:07213 void RequestBeginMainFrameNotExpected(bool new_state) override;
[email protected]943528e2013-11-07 05:01:32214
enne7f8fdde2014-12-10 21:32:09215 protected:
oshima50872a72016-03-04 13:26:18216 friend class RenderViewImplScaleFactorTest;
217
fsamuel78f86e42016-01-20 04:10:23218 RenderWidgetCompositor(RenderWidgetCompositorDelegate* delegate,
danakj6e3bf8012014-12-16 18:27:53219 CompositorDependencies* compositor_deps);
[email protected]ba91a792013-02-06 09:48:28220
khushalsagar61567792016-09-17 00:13:58221 cc::LayerTreeHost* layer_tree_host() { return layer_tree_host_.get(); }
enne7f8fdde2014-12-10 21:32:09222
223 private:
danakjc7afae52017-06-20 21:12:41224 void SetLayerTreeFrameSink(
225 std::unique_ptr<cc::LayerTreeFrameSink> layer_tree_frame_sink);
wangxianzhu67d1fae2015-06-30 22:15:53226 void LayoutAndUpdateLayers();
227 void InvokeLayoutAndPaintCallback();
228 bool CompositeIsSynchronous() const;
229 void SynchronouslyComposite();
wangxianzhu372112e2015-05-06 23:01:57230
Sadrul Habib Chowdhury49c92572017-07-14 19:17:41231 bool attempt_software_fallback_ = false;
fsamuel78f86e42016-01-20 04:10:23232 RenderWidgetCompositorDelegate* const delegate_;
233 CompositorDependencies* const compositor_deps_;
danakja40dd4482016-06-28 01:14:10234 const bool threaded_;
loyso2cb3f32f2016-11-08 07:08:34235 std::unique_ptr<cc::AnimationHost> animation_host_;
khushalsagar61567792016-09-17 00:13:58236 std::unique_ptr<cc::LayerTreeHost> layer_tree_host_;
sievers71c62dd52015-10-07 01:44:39237 bool never_visible_;
wjmaclean1d970622017-01-21 22:28:24238 bool is_for_oopif_;
ernstm50aec922014-08-26 22:16:11239
wangxianzhu372112e2015-05-06 23:01:57240 blink::WebLayoutAndPaintAsyncCallback* layout_and_paint_async_callback_;
enne89e6c3aa2014-10-01 15:07:59241
Fady Samueld5c26182017-07-12 02:43:33242 viz::FrameSinkId frame_sink_id_;
samansd5db2502017-01-13 23:18:27243
enne7f8fdde2014-12-10 21:32:09244 base::WeakPtrFactory<RenderWidgetCompositor> weak_factory_;
panicker34797fd2017-05-05 04:09:26245
246 DISALLOW_COPY_AND_ASSIGN(RenderWidgetCompositor);
[email protected]ba91a792013-02-06 09:48:28247};
248
249} // namespace content
250
251#endif // CONTENT_RENDERER_GPU_RENDER_WIDGET_COMPOSITOR_H_