[chromium] Canvas2D should rate-limit drawing to prevent swamping the GPU process.
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCLayerTreeHost.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1.  Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef CCLayerTreeHost_h
26 #define CCLayerTreeHost_h
27
28 #include "GraphicsTypes3D.h"
29 #include "IntRect.h"
30 #include "RateLimiter.h"
31 #include "TransformationMatrix.h"
32 #include "cc/CCLayerTreeHostCommon.h"
33 #include "cc/CCProxy.h"
34
35 #include <wtf/HashMap.h>
36 #include <wtf/PassOwnPtr.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39
40 #if USE(SKIA)
41 class GrContext;
42 #endif
43
44 namespace WebCore {
45
46 class CCLayerTreeHostImpl;
47 class CCTextureUpdater;
48 class GraphicsContext3D;
49 class LayerChromium;
50 class LayerPainterChromium;
51 class TextureAllocator;
52 class TextureManager;
53
54 class CCLayerTreeHostClient {
55 public:
56     virtual void animateAndLayout(double frameBeginTime) = 0;
57     virtual void applyScrollDelta(const IntSize&) = 0;
58     virtual PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D() = 0;
59     virtual void didRecreateGraphicsContext(bool success) = 0;
60
61     // Used only in the single-threaded path.
62     virtual void scheduleComposite() = 0;
63
64 protected:
65     virtual ~CCLayerTreeHostClient() { }
66 };
67
68 struct CCSettings {
69     CCSettings()
70             : acceleratePainting(false)
71             , compositeOffscreen(false)
72             , enableCompositorThread(false)
73             , showFPSCounter(false)
74             , showPlatformLayerTree(false) { }
75
76     bool acceleratePainting;
77     bool compositeOffscreen;
78     bool enableCompositorThread;
79     bool showFPSCounter;
80     bool showPlatformLayerTree;
81 };
82
83 // Provides information on an Impl's rendering capabilities back to the CCLayerTreeHost
84 struct LayerRendererCapabilities {
85     LayerRendererCapabilities()
86         : bestTextureFormat(0)
87         , usingMapSub(false)
88         , usingAcceleratedPainting(false)
89         , usingSetVisibility(false)
90         , usingSwapCompleteCallback(false)
91         , maxTextureSize(0) { }
92
93     GC3Denum bestTextureFormat;
94     bool usingMapSub;
95     bool usingAcceleratedPainting;
96     bool usingSetVisibility;
97     bool usingSwapCompleteCallback;
98     int maxTextureSize;
99 };
100
101 class CCLayerTreeHost : public RefCounted<CCLayerTreeHost> {
102 public:
103     static PassRefPtr<CCLayerTreeHost> create(CCLayerTreeHostClient*, PassRefPtr<LayerChromium> rootLayer, const CCSettings&);
104     virtual ~CCLayerTreeHost();
105
106     // CCLayerTreeHost interface to CCProxy.
107     void animateAndLayout(double frameBeginTime);
108     void beginCommitOnImplThread(CCLayerTreeHostImpl*);
109     void finishCommitOnImplThread(CCLayerTreeHostImpl*);
110     void commitComplete();
111     PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D();
112     virtual PassOwnPtr<CCLayerTreeHostImpl> createLayerTreeHostImpl(CCLayerTreeHostImplClient*);
113     void didRecreateGraphicsContext(bool success);
114     void deleteContentsTexturesOnImplThread(TextureAllocator*);
115
116     // CCLayerTreeHost interface to WebView.
117     bool animating() const { return m_animating; }
118     void setAnimating(bool animating) { m_animating = animating; } // Can be removed when non-threaded scheduling moves inside.
119
120     CCLayerTreeHostClient* client() { return m_client; }
121
122     int compositorIdentifier() const { return m_compositorIdentifier; }
123
124     // Only used when compositing on the main thread.
125     void composite();
126
127     GraphicsContext3D* context();
128
129     // Composites and attempts to read back the result into the provided
130     // buffer. If it wasn't possible, e.g. due to context lost, will return
131     // false.
132     bool compositeAndReadback(void *pixels, const IntRect&);
133
134     void finishAllRendering();
135
136     int frameNumber() const { return m_frameNumber; }
137
138     void setZoomAnimatorTransform(const TransformationMatrix&);
139
140     const LayerRendererCapabilities& layerRendererCapabilities() const;
141
142     // Test-only hook
143     void loseCompositorContext(int numTimes);
144
145     void setNeedsAnimate();
146     void setNeedsCommitThenRedraw();
147     void setNeedsRedraw();
148
149     LayerChromium* rootLayer() { return m_rootLayer.get(); }
150     const LayerChromium* rootLayer() const { return m_rootLayer.get(); }
151
152     const CCSettings& settings() const { return m_settings; }
153
154     void setViewport(const IntSize& viewportSize);
155
156     const IntSize& viewportSize() const { return m_viewportSize; }
157     TextureManager* contentsTextureManager() const;
158
159     void setVisible(bool);
160
161     void updateLayers();
162
163     void updateCompositorResources(GraphicsContext3D*, CCTextureUpdater&);
164     void applyScrollDeltas(const CCScrollUpdateSet&);
165     void startRateLimiter(GraphicsContext3D*);
166     void stopRateLimiter(GraphicsContext3D*);
167 protected:
168     CCLayerTreeHost(CCLayerTreeHostClient*, PassRefPtr<LayerChromium> rootLayer, const CCSettings&);
169     bool initialize();
170
171 private:
172     typedef Vector<RefPtr<LayerChromium> > LayerList;
173
174     void paintLayerContents(const LayerList&);
175     void paintMaskAndReplicaForRenderSurface(LayerChromium*);
176
177     void updateLayers(LayerChromium*);
178     void updateCompositorResources(LayerChromium*, GraphicsContext3D*, CCTextureUpdater&);
179     void clearPendingUpdate();
180
181     int m_compositorIdentifier;
182
183     bool m_animating;
184
185     CCLayerTreeHostClient* m_client;
186
187     int m_frameNumber;
188
189     OwnPtr<CCProxy> m_proxy;
190
191     RefPtr<LayerChromium> m_rootLayer;
192     OwnPtr<TextureManager> m_contentsTextureManager;
193
194     LayerList m_updateList;
195
196     CCSettings m_settings;
197
198     IntSize m_viewportSize;
199     TransformationMatrix m_zoomAnimatorTransform;
200     bool m_visible;
201     typedef HashMap<GraphicsContext3D*, RefPtr<RateLimiter> > RateLimiterMap;
202     RateLimiterMap m_rateLimiters;
203 };
204
205 }
206
207 #endif