blob: ab2c72dbdad1b0a4478c8100a8518eab0eff2dac [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"
[email protected]9b003482013-05-21 14:00:1714#include "cc/input/top_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"
dtrainor5ef644e2015-11-19 00:12:4720#include "cc/trees/remote_proto_channel.h"
jamesrf313a212015-03-16 21:27:3721#include "cc/trees/swap_promise_monitor.h"
skyostil7759d7a2014-09-05 08:22:2322#include "content/common/content_export.h"
danakj6e3bf8012014-12-16 18:27:5323#include "content/renderer/gpu/compositor_dependencies.h"
[email protected]5c30b5e02013-05-30 03:46:0824#include "third_party/WebKit/public/platform/WebLayerTreeView.h"
[email protected]9f4f6a32013-09-04 21:35:1225#include "third_party/skia/include/core/SkBitmap.h"
tfarina3b0452d2014-12-31 15:20:0926#include "ui/gfx/geometry/rect.h"
[email protected]ba91a792013-02-06 09:48:2827
[email protected]4b157662013-05-29 04:05:0528namespace ui {
miletus45effdc42015-08-05 00:29:1829class LatencyInfo;
[email protected]4b157662013-05-29 04:05:0530}
31
[email protected]ba91a792013-02-06 09:48:2832namespace cc {
enne89e6c3aa2014-10-01 15:07:5933class CopyOutputRequest;
[email protected]200a9c062013-05-20 04:34:3734class InputHandler;
[email protected]f7837a92013-08-21 03:00:0535class Layer;
[email protected]ba91a792013-02-06 09:48:2836class LayerTreeHost;
dtrainor5ef644e2015-11-19 00:12:4737
38namespace proto {
39class CompositorMessage;
40}
41
[email protected]ba91a792013-02-06 09:48:2842}
43
44namespace content {
fsamuel78f86e42016-01-20 04:10:2345
46class RenderWidgetCompositorDelegate;
[email protected]ba91a792013-02-06 09:48:2847
skyostil7759d7a2014-09-05 08:22:2348class CONTENT_EXPORT RenderWidgetCompositor
49 : NON_EXPORTED_BASE(public blink::WebLayerTreeView),
50 NON_EXPORTED_BASE(public cc::LayerTreeHostClient),
dtrainor5ef644e2015-11-19 00:12:4751 NON_EXPORTED_BASE(public cc::LayerTreeHostSingleThreadClient),
52 NON_EXPORTED_BASE(public cc::RemoteProtoChannel) {
[email protected]ba91a792013-02-06 09:48:2853 public:
54 // Attempt to construct and initialize a compositor instance for the widget
55 // with the given settings. Returns NULL if initialization fails.
danakj6e3bf8012014-12-16 18:27:5356 static scoped_ptr<RenderWidgetCompositor> Create(
fsamuel78f86e42016-01-20 04:10:2357 RenderWidgetCompositorDelegate* delegate,
58 float device_scale_factor,
danakj6e3bf8012014-12-16 18:27:5359 CompositorDependencies* compositor_deps);
[email protected]ba91a792013-02-06 09:48:2860
avi5c77d212015-09-25 20:08:2561 ~RenderWidgetCompositor() override;
[email protected]ba91a792013-02-06 09:48:2862
sievers71c62dd52015-10-07 01:44:3963 void SetNeverVisible();
[email protected]200a9c062013-05-20 04:34:3764 const base::WeakPtr<cc::InputHandler>& GetInputHandler();
[email protected]971728d2013-10-26 10:39:3165 bool BeginMainFrameRequested() const;
[email protected]24ed0432013-04-24 07:50:3166 void SetNeedsDisplayOnAllLayers();
[email protected]206a3922013-05-17 06:34:1267 void SetRasterizeOnlyVisibleContent();
[email protected]0bc1f572013-04-17 01:46:3168 void SetNeedsRedrawRect(gfx::Rect damage_rect);
[email protected]7d08a9352013-10-15 08:24:5669 // Like setNeedsRedraw but forces the frame to be drawn, without early-outs.
70 // Redraw will be forced after the next commit
71 void SetNeedsForcedRedraw();
[email protected]6be422b2013-12-08 06:47:3172 // Calling CreateLatencyInfoSwapPromiseMonitor() to get a scoped
73 // LatencyInfoSwapPromiseMonitor. During the life time of the
igsollaeab34cc2015-02-20 11:33:3574 // LatencyInfoSwapPromiseMonitor, if SetNeedsCommit() or
75 // SetNeedsUpdateLayers() is called on LayerTreeHost, the original latency
76 // info will be turned into a LatencyInfoSwapPromise.
[email protected]6be422b2013-12-08 06:47:3177 scoped_ptr<cc::SwapPromiseMonitor> CreateLatencyInfoSwapPromiseMonitor(
78 ui::LatencyInfo* latency);
[email protected]8062ab262014-05-27 16:56:4379 // Calling QueueSwapPromise() to directly queue a SwapPromise into
80 // LayerTreeHost.
81 void QueueSwapPromise(scoped_ptr<cc::SwapPromise> swap_promise);
[email protected]586871b2014-07-22 17:05:1182 int GetSourceFrameNumber() const;
igsollaeab34cc2015-02-20 11:33:3583 void SetNeedsUpdateLayers();
[email protected]586871b2014-07-22 17:05:1184 void SetNeedsCommit();
[email protected]df09e052013-07-31 18:59:5085 void NotifyInputThrottledUntilCommit();
[email protected]f7837a92013-08-21 03:00:0586 const cc::Layer* GetRootLayer() const;
[email protected]67e703e12014-05-30 05:31:5187 int ScheduleMicroBenchmark(
[email protected]666d7cf2013-10-12 01:30:2988 const std::string& name,
[email protected]752e2cf2013-10-21 21:41:1589 scoped_ptr<base::Value> value,
[email protected]666d7cf2013-10-12 01:30:2990 const base::Callback<void(scoped_ptr<base::Value>)>& callback);
[email protected]67e703e12014-05-30 05:31:5191 bool SendMessageToMicroBenchmark(int id, scoped_ptr<base::Value> value);
kenrbb4e2a3b2015-05-14 15:05:0592 void SetSurfaceIdNamespace(uint32_t surface_id_namespace);
dtrainor5ef644e2015-11-19 00:12:4793 void OnHandleCompositorProto(const std::vector<uint8_t>& proto);
sohan.jyoti127a06b42015-10-05 08:23:3494 cc::ManagedMemoryPolicy GetGpuMemoryPolicy(
95 const cc::ManagedMemoryPolicy& policy);
oshima750cb4342015-10-31 00:59:0196 void SetPaintedDeviceScaleFactor(float device_scale);
[email protected]9ed83fe2013-02-27 01:52:2897
[email protected]ba91a792013-02-06 09:48:2898 // WebLayerTreeView implementation.
avi5c77d212015-09-25 20:08:2599 void setRootLayer(const blink::WebLayer& layer) override;
100 void clearRootLayer() override;
101 void attachCompositorAnimationTimeline(
loyso26f3c552016-02-10 23:54:34102 cc::AnimationTimeline* compositor_timeline) override;
avi5c77d212015-09-25 20:08:25103 void detachCompositorAnimationTimeline(
loyso26f3c552016-02-10 23:54:34104 cc::AnimationTimeline* compositor_timeline) override;
avi5c77d212015-09-25 20:08:25105 void setViewportSize(const blink::WebSize& device_viewport_size) override;
[email protected]180ef242013-11-07 06:50:46106 virtual blink::WebFloatPoint adjustEventPointForPinchZoom(
107 const blink::WebFloatPoint& point) const;
avi5c77d212015-09-25 20:08:25108 void setDeviceScaleFactor(float device_scale) override;
avi5c77d212015-09-25 20:08:25109 void setBackgroundColor(blink::WebColor color) override;
110 void setHasTransparentBackground(bool transparent) override;
111 void setVisible(bool visible) override;
112 void setPageScaleFactorAndLimits(float page_scale_factor,
113 float minimum,
114 float maximum) override;
115 void startPageScaleAnimation(const blink::WebPoint& destination,
116 bool use_anchor,
117 float new_page_scale,
118 double duration_sec) override;
119 void heuristicsForGpuRasterizationUpdated(bool matches_heuristics) override;
120 void setNeedsAnimate() override;
121 void setNeedsBeginFrame() override;
122 void setNeedsCompositorUpdate() override;
123 void didStopFlinging() override;
124 void layoutAndPaintAsync(
125 blink::WebLayoutAndPaintAsyncCallback* callback) override;
126 void compositeAndReadbackAsync(
127 blink::WebCompositeAndReadbackAsyncCallback* callback) override;
128 void setDeferCommits(bool defer_commits) override;
avi5c77d212015-09-25 20:08:25129 void registerViewportLayers(
ccameron8230b68b2014-11-21 19:25:18130 const blink::WebLayer* overscrollElasticityLayer,
131 const blink::WebLayer* pageScaleLayer,
132 const blink::WebLayer* innerViewportScrollLayer,
133 const blink::WebLayer* outerViewportScrollLayer) override;
avi5c77d212015-09-25 20:08:25134 void clearViewportLayers() override;
135 void registerSelection(const blink::WebSelection& selection) override;
136 void clearSelection() override;
dtapuskaf206a40d2016-02-05 21:36:02137 void setEventListenerProperties(
138 blink::WebEventListenerClass eventClass,
139 blink::WebEventListenerProperties properties) override;
140 blink::WebEventListenerProperties eventListenerProperties(
141 blink::WebEventListenerClass eventClass) const override;
dtapuskaf024e552016-02-03 01:19:46142 void setHaveScrollEventHandlers(bool) override;
143 bool haveScrollEventHandlers() const override;
avi5c77d212015-09-25 20:08:25144 int layerTreeId() const override;
145 void setShowFPSCounter(bool show) override;
146 void setShowPaintRects(bool show) override;
147 void setShowDebugBorders(bool show) override;
148 void setShowScrollBottleneckRects(bool show) override;
aelias6004fe02015-02-07 21:43:01149
avi5c77d212015-09-25 20:08:25150 void updateTopControlsState(blink::WebTopControlsState constraints,
majidvpfb80e432015-02-23 14:15:50151 blink::WebTopControlsState current,
avi5c77d212015-09-25 20:08:25152 bool animate) override;
153 void setTopControlsHeight(float height, bool shrink) override;
154 void setTopControlsShownRatio(float) override;
[email protected]ba91a792013-02-06 09:48:28155
156 // cc::LayerTreeHostClient implementation.
caseq7d2f4c92015-02-04 16:43:27157 void WillBeginMainFrame() override;
dcheng6d18e402014-10-21 12:32:52158 void DidBeginMainFrame() override;
159 void BeginMainFrame(const cc::BeginFrameArgs& args) override;
rmcilroy0a19362a2015-02-18 12:34:25160 void BeginMainFrameNotExpectedSoon() override;
wkorman7265db012015-11-03 04:08:25161 void UpdateLayerTreeHost() override;
miletus7a221752015-02-04 20:44:49162 void ApplyViewportDeltas(const gfx::Vector2dF& inner_delta,
163 const gfx::Vector2dF& outer_delta,
ccameron98be9ac2014-12-09 19:56:32164 const gfx::Vector2dF& elastic_overscroll_delta,
dcheng6d18e402014-10-21 12:32:52165 float page_scale,
166 float top_controls_delta) override;
enne7f8fdde2014-12-10 21:32:09167 void RequestNewOutputSurface() override;
dcheng6d18e402014-10-21 12:32:52168 void DidInitializeOutputSurface() override;
enne7f8fdde2014-12-10 21:32:09169 void DidFailToInitializeOutputSurface() override;
dcheng6d18e402014-10-21 12:32:52170 void WillCommit() override;
171 void DidCommit() override;
172 void DidCommitAndDrawFrame() override;
173 void DidCompleteSwapBuffers() override;
rouslanf7ebd8832015-01-22 01:54:14174 void DidCompletePageScaleAnimation() override;
mpbed24c2c2015-06-05 20:57:13175 void RecordFrameTimingEvents(
176 scoped_ptr<cc::FrameTimingTracker::CompositeTimingSet> composite_events,
177 scoped_ptr<cc::FrameTimingTracker::MainFrameTimingSet> main_frame_events)
178 override;
[email protected]ba91a792013-02-06 09:48:28179
[email protected]943528e2013-11-07 05:01:32180 // cc::LayerTreeHostSingleThreadClient implementation.
danakj53eccbc2016-03-02 22:51:07181 void RequestScheduleAnimation() override;
dcheng6d18e402014-10-21 12:32:52182 void DidPostSwapBuffers() override;
183 void DidAbortSwapBuffers() override;
[email protected]943528e2013-11-07 05:01:32184
dtrainor5ef644e2015-11-19 00:12:47185 // cc::RemoteProtoChannel implementation.
186 void SetProtoReceiver(ProtoReceiver* receiver) override;
187 void SendCompositorProto(const cc::proto::CompositorMessage& proto) override;
188
enne7f8fdde2014-12-10 21:32:09189 enum {
mpbed24c2c2015-06-05 20:57:13190 OUTPUT_SURFACE_RETRIES_BEFORE_FALLBACK = 4,
191 MAX_OUTPUT_SURFACE_RETRIES = 5,
enne7f8fdde2014-12-10 21:32:09192 };
193
194 protected:
fsamuel78f86e42016-01-20 04:10:23195 RenderWidgetCompositor(RenderWidgetCompositorDelegate* delegate,
danakj6e3bf8012014-12-16 18:27:53196 CompositorDependencies* compositor_deps);
[email protected]ba91a792013-02-06 09:48:28197
fsamuel78f86e42016-01-20 04:10:23198 void Initialize(float device_scale_factor);
enne7f8fdde2014-12-10 21:32:09199 cc::LayerTreeHost* layer_tree_host() { return layer_tree_host_.get(); }
200
201 private:
wangxianzhu67d1fae2015-06-30 22:15:53202 void LayoutAndUpdateLayers();
203 void InvokeLayoutAndPaintCallback();
204 bool CompositeIsSynchronous() const;
205 void SynchronouslyComposite();
wangxianzhu372112e2015-05-06 23:01:57206
enne7f8fdde2014-12-10 21:32:09207 int num_failed_recreate_attempts_;
fsamuel78f86e42016-01-20 04:10:23208 RenderWidgetCompositorDelegate* const delegate_;
209 CompositorDependencies* const compositor_deps_;
[email protected]ba91a792013-02-06 09:48:28210 scoped_ptr<cc::LayerTreeHost> layer_tree_host_;
sievers71c62dd52015-10-07 01:44:39211 bool never_visible_;
ernstm50aec922014-08-26 22:16:11212
wangxianzhu372112e2015-05-06 23:01:57213 blink::WebLayoutAndPaintAsyncCallback* layout_and_paint_async_callback_;
enne89e6c3aa2014-10-01 15:07:59214 scoped_ptr<cc::CopyOutputRequest> temporary_copy_output_request_;
215
dtrainor5ef644e2015-11-19 00:12:47216 cc::RemoteProtoChannel::ProtoReceiver* remote_proto_channel_receiver_;
217
enne7f8fdde2014-12-10 21:32:09218 base::WeakPtrFactory<RenderWidgetCompositor> weak_factory_;
[email protected]ba91a792013-02-06 09:48:28219};
220
221} // namespace content
222
223#endif // CONTENT_RENDERER_GPU_RENDER_WIDGET_COMPOSITOR_H_