Add a way to update GraphicsLayerCA visibleRects without having to do a flush
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / GraphicsLayerCA.h
1 /*
2  * Copyright (C) 2010 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 GraphicsLayerCA_h
27 #define GraphicsLayerCA_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "GraphicsLayer.h"
32 #include "Image.h"
33 #include "PlatformCAAnimation.h"
34 #include "PlatformCALayerClient.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/RetainPtr.h>
38 #include <wtf/text/StringHash.h>
39
40 // Enable this to add a light red wash over the visible portion of Tiled Layers, as computed
41 // by flushCompositingState().
42 // #define VISIBLE_TILE_WASH
43
44 namespace WebCore {
45
46 class PlatformCALayer;
47 class TransformState;
48
49 class GraphicsLayerCA : public GraphicsLayer, public PlatformCALayerClient {
50 public:
51     // The width and height of a single tile in a tiled layer. Should be large enough to
52     // avoid lots of small tiles (and therefore lots of drawing callbacks), but small enough
53     // to keep the overall tile cost low.
54     static const int kTiledLayerTileSize = 512;
55
56     GraphicsLayerCA(GraphicsLayerClient*);
57     virtual ~GraphicsLayerCA();
58
59     virtual void setName(const String&);
60
61     virtual PlatformLayer* platformLayer() const;
62     virtual PlatformCALayer* platformCALayer() const { return primaryLayer(); }
63
64     virtual bool setChildren(const Vector<GraphicsLayer*>&);
65     virtual void addChild(GraphicsLayer*);
66     virtual void addChildAtIndex(GraphicsLayer*, int index);
67     virtual void addChildAbove(GraphicsLayer* layer, GraphicsLayer* sibling);
68     virtual void addChildBelow(GraphicsLayer* layer, GraphicsLayer* sibling);
69     virtual bool replaceChild(GraphicsLayer* oldChild, GraphicsLayer* newChild);
70
71     virtual void removeFromParent();
72
73     virtual void setMaskLayer(GraphicsLayer*);
74     virtual void setReplicatedLayer(GraphicsLayer*);
75
76     virtual void setPosition(const FloatPoint&);
77     virtual void setAnchorPoint(const FloatPoint3D&);
78     virtual void setSize(const FloatSize&);
79     virtual void setBoundsOrigin(const FloatPoint&);
80
81     virtual void setTransform(const TransformationMatrix&);
82
83     virtual void setChildrenTransform(const TransformationMatrix&);
84
85     virtual void setPreserves3D(bool);
86     virtual void setMasksToBounds(bool);
87     virtual void setDrawsContent(bool);
88     virtual void setContentsVisible(bool);
89     virtual void setAcceleratesDrawing(bool);
90
91     virtual void setBackgroundColor(const Color&);
92
93     virtual void setContentsOpaque(bool);
94     virtual void setBackfaceVisibility(bool);
95
96     // return true if we started an animation
97     virtual void setOpacity(float);
98
99 #if ENABLE(CSS_FILTERS)
100     virtual bool setFilters(const FilterOperations&);
101 #endif
102
103     virtual void setNeedsDisplay();
104     virtual void setNeedsDisplayInRect(const FloatRect&);
105     virtual void setContentsNeedsDisplay();
106     
107     virtual void setContentsRect(const IntRect&);
108     
109     virtual void suspendAnimations(double time);
110     virtual void resumeAnimations();
111
112     virtual bool addAnimation(const KeyframeValueList&, const IntSize& boxSize, const Animation*, const String& animationName, double timeOffset);
113     virtual void pauseAnimation(const String& animationName, double timeOffset);
114     virtual void removeAnimation(const String& animationName);
115
116     virtual void setContentsToImage(Image*);
117     virtual void setContentsToMedia(PlatformLayer*);
118     virtual void setContentsToCanvas(PlatformLayer*);
119     virtual void setContentsToSolidColor(const Color&);
120
121     virtual bool hasContentsLayer() const { return m_contentsLayer; }
122     
123     virtual void setShowDebugBorder(bool) OVERRIDE;
124     virtual void setShowRepaintCounter(bool) OVERRIDE;
125
126     virtual void setDebugBackgroundColor(const Color&);
127     virtual void setDebugBorder(const Color&, float borderWidth);
128
129     virtual void layerDidDisplay(PlatformLayer*);
130
131     virtual void setMaintainsPixelAlignment(bool);
132     virtual void deviceOrPageScaleFactorChanged();
133
134     struct CommitState {
135         bool ancestorHasTransformAnimation;
136         CommitState()
137             : ancestorHasTransformAnimation(false)
138         { }
139     };
140     void recursiveCommitChanges(const CommitState&, const TransformState&, float pageScaleFactor = 1, const FloatPoint& positionRelativeToBase = FloatPoint(), bool affectedByPageScale = false);
141
142     virtual void flushCompositingState(const FloatRect&);
143     virtual void flushCompositingStateForThisLayerOnly();
144
145     void recursiveComputeVisibleRect(const TransformState&);
146     virtual void recomputeVisibleRects(const FloatRect& clipRect);
147
148     virtual TiledBacking* tiledBacking() const OVERRIDE;
149
150     bool allowTiledLayer() const { return m_allowTiledLayer; }
151     virtual void setAllowTiledLayer(bool b);
152
153 protected:
154     virtual void setOpacityInternal(float);
155
156 private:
157     virtual void willBeDestroyed();
158
159     // PlatformCALayerClient overrides
160     virtual void platformCALayerLayoutSublayersOfLayer(PlatformCALayer*) { }
161     virtual bool platformCALayerRespondsToLayoutChanges() const { return false; }
162
163     virtual void platformCALayerAnimationStarted(CFTimeInterval beginTime);
164     virtual CompositingCoordinatesOrientation platformCALayerContentsOrientation() const { return contentsOrientation(); }
165     virtual void platformCALayerPaintContents(GraphicsContext&, const IntRect& clip);
166     virtual bool platformCALayerShowDebugBorders() const { return isShowingDebugBorder(); }
167     virtual bool platformCALayerShowRepaintCounter(PlatformCALayer*) const;
168     virtual int platformCALayerIncrementRepaintCount() { return incrementRepaintCount(); }
169
170     virtual bool platformCALayerContentsOpaque() const { return contentsOpaque(); }
171     virtual bool platformCALayerDrawsContent() const { return drawsContent(); }
172     virtual void platformCALayerLayerDidDisplay(PlatformLayer* layer) { return layerDidDisplay(layer); }
173     virtual void platformCALayerDidCreateTiles(const Vector<FloatRect>& dirtyRects) OVERRIDE;
174     virtual float platformCALayerDeviceScaleFactor() OVERRIDE;
175
176     virtual double backingStoreMemoryEstimate() const;
177
178     void updateOpacityOnLayer();
179     
180 #if ENABLE(CSS_FILTERS)
181     void updateFilters();
182 #endif
183
184     PlatformCALayer* primaryLayer() const { return m_structuralLayer.get() ? m_structuralLayer.get() : m_layer.get(); }
185     PlatformCALayer* hostLayerForSublayers() const;
186     PlatformCALayer* layerForSuperlayer() const;
187     PlatformCALayer* animatedLayer(AnimatedPropertyID) const;
188
189     typedef String CloneID; // Identifier for a given clone, based on original/replica branching down the tree.
190     static bool isReplicatedRootClone(const CloneID& cloneID) { return cloneID[0U] & 1; }
191
192     typedef HashMap<CloneID, RefPtr<PlatformCALayer> > LayerMap;
193     LayerMap* primaryLayerClones() const { return m_structuralLayer.get() ? m_structuralLayerClones.get() : m_layerClones.get(); }
194     LayerMap* animatedLayerClones(AnimatedPropertyID) const;
195
196     bool createAnimationFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset);
197     bool createTransformAnimationsFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset, const IntSize& boxSize);
198 #if ENABLE(CSS_FILTERS)
199     bool createFilterAnimationsFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset);
200 #endif
201
202     // Return autoreleased animation (use RetainPtr?)
203     PassRefPtr<PlatformCAAnimation> createBasicAnimation(const Animation*, const String& keyPath, bool additive);
204     PassRefPtr<PlatformCAAnimation> createKeyframeAnimation(const Animation*, const String&, bool additive);
205     void setupAnimation(PlatformCAAnimation*, const Animation*, bool additive);
206     
207     const TimingFunction* timingFunctionForAnimationValue(const AnimationValue*, const Animation*);
208     
209     bool setAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*);
210     bool setAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*);
211
212     bool setTransformAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, TransformOperation::OperationType, bool isMatrixAnimation, const IntSize& boxSize);
213     bool setTransformAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, TransformOperation::OperationType, bool isMatrixAnimation, const IntSize& boxSize);
214     
215 #if ENABLE(CSS_FILTERS)
216     bool setFilterAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, int internalFilterPropertyIndex);
217     bool setFilterAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, int internalFilterPropertyIndex, FilterOperation::OperationType);
218 #endif
219
220     bool isRunningTransformAnimation() const;
221
222     bool animationIsRunning(const String& animationName) const
223     {
224         return m_runningAnimations.find(animationName) != m_runningAnimations.end();
225     }
226
227     void commitLayerChangesBeforeSublayers(float pageScaleFactor, const FloatPoint& positionRelativeToBase, const FloatRect& oldVisibleRect);
228     void commitLayerChangesAfterSublayers();
229
230     FloatPoint computePositionRelativeToBase(float& pageScale) const;
231
232     FloatSize constrainedSize() const;
233
234     bool requiresTiledLayer(float pageScaleFactor) const;
235     void swapFromOrToTiledLayer(bool useTiledLayer);
236
237     CompositingCoordinatesOrientation defaultContentsOrientation() const;
238     
239     void setupContentsLayer(PlatformCALayer*);
240     PlatformCALayer* contentsLayer() const { return m_contentsLayer.get(); }
241
242     virtual void setReplicatedByLayer(GraphicsLayer*);
243
244     virtual void getDebugBorderInfo(Color&, float& width) const;
245     virtual void dumpAdditionalProperties(TextStream&, int indent, LayerTreeAsTextBehavior) const;
246
247     void computePixelAlignment(float pixelAlignmentScale, const FloatPoint& positionRelativeToBase,
248         FloatPoint& position, FloatSize&, FloatPoint3D& anchorPoint, FloatSize& alignmentOffset) const;
249     enum ComputeVisibleRectFlag { RespectAnimatingTransforms = 1 << 0 };
250     typedef unsigned ComputeVisibleRectFlags;
251     FloatRect computeVisibleRect(TransformState&, ComputeVisibleRectFlags = RespectAnimatingTransforms) const;
252     const FloatRect& visibleRect() const { return m_visibleRect; }
253     
254     FloatRect adjustTiledLayerVisibleRect(TiledBacking*, const FloatRect& oldVisibleRect, const FloatSize& oldSize) const;
255
256     // Used to track the path down the tree for replica layers.
257     struct ReplicaState {
258         static const size_t maxReplicaDepth = 16;
259         enum ReplicaBranchType { ChildBranch = 0, ReplicaBranch = 1 };
260         ReplicaState(ReplicaBranchType firstBranch)
261             : m_replicaDepth(0)
262         {
263             push(firstBranch);
264         }
265         
266         // Called as we walk down the tree to build replicas.
267         void push(ReplicaBranchType branchType)
268         {
269             m_replicaBranches.append(branchType);
270             if (branchType == ReplicaBranch)
271                 ++m_replicaDepth;
272         }
273         
274         void setBranchType(ReplicaBranchType branchType)
275         {
276             ASSERT(!m_replicaBranches.isEmpty());
277
278             if (m_replicaBranches.last() != branchType) {
279                 if (branchType == ReplicaBranch)
280                     ++m_replicaDepth;
281                 else
282                     --m_replicaDepth;
283             }
284
285             m_replicaBranches.last() = branchType;
286         }
287
288         void pop()
289         {
290             if (m_replicaBranches.last() == ReplicaBranch)
291                 --m_replicaDepth;
292             m_replicaBranches.removeLast();
293         }
294         
295         size_t depth() const { return m_replicaBranches.size(); }
296         size_t replicaDepth() const { return m_replicaDepth; }
297
298         CloneID cloneID() const;        
299
300     private:
301         Vector<ReplicaBranchType> m_replicaBranches;
302         size_t m_replicaDepth;
303     };
304     PassRefPtr<PlatformCALayer>replicatedLayerRoot(ReplicaState&);
305
306     enum CloneLevel { RootCloneLevel, IntermediateCloneLevel };
307     PassRefPtr<PlatformCALayer> fetchCloneLayers(GraphicsLayer* replicaRoot, ReplicaState&, CloneLevel);
308     
309     PassRefPtr<PlatformCALayer> cloneLayer(PlatformCALayer *, CloneLevel);
310     PassRefPtr<PlatformCALayer> findOrMakeClone(CloneID, PlatformCALayer *, LayerMap*, CloneLevel);
311
312     void ensureCloneLayers(CloneID cloneID, RefPtr<PlatformCALayer>& primaryLayer, RefPtr<PlatformCALayer>& structuralLayer, RefPtr<PlatformCALayer>& contentsLayer, CloneLevel cloneLevel);
313
314     bool hasCloneLayers() const { return m_layerClones; }
315     void removeCloneLayers();
316     FloatPoint positionForCloneRootLayer() const;
317     
318     void propagateLayerChangeToReplicas();
319     
320     // All these "update" methods will be called inside a BEGIN_BLOCK_OBJC_EXCEPTIONS/END_BLOCK_OBJC_EXCEPTIONS block.
321     void updateLayerNames();
322     void updateSublayerList();
323     void updateGeometry(float pixelAlignmentScale, const FloatPoint& positionRelativeToBase);
324     void updateTransform();
325     void updateChildrenTransform();
326     void updateMasksToBounds();
327     void updateContentsVisibility();
328     void updateContentsOpaque();
329     void updateBackfaceVisibility();
330     void updateStructuralLayer();
331     void updateLayerDrawsContent(float pixelAlignmentScale);
332     void updateBackgroundColor();
333
334     void updateContentsImage();
335     void updateContentsMediaLayer();
336     void updateContentsCanvasLayer();
337     void updateContentsColorLayer();
338     void updateContentsRect();
339     void updateMaskLayer();
340     void updateReplicatedLayers();
341
342     void updateAnimations();
343     void updateContentsNeedsDisplay();
344     void updateAcceleratesDrawing();
345     void updateDebugBorder();
346     void updateVisibleRect(const FloatRect& oldVisibleRect);
347     void updateContentsScale(float pageScaleFactor);
348     
349     enum StructuralLayerPurpose {
350         NoStructuralLayer = 0,
351         StructuralLayerForPreserves3D,
352         StructuralLayerForReplicaFlattening
353     };
354     void ensureStructuralLayer(StructuralLayerPurpose);
355     StructuralLayerPurpose structuralLayerPurpose() const;
356
357     void setAnimationOnLayer(PlatformCAAnimation*, AnimatedPropertyID, const String& animationName, int index, int subIndex, double timeOffset);
358     bool removeCAAnimationFromLayer(AnimatedPropertyID, const String& animationName, int index, int subINdex);
359     void pauseCAAnimationOnLayer(AnimatedPropertyID, const String& animationName, int index, int subIndex, double timeOffset);
360
361     enum MoveOrCopy { Move, Copy };
362     static void moveOrCopyLayerAnimation(MoveOrCopy, const String& animationIdentifier, PlatformCALayer *fromLayer, PlatformCALayer *toLayer);
363     void moveOrCopyAnimations(MoveOrCopy, PlatformCALayer * fromLayer, PlatformCALayer * toLayer);
364     
365     bool appendToUncommittedAnimations(const KeyframeValueList&, const TransformOperations*, const Animation*, const String& animationName, const IntSize& boxSize, int animationIndex, double timeOffset, bool isMatrixAnimation);
366 #if ENABLE(CSS_FILTERS)
367     bool appendToUncommittedAnimations(const KeyframeValueList&, const FilterOperation*, const Animation*, const String& animationName, int animationIndex, double timeOffset);
368 #endif
369     
370     enum LayerChange {
371         NoChange = 0,
372         NameChanged = 1 << 1,
373         ChildrenChanged = 1 << 2, // also used for content layer, and preserves-3d, and size if tiling changes?
374         GeometryChanged = 1 << 3,
375         TransformChanged = 1 << 4,
376         ChildrenTransformChanged = 1 << 5,
377         Preserves3DChanged = 1 << 6,
378         MasksToBoundsChanged = 1 << 7,
379         DrawsContentChanged = 1 << 8,
380         BackgroundColorChanged = 1 << 9,
381         ContentsOpaqueChanged = 1 << 10,
382         BackfaceVisibilityChanged = 1 << 11,
383         OpacityChanged = 1 << 12,
384         AnimationChanged = 1 << 13,
385         DirtyRectsChanged = 1 << 14,
386         ContentsImageChanged = 1 << 15,
387         ContentsMediaLayerChanged = 1 << 16,
388         ContentsCanvasLayerChanged = 1 << 17,
389         ContentsColorLayerChanged = 1 << 18,
390         ContentsRectChanged = 1 << 19,
391         MaskLayerChanged = 1 << 20,
392         ReplicatedLayerChanged = 1 << 21,
393         ContentsNeedsDisplay = 1 << 22,
394         AcceleratesDrawingChanged = 1 << 23,
395         ContentsScaleChanged = 1 << 24,
396         ContentsVisibilityChanged = 1 << 25,
397         VisibleRectChanged = 1 << 26,
398         FiltersChanged = 1 << 27,
399         DebugIndicatorsChanged = 1 << 28
400     };
401     typedef unsigned LayerChangeFlags;
402     void noteLayerPropertyChanged(LayerChangeFlags flags);
403     void noteSublayersChanged();
404     void noteChangesForScaleSensitiveProperties();
405
406     void repaintLayerDirtyRects();
407
408     RefPtr<PlatformCALayer> m_layer; // The main layer
409     RefPtr<PlatformCALayer> m_structuralLayer; // A layer used for structural reasons, like preserves-3d or replica-flattening. Is the parent of m_layer.
410     RefPtr<PlatformCALayer> m_contentsLayer; // A layer used for inner content, like image and video
411
412     // References to clones of our layers, for replicated layers.
413     OwnPtr<LayerMap> m_layerClones;
414     OwnPtr<LayerMap> m_structuralLayerClones;
415     OwnPtr<LayerMap> m_contentsLayerClones;
416
417 #ifdef VISIBLE_TILE_WASH
418     RefPtr<PlatformCALayer> m_visibleTileWashLayer;
419 #endif
420     FloatRect m_visibleRect;
421     FloatSize m_sizeAtLastVisibleRectUpdate;
422     
423     enum ContentsLayerPurpose {
424         NoContentsLayer = 0,
425         ContentsLayerForImage,
426         ContentsLayerForMedia,
427         ContentsLayerForCanvas,
428         ContentsLayerForBackgroundColor
429     };
430     
431     ContentsLayerPurpose m_contentsLayerPurpose;
432     bool m_allowTiledLayer : 1;
433     bool m_isPageTiledBackingLayer : 1;
434     
435     Color m_contentsSolidColor;
436
437     RetainPtr<CGImageRef> m_uncorrectedContentsImage;
438     RetainPtr<CGImageRef> m_pendingContentsImage;
439     
440     // This represents the animation of a single property. There may be multiple transform animations for
441     // a single transition or keyframe animation, so index is used to distinguish these.
442     struct LayerPropertyAnimation {
443         LayerPropertyAnimation(PassRefPtr<PlatformCAAnimation> caAnimation, const String& animationName, AnimatedPropertyID property, int index, int subIndex, double timeOffset)
444         : m_animation(caAnimation)
445         , m_name(animationName)
446         , m_property(property)
447         , m_index(index)
448         , m_subIndex(subIndex)
449         , m_timeOffset(timeOffset)
450         { }
451
452         RefPtr<PlatformCAAnimation> m_animation;
453         String m_name;
454         AnimatedPropertyID m_property;
455         int m_index;
456         int m_subIndex;
457         double m_timeOffset;
458     };
459     
460     // Uncommitted transitions and animations.
461     Vector<LayerPropertyAnimation> m_uncomittedAnimations;
462     
463     enum Action { Remove, Pause };
464     struct AnimationProcessingAction {
465         AnimationProcessingAction(Action action = Remove, double timeOffset = 0)
466             : action(action)
467             , timeOffset(timeOffset)
468         {
469         }
470         Action action;
471         double timeOffset; // only used for pause
472     };
473     typedef HashMap<String, AnimationProcessingAction> AnimationsToProcessMap;
474     AnimationsToProcessMap m_animationsToProcess;
475
476     // Map of animation names to their associated lists of property animations, so we can remove/pause them.
477     typedef HashMap<String, Vector<LayerPropertyAnimation> > AnimationsMap;
478     AnimationsMap m_runningAnimations;
479
480     Vector<FloatRect> m_dirtyRects;
481     FloatSize m_pixelAlignmentOffset;
482     
483     LayerChangeFlags m_uncommittedChanges;
484 };
485
486 } // namespace WebCore
487
488
489 #endif // USE(ACCELERATED_COMPOSITING)
490
491 #endif // GraphicsLayerCA_h