[Chromium] Incremental texture updates are not atomic.
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / TiledLayerChromium.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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if USE(ACCELERATED_COMPOSITING)
29
30 #include "TiledLayerChromium.h"
31
32 #include "GraphicsContext3D.h"
33 #include "LayerRendererChromium.h"
34 #include "ManagedTexture.h"
35 #include "MathExtras.h"
36 #include "Region.h"
37 #include "TextStream.h"
38 #include "cc/CCLayerImpl.h"
39 #include "cc/CCTextureUpdater.h"
40 #include "cc/CCTiledLayerImpl.h"
41 #include <wtf/CurrentTime.h>
42
43 // Start tiling when the width and height of a layer are larger than this size.
44 static int maxUntiledSize = 512;
45
46 // When tiling is enabled, use tiles of this dimension squared.
47 static int defaultTileSize = 256;
48
49 using namespace std;
50
51 namespace WebCore {
52
53 class UpdatableTile : public CCLayerTilingData::Tile {
54     WTF_MAKE_NONCOPYABLE(UpdatableTile);
55 public:
56     explicit UpdatableTile(PassOwnPtr<LayerTextureUpdater::Texture> texture) : m_texture(texture) { }
57
58     LayerTextureUpdater::Texture* texture() { return m_texture.get(); }
59     ManagedTexture* managedTexture() { return m_texture->texture(); }
60
61     bool isDirty() const { return !m_dirtyRect.isEmpty(); }
62     void copyAndClearDirty()
63     {
64         m_updateRect = m_dirtyRect;
65         m_dirtyRect = IntRect();
66     }
67
68     IntRect m_dirtyRect;
69     IntRect m_updateRect;
70 private:
71     OwnPtr<LayerTextureUpdater::Texture> m_texture;
72 };
73
74 TiledLayerChromium::TiledLayerChromium()
75     : LayerChromium()
76     , m_textureFormat(GraphicsContext3D::INVALID_ENUM)
77     , m_skipsDraw(false)
78     , m_skipsIdlePaint(false)
79     , m_sampledTexelFormat(LayerTextureUpdater::SampledTexelFormatInvalid)
80     , m_tilingOption(AutoTile)
81 {
82     m_tiler = CCLayerTilingData::create(IntSize(defaultTileSize, defaultTileSize), CCLayerTilingData::HasBorderTexels);
83 }
84
85 TiledLayerChromium::~TiledLayerChromium()
86 {
87 }
88
89 PassRefPtr<CCLayerImpl> TiledLayerChromium::createCCLayerImpl()
90 {
91     return CCTiledLayerImpl::create(id());
92 }
93
94 void TiledLayerChromium::cleanupResources()
95 {
96     LayerChromium::cleanupResources();
97
98     m_tiler->reset();
99     m_paintRect = IntRect();
100     m_requestedUpdateTilesRect = IntRect();
101 }
102
103 void TiledLayerChromium::updateTileSizeAndTilingOption()
104 {
105     const IntSize tileSize(min(defaultTileSize, contentBounds().width()), min(defaultTileSize, contentBounds().height()));
106
107     // Tile if both dimensions large, or any one dimension large and the other
108     // extends into a second tile. This heuristic allows for long skinny layers
109     // (e.g. scrollbars) that are Nx1 tiles to minimize wasted texture space.
110     const bool anyDimensionLarge = contentBounds().width() > maxUntiledSize || contentBounds().height() > maxUntiledSize;
111     const bool anyDimensionOneTile = contentBounds().width() <= defaultTileSize || contentBounds().height() <= defaultTileSize;
112     const bool autoTiled = anyDimensionLarge && !anyDimensionOneTile;
113
114     bool isTiled;
115     if (m_tilingOption == AlwaysTile)
116         isTiled = true;
117     else if (m_tilingOption == NeverTile)
118         isTiled = false;
119     else
120         isTiled = autoTiled;
121
122     IntSize requestedSize = isTiled ? tileSize : contentBounds();
123     const int maxSize = layerTreeHost()->layerRendererCapabilities().maxTextureSize;
124     IntSize clampedSize = requestedSize.shrunkTo(IntSize(maxSize, maxSize));
125     setTileSize(clampedSize);
126 }
127
128 void TiledLayerChromium::updateBounds()
129 {
130     IntSize oldBounds = m_tiler->bounds();
131     IntSize newBounds = contentBounds();
132     if (oldBounds == newBounds)
133         return;
134     m_tiler->setBounds(newBounds);
135
136     // Invalidate any areas that the new bounds exposes.
137     Region oldRegion(IntRect(IntPoint(), oldBounds));
138     Region newRegion(IntRect(IntPoint(), newBounds));
139     newRegion.subtract(oldRegion);
140     Vector<IntRect> rects = newRegion.rects();
141     for (size_t i = 0; i < rects.size(); ++i)
142         invalidateRect(rects[i]);
143 }
144
145 void TiledLayerChromium::setTileSize(const IntSize& size)
146 {
147     m_tiler->setTileSize(size);
148 }
149
150 void TiledLayerChromium::setBorderTexelOption(CCLayerTilingData::BorderTexelOption borderTexelOption)
151 {
152     m_tiler->setBorderTexelOption(borderTexelOption);
153 }
154
155 bool TiledLayerChromium::drawsContent() const
156 {
157     if (!LayerChromium::drawsContent())
158         return false;
159
160     if (m_tilingOption == NeverTile && m_tiler->numTiles() > 1)
161         return false;
162
163     return !m_skipsDraw;
164 }
165
166 bool TiledLayerChromium::needsContentsScale() const
167 {
168     return true;
169 }
170
171 IntSize TiledLayerChromium::contentBounds() const
172 {
173     return IntSize(lroundf(bounds().width() * contentsScale()), lroundf(bounds().height() * contentsScale()));
174 }
175
176 void TiledLayerChromium::setLayerTreeHost(CCLayerTreeHost* host)
177 {
178     if (host == layerTreeHost())
179         return;
180
181     if (layerTreeHost())
182         cleanupResources();
183
184     LayerChromium::setLayerTreeHost(host);
185
186     if (!host)
187         return;
188
189     createTextureUpdater(host);
190     setTextureFormat(host->layerRendererCapabilities().bestTextureFormat);
191     m_sampledTexelFormat = textureUpdater()->sampledTexelFormat(m_textureFormat);
192 }
193
194 void TiledLayerChromium::updateCompositorResources(GraphicsContext3D*, CCTextureUpdater& updater)
195 {
196     // Painting could cause compositing to get turned off, which may cause the tiler to become invalidated mid-update.
197     if (m_skipsDraw || m_requestedUpdateTilesRect.isEmpty() || m_tiler->isEmpty())
198         return;
199
200     int left = m_requestedUpdateTilesRect.x();
201     int top = m_requestedUpdateTilesRect.y();
202     int right = m_requestedUpdateTilesRect.maxX() - 1;
203     int bottom = m_requestedUpdateTilesRect.maxY() - 1;
204     for (int j = top; j <= bottom; ++j) {
205         for (int i = left; i <= right; ++i) {
206             UpdatableTile* tile = tileAt(i, j);
207
208             // Required tiles are created in prepareToUpdate(). A tile should
209             // never be removed between the call to prepareToUpdate() and the
210             // call to updateCompositorResources().
211             if (!tile)
212                 CRASH();
213
214             IntRect sourceRect = tile->m_updateRect;
215             if (tile->m_updateRect.isEmpty())
216                 continue;
217
218             ASSERT(tile->managedTexture()->isReserved());
219             const IntPoint anchor = m_tiler->tileRect(tile).location();
220
221             // Calculate tile-space rectangle to upload into.
222             IntRect destRect(IntPoint(sourceRect.x() - anchor.x(), sourceRect.y() - anchor.y()), sourceRect.size());
223             if (destRect.x() < 0)
224                 CRASH();
225             if (destRect.y() < 0)
226                 CRASH();
227
228             // Offset from paint rectangle to this tile's dirty rectangle.
229             IntPoint paintOffset(sourceRect.x() - m_paintRect.x(), sourceRect.y() - m_paintRect.y());
230             if (paintOffset.x() < 0)
231                 CRASH();
232             if (paintOffset.y() < 0)
233                 CRASH();
234             if (paintOffset.x() + destRect.width() > m_paintRect.width())
235                 CRASH();
236             if (paintOffset.y() + destRect.height() > m_paintRect.height())
237                 CRASH();
238
239             updater.append(tile->texture(), sourceRect, destRect);
240         }
241     }
242
243     m_updateRect = FloatRect(m_paintRect);
244 }
245
246 void TiledLayerChromium::setTilingOption(TilingOption tilingOption)
247 {
248     m_tilingOption = tilingOption;
249 }
250
251 void TiledLayerChromium::setIsMask(bool isMask)
252 {
253     setTilingOption(isMask ? NeverTile : AutoTile);
254 }
255
256 void TiledLayerChromium::pushPropertiesTo(CCLayerImpl* layer)
257 {
258     LayerChromium::pushPropertiesTo(layer);
259
260     CCTiledLayerImpl* tiledLayer = static_cast<CCTiledLayerImpl*>(layer);
261
262     tiledLayer->setSkipsDraw(m_skipsDraw);
263     tiledLayer->setContentsSwizzled(m_sampledTexelFormat != LayerTextureUpdater::SampledTexelFormatRGBA);
264     tiledLayer->setTilingData(*m_tiler);
265
266     for (CCLayerTilingData::TileMap::const_iterator iter = m_tiler->tiles().begin(); iter != m_tiler->tiles().end(); ++iter) {
267         int i = iter->first.first;
268         int j = iter->first.second;
269         UpdatableTile* tile = static_cast<UpdatableTile*>(iter->second.get());
270         if (!tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
271             continue;
272         if (tile->isDirty())
273             continue;
274
275         tiledLayer->syncTextureId(i, j, tile->managedTexture()->textureId());
276     }
277 }
278
279 TextureManager* TiledLayerChromium::textureManager() const
280 {
281     if (!layerTreeHost())
282         return 0;
283     return layerTreeHost()->contentsTextureManager();
284 }
285
286 UpdatableTile* TiledLayerChromium::tileAt(int i, int j) const
287 {
288     return static_cast<UpdatableTile*>(m_tiler->tileAt(i, j));
289 }
290
291 UpdatableTile* TiledLayerChromium::createTile(int i, int j)
292 {
293     RefPtr<UpdatableTile> tile = adoptRef(new UpdatableTile(textureUpdater()->createTexture(textureManager())));
294     m_tiler->addTile(tile, i, j);
295     tile->m_dirtyRect = m_tiler->tileRect(tile.get());
296
297     return tile.get();
298 }
299
300 void TiledLayerChromium::setNeedsDisplayRect(const FloatRect& dirtyRect)
301 {
302     IntRect dirty = enclosingIntRect(dirtyRect);
303     invalidateRect(dirty);
304     LayerChromium::setNeedsDisplayRect(dirtyRect);
305 }
306
307 void TiledLayerChromium::setIsNonCompositedContent(bool isNonCompositedContent)
308 {
309     LayerChromium::setIsNonCompositedContent(isNonCompositedContent);
310
311     CCLayerTilingData::BorderTexelOption borderTexelOption;
312 #if OS(ANDROID)
313     // Always want border texels and GL_LINEAR due to pinch zoom.
314     borderTexelOption = CCLayerTilingData::HasBorderTexels;
315 #else
316     borderTexelOption = isNonCompositedContent ? CCLayerTilingData::NoBorderTexels : CCLayerTilingData::HasBorderTexels;
317 #endif
318     setBorderTexelOption(borderTexelOption);
319 }
320
321 void TiledLayerChromium::invalidateRect(const IntRect& layerRect)
322 {
323     if (m_tiler->isEmpty() || layerRect.isEmpty() || m_skipsDraw)
324         return;
325
326     int left, top, right, bottom;
327     m_tiler->layerRectToTileIndices(layerRect, left, top, right, bottom);
328     for (int j = top; j <= bottom; ++j) {
329         for (int i = left; i <= right; ++i) {
330             UpdatableTile* tile = tileAt(i, j);
331             if (!tile)
332                 continue;
333             IntRect bound = m_tiler->tileRect(tile);
334             bound.intersect(layerRect);
335             tile->m_dirtyRect.unite(bound);
336         }
337     }
338 }
339
340 void TiledLayerChromium::protectVisibleTileTextures()
341 {
342     protectTileTextures(IntRect(IntPoint::zero(), contentBounds()));
343 }
344
345 void TiledLayerChromium::protectTileTextures(const IntRect& layerRect)
346 {
347     if (m_tiler->isEmpty() || layerRect.isEmpty())
348         return;
349
350     int left, top, right, bottom;
351     m_tiler->layerRectToTileIndices(layerRect, left, top, right, bottom);
352
353     for (int j = top; j <= bottom; ++j) {
354         for (int i = left; i <= right; ++i) {
355             UpdatableTile* tile = tileAt(i, j);
356             if (!tile || !tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
357                 continue;
358
359             tile->managedTexture()->reserve(m_tiler->tileSize(), m_textureFormat);
360         }
361     }
362 }
363
364 void TiledLayerChromium::prepareToUpdateTiles(bool idle, int left, int top, int right, int bottom)
365 {
366     // Reset m_updateRect for all tiles.
367     for (CCLayerTilingData::TileMap::const_iterator iter = m_tiler->tiles().begin(); iter != m_tiler->tiles().end(); ++iter) {
368         UpdatableTile* tile = static_cast<UpdatableTile*>(iter->second.get());
369         tile->m_updateRect = IntRect();
370     }
371
372     // Create tiles as needed, expanding a dirty rect to contain all
373     // the dirty regions currently being drawn. All dirty tiles that are to be painted
374     // get their m_updateRect set to m_dirtyRect and m_dirtyRect cleared. This way if
375     // invalidateRect is invoked during prepareToUpdate we don't lose the request.
376     IntRect dirtyLayerRect;
377     for (int j = top; j <= bottom; ++j) {
378         for (int i = left; i <= right; ++i) {
379             UpdatableTile* tile = tileAt(i, j);
380             if (!tile)
381                 tile = createTile(i, j);
382
383             // Do post commit deletion of current texture when partial texture
384             // updates are not used.
385             if (tile->isDirty() && layerTreeHost() && !layerTreeHost()->settings().partialTextureUpdates)
386                 layerTreeHost()->deleteTextureAfterCommit(tile->managedTexture()->steal());
387
388             if (!tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
389                 tile->m_dirtyRect = m_tiler->tileRect(tile);
390
391             if (!tile->managedTexture()->reserve(m_tiler->tileSize(), m_textureFormat)) {
392                 m_skipsIdlePaint = true;
393                 if (!idle) {
394                     m_skipsDraw = true;
395                     cleanupResources();
396                 }
397                 return;
398             }
399
400             dirtyLayerRect.unite(tile->m_dirtyRect);
401             tile->copyAndClearDirty();
402         }
403     }
404
405     m_paintRect = dirtyLayerRect;
406     if (dirtyLayerRect.isEmpty())
407         return;
408
409     // Due to borders, when the paint rect is extended to tile boundaries, it
410     // may end up overlapping more tiles than the original content rect. Record
411     // the original tiles so we don't upload more tiles than necessary.
412     if (!m_paintRect.isEmpty())
413         m_requestedUpdateTilesRect = IntRect(left, top, right - left + 1, bottom - top + 1);
414
415     // Calling prepareToUpdate() calls into WebKit to paint, which may have the side
416     // effect of disabling compositing, which causes our reference to the texture updater to be deleted.
417     // However, we can't free the memory backing the GraphicsContext until the paint finishes,
418     // so we grab a local reference here to hold the updater alive until the paint completes.
419     RefPtr<LayerTextureUpdater> protector(textureUpdater());
420     IntRect opaqueRect; // FIXME: unused. remove this and store in the layer to pass to impl for draw culling
421     textureUpdater()->prepareToUpdate(m_paintRect, m_tiler->tileSize(), m_tiler->hasBorderTexels(), contentsScale(), &opaqueRect);
422     for (int j = top; j <= bottom; ++j) {
423         for (int i = left; i <= right; ++i) {
424             UpdatableTile* tile = tileAt(i, j);
425
426             // Tiles are created before prepareToUpdate() is called.
427             if (!tile)
428                 CRASH();
429
430             // Use m_updateRect as copyAndClearDirty above moved the existing dirty rect to m_updateRect.
431             const IntRect& dirtyRect = tile->m_updateRect;
432             if (dirtyRect.isEmpty())
433                 continue;
434
435             IntRect sourceRect = m_tiler->tileRect(tile);
436             sourceRect.intersect(dirtyRect);
437             // Paint rect not guaranteed to line up on tile boundaries, so
438             // make sure that sourceRect doesn't extend outside of it.
439             sourceRect.intersect(m_paintRect);
440
441             tile->m_updateRect = sourceRect;
442             if (sourceRect.isEmpty())
443                 continue;
444
445             tile->texture()->prepareRect(sourceRect);
446         }
447     }
448 }
449
450
451 void TiledLayerChromium::prepareToUpdate(const IntRect& layerRect)
452 {
453     m_skipsDraw = false;
454     m_skipsIdlePaint = false;
455     m_requestedUpdateTilesRect = IntRect();
456     m_paintRect = IntRect();
457
458     updateBounds();
459
460     if (layerRect.isEmpty() || !m_tiler->numTiles())
461         return;
462
463     int left, top, right, bottom;
464     m_tiler->layerRectToTileIndices(layerRect, left, top, right, bottom);
465
466     prepareToUpdateTiles(false, left, top, right, bottom);
467 }
468
469 void TiledLayerChromium::prepareToUpdateIdle(const IntRect& layerRect)
470 {
471     // Abort if we have already prepared a paint or run out of memory.
472     if (m_skipsIdlePaint || !m_paintRect.isEmpty())
473         return;
474
475     ASSERT(m_tiler);
476
477     updateBounds();
478
479     if (m_tiler->isEmpty())
480         return;
481
482     // Protect any textures in the pre-paint area so we don't end up just
483     // reclaiming them below.
484     IntRect idlePaintLayerRect = idlePaintRect(layerRect);
485     protectTileTextures(idlePaintLayerRect);
486
487     // Expand outwards until we find a dirty row or column to update.
488     int left, top, right, bottom;
489     m_tiler->layerRectToTileIndices(layerRect, left, top, right, bottom);
490     int prepaintLeft, prepaintTop, prepaintRight, prepaintBottom;
491     m_tiler->layerRectToTileIndices(idlePaintLayerRect, prepaintLeft, prepaintTop, prepaintRight, prepaintBottom);
492     while (!m_skipsIdlePaint && (left > prepaintLeft || top > prepaintTop || right < prepaintRight || bottom < prepaintBottom)) {
493         if (bottom < prepaintBottom) {
494             ++bottom;
495             prepareToUpdateTiles(true, left, bottom, right, bottom);
496             if (!m_paintRect.isEmpty() || m_skipsIdlePaint)
497                 break;
498         }
499         if (top > prepaintTop) {
500             --top;
501             prepareToUpdateTiles(true, left, top, right, top);
502             if (!m_paintRect.isEmpty() || m_skipsIdlePaint)
503                 break;
504         }
505         if (left > prepaintLeft) {
506             --left;
507             prepareToUpdateTiles(true, left, top, left, bottom);
508             if (!m_paintRect.isEmpty() || m_skipsIdlePaint)
509                 break;
510         }
511         if (right < prepaintRight) {
512             ++right;
513             prepareToUpdateTiles(true, right, top, right, bottom);
514             if (!m_paintRect.isEmpty() || m_skipsIdlePaint)
515                 break;
516         }
517     }
518 }
519
520 bool TiledLayerChromium::needsIdlePaint(const IntRect& layerRect)
521 {
522     if (m_skipsIdlePaint)
523         return false;
524
525     IntRect idlePaintLayerRect = idlePaintRect(layerRect);
526
527     int left, top, right, bottom;
528     m_tiler->layerRectToTileIndices(idlePaintLayerRect, left, top, right, bottom);
529     for (int j = top; j <= bottom; ++j) {
530         for (int i = left; i <= right; ++i) {
531             if (m_requestedUpdateTilesRect.contains(IntPoint(i, j)))
532                 continue;
533             UpdatableTile* tile = tileAt(i, j);
534             if (!tile || !tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat) || tile->isDirty())
535                 return true;
536         }
537     }
538     return false;
539 }
540
541 IntRect TiledLayerChromium::idlePaintRect(const IntRect& visibleLayerRect)
542 {
543     IntRect prepaintRect = visibleLayerRect;
544     // FIXME: This can be made a lot larger if we can:
545     // - reserve memory at a lower priority than for visible content
546     // - only reserve idle paint tiles up to a memory reclaim threshold and
547     // - insure we play nicely with other layers
548     prepaintRect.inflateX(m_tiler->tileSize().width());
549     prepaintRect.inflateY(m_tiler->tileSize().height());
550     prepaintRect.intersect(IntRect(IntPoint::zero(), contentBounds()));
551     return prepaintRect;
552 }
553
554 }
555 #endif // USE(ACCELERATED_COMPOSITING)