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