c4b7e3bcda86498fe2743e754a2cb53eb1256f72
[WebKit-https.git] / Source / WebCore / rendering / RenderLayerCompositor.h
1 /*
2  * Copyright (C) 2009 Apple 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef RenderLayerCompositor_h
27 #define RenderLayerCompositor_h
28
29 #include "ChromeClient.h"
30 #include "Frame.h"
31 #include "GraphicsLayerUpdater.h"
32 #include "RenderLayer.h"
33 #include "RenderLayerBacking.h"
34 #include <wtf/HashMap.h>
35
36 namespace WebCore {
37
38 class FixedPositionViewportConstraints;
39 class GraphicsLayer;
40 class GraphicsLayerUpdater;
41 class RenderEmbeddedObject;
42 class RenderPart;
43 class ScrollingCoordinator;
44 class StickyPositionViewportConstraints;
45 #if ENABLE(VIDEO)
46 class RenderVideo;
47 #endif
48 class TiledBacking;
49
50 enum CompositingUpdateType {
51     CompositingUpdateAfterStyleChange,
52     CompositingUpdateAfterLayout,
53     CompositingUpdateOnHitTest,
54     CompositingUpdateOnScroll
55 };
56
57 // RenderLayerCompositor manages the hierarchy of
58 // composited RenderLayers. It determines which RenderLayers
59 // become compositing, and creates and maintains a hierarchy of
60 // GraphicsLayers based on the RenderLayer painting order.
61 // 
62 // There is one RenderLayerCompositor per RenderView.
63
64 class RenderLayerCompositor : public GraphicsLayerClient, public GraphicsLayerUpdaterClient {
65     WTF_MAKE_FAST_ALLOCATED;
66 public:
67     RenderLayerCompositor(RenderView*);
68     ~RenderLayerCompositor();
69
70     // Return true if this RenderView is in "compositing mode" (i.e. has one or more
71     // composited RenderLayers)
72     bool inCompositingMode() const { return m_compositing; }
73     // This will make a compositing layer at the root automatically, and hook up to
74     // the native view/window system.
75     void enableCompositingMode(bool enable = true);
76
77     bool inForcedCompositingMode() const { return m_forceCompositingMode; }
78
79     // Returns true if the accelerated compositing is enabled
80     bool hasAcceleratedCompositing() const { return m_hasAcceleratedCompositing; }
81
82     bool canRender3DTransforms() const;
83
84     // Copy the accelerated compositing related flags from Settings
85     void cacheAcceleratedCompositingFlags();
86
87     // Called when the layer hierarchy needs to be updated (compositing layers have been
88     // created, destroyed or re-parented).
89     void setCompositingLayersNeedRebuild(bool needRebuild = true);
90     bool compositingLayersNeedRebuild() const { return m_compositingLayersNeedRebuild; }
91
92     // Controls whether or not to consult geometry when deciding which layers need
93     // to be composited. Defaults to true.
94     void setCompositingConsultsOverlap(bool b) { m_compositingConsultsOverlap = b; }
95     bool compositingConsultsOverlap() const { return m_compositingConsultsOverlap; }
96     
97     // GraphicsLayers buffer state, which gets pushed to the underlying platform layers
98     // at specific times.
99     void scheduleLayerFlush();
100     void flushPendingLayerChanges(bool isFlushRoot = true);
101     
102     // flushPendingLayerChanges() flushes the entire GraphicsLayer tree, which can cross frame boundaries.
103     // This call returns the rootmost compositor that is being flushed (including self).
104     RenderLayerCompositor* enclosingCompositorFlushingLayers() const;
105
106     // Called when the GraphicsLayer for the given RenderLayer has flushed changes inside of flushPendingLayerChanges().
107     void didFlushChangesForLayer(RenderLayer*);
108     
109     // Rebuild the tree of compositing layers
110     void updateCompositingLayers(CompositingUpdateType, RenderLayer* updateRoot = 0);
111     // This is only used when state changes and we do not exepect a style update or layout to happen soon (e.g. when
112     // we discover that an iframe is overlapped during painting).
113     void scheduleCompositingLayerUpdate();
114     
115     // Update the compositing state of the given layer. Returns true if that state changed.
116     enum CompositingChangeRepaint { CompositingChangeRepaintNow, CompositingChangeWillRepaintLater };
117     bool updateLayerCompositingState(RenderLayer*, CompositingChangeRepaint = CompositingChangeRepaintNow);
118
119     // Update the geometry for compositing children of compositingAncestor.
120     void updateCompositingDescendantGeometry(RenderLayer* compositingAncestor, RenderLayer* layer, RenderLayerBacking::UpdateDepth);
121     
122     // Whether layer's backing needs a graphics layer to do clipping by an ancestor (non-stacking-context parent with overflow).
123     bool clippedByAncestor(RenderLayer*) const;
124     // Whether layer's backing needs a graphics layer to clip z-order children of the given layer.
125     bool clipsCompositingDescendants(const RenderLayer*) const;
126
127     // Whether the layer is fixed positioned to the view by an ancestor layer.
128     bool fixedPositionedByAncestor(const RenderLayer*) const;
129
130     // Whether the given layer needs an extra 'contents' layer.
131     bool needsContentsCompositingLayer(const RenderLayer*) const;
132     // Return the bounding box required for compositing layer and its childern, relative to ancestorLayer.
133     // If layerBoundingBox is not 0, on return it contains the bounding box of this layer only.
134     IntRect calculateCompositedBounds(const RenderLayer*, const RenderLayer* ancestorLayer) const;
135
136     // Repaint the appropriate layers when the given RenderLayer starts or stops being composited.
137     void repaintOnCompositingChange(RenderLayer*);
138     
139     void repaintInCompositedAncestor(RenderLayer*, const LayoutRect&);
140     
141     // Notify us that a layer has been added or removed
142     void layerWasAdded(RenderLayer* parent, RenderLayer* child);
143     void layerWillBeRemoved(RenderLayer* parent, RenderLayer* child);
144
145     // Get the nearest ancestor layer that has overflow or clip, but is not a stacking context
146     RenderLayer* enclosingNonStackingClippingLayer(const RenderLayer* layer) const;
147
148     // Repaint parts of all composited layers that intersect the given absolute rectangle (or the entire layer if the pointer is null).
149     void repaintCompositedLayers(const IntRect* = 0);
150
151     // Returns true if the given layer needs it own backing store.
152     bool requiresOwnBackingStore(const RenderLayer*, const RenderLayer* compositingAncestorLayer) const;
153
154     RenderLayer* rootRenderLayer() const;
155     GraphicsLayer* rootGraphicsLayer() const;
156     GraphicsLayer* scrollLayer() const;
157
158     enum RootLayerAttachment {
159         RootLayerUnattached,
160         RootLayerAttachedViaChromeClient,
161         RootLayerAttachedViaEnclosingFrame
162     };
163
164     RootLayerAttachment rootLayerAttachment() const { return m_rootLayerAttachment; }
165     void updateRootLayerAttachment();
166     void updateRootLayerPosition();
167     
168     void didMoveOnscreen();
169     void willMoveOffscreen();
170
171     void clearBackingForAllLayers();
172     
173     void layerBecameComposited(const RenderLayer*) { ++m_compositedLayerCount; }
174     void layerBecameNonComposited(const RenderLayer*);
175     
176 #if ENABLE(VIDEO)
177     // Use by RenderVideo to ask if it should try to use accelerated compositing.
178     bool canAccelerateVideoRendering(RenderVideo*) const;
179 #endif
180
181     // Walk the tree looking for layers with 3d transforms. Useful in case you need
182     // to know if there is non-affine content, e.g. for drawing into an image.
183     bool has3DContent() const;
184     
185     // Most platforms connect compositing layer trees between iframes and their parent document.
186     // Some (currently just Mac) allow iframes to do their own compositing.
187     static bool allowsIndependentlyCompositedFrames(const FrameView*);
188     bool shouldPropagateCompositingToEnclosingFrame() const;
189
190     static RenderLayerCompositor* frameContentsCompositor(RenderPart*);
191     // Return true if the layers changed.
192     static bool parentFrameContentLayers(RenderPart*);
193
194     // Update the geometry of the layers used for clipping and scrolling in frames.
195     void frameViewDidChangeLocation(const IntPoint& contentsOffset);
196     void frameViewDidChangeSize();
197     void frameViewDidScroll();
198     void frameViewDidLayout();
199
200     void scrollingLayerDidChange(RenderLayer*);
201
202     String layerTreeAsText(LayerTreeFlags);
203
204     virtual float deviceScaleFactor() const OVERRIDE;
205     virtual float pageScaleFactor() const OVERRIDE;
206     virtual void didCommitChangesForLayer(const GraphicsLayer*) const OVERRIDE;
207     virtual void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) OVERRIDE;
208     
209     bool keepLayersPixelAligned() const;
210     bool acceleratedDrawingEnabled() const { return m_acceleratedDrawingEnabled; }
211
212     void deviceOrPageScaleFactorChanged();
213
214     void windowScreenDidChange(PlatformDisplayID);
215
216     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
217     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
218     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
219 #if ENABLE(RUBBER_BANDING)
220     GraphicsLayer* layerForOverhangAreas() const { return m_layerForOverhangAreas.get(); }
221 #endif
222
223     void updateViewportConstraintStatus(RenderLayer*);
224     void removeViewportConstrainedLayer(RenderLayer*);
225
226     void resetTrackedRepaintRects();
227     void setTracksRepaints(bool);
228
229     void reportMemoryUsage(MemoryObjectInfo*) const;
230
231     enum FixedPositionLayerNotCompositedReason {
232         NoReason,
233         LayerBoundsOutOfView,
234         DescendantOfTransformedElement,
235     };
236
237     FixedPositionLayerNotCompositedReason fixedPositionLayerNotCompositedReason(const RenderLayer* layer) const { return m_fixedPositionLayerNotCompositedReasonMap.get(layer); }
238
239 private:
240     class OverlapMap;
241
242     // GraphicsLayerClient implementation
243     virtual void notifyAnimationStarted(const GraphicsLayer*, double) OVERRIDE { }
244     virtual void notifyFlushRequired(const GraphicsLayer*) OVERRIDE { scheduleLayerFlush(); }
245     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect&) OVERRIDE;
246
247     virtual bool isTrackingRepaints() const OVERRIDE;
248     
249     // GraphicsLayerUpdaterClient implementation
250     virtual void flushLayers(GraphicsLayerUpdater*) OVERRIDE;
251     
252     // Whether the given RL needs a compositing layer.
253     bool needsToBeComposited(const RenderLayer*, FixedPositionLayerNotCompositedReason* = 0) const;
254     // Whether the layer has an intrinsic need for compositing layer.
255     bool requiresCompositingLayer(const RenderLayer*, FixedPositionLayerNotCompositedReason* = 0) const;
256     // Whether the layer could ever be composited.
257     bool canBeComposited(const RenderLayer*) const;
258
259     // Make or destroy the backing for this layer; returns true if backing changed.
260     bool updateBacking(RenderLayer*, CompositingChangeRepaint shouldRepaint);
261
262     void clearBackingForLayerIncludingDescendants(RenderLayer*);
263
264     // Repaint the given rect (which is layer's coords), and regions of child layers that intersect that rect.
265     void recursiveRepaintLayer(RenderLayer*, const IntRect* = 0);
266
267     void addToOverlapMap(OverlapMap&, RenderLayer*, IntRect& layerBounds, bool& boundsComputed);
268     void addToOverlapMapRecursive(OverlapMap&, RenderLayer*, RenderLayer* ancestorLayer = 0);
269
270     void updateCompositingLayersTimerFired(Timer<RenderLayerCompositor>*);
271
272     // Returns true if any layer's compositing changed
273     void computeCompositingRequirements(RenderLayer* ancestorLayer, RenderLayer*, OverlapMap*, struct CompositingState&, bool& layersChanged, bool& descendantHas3DTransform);
274     
275     // Recurses down the tree, parenting descendant compositing layers and collecting an array of child layers for the current compositing layer.
276     void rebuildCompositingLayerTree(RenderLayer*, Vector<GraphicsLayer*>& childGraphicsLayersOfEnclosingLayer, int depth);
277
278     // Recurses down the tree, updating layer geometry only.
279     void updateLayerTreeGeometry(RenderLayer*, int depth);
280     
281     // Hook compositing layers together
282     void setCompositingParent(RenderLayer* childLayer, RenderLayer* parentLayer);
283     void removeCompositedChildren(RenderLayer*);
284
285     bool layerHas3DContent(const RenderLayer*) const;
286     bool isRunningAcceleratedTransformAnimation(RenderObject*) const;
287
288     bool hasAnyAdditionalCompositedLayers(const RenderLayer* rootLayer) const;
289
290     void ensureRootLayer();
291     void destroyRootLayer();
292
293     void attachRootLayer(RootLayerAttachment);
294     void detachRootLayer();
295     
296     void rootLayerAttachmentChanged();
297
298     void updateOverflowControlsLayers();
299
300     void notifyIFramesOfCompositingChange();
301
302     bool isFlushingLayers() const { return m_flushingLayers; }
303     
304     Page* page() const;
305     TiledBacking* pageTiledBacking() const;
306
307     GraphicsLayerFactory* graphicsLayerFactory() const;
308     ScrollingCoordinator* scrollingCoordinator() const;
309
310     // Whether a running transition or animation enforces the need for a compositing layer.
311     bool requiresCompositingForAnimation(RenderObject*) const;
312     bool requiresCompositingForTransform(RenderObject*) const;
313     bool requiresCompositingForVideo(RenderObject*) const;
314     bool requiresCompositingForCanvas(RenderObject*) const;
315     bool requiresCompositingForPlugin(RenderObject*) const;
316     bool requiresCompositingForFrame(RenderObject*) const;
317     bool requiresCompositingForFilters(RenderObject*) const;
318     bool requiresCompositingForBlending(RenderObject* renderer) const;
319     bool requiresCompositingForScrollableFrame() const;
320     bool requiresCompositingForPosition(RenderObject*, const RenderLayer*, FixedPositionLayerNotCompositedReason* = 0) const;
321     bool requiresCompositingForOverflowScrolling(const RenderLayer*) const;
322     bool requiresCompositingForIndirectReason(RenderObject*, bool hasCompositedDescendants, bool has3DTransformedDescendants, RenderLayer::IndirectCompositingReason&) const;
323
324     void addViewportConstrainedLayer(RenderLayer*);
325     void registerOrUpdateViewportConstrainedLayer(RenderLayer*);
326     void unregisterViewportConstrainedLayer(RenderLayer*);
327
328     const FixedPositionViewportConstraints computeFixedViewportConstraints(RenderLayer*);
329     const StickyPositionViewportConstraints computeStickyViewportConstraints(RenderLayer*);
330
331     bool requiresScrollLayer(RootLayerAttachment) const;
332     bool requiresHorizontalScrollbarLayer() const;
333     bool requiresVerticalScrollbarLayer() const;
334     bool requiresScrollCornerLayer() const;
335 #if ENABLE(RUBBER_BANDING)
336     bool requiresOverhangAreasLayer() const;
337     bool requiresContentShadowLayer() const;
338 #endif
339
340 #if !LOG_DISABLED
341     const char* reasonForCompositing(const RenderLayer*);
342     void logLayerInfo(const RenderLayer*, int depth);
343 #endif
344
345 private:
346     RenderView* m_renderView;
347     OwnPtr<GraphicsLayer> m_rootContentLayer;
348     Timer<RenderLayerCompositor> m_updateCompositingLayersTimer;
349
350     bool m_hasAcceleratedCompositing;
351     ChromeClient::CompositingTriggerFlags m_compositingTriggers;
352
353     int m_compositedLayerCount;
354     bool m_showDebugBorders;
355     bool m_showRepaintCounter;
356     bool m_acceleratedDrawingEnabled;
357     bool m_compositingConsultsOverlap;
358
359     // When true, we have to wait until layout has happened before we can decide whether to enter compositing mode,
360     // because only then do we know the final size of plugins and iframes.
361     mutable bool m_reevaluateCompositingAfterLayout;
362
363     bool m_compositing;
364     bool m_compositingLayersNeedRebuild;
365     bool m_flushingLayers;
366     bool m_shouldFlushOnReattach;
367     bool m_forceCompositingMode;
368
369     bool m_isTrackingRepaints; // Used for testing.
370
371     RootLayerAttachment m_rootLayerAttachment;
372
373     // Enclosing clipping layer for iframe content
374     OwnPtr<GraphicsLayer> m_clipLayer;
375     OwnPtr<GraphicsLayer> m_scrollLayer;
376
377     HashSet<RenderLayer*> m_viewportConstrainedLayers;
378     HashSet<RenderLayer*> m_viewportConstrainedLayersNeedingUpdate;
379
380     // Enclosing layer for overflow controls and the clipping layer
381     OwnPtr<GraphicsLayer> m_overflowControlsHostLayer;
382
383     // Layers for overflow controls
384     OwnPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
385     OwnPtr<GraphicsLayer> m_layerForVerticalScrollbar;
386     OwnPtr<GraphicsLayer> m_layerForScrollCorner;
387 #if ENABLE(RUBBER_BANDING)
388     OwnPtr<GraphicsLayer> m_layerForOverhangAreas;
389     OwnPtr<GraphicsLayer> m_contentShadowLayer;
390 #endif
391
392     OwnPtr<GraphicsLayerUpdater> m_layerUpdater; // Updates tiled layer visible area periodically while animations are running.
393
394 #if !LOG_DISABLED
395     int m_rootLayerUpdateCount;
396     int m_obligateCompositedLayerCount; // count of layer that have to be composited.
397     int m_secondaryCompositedLayerCount; // count of layers that have to be composited because of stacking or overlap.
398     double m_obligatoryBackingStoreBytes;
399     double m_secondaryBackingStoreBytes;
400 #endif
401
402     typedef HashMap<const RenderLayer*, FixedPositionLayerNotCompositedReason> FixedPositionLayerNotCompositedReasonMap;
403     FixedPositionLayerNotCompositedReasonMap m_fixedPositionLayerNotCompositedReasonMap;
404 };
405
406
407 } // namespace WebCore
408
409 #endif // RenderLayerCompositor_h