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