2aaf6a99b222f31ecf5bbcc141bd680faf18c66d
[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     virtual TiledBacking* tiledBacking() const OVERRIDE;
146
147     bool allowTiledLayer() const { return m_allowTiledLayer; }
148     virtual void setAllowTiledLayer(bool b);
149
150 protected:
151     virtual void setOpacityInternal(float);
152
153 private:
154     virtual void willBeDestroyed();
155
156     // PlatformCALayerClient overrides
157     virtual void platformCALayerLayoutSublayersOfLayer(PlatformCALayer*) { }
158     virtual bool platformCALayerRespondsToLayoutChanges() const { return false; }
159
160     virtual void platformCALayerAnimationStarted(CFTimeInterval beginTime);
161     virtual CompositingCoordinatesOrientation platformCALayerContentsOrientation() const { return contentsOrientation(); }
162     virtual void platformCALayerPaintContents(GraphicsContext&, const IntRect& clip);
163     virtual bool platformCALayerShowDebugBorders() const { return isShowingDebugBorder(); }
164     virtual bool platformCALayerShowRepaintCounter(PlatformCALayer*) const;
165     virtual int platformCALayerIncrementRepaintCount() { return incrementRepaintCount(); }
166
167     virtual bool platformCALayerContentsOpaque() const { return contentsOpaque(); }
168     virtual bool platformCALayerDrawsContent() const { return drawsContent(); }
169     virtual void platformCALayerLayerDidDisplay(PlatformLayer* layer) { return layerDidDisplay(layer); }
170     virtual void platformCALayerDidCreateTiles(const Vector<FloatRect>& dirtyRects) OVERRIDE;
171     virtual float platformCALayerDeviceScaleFactor() OVERRIDE;
172
173     virtual double backingStoreMemoryEstimate() const;
174
175     void updateOpacityOnLayer();
176     
177 #if ENABLE(CSS_FILTERS)
178     void updateFilters();
179 #endif
180
181     PlatformCALayer* primaryLayer() const { return m_structuralLayer.get() ? m_structuralLayer.get() : m_layer.get(); }
182     PlatformCALayer* hostLayerForSublayers() const;
183     PlatformCALayer* layerForSuperlayer() const;
184     PlatformCALayer* animatedLayer(AnimatedPropertyID) const;
185
186     typedef String CloneID; // Identifier for a given clone, based on original/replica branching down the tree.
187     static bool isReplicatedRootClone(const CloneID& cloneID) { return cloneID[0U] & 1; }
188
189     typedef HashMap<CloneID, RefPtr<PlatformCALayer> > LayerMap;
190     LayerMap* primaryLayerClones() const { return m_structuralLayer.get() ? m_structuralLayerClones.get() : m_layerClones.get(); }
191     LayerMap* animatedLayerClones(AnimatedPropertyID) const;
192
193     bool createAnimationFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset);
194     bool createTransformAnimationsFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset, const IntSize& boxSize);
195 #if ENABLE(CSS_FILTERS)
196     bool createFilterAnimationsFromKeyframes(const KeyframeValueList&, const Animation*, const String& animationName, double timeOffset);
197 #endif
198
199     // Return autoreleased animation (use RetainPtr?)
200     PassRefPtr<PlatformCAAnimation> createBasicAnimation(const Animation*, const String& keyPath, bool additive);
201     PassRefPtr<PlatformCAAnimation> createKeyframeAnimation(const Animation*, const String&, bool additive);
202     void setupAnimation(PlatformCAAnimation*, const Animation*, bool additive);
203     
204     const TimingFunction* timingFunctionForAnimationValue(const AnimationValue*, const Animation*);
205     
206     bool setAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*);
207     bool setAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*);
208
209     bool setTransformAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, TransformOperation::OperationType, bool isMatrixAnimation, const IntSize& boxSize);
210     bool setTransformAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, TransformOperation::OperationType, bool isMatrixAnimation, const IntSize& boxSize);
211     
212 #if ENABLE(CSS_FILTERS)
213     bool setFilterAnimationEndpoints(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, int internalFilterPropertyIndex);
214     bool setFilterAnimationKeyframes(const KeyframeValueList&, const Animation*, PlatformCAAnimation*, int functionIndex, int internalFilterPropertyIndex, FilterOperation::OperationType);
215 #endif
216
217     bool isRunningTransformAnimation() const;
218
219     bool animationIsRunning(const String& animationName) const
220     {
221         return m_runningAnimations.find(animationName) != m_runningAnimations.end();
222     }
223
224     void commitLayerChangesBeforeSublayers(float pageScaleFactor, const FloatPoint& positionRelativeToBase, const FloatRect& oldVisibleRect);
225     void commitLayerChangesAfterSublayers();
226
227     FloatPoint computePositionRelativeToBase(float& pageScale) const;
228
229     FloatSize constrainedSize() const;
230
231     bool requiresTiledLayer(float pageScaleFactor) const;
232     void swapFromOrToTiledLayer(bool useTiledLayer);
233
234     CompositingCoordinatesOrientation defaultContentsOrientation() const;
235     
236     void setupContentsLayer(PlatformCALayer*);
237     PlatformCALayer* contentsLayer() const { return m_contentsLayer.get(); }
238
239     virtual void setReplicatedByLayer(GraphicsLayer*);
240
241     virtual void getDebugBorderInfo(Color&, float& width) const;
242     virtual void dumpAdditionalProperties(TextStream&, int indent, LayerTreeAsTextBehavior) const;
243
244     void computePixelAlignment(float pixelAlignmentScale, const FloatPoint& positionRelativeToBase,
245         FloatPoint& position, FloatSize&, FloatPoint3D& anchorPoint, FloatSize& alignmentOffset) const;
246     FloatRect computeVisibleRect(TransformState&) const;
247     const FloatRect& visibleRect() const { return m_visibleRect; }
248     
249     FloatRect adjustTiledLayerVisibleRect(TiledBacking*, const FloatRect& oldVisibleRect, const FloatSize& oldSize) const;
250
251     // Used to track the path down the tree for replica layers.
252     struct ReplicaState {
253         static const size_t maxReplicaDepth = 16;
254         enum ReplicaBranchType { ChildBranch = 0, ReplicaBranch = 1 };
255         ReplicaState(ReplicaBranchType firstBranch)
256             : m_replicaDepth(0)
257         {
258             push(firstBranch);
259         }
260         
261         // Called as we walk down the tree to build replicas.
262         void push(ReplicaBranchType branchType)
263         {
264             m_replicaBranches.append(branchType);
265             if (branchType == ReplicaBranch)
266                 ++m_replicaDepth;
267         }
268         
269         void setBranchType(ReplicaBranchType branchType)
270         {
271             ASSERT(!m_replicaBranches.isEmpty());
272
273             if (m_replicaBranches.last() != branchType) {
274                 if (branchType == ReplicaBranch)
275                     ++m_replicaDepth;
276                 else
277                     --m_replicaDepth;
278             }
279
280             m_replicaBranches.last() = branchType;
281         }
282
283         void pop()
284         {
285             if (m_replicaBranches.last() == ReplicaBranch)
286                 --m_replicaDepth;
287             m_replicaBranches.removeLast();
288         }
289         
290         size_t depth() const { return m_replicaBranches.size(); }
291         size_t replicaDepth() const { return m_replicaDepth; }
292
293         CloneID cloneID() const;        
294
295     private:
296         Vector<ReplicaBranchType> m_replicaBranches;
297         size_t m_replicaDepth;
298     };
299     PassRefPtr<PlatformCALayer>replicatedLayerRoot(ReplicaState&);
300
301     enum CloneLevel { RootCloneLevel, IntermediateCloneLevel };
302     PassRefPtr<PlatformCALayer> fetchCloneLayers(GraphicsLayer* replicaRoot, ReplicaState&, CloneLevel);
303     
304     PassRefPtr<PlatformCALayer> cloneLayer(PlatformCALayer *, CloneLevel);
305     PassRefPtr<PlatformCALayer> findOrMakeClone(CloneID, PlatformCALayer *, LayerMap*, CloneLevel);
306
307     void ensureCloneLayers(CloneID cloneID, RefPtr<PlatformCALayer>& primaryLayer, RefPtr<PlatformCALayer>& structuralLayer, RefPtr<PlatformCALayer>& contentsLayer, CloneLevel cloneLevel);
308
309     bool hasCloneLayers() const { return m_layerClones; }
310     void removeCloneLayers();
311     FloatPoint positionForCloneRootLayer() const;
312     
313     void propagateLayerChangeToReplicas();
314     
315     // All these "update" methods will be called inside a BEGIN_BLOCK_OBJC_EXCEPTIONS/END_BLOCK_OBJC_EXCEPTIONS block.
316     void updateLayerNames();
317     void updateSublayerList();
318     void updateGeometry(float pixelAlignmentScale, const FloatPoint& positionRelativeToBase);
319     void updateTransform();
320     void updateChildrenTransform();
321     void updateMasksToBounds();
322     void updateContentsVisibility();
323     void updateContentsOpaque();
324     void updateBackfaceVisibility();
325     void updateStructuralLayer();
326     void updateLayerDrawsContent(float pixelAlignmentScale);
327     void updateBackgroundColor();
328
329     void updateContentsImage();
330     void updateContentsMediaLayer();
331     void updateContentsCanvasLayer();
332     void updateContentsColorLayer();
333     void updateContentsRect();
334     void updateMaskLayer();
335     void updateReplicatedLayers();
336
337     void updateAnimations();
338     void updateContentsNeedsDisplay();
339     void updateAcceleratesDrawing();
340     void updateDebugBorder();
341     void updateVisibleRect(const FloatRect& oldVisibleRect);
342     void updateContentsScale(float pageScaleFactor);
343     
344     enum StructuralLayerPurpose {
345         NoStructuralLayer = 0,
346         StructuralLayerForPreserves3D,
347         StructuralLayerForReplicaFlattening
348     };
349     void ensureStructuralLayer(StructuralLayerPurpose);
350     StructuralLayerPurpose structuralLayerPurpose() const;
351
352     void setAnimationOnLayer(PlatformCAAnimation*, AnimatedPropertyID, const String& animationName, int index, int subIndex, double timeOffset);
353     bool removeCAAnimationFromLayer(AnimatedPropertyID, const String& animationName, int index, int subINdex);
354     void pauseCAAnimationOnLayer(AnimatedPropertyID, const String& animationName, int index, int subIndex, double timeOffset);
355
356     enum MoveOrCopy { Move, Copy };
357     static void moveOrCopyLayerAnimation(MoveOrCopy, const String& animationIdentifier, PlatformCALayer *fromLayer, PlatformCALayer *toLayer);
358     void moveOrCopyAnimations(MoveOrCopy, PlatformCALayer * fromLayer, PlatformCALayer * toLayer);
359     
360     bool appendToUncommittedAnimations(const KeyframeValueList&, const TransformOperations*, const Animation*, const String& animationName, const IntSize& boxSize, int animationIndex, double timeOffset, bool isMatrixAnimation);
361 #if ENABLE(CSS_FILTERS)
362     bool appendToUncommittedAnimations(const KeyframeValueList&, const FilterOperation*, const Animation*, const String& animationName, int animationIndex, double timeOffset);
363 #endif
364     
365     enum LayerChange {
366         NoChange = 0,
367         NameChanged = 1 << 1,
368         ChildrenChanged = 1 << 2, // also used for content layer, and preserves-3d, and size if tiling changes?
369         GeometryChanged = 1 << 3,
370         TransformChanged = 1 << 4,
371         ChildrenTransformChanged = 1 << 5,
372         Preserves3DChanged = 1 << 6,
373         MasksToBoundsChanged = 1 << 7,
374         DrawsContentChanged = 1 << 8,
375         BackgroundColorChanged = 1 << 9,
376         ContentsOpaqueChanged = 1 << 10,
377         BackfaceVisibilityChanged = 1 << 11,
378         OpacityChanged = 1 << 12,
379         AnimationChanged = 1 << 13,
380         DirtyRectsChanged = 1 << 14,
381         ContentsImageChanged = 1 << 15,
382         ContentsMediaLayerChanged = 1 << 16,
383         ContentsCanvasLayerChanged = 1 << 17,
384         ContentsColorLayerChanged = 1 << 18,
385         ContentsRectChanged = 1 << 19,
386         MaskLayerChanged = 1 << 20,
387         ReplicatedLayerChanged = 1 << 21,
388         ContentsNeedsDisplay = 1 << 22,
389         AcceleratesDrawingChanged = 1 << 23,
390         ContentsScaleChanged = 1 << 24,
391         ContentsVisibilityChanged = 1 << 25,
392         VisibleRectChanged = 1 << 26,
393         FiltersChanged = 1 << 27,
394         DebugIndicatorsChanged = 1 << 28
395     };
396     typedef unsigned LayerChangeFlags;
397     void noteLayerPropertyChanged(LayerChangeFlags flags);
398     void noteSublayersChanged();
399     void noteChangesForScaleSensitiveProperties();
400
401     void repaintLayerDirtyRects();
402
403     RefPtr<PlatformCALayer> m_layer; // The main layer
404     RefPtr<PlatformCALayer> m_structuralLayer; // A layer used for structural reasons, like preserves-3d or replica-flattening. Is the parent of m_layer.
405     RefPtr<PlatformCALayer> m_contentsLayer; // A layer used for inner content, like image and video
406
407     // References to clones of our layers, for replicated layers.
408     OwnPtr<LayerMap> m_layerClones;
409     OwnPtr<LayerMap> m_structuralLayerClones;
410     OwnPtr<LayerMap> m_contentsLayerClones;
411
412 #ifdef VISIBLE_TILE_WASH
413     RefPtr<PlatformCALayer> m_visibleTileWashLayer;
414 #endif
415     FloatRect m_visibleRect;
416     FloatSize m_sizeAtLastVisibleRectUpdate;
417     
418     enum ContentsLayerPurpose {
419         NoContentsLayer = 0,
420         ContentsLayerForImage,
421         ContentsLayerForMedia,
422         ContentsLayerForCanvas,
423         ContentsLayerForBackgroundColor
424     };
425     
426     ContentsLayerPurpose m_contentsLayerPurpose;
427     bool m_allowTiledLayer : 1;
428     bool m_isPageTiledBackingLayer : 1;
429     
430     Color m_contentsSolidColor;
431
432     RetainPtr<CGImageRef> m_uncorrectedContentsImage;
433     RetainPtr<CGImageRef> m_pendingContentsImage;
434     
435     // This represents the animation of a single property. There may be multiple transform animations for
436     // a single transition or keyframe animation, so index is used to distinguish these.
437     struct LayerPropertyAnimation {
438         LayerPropertyAnimation(PassRefPtr<PlatformCAAnimation> caAnimation, const String& animationName, AnimatedPropertyID property, int index, int subIndex, double timeOffset)
439         : m_animation(caAnimation)
440         , m_name(animationName)
441         , m_property(property)
442         , m_index(index)
443         , m_subIndex(subIndex)
444         , m_timeOffset(timeOffset)
445         { }
446
447         RefPtr<PlatformCAAnimation> m_animation;
448         String m_name;
449         AnimatedPropertyID m_property;
450         int m_index;
451         int m_subIndex;
452         double m_timeOffset;
453     };
454     
455     // Uncommitted transitions and animations.
456     Vector<LayerPropertyAnimation> m_uncomittedAnimations;
457     
458     enum Action { Remove, Pause };
459     struct AnimationProcessingAction {
460         AnimationProcessingAction(Action action = Remove, double timeOffset = 0)
461             : action(action)
462             , timeOffset(timeOffset)
463         {
464         }
465         Action action;
466         double timeOffset; // only used for pause
467     };
468     typedef HashMap<String, AnimationProcessingAction> AnimationsToProcessMap;
469     AnimationsToProcessMap m_animationsToProcess;
470
471     // Map of animation names to their associated lists of property animations, so we can remove/pause them.
472     typedef HashMap<String, Vector<LayerPropertyAnimation> > AnimationsMap;
473     AnimationsMap m_runningAnimations;
474
475     Vector<FloatRect> m_dirtyRects;
476     FloatSize m_pixelAlignmentOffset;
477     
478     LayerChangeFlags m_uncommittedChanges;
479 };
480
481 } // namespace WebCore
482
483
484 #endif // USE(ACCELERATED_COMPOSITING)
485
486 #endif // GraphicsLayerCA_h