REGRESSION(r198782, r201043): [image-decoders] Flickering with some animated gif
[WebKit-https.git] / Source / WebCore / platform / image-decoders / gif / GIFImageDecoder.cpp
1 /*
2  * Copyright (C) 2006 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 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 #include "config.h"
27 #include "GIFImageDecoder.h"
28
29 #include "GIFImageReader.h"
30 #include <limits>
31
32 namespace WebCore {
33
34 GIFImageDecoder::GIFImageDecoder(ImageSource::AlphaOption alphaOption,
35                                  ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
36     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
37     , m_repetitionCount(cAnimationLoopOnce)
38 {
39 }
40
41 GIFImageDecoder::~GIFImageDecoder()
42 {
43 }
44
45 void GIFImageDecoder::setData(SharedBuffer& data, bool allDataReceived)
46 {
47     if (failed())
48         return;
49
50     ImageDecoder::setData(data, allDataReceived);
51     if (m_reader)
52         m_reader->setData(&data);
53 }
54
55 bool GIFImageDecoder::isSizeAvailable()
56 {
57     if (!ImageDecoder::isSizeAvailable())
58          decode(0, GIFSizeQuery);
59
60     return ImageDecoder::isSizeAvailable();
61 }
62
63 bool GIFImageDecoder::setSize(unsigned width, unsigned height)
64 {
65     if (ImageDecoder::isSizeAvailable() && size() == IntSize(width, height))
66         return true;
67
68     if (!ImageDecoder::setSize(width, height))
69         return false;
70
71     prepareScaleDataIfNecessary();
72     return true;
73 }
74
75 size_t GIFImageDecoder::frameCount()
76 {
77     decode(std::numeric_limits<unsigned>::max(), GIFFrameCountQuery);
78     return m_frameBufferCache.size();
79 }
80
81 int GIFImageDecoder::repetitionCount() const
82 {
83     // This value can arrive at any point in the image data stream.  Most GIFs
84     // in the wild declare it near the beginning of the file, so it usually is
85     // set by the time we've decoded the size, but (depending on the GIF and the
86     // packets sent back by the webserver) not always.  If the reader hasn't
87     // seen a loop count yet, it will return cLoopCountNotSeen, in which case we
88     // should default to looping once (the initial value for
89     // |m_repetitionCount|).
90     //
91     // There are some additional wrinkles here. First, ImageSource::clear()
92     // may destroy the reader, making the result from the reader _less_
93     // authoritative on future calls if the recreated reader hasn't seen the
94     // loop count.  We don't need to special-case this because in this case the
95     // new reader will once again return cLoopCountNotSeen, and we won't
96     // overwrite the cached correct value.
97     //
98     // Second, a GIF might never set a loop count at all, in which case we
99     // should continue to treat it as a "loop once" animation.  We don't need
100     // special code here either, because in this case we'll never change
101     // |m_repetitionCount| from its default value.
102     //
103     // Third, we use the same GIFImageReader for counting frames and we might
104     // see the loop count and then encounter a decoding error which happens
105     // later in the stream. It is also possible that no frames are in the
106     // stream. In these cases we should just loop once.
107     if (failed() || (m_reader && (!m_reader->imagesCount())))
108         m_repetitionCount = cAnimationLoopOnce;
109     else if (m_reader && m_reader->loopCount() != cLoopCountNotSeen)
110         m_repetitionCount = m_reader->loopCount();
111     return m_repetitionCount;
112 }
113
114 ImageFrame* GIFImageDecoder::frameBufferAtIndex(size_t index)
115 {
116     if (index >= frameCount())
117         return 0;
118
119     ImageFrame& frame = m_frameBufferCache[index];
120     if (frame.status() != ImageFrame::FrameComplete)
121         decode(index + 1, GIFFullQuery);
122     return &frame;
123 }
124
125 bool GIFImageDecoder::setFailed()
126 {
127     m_reader = nullptr;
128     return ImageDecoder::setFailed();
129 }
130
131 void GIFImageDecoder::clearFrameBufferCache(size_t clearBeforeFrame)
132 {
133     // In some cases, like if the decoder was destroyed while animating, we
134     // can be asked to clear more frames than we currently have.
135     if (m_frameBufferCache.isEmpty())
136         return; // Nothing to do.
137
138     // The "-1" here is tricky.  It does not mean that |clearBeforeFrame| is the
139     // last frame we wish to preserve, but rather that we never want to clear
140     // the very last frame in the cache: it's empty (so clearing it is
141     // pointless), it's partial (so we don't want to clear it anyway), or the
142     // cache could be enlarged with a future setData() call and it could be
143     // needed to construct the next frame (see comments below).  Callers can
144     // always use ImageSource::clear(true, ...) to completely free the memory in
145     // this case.
146     clearBeforeFrame = std::min(clearBeforeFrame, m_frameBufferCache.size() - 1);
147     const Vector<ImageFrame>::iterator end(m_frameBufferCache.begin() + clearBeforeFrame);
148
149     // We need to preserve frames such that:
150     //   * We don't clear |end|
151     //   * We don't clear the frame we're currently decoding
152     //   * We don't clear any frame from which a future initFrameBuffer() call
153     //     will copy bitmap data
154     // All other frames can be cleared.  Because of the constraints on when
155     // ImageSource::clear() can be called (see ImageSource.h), we're guaranteed
156     // not to have non-empty frames after the frame we're currently decoding.
157     // So, scan backwards from |end| as follows:
158     //   * If the frame is empty, we're still past any frames we care about.
159     //   * If the frame is complete, but is DisposeOverwritePrevious, we'll
160     //     skip over it in future initFrameBuffer() calls.  We can clear it
161     //     unless it's |end|, and keep scanning.  For any other disposal method,
162     //     stop scanning, as we've found the frame initFrameBuffer() will need
163     //     next.
164     //   * If the frame is partial, we're decoding it, so don't clear it; if it
165     //     has a disposal method other than DisposeOverwritePrevious, stop
166     //     scanning, as we'll only need this frame when decoding the next one.
167     Vector<ImageFrame>::iterator i(end);
168     for (; (i != m_frameBufferCache.begin()) && ((i->status() == ImageFrame::FrameEmpty) || (i->disposalMethod() == ImageFrame::DisposeOverwritePrevious)); --i) {
169         if ((i->status() == ImageFrame::FrameComplete) && (i != end))
170             i->clearPixelData();
171     }
172
173     // Now |i| holds the last frame we need to preserve; clear prior frames.
174     for (Vector<ImageFrame>::iterator j(m_frameBufferCache.begin()); j != i; ++j) {
175         ASSERT(j->status() != ImageFrame::FramePartial);
176         if (j->status() != ImageFrame::FrameEmpty)
177             j->clearPixelData();
178     }
179
180     // When some frames are cleared, the reader is out of sync, since the caller might ask for any frame not
181     // necessarily in the order expected by the reader. See https://bugs.webkit.org/show_bug.cgi?id=159089.
182     m_reader = nullptr;
183 }
184
185 bool GIFImageDecoder::haveDecodedRow(unsigned frameIndex, const Vector<unsigned char>& rowBuffer, size_t width, size_t rowNumber, unsigned repeatCount, bool writeTransparentPixels)
186 {
187     const GIFFrameContext* frameContext = m_reader->frameContext();
188     // The pixel data and coordinates supplied to us are relative to the frame's
189     // origin within the entire image size, i.e.
190     // (frameContext->xOffset, frameContext->yOffset). There is no guarantee
191     // that width == (size().width() - frameContext->xOffset), so
192     // we must ensure we don't run off the end of either the source data or the
193     // row's X-coordinates.
194     int xBegin = upperBoundScaledX(frameContext->xOffset);
195     int yBegin = upperBoundScaledY(frameContext->yOffset + rowNumber);
196     int xEnd = lowerBoundScaledX(std::min(static_cast<int>(frameContext->xOffset + width), size().width()) - 1, xBegin + 1) + 1;
197     int yEnd = lowerBoundScaledY(std::min(static_cast<int>(frameContext->yOffset + rowNumber + repeatCount), size().height()) - 1, yBegin + 1) + 1;
198     if (rowBuffer.isEmpty() || (xBegin < 0) || (yBegin < 0) || (xEnd <= xBegin) || (yEnd <= yBegin))
199         return true;
200
201     // Get the colormap.
202     const unsigned char* colorMap;
203     unsigned colorMapSize;
204     if (frameContext->isLocalColormapDefined) {
205         colorMap = m_reader->localColormap(frameContext);
206         colorMapSize = m_reader->localColormapSize(frameContext);
207     } else {
208         colorMap = m_reader->globalColormap();
209         colorMapSize = m_reader->globalColormapSize();
210     }
211     if (!colorMap)
212         return true;
213
214     // Initialize the frame if necessary.
215     ImageFrame& buffer = m_frameBufferCache[frameIndex];
216     if (((buffer.status() == ImageFrame::FrameEmpty) && !initFrameBuffer(frameIndex)) || !buffer.hasPixelData())
217         return false;
218
219     ImageFrame::PixelData* currentAddress = buffer.getAddr(xBegin, yBegin);
220     // Write one row's worth of data into the frame.  
221     for (int x = xBegin; x < xEnd; ++x) {
222         const unsigned char sourceValue = rowBuffer[(m_scaled ? m_scaledColumns[x] : x) - frameContext->xOffset];
223         if ((!frameContext->isTransparent || (sourceValue != frameContext->tpixel)) && (sourceValue < colorMapSize)) {
224             const size_t colorIndex = static_cast<size_t>(sourceValue) * 3;
225             buffer.setRGBA(currentAddress, colorMap[colorIndex], colorMap[colorIndex + 1], colorMap[colorIndex + 2], 255);
226         } else {
227             m_currentBufferSawAlpha = true;
228             // We may or may not need to write transparent pixels to the buffer.
229             // If we're compositing against a previous image, it's wrong, and if
230             // we're writing atop a cleared, fully transparent buffer, it's
231             // unnecessary; but if we're decoding an interlaced gif and
232             // displaying it "Haeberli"-style, we must write these for passes
233             // beyond the first, or the initial passes will "show through" the
234             // later ones.
235             if (writeTransparentPixels)
236                 buffer.setRGBA(currentAddress, 0, 0, 0, 0);
237         }
238         ++currentAddress;
239     }
240
241     // Tell the frame to copy the row data if need be.
242     if (repeatCount > 1)
243         buffer.copyRowNTimes(xBegin, xEnd, yBegin, yEnd);
244
245     return true;
246 }
247
248 bool GIFImageDecoder::frameComplete(unsigned frameIndex, unsigned frameDuration, ImageFrame::FrameDisposalMethod disposalMethod)
249 {
250     // Initialize the frame if necessary.  Some GIFs insert do-nothing frames,
251     // in which case we never reach haveDecodedRow() before getting here.
252     ImageFrame& buffer = m_frameBufferCache[frameIndex];
253     if ((buffer.status() == ImageFrame::FrameEmpty) && !initFrameBuffer(frameIndex))
254         return false; // initFrameBuffer() has already called setFailed().
255
256     buffer.setStatus(ImageFrame::FrameComplete);
257     buffer.setDuration(frameDuration);
258     buffer.setDisposalMethod(disposalMethod);
259
260     if (!m_currentBufferSawAlpha) {
261         // The whole frame was non-transparent, so it's possible that the entire
262         // resulting buffer was non-transparent, and we can setHasAlpha(false).
263         if (buffer.originalFrameRect().contains(IntRect(IntPoint(), scaledSize())))
264             buffer.setHasAlpha(false);
265         else if (frameIndex) {
266             // Tricky case.  This frame does not have alpha only if everywhere
267             // outside its rect doesn't have alpha.  To know whether this is
268             // true, we check the start state of the frame -- if it doesn't have
269             // alpha, we're safe.
270             //
271             // First skip over prior DisposeOverwritePrevious frames (since they
272             // don't affect the start state of this frame) the same way we do in
273             // initFrameBuffer().
274             const ImageFrame* prevBuffer = &m_frameBufferCache[--frameIndex];
275             while (frameIndex && (prevBuffer->disposalMethod() == ImageFrame::DisposeOverwritePrevious))
276                 prevBuffer = &m_frameBufferCache[--frameIndex];
277
278             // Now, if we're at a DisposeNotSpecified or DisposeKeep frame, then
279             // we can say we have no alpha if that frame had no alpha.  But
280             // since in initFrameBuffer() we already copied that frame's alpha
281             // state into the current frame's, we need do nothing at all here.
282             //
283             // The only remaining case is a DisposeOverwriteBgcolor frame.  If
284             // it had no alpha, and its rect is contained in the current frame's
285             // rect, we know the current frame has no alpha.
286             if ((prevBuffer->disposalMethod() == ImageFrame::DisposeOverwriteBgcolor) && !prevBuffer->hasAlpha() && buffer.originalFrameRect().contains(prevBuffer->originalFrameRect()))
287                 buffer.setHasAlpha(false);
288         }
289     }
290
291     return true;
292 }
293
294 void GIFImageDecoder::gifComplete()
295 {
296     // Cache the repetition count, which is now as authoritative as it's ever
297     // going to be.
298     repetitionCount();
299
300     m_reader = nullptr;
301 }
302
303 void GIFImageDecoder::decode(unsigned haltAtFrame, GIFQuery query)
304 {
305     if (failed())
306         return;
307
308     if (!m_reader) {
309         m_reader = std::make_unique<GIFImageReader>(this);
310         m_reader->setData(m_data.get());
311     }
312
313     if (query == GIFSizeQuery) {
314         if (!m_reader->decode(GIFSizeQuery, haltAtFrame))
315             setFailed();
316         return;
317     }
318
319     if (!m_reader->decode(GIFFrameCountQuery, haltAtFrame)) {
320         setFailed();
321         return;
322     }
323
324     const size_t oldSize = m_frameBufferCache.size();
325     m_frameBufferCache.resize(m_reader->imagesCount());
326     for (size_t i = oldSize; i < m_reader->imagesCount(); ++i)
327         m_frameBufferCache[i].setPremultiplyAlpha(m_premultiplyAlpha);
328
329     if (query == GIFFrameCountQuery)
330         return;
331
332     if (!m_reader->decode(GIFFullQuery, haltAtFrame)) {
333         setFailed();
334         return;
335     }
336
337     // It is also a fatal error if all data is received but we failed to decode
338     // all frames completely.
339     if (isAllDataReceived() && haltAtFrame >= m_frameBufferCache.size() && m_reader)
340         setFailed();
341 }
342
343 bool GIFImageDecoder::initFrameBuffer(unsigned frameIndex)
344 {
345     // Initialize the frame rect in our buffer.
346     const GIFFrameContext* frameContext = m_reader->frameContext();
347     IntRect frameRect(frameContext->xOffset, frameContext->yOffset, frameContext->width, frameContext->height);
348
349     // Make sure the frameRect doesn't extend outside the buffer.
350     if (frameRect.maxX() > size().width())
351         frameRect.setWidth(size().width() - frameContext->xOffset);
352     if (frameRect.maxY() > size().height())
353         frameRect.setHeight(size().height() - frameContext->yOffset);
354
355     ImageFrame* const buffer = &m_frameBufferCache[frameIndex];
356     int left = upperBoundScaledX(frameRect.x());
357     int right = lowerBoundScaledX(frameRect.maxX(), left);
358     int top = upperBoundScaledY(frameRect.y());
359     int bottom = lowerBoundScaledY(frameRect.maxY(), top);
360     buffer->setOriginalFrameRect(IntRect(left, top, right - left, bottom - top));
361
362     if (!frameIndex) {
363         // This is the first frame, so we're not relying on any previous data.
364         if (!buffer->setSize(scaledSize().width(), scaledSize().height()))
365             return setFailed();
366     } else {
367         // The starting state for this frame depends on the previous frame's
368         // disposal method.
369         //
370         // Frames that use the DisposeOverwritePrevious method are effectively
371         // no-ops in terms of changing the starting state of a frame compared to
372         // the starting state of the previous frame, so skip over them.  (If the
373         // first frame specifies this method, it will get treated like
374         // DisposeOverwriteBgcolor below and reset to a completely empty image.)
375         const ImageFrame* prevBuffer = &m_frameBufferCache[--frameIndex];
376         ImageFrame::FrameDisposalMethod prevMethod = prevBuffer->disposalMethod();
377         while (frameIndex && (prevMethod == ImageFrame::DisposeOverwritePrevious)) {
378             prevBuffer = &m_frameBufferCache[--frameIndex];
379             prevMethod = prevBuffer->disposalMethod();
380         }
381         ASSERT(prevBuffer->status() == ImageFrame::FrameComplete);
382
383         if ((prevMethod == ImageFrame::DisposeNotSpecified) || (prevMethod == ImageFrame::DisposeKeep)) {
384             // Preserve the last frame as the starting state for this frame.
385             if (!buffer->copyBitmapData(*prevBuffer))
386                 return setFailed();
387         } else {
388             // We want to clear the previous frame to transparent, without
389             // affecting pixels in the image outside of the frame.
390             const IntRect& prevRect = prevBuffer->originalFrameRect();
391             const IntSize& bufferSize = scaledSize();
392             if (!frameIndex || prevRect.contains(IntRect(IntPoint(), scaledSize()))) {
393                 // Clearing the first frame, or a frame the size of the whole
394                 // image, results in a completely empty image.
395                 if (!buffer->setSize(bufferSize.width(), bufferSize.height()))
396                     return setFailed();
397             } else {
398                 // Copy the whole previous buffer, then clear just its frame.
399                 if (!buffer->copyBitmapData(*prevBuffer))
400                     return setFailed();
401                 buffer->zeroFillFrameRect(prevRect);
402             }
403         }
404     }
405
406     // Update our status to be partially complete.
407     buffer->setStatus(ImageFrame::FramePartial);
408
409     // Reset the alpha pixel tracker for this frame.
410     m_currentBufferSawAlpha = false;
411     return true;
412 }
413
414 } // namespace WebCore