[chromium] Incorrect replica originTransform used in CCDamageTracker
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCDamageTracker.cpp
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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #if USE(ACCELERATED_COMPOSITING)
34
35 #include "cc/CCDamageTracker.h"
36
37 #include "cc/CCLayerImpl.h"
38 #include "cc/CCLayerTreeHostCommon.h"
39 #include "cc/CCRenderSurface.h"
40
41 namespace WebCore {
42
43 PassOwnPtr<CCDamageTracker> CCDamageTracker::create()
44 {
45     return adoptPtr(new CCDamageTracker());
46 }
47
48 CCDamageTracker::CCDamageTracker()
49     : m_forceFullDamageNextUpdate(false)
50 {
51     m_currentRectHistory = adoptPtr(new RectMap);
52     m_nextRectHistory = adoptPtr(new RectMap);
53 }
54
55 CCDamageTracker::~CCDamageTracker()
56 {
57 }
58
59 void CCDamageTracker::updateDamageTrackingState(const Vector<CCLayerImpl*>& layerList, int targetSurfaceLayerID, bool targetSurfacePropertyChangedOnlyFromDescendant, const IntRect& targetSurfaceContentRect, CCLayerImpl* targetSurfaceMaskLayer)
60 {
61     //
62     // This function computes the "damage rect" of a target surface, and updates the state
63     // that is used to correctly track damage across frames. The damage rect is the region
64     // of the surface that may have changed and needs to be redrawn. This can be used to
65     // scissor what is actually drawn, to save GPU computation and bandwidth.
66     //
67     // The surface's damage rect is computed as the union of all possible changes that
68     // have happened to the surface since the last frame was drawn. This includes:
69     //   - any changes for existing layers/surfaces that contribute to the target surface
70     //   - layers/surfaces that existed in the previous frame, but no longer exist.
71     //
72     // The basic algorithm for computing the damage region is as follows:
73     //
74     //   1. compute damage caused by changes in active/new layers
75     //       for each layer in the layerList:
76     //           if the layer is actually a renderSurface:
77     //               add the surface's damage to our target surface.
78     //           else
79     //               add the layer's damage to the target surface.
80     //
81     //   2. compute damage caused by the target surface's mask, if it exists.
82     //
83     //   3. compute damage caused by old layers/surfaces that no longer exist
84     //       for each leftover layer:
85     //           add the old layer/surface bounds to the target surface damage.
86     //
87     //   4. combine all partial damage rects to get the full damage rect.
88     //
89     // Additional important points:
90     //
91     // - This algorithm is implicitly recursive; it assumes that descendant surfaces have
92     //   already computed their damage.
93     //
94     // - Changes to layers/surfaces indicate "damage" to the target surface; If a layer is
95     //   not changed, it does NOT mean that the layer can skip drawing. All layers that
96     //   overlap the damaged region still need to be drawn. For example, if a layer
97     //   changed its opacity, then layers underneath must be re-drawn as well, even if
98     //   they did not change.
99     //
100     // - If a layer/surface property changed, the old bounds and new bounds may overlap...
101     //   i.e. some of the exposed region may not actually be exposing anything. But this
102     //   does not artificially inflate the damage rect. If the layer changed, its entire
103     //   old bounds would always need to be redrawn, regardless of how much it overlaps
104     //   with the layer's new bounds, which also need to be entirely redrawn.
105     //
106     // - See comments in the rest of the code to see what exactly is considered a "change"
107     //   in a layer/surface.
108     //
109     // - To correctly manage exposed rects, two RectMaps are maintained:
110     //
111     //      1. The "current" map contains all the layer bounds that contributed to the
112     //         previous frame (even outside the previous damaged area). If a layer changes
113     //         or does not exist anymore, those regions are then exposed and damage the
114     //         target surface. As the algorithm progresses, entries are removed from the
115     //         map until it has only leftover layers that no longer exist.
116     //
117     //      2. The "next" map starts out empty, and as the algorithm progresses, every
118     //         layer/surface that contributes to the surface is added to the map.
119     //
120     //      3. After the damage rect is computed, the two maps are swapped, so that the
121     //         damage tracker is ready for the next frame.
122     //
123
124     // These functions cannot be bypassed with early-exits, even if we know what the
125     // damage will be for this frame, because we need to update the damage tracker state
126     // to correctly track the next frame.
127     FloatRect damageFromActiveLayers = trackDamageFromActiveLayers(layerList, targetSurfaceLayerID);
128     FloatRect damageFromSurfaceMask = trackDamageFromSurfaceMask(targetSurfaceMaskLayer);
129     FloatRect damageFromLeftoverRects = trackDamageFromLeftoverRects();
130
131     if (m_forceFullDamageNextUpdate || targetSurfacePropertyChangedOnlyFromDescendant) {
132         m_currentDamageRect = targetSurfaceContentRect;
133         m_forceFullDamageNextUpdate = false;
134     } else {
135         // FIXME: can we clamp this damage to the surface's content rect? (affects performance, but not correctness)
136         m_currentDamageRect = damageFromActiveLayers;
137         m_currentDamageRect.uniteIfNonZero(damageFromSurfaceMask);
138         m_currentDamageRect.uniteIfNonZero(damageFromLeftoverRects);
139     }
140
141     // The next history map becomes the current map for the next frame.
142     swap(m_currentRectHistory, m_nextRectHistory);
143 }
144
145 FloatRect CCDamageTracker::removeRectFromCurrentFrame(int layerID, bool& layerIsNew)
146 {
147     layerIsNew = !m_currentRectHistory->contains(layerID);
148
149     // take() will remove the entry from the map, or if not found, return a default (empty) rect.
150     return m_currentRectHistory->take(layerID);
151 }
152
153 void CCDamageTracker::saveRectForNextFrame(int layerID, const FloatRect& targetSpaceRect)
154 {
155     // This layer should not yet exist in next frame's history.
156     ASSERT(m_nextRectHistory->find(layerID) == m_nextRectHistory->end());
157     m_nextRectHistory->set(layerID, targetSpaceRect);
158 }
159
160 FloatRect CCDamageTracker::trackDamageFromActiveLayers(const Vector<CCLayerImpl*>& layerList, int targetSurfaceLayerID)
161 {
162     FloatRect damageRect = FloatRect();
163
164     for (unsigned layerIndex = 0; layerIndex < layerList.size(); ++layerIndex) {
165         CCLayerImpl* layer = layerList[layerIndex];
166
167         if (CCLayerTreeHostCommon::renderSurfaceContributesToTarget<CCLayerImpl>(layer, targetSurfaceLayerID))
168             extendDamageForRenderSurface(layer, damageRect);
169         else
170             extendDamageForLayer(layer, damageRect);
171     }
172
173     return damageRect;
174 }
175
176 FloatRect CCDamageTracker::trackDamageFromSurfaceMask(CCLayerImpl* targetSurfaceMaskLayer)
177 {
178     FloatRect damageRect = FloatRect();
179
180     if (!targetSurfaceMaskLayer)
181         return damageRect;
182
183     // Currently, if there is any change to the mask, we choose to damage the entire
184     // surface. This could potentially be optimized later, but it is not expected to be a
185     // common case.
186     if (targetSurfaceMaskLayer->layerPropertyChanged() || !targetSurfaceMaskLayer->updateRect().isEmpty())
187         damageRect = FloatRect(FloatPoint::zero(), FloatSize(targetSurfaceMaskLayer->bounds()));
188
189     return damageRect;
190 }
191
192 FloatRect CCDamageTracker::trackDamageFromLeftoverRects()
193 {
194     // After computing damage for all active layers, any leftover items in the current
195     // rect history correspond to layers/surfaces that no longer exist. So, these regions
196     // are now exposed on the target surface.
197
198     FloatRect damageRect = FloatRect();
199
200     for (RectMap::iterator it = m_currentRectHistory->begin(); it != m_currentRectHistory->end(); ++it)
201         damageRect.unite(it->second);
202
203     m_currentRectHistory->clear();
204
205     return damageRect;
206 }
207
208 void CCDamageTracker::extendDamageForLayer(CCLayerImpl* layer, FloatRect& targetDamageRect)
209 {
210     // There are two ways that a layer can damage a region of the target surface:
211     //   1. Property change (e.g. opacity, position, transforms):
212     //        - the entire region of the layer itself damages the surface.
213     //        - the old layer region also damages the surface, because this region is now exposed.
214     //        - note that in many cases the old and new layer rects may overlap, which is fine.
215     //
216     //   2. Repaint/update: If a region of the layer that was repainted/updated, that
217     //      region damages the surface.
218     //
219     // Property changes take priority over update rects.
220
221     // Compute the layer's "originTransform" by translating the drawTransform.
222     TransformationMatrix originTransform = layer->drawTransform();
223     originTransform.translate(-0.5 * layer->bounds().width(), -0.5 * layer->bounds().height());
224
225     bool layerIsNew = false;
226     FloatRect oldLayerRect = removeRectFromCurrentFrame(layer->id(), layerIsNew);
227
228     FloatRect layerRectInTargetSpace = originTransform.mapRect(FloatRect(FloatPoint::zero(), layer->bounds()));
229     saveRectForNextFrame(layer->id(), layerRectInTargetSpace);
230
231     if (layerIsNew || layer->layerPropertyChanged()) {
232         // If a layer is new or has changed, then its entire layer rect affects the target surface.
233         targetDamageRect.uniteIfNonZero(layerRectInTargetSpace);
234
235         // The layer's old region is now exposed on the target surface, too.
236         // Note oldLayerRect is already in target space.
237         targetDamageRect.uniteIfNonZero(oldLayerRect);
238     } else if (!layer->updateRect().isEmpty()) {
239         // If the layer properties havent changed, then the the target surface is only
240         // affected by the layer's update area, which could be empty.
241         FloatRect updateRectInTargetSpace = originTransform.mapRect(layer->updateRect());
242         targetDamageRect.uniteIfNonZero(updateRectInTargetSpace);
243     }
244 }
245
246 void CCDamageTracker::extendDamageForRenderSurface(CCLayerImpl* layer, FloatRect& targetDamageRect)
247 {
248     // There are two ways a "descendant surface" can damage regions of the "target surface":
249     //   1. Property change:
250     //        - a surface's geometry can change because of
251     //            - changes to descendants (i.e. the subtree) that affect the surface's content rect
252     //            - changes to ancestor layers that propagate their property changes to their entire subtree.
253     //        - just like layers, both the old surface rect and new surface rect will
254     //          damage the target surface in this case.
255     //
256     //   2. Damage rect: This surface may have been damaged by its own layerList as well, and that damage
257     //      should propagate to the target surface.
258     //
259
260     CCRenderSurface* renderSurface = layer->renderSurface();
261
262     bool surfaceIsNew = false;
263     FloatRect oldSurfaceRect = removeRectFromCurrentFrame(layer->id(), surfaceIsNew);
264
265     FloatRect surfaceRectInTargetSpace = renderSurface->drawableContentRect(); // already includes replica if it exists.
266     saveRectForNextFrame(layer->id(), surfaceRectInTargetSpace);
267
268     FloatRect damageRectInLocalSpace;
269     if (surfaceIsNew || renderSurface->surfacePropertyChanged()) {
270         // The entire surface contributes damage.
271         damageRectInLocalSpace = renderSurface->contentRect();
272
273         // The surface's old region is now exposed on the target surface, too.
274         targetDamageRect.uniteIfNonZero(oldSurfaceRect);
275     } else {
276         // Only the surface's damageRect will damage the target surface.
277         damageRectInLocalSpace = renderSurface->damageTracker()->currentDamageRect();
278     }
279
280     // If there was damage, transform it to target space, and possibly contribute its reflection if needed.
281     if (!damageRectInLocalSpace.isEmpty()) {
282         const TransformationMatrix& originTransform = renderSurface->originTransform();
283         FloatRect damageRectInTargetSpace = originTransform.mapRect(damageRectInLocalSpace);
284         targetDamageRect.uniteIfNonZero(damageRectInTargetSpace);
285
286         if (layer->replicaLayer()) {
287             const TransformationMatrix& replicaOriginTransform = renderSurface->replicaOriginTransform();
288             targetDamageRect.uniteIfNonZero(replicaOriginTransform.mapRect(damageRectInLocalSpace));
289         }
290     }
291
292     // If there was damage on the replica's mask, then the target surface receives that damage as well.
293     if (layer->replicaLayer() && layer->replicaLayer()->maskLayer()) {
294         CCLayerImpl* replicaMaskLayer = layer->replicaLayer()->maskLayer();
295
296         bool replicaIsNew = false;
297         removeRectFromCurrentFrame(replicaMaskLayer->id(), replicaIsNew);
298
299         // Compute the replica's "originTransform" that maps from the replica's origin space to the target surface origin space.
300         const TransformationMatrix& replicaOriginTransform = renderSurface->replicaOriginTransform();
301         FloatRect replicaMaskLayerRect = replicaOriginTransform.mapRect(FloatRect(FloatPoint::zero(), FloatSize(replicaMaskLayer->bounds().width(), replicaMaskLayer->bounds().height())));
302         saveRectForNextFrame(replicaMaskLayer->id(), replicaMaskLayerRect);
303
304         // In the current implementation, a change in the replica mask damages the entire replica region.
305         if (replicaIsNew || replicaMaskLayer->layerPropertyChanged() || !replicaMaskLayer->updateRect().isEmpty())
306             targetDamageRect.uniteIfNonZero(replicaMaskLayerRect);
307     }
308 }
309
310 } // namespace WebCore
311
312 #endif // USE(ACCELERATED_COMPOSITING)