9604a5012e879aea8fc1ac2a781df5903a5ded23
[WebKit-https.git] / Source / WebCore / platform / image-decoders / png / PNGImageDecoder.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc.
3  * Copyright (C) 2007-2009 Torch Mobile, Inc.
4  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
5  *
6  * Portions are Copyright (C) 2001 mozilla.org
7  *
8  * Other contributors:
9  *   Stuart Parmenter <stuart@mozilla.com>
10  *   Max Stepin <maxstepin@gmail.com>
11  *
12  * This library is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Lesser General Public
14  * License as published by the Free Software Foundation; either
15  * version 2.1 of the License, or (at your option) any later version.
16  *
17  * This library is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
25  *
26  * Alternatively, the contents of this file may be used under the terms
27  * of either the Mozilla Public License Version 1.1, found at
28  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
29  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
30  * (the "GPL"), in which case the provisions of the MPL or the GPL are
31  * applicable instead of those above.  If you wish to allow use of your
32  * version of this file only under the terms of one of those two
33  * licenses (the MPL or the GPL) and not to allow others to use your
34  * version of this file under the LGPL, indicate your decision by
35  * deletingthe provisions above and replace them with the notice and
36  * other provisions required by the MPL or the GPL, as the case may be.
37  * If you do not delete the provisions above, a recipient may use your
38  * version of this file under any of the LGPL, the MPL or the GPL.
39  */
40
41 #include "config.h"
42 #include "PNGImageDecoder.h"
43
44 #include "Color.h"
45 #include <png.h>
46 #include <wtf/StdLibExtras.h>
47
48 #if defined(PNG_LIBPNG_VER_MAJOR) && defined(PNG_LIBPNG_VER_MINOR) && (PNG_LIBPNG_VER_MAJOR > 1 || (PNG_LIBPNG_VER_MAJOR == 1 && PNG_LIBPNG_VER_MINOR >= 4))
49 #define JMPBUF(png_ptr) png_jmpbuf(png_ptr)
50 #else
51 #define JMPBUF(png_ptr) png_ptr->jmpbuf
52 #endif
53
54 namespace WebCore {
55
56 // Gamma constants.
57 const double cMaxGamma = 21474.83;
58 const double cDefaultGamma = 2.2;
59 const double cInverseGamma = 0.45455;
60
61 // Protect against large PNGs. See Mozilla's bug #251381 for more info.
62 const unsigned long cMaxPNGSize = 1000000UL;
63
64 // Called if the decoding of the image fails.
65 static void PNGAPI decodingFailed(png_structp png, png_const_charp)
66 {
67     longjmp(JMPBUF(png), 1);
68 }
69
70 // Callbacks given to the read struct.  The first is for warnings (we want to
71 // treat a particular warning as an error, which is why we have to register this
72 // callback).
73 static void PNGAPI decodingWarning(png_structp png, png_const_charp warningMsg)
74 {
75     // Mozilla did this, so we will too.
76     // Convert a tRNS warning to be an error (see
77     // http://bugzilla.mozilla.org/show_bug.cgi?id=251381 )
78     if (!strncmp(warningMsg, "Missing PLTE before tRNS", 24))
79         png_error(png, warningMsg);
80 }
81
82 // Called when we have obtained the header information (including the size).
83 static void PNGAPI headerAvailable(png_structp png, png_infop)
84 {
85     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->headerAvailable();
86 }
87
88 // Called when a row is ready.
89 static void PNGAPI rowAvailable(png_structp png, png_bytep rowBuffer, png_uint_32 rowIndex, int interlacePass)
90 {
91     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->rowAvailable(rowBuffer, rowIndex, interlacePass);
92 }
93
94 // Called when we have completely finished decoding the image.
95 static void PNGAPI pngComplete(png_structp png, png_infop)
96 {
97     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->pngComplete();
98 }
99
100 #if ENABLE(APNG)
101 // Called when we have the frame header.
102 static void PNGAPI frameHeader(png_structp png, png_infop)
103 {
104     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->frameHeader();
105 }
106
107 // Called when we found user chunks.
108 static int PNGAPI readChunks(png_structp png, png_unknown_chunkp chunk)
109 {
110     static_cast<PNGImageDecoder*>(png_get_user_chunk_ptr(png))->readChunks(chunk);
111     return 1;
112 }
113 #endif
114
115 class PNGImageReader {
116     WTF_MAKE_FAST_ALLOCATED;
117 public:
118     PNGImageReader(PNGImageDecoder* decoder)
119         : m_readOffset(0)
120         , m_currentBufferSize(0)
121         , m_decodingSizeOnly(false)
122         , m_hasAlpha(false)
123         , m_interlaceBuffer(0)
124     {
125         m_png = png_create_read_struct(PNG_LIBPNG_VER_STRING, 0, decodingFailed, decodingWarning);
126         m_info = png_create_info_struct(m_png);
127         png_set_progressive_read_fn(m_png, decoder, headerAvailable, rowAvailable, pngComplete);
128 #if ENABLE(APNG)
129         png_byte apngChunks[]= {"acTL\0fcTL\0fdAT\0"};
130         png_set_keep_unknown_chunks(m_png, 1, apngChunks, 3);
131         png_set_read_user_chunk_fn(m_png, static_cast<png_voidp>(decoder), readChunks);
132         decoder->init();
133 #endif
134     }
135
136     ~PNGImageReader()
137     {
138         close();
139     }
140
141     void close()
142     {
143         if (m_png && m_info)
144             // This will zero the pointers.
145             png_destroy_read_struct(&m_png, &m_info, 0);
146         delete[] m_interlaceBuffer;
147         m_interlaceBuffer = 0;
148         m_readOffset = 0;
149     }
150
151     bool decode(const SharedBuffer& data, bool sizeOnly, unsigned haltAtFrame)
152     {
153         m_decodingSizeOnly = sizeOnly;
154         PNGImageDecoder* decoder = static_cast<PNGImageDecoder*>(png_get_progressive_ptr(m_png));
155
156         // We need to do the setjmp here. Otherwise bad things will happen.
157         if (setjmp(JMPBUF(m_png)))
158             return decoder->setFailed();
159
160         const char* segment;
161         while (unsigned segmentLength = data.getSomeData(segment, m_readOffset)) {
162             m_readOffset += segmentLength;
163             m_currentBufferSize = m_readOffset;
164             png_process_data(m_png, m_info, reinterpret_cast<png_bytep>(const_cast<char*>(segment)), segmentLength);
165             // We explicitly specify the superclass encodedDataStatus() because we
166             // merely want to check if we've managed to set the size, not
167             // (recursively) trigger additional decoding if we haven't.
168             if (sizeOnly ? decoder->ImageDecoder::encodedDataStatus() >= EncodedDataStatus::SizeAvailable : decoder->isCompleteAtIndex(haltAtFrame))
169                 return true;
170         }
171         return false;
172     }
173
174     png_structp pngPtr() const { return m_png; }
175     png_infop infoPtr() const { return m_info; }
176
177     void setReadOffset(unsigned offset) { m_readOffset = offset; }
178     unsigned currentBufferSize() const { return m_currentBufferSize; }
179     bool decodingSizeOnly() const { return m_decodingSizeOnly; }
180     void setHasAlpha(bool hasAlpha) { m_hasAlpha = hasAlpha; }
181     bool hasAlpha() const { return m_hasAlpha; }
182
183     png_bytep interlaceBuffer() const { return m_interlaceBuffer; }
184     void createInterlaceBuffer(int size) { m_interlaceBuffer = new png_byte[size]; }
185
186 private:
187     png_structp m_png;
188     png_infop m_info;
189     unsigned m_readOffset;
190     unsigned m_currentBufferSize;
191     bool m_decodingSizeOnly;
192     bool m_hasAlpha;
193     png_bytep m_interlaceBuffer;
194 };
195
196 PNGImageDecoder::PNGImageDecoder(AlphaOption alphaOption, GammaAndColorProfileOption gammaAndColorProfileOption)
197     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
198     , m_doNothingOnFailure(false)
199     , m_currentFrame(0)
200 #if ENABLE(APNG)
201     , m_png(nullptr)
202     , m_info(nullptr)
203     , m_isAnimated(false)
204     , m_frameInfo(false)
205     , m_frameIsHidden(false)
206     , m_hasInfo(false)
207     , m_gamma(45455)
208     , m_frameCount(1)
209     , m_playCount(0)
210     , m_totalFrames(0)
211     , m_sizePLTE(0)
212     , m_sizetRNS(0)
213     , m_sequenceNumber(0)
214     , m_width(0)
215     , m_height(0)
216     , m_xOffset(0)
217     , m_yOffset(0)
218     , m_delayNumerator(1)
219     , m_delayDenominator(1)
220     , m_dispose(0)
221     , m_blend(0)
222 #endif
223 {
224 }
225
226 PNGImageDecoder::~PNGImageDecoder()
227 {
228 }
229
230 #if ENABLE(APNG)
231 RepetitionCount PNGImageDecoder::repetitionCount() const
232 {
233     // APNG format uses 0 to indicate that an animation must play indefinitely. But
234     // the RepetitionCount enumeration uses RepetitionCountInfinite, so we need to adapt this.
235     if (!m_playCount)
236         return RepetitionCountInfinite;
237
238     return m_playCount;
239 }
240 #endif
241
242 EncodedDataStatus PNGImageDecoder::encodedDataStatus()
243 {
244     if (ImageDecoder::encodedDataStatus() < EncodedDataStatus::SizeAvailable)
245         decode(true, 0);
246
247     return ImageDecoder::encodedDataStatus();
248 }
249
250 bool PNGImageDecoder::setSize(const IntSize& size)
251 {
252     if (!ImageDecoder::setSize(size))
253         return false;
254
255     prepareScaleDataIfNecessary();
256     return true;
257 }
258
259 ImageFrame* PNGImageDecoder::frameBufferAtIndex(size_t index)
260 {
261 #if ENABLE(APNG)
262     if (ImageDecoder::encodedDataStatus() < EncodedDataStatus::SizeAvailable)
263         return nullptr;
264
265     if (index >= frameCount())
266         index = frameCount() - 1;
267 #else
268     if (index)
269         return nullptr;
270 #endif
271
272     if (m_frameBufferCache.isEmpty())
273         m_frameBufferCache.resize(1);
274
275     ImageFrame& frame = m_frameBufferCache[index];
276     if (!frame.isComplete())
277         decode(false, index);
278     return &frame;
279 }
280
281 bool PNGImageDecoder::setFailed()
282 {
283     if (m_doNothingOnFailure)
284         return false;
285     m_reader = nullptr;
286     return ImageDecoder::setFailed();
287 }
288
289 void PNGImageDecoder::headerAvailable()
290 {
291     png_structp png = m_reader->pngPtr();
292     png_infop info = m_reader->infoPtr();
293     png_uint_32 width = png_get_image_width(png, info);
294     png_uint_32 height = png_get_image_height(png, info);
295
296     // Protect against large images.
297     if (width > cMaxPNGSize || height > cMaxPNGSize) {
298         longjmp(JMPBUF(png), 1);
299         return;
300     }
301
302     // We can fill in the size now that the header is available.  Avoid memory
303     // corruption issues by neutering setFailed() during this call; if we don't
304     // do this, failures will cause |m_reader| to be deleted, and our jmpbuf
305     // will cease to exist.  Note that we'll still properly set the failure flag
306     // in this case as soon as we longjmp().
307     m_doNothingOnFailure = true;
308     bool result = setSize(IntSize(width, height));
309     m_doNothingOnFailure = false;
310     if (!result) {
311         longjmp(JMPBUF(png), 1);
312         return;
313     }
314
315     int bitDepth, colorType, interlaceType, compressionType, filterType, channels;
316     png_get_IHDR(png, info, &width, &height, &bitDepth, &colorType, &interlaceType, &compressionType, &filterType);
317
318     // The options we set here match what Mozilla does.
319
320 #if ENABLE(APNG)
321     m_hasInfo = true;
322     if (m_isAnimated) {
323         png_save_uint_32(m_dataIHDR, 13);
324         memcpy(m_dataIHDR + 4, "IHDR", 4);
325         png_save_uint_32(m_dataIHDR + 8, width);
326         png_save_uint_32(m_dataIHDR + 12, height);
327         m_dataIHDR[16] = bitDepth;
328         m_dataIHDR[17] = colorType;
329         m_dataIHDR[18] = compressionType;
330         m_dataIHDR[19] = filterType;
331         m_dataIHDR[20] = interlaceType;
332     }
333 #endif
334
335     // Expand to ensure we use 24-bit for RGB and 32-bit for RGBA.
336     if (colorType == PNG_COLOR_TYPE_PALETTE) {
337 #if ENABLE(APNG)
338         if (m_isAnimated) {
339             png_colorp palette;
340             int paletteSize = 0;
341             png_get_PLTE(png, info, &palette, &paletteSize);
342             paletteSize *= 3;
343             png_save_uint_32(m_dataPLTE, paletteSize);
344             memcpy(m_dataPLTE + 4, "PLTE", 4);
345             memcpy(m_dataPLTE + 8, palette, paletteSize);
346             m_sizePLTE = paletteSize + 12;
347         }
348 #endif
349         png_set_expand(png);
350     }
351
352     if (colorType == PNG_COLOR_TYPE_GRAY && bitDepth < 8)
353         png_set_expand(png);
354
355     png_bytep trns = 0;
356     int trnsCount = 0;
357     png_color_16p transValues;
358     if (png_get_valid(png, info, PNG_INFO_tRNS)) {
359         png_get_tRNS(png, info, &trns, &trnsCount, &transValues);
360 #if ENABLE(APNG)
361         if (m_isAnimated) {
362             if (colorType == PNG_COLOR_TYPE_RGB) {
363                 png_save_uint_16(m_datatRNS + 8, transValues->red);
364                 png_save_uint_16(m_datatRNS + 10, transValues->green);
365                 png_save_uint_16(m_datatRNS + 12, transValues->blue);
366                 trnsCount = 6;
367             } else if (colorType == PNG_COLOR_TYPE_GRAY) {
368                 png_save_uint_16(m_datatRNS + 8, transValues->gray);
369                 trnsCount = 2;
370             } else if (colorType == PNG_COLOR_TYPE_PALETTE)
371                 memcpy(m_datatRNS + 8, trns, trnsCount);
372
373             png_save_uint_32(m_datatRNS, trnsCount);
374             memcpy(m_datatRNS + 4, "tRNS", 4);
375             m_sizetRNS = trnsCount + 12;
376         }
377 #endif
378         png_set_expand(png);
379     }
380
381     if (bitDepth == 16)
382         png_set_strip_16(png);
383
384     if (colorType == PNG_COLOR_TYPE_GRAY || colorType == PNG_COLOR_TYPE_GRAY_ALPHA)
385         png_set_gray_to_rgb(png);
386
387     // Deal with gamma and keep it under our control.
388     double gamma;
389     if (!m_ignoreGammaAndColorProfile && png_get_gAMA(png, info, &gamma)) {
390         if ((gamma <= 0.0) || (gamma > cMaxGamma)) {
391             gamma = cInverseGamma;
392             png_set_gAMA(png, info, gamma);
393         }
394         png_set_gamma(png, cDefaultGamma, gamma);
395 #if ENABLE(APNG)
396         m_gamma = static_cast<int>(gamma * 100000);
397 #endif
398     } else
399         png_set_gamma(png, cDefaultGamma, cInverseGamma);
400
401     // Tell libpng to send us rows for interlaced pngs.
402     if (interlaceType == PNG_INTERLACE_ADAM7)
403         png_set_interlace_handling(png);
404
405     // Update our info now.
406     png_read_update_info(png, info);
407     channels = png_get_channels(png, info);
408     ASSERT(channels == 3 || channels == 4);
409
410     m_reader->setHasAlpha(channels == 4);
411
412     if (m_reader->decodingSizeOnly()) {
413         // If we only needed the size, halt the reader.
414 #if defined(PNG_LIBPNG_VER_MAJOR) && defined(PNG_LIBPNG_VER_MINOR) && (PNG_LIBPNG_VER_MAJOR > 1 || (PNG_LIBPNG_VER_MAJOR == 1 && PNG_LIBPNG_VER_MINOR >= 5))
415         // '0' argument to png_process_data_pause means: Do not cache unprocessed data.
416         m_reader->setReadOffset(m_reader->currentBufferSize() - png_process_data_pause(png, 0));
417 #else
418         m_reader->setReadOffset(m_reader->currentBufferSize() - png->buffer_size);
419         png->buffer_size = 0;
420 #endif
421     }
422 }
423
424 void PNGImageDecoder::rowAvailable(unsigned char* rowBuffer, unsigned rowIndex, int)
425 {
426     if (m_frameBufferCache.isEmpty())
427         return;
428
429     // Initialize the framebuffer if needed.
430 #if ENABLE(APNG)
431     if (m_currentFrame >= frameCount())
432         return;
433 #endif
434     ImageFrame& buffer = m_frameBufferCache[m_currentFrame];
435     if (buffer.isEmpty()) {
436         png_structp png = m_reader->pngPtr();
437         if (!buffer.initialize(scaledSize(), m_premultiplyAlpha)) {
438             longjmp(JMPBUF(png), 1);
439             return;
440         }
441
442         unsigned colorChannels = m_reader->hasAlpha() ? 4 : 3;
443         if (PNG_INTERLACE_ADAM7 == png_get_interlace_type(png, m_reader->infoPtr())
444             || m_currentFrame) {
445             if (!m_reader->interlaceBuffer())
446                 m_reader->createInterlaceBuffer(colorChannels * size().width() * size().height());
447             if (!m_reader->interlaceBuffer()) {
448                 longjmp(JMPBUF(png), 1);
449                 return;
450             }
451         }
452
453         buffer.setDecoding(ImageFrame::Decoding::Partial);
454         buffer.setHasAlpha(false);
455
456 #if ENABLE(APNG)
457         if (m_currentFrame)
458             initFrameBuffer(m_currentFrame);
459 #endif
460     }
461
462     /* libpng comments (here to explain what follows).
463      *
464      * this function is called for every row in the image.  If the
465      * image is interlacing, and you turned on the interlace handler,
466      * this function will be called for every row in every pass.
467      * Some of these rows will not be changed from the previous pass.
468      * When the row is not changed, the new_row variable will be NULL.
469      * The rows and passes are called in order, so you don't really
470      * need the row_num and pass, but I'm supplying them because it
471      * may make your life easier.
472      */
473
474     // Nothing to do if the row is unchanged, or the row is outside
475     // the image bounds: libpng may send extra rows, ignore them to
476     // make our lives easier.
477     if (!rowBuffer)
478         return;
479     int y = !m_scaled ? rowIndex : scaledY(rowIndex);
480     if (y < 0 || y >= scaledSize().height())
481         return;
482
483     /* libpng comments (continued).
484      *
485      * For the non-NULL rows of interlaced images, you must call
486      * png_progressive_combine_row() passing in the row and the
487      * old row.  You can call this function for NULL rows (it will
488      * just return) and for non-interlaced images (it just does the
489      * memcpy for you) if it will make the code easier.  Thus, you
490      * can just do this for all cases:
491      *
492      *    png_progressive_combine_row(png_ptr, old_row, new_row);
493      *
494      * where old_row is what was displayed for previous rows.  Note
495      * that the first pass (pass == 0 really) will completely cover
496      * the old row, so the rows do not have to be initialized.  After
497      * the first pass (and only for interlaced images), you will have
498      * to pass the current row, and the function will combine the
499      * old row and the new row.
500      */
501
502     bool hasAlpha = m_reader->hasAlpha();
503     unsigned colorChannels = hasAlpha ? 4 : 3;
504     png_bytep row = rowBuffer;
505
506     if (png_bytep interlaceBuffer = m_reader->interlaceBuffer()) {
507         row = interlaceBuffer + (rowIndex * colorChannels * size().width());
508 #if ENABLE(APNG)
509         if (m_currentFrame) {
510             png_progressive_combine_row(m_png, row, rowBuffer);
511             return; // Only do incremental image display for the first frame.
512         }
513 #endif
514         png_progressive_combine_row(m_reader->pngPtr(), row, rowBuffer);
515     }
516
517     // Write the decoded row pixels to the frame buffer.
518     RGBA32* address = buffer.backingStore()->pixelAt(0, y);
519     int width = scaledSize().width();
520     unsigned char nonTrivialAlphaMask = 0;
521
522 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
523     if (m_scaled) {
524         for (int x = 0; x < width; ++x, ++address) {
525             png_bytep pixel = row + m_scaledColumns[x] * colorChannels;
526             unsigned alpha = hasAlpha ? pixel[3] : 255;
527             buffer.backingStore()->setPixel(address, pixel[0], pixel[1], pixel[2], alpha);
528             nonTrivialAlphaMask |= (255 - alpha);
529         }
530     } else
531 #endif
532     {
533         png_bytep pixel = row;
534         if (hasAlpha) {
535             for (int x = 0; x < width; ++x, pixel += 4, ++address) {
536                 unsigned alpha = pixel[3];
537                 buffer.backingStore()->setPixel(address, pixel[0], pixel[1], pixel[2], alpha);
538                 nonTrivialAlphaMask |= (255 - alpha);
539             }
540         } else {
541             for (int x = 0; x < width; ++x, pixel += 3, ++address)
542                 *address = makeRGB(pixel[0], pixel[1], pixel[2]);
543         }
544     }
545
546     if (nonTrivialAlphaMask && !buffer.hasAlpha())
547         buffer.setHasAlpha(true);
548 }
549
550 void PNGImageDecoder::pngComplete()
551 {
552 #if ENABLE(APNG)
553     if (m_isAnimated) {
554         if (!processingFinish() && m_frameCount == m_currentFrame)
555             return;
556
557         fallbackNotAnimated();
558     }
559 #endif
560     if (!m_frameBufferCache.isEmpty())
561         m_frameBufferCache.first().setDecoding(ImageFrame::Decoding::Complete);
562 }
563
564 void PNGImageDecoder::decode(bool onlySize, unsigned haltAtFrame)
565 {
566     if (failed())
567         return;
568
569     if (!m_reader)
570         m_reader = std::make_unique<PNGImageReader>(this);
571
572     // If we couldn't decode the image but we've received all the data, decoding
573     // has failed.
574     if (!m_reader->decode(*m_data, onlySize, haltAtFrame) && isAllDataReceived())
575         setFailed();
576     // If we're done decoding the image, we don't need the PNGImageReader
577     // anymore.  (If we failed, |m_reader| has already been cleared.)
578     else if (isComplete())
579         m_reader = nullptr;
580 }
581
582 #if ENABLE(APNG)
583 void PNGImageDecoder::readChunks(png_unknown_chunkp chunk)
584 {
585     if (!memcmp(chunk->name, "acTL", 4) && chunk->size == 8) {
586         if (m_hasInfo || m_isAnimated)
587             return;
588
589         m_frameCount = png_get_uint_32(chunk->data);
590         m_playCount = png_get_uint_32(chunk->data + 4);
591
592         if (!m_frameCount || m_frameCount > PNG_UINT_31_MAX || m_playCount > PNG_UINT_31_MAX) {
593             fallbackNotAnimated();
594             return;
595         }
596
597         m_isAnimated = true;
598         if (!m_frameInfo)
599             m_frameIsHidden = true;
600
601         if (m_frameBufferCache.size() == m_frameCount)
602             return;
603
604         m_frameBufferCache.resize(m_frameCount);
605     } else if (!memcmp(chunk->name, "fcTL", 4) && chunk->size == 26) {
606         if (m_hasInfo && !m_isAnimated)
607             return;
608
609         m_frameInfo = false;
610
611         if (processingFinish()) {
612             fallbackNotAnimated();
613             return;
614         }
615
616         // At this point the old frame is done. Let's start a new one.
617         unsigned sequenceNumber = png_get_uint_32(chunk->data);
618         if (sequenceNumber != m_sequenceNumber++) {
619             fallbackNotAnimated();
620             return;
621         }
622
623         m_width = png_get_uint_32(chunk->data + 4);
624         m_height = png_get_uint_32(chunk->data + 8);
625         m_xOffset = png_get_uint_32(chunk->data + 12);
626         m_yOffset = png_get_uint_32(chunk->data + 16);
627         m_delayNumerator = png_get_uint_16(chunk->data + 20);
628         m_delayDenominator = png_get_uint_16(chunk->data + 22);
629         m_dispose = chunk->data[24];
630         m_blend = chunk->data[25];
631
632         png_structp png = m_reader->pngPtr();
633         png_infop info = m_reader->infoPtr();
634         png_uint_32 width = png_get_image_width(png, info);
635         png_uint_32 height = png_get_image_height(png, info);
636
637         if (m_width > cMaxPNGSize || m_height > cMaxPNGSize
638             || m_xOffset > cMaxPNGSize || m_yOffset > cMaxPNGSize
639             || m_xOffset + m_width > width
640             || m_yOffset + m_height > height
641             || m_dispose > 2 || m_blend > 1) {
642             fallbackNotAnimated();
643             return;
644         }
645
646         if (m_frameBufferCache.isEmpty())
647             m_frameBufferCache.resize(1);
648
649         if (m_currentFrame < m_frameBufferCache.size()) {
650             ImageFrame& buffer = m_frameBufferCache[m_currentFrame];
651
652             if (!m_delayDenominator)
653                 buffer.setDuration(m_delayNumerator * 10);
654             else
655                 buffer.setDuration(m_delayNumerator * 1000 / m_delayDenominator);
656
657             if (m_dispose == 2)
658                 buffer.setDisposalMethod(ImageFrame::DisposalMethod::RestoreToPrevious);
659             else if (m_dispose == 1)
660                 buffer.setDisposalMethod(ImageFrame::DisposalMethod::RestoreToBackground);
661             else
662                 buffer.setDisposalMethod(ImageFrame::DisposalMethod::DoNotDispose);
663         }
664
665         m_frameInfo = true;
666         m_frameIsHidden = false;
667
668         if (processingStart(chunk)) {
669             fallbackNotAnimated();
670             return;
671         }
672     } else if (!memcmp(chunk->name, "fdAT", 4) && chunk->size >= 4) {
673         if (!m_frameInfo || !m_isAnimated)
674             return;
675
676         unsigned sequenceNumber = png_get_uint_32(chunk->data);
677         if (sequenceNumber != m_sequenceNumber++) {
678             fallbackNotAnimated();
679             return;
680         }
681
682         if (setjmp(JMPBUF(m_png))) {
683             fallbackNotAnimated();
684             return;
685         }
686
687         png_save_uint_32(chunk->data, chunk->size - 4);
688         png_process_data(m_png, m_info, chunk->data, 4);
689         memcpy(chunk->data, "IDAT", 4);
690         png_process_data(m_png, m_info, chunk->data, chunk->size);
691         png_process_data(m_png, m_info, chunk->data, 4);
692     }
693 }
694
695 void PNGImageDecoder::frameHeader()
696 {
697     int colorType = png_get_color_type(m_png, m_info);
698
699     if (colorType == PNG_COLOR_TYPE_PALETTE)
700         png_set_expand(m_png);
701
702     int bitDepth = png_get_bit_depth(m_png, m_info);
703     if (colorType == PNG_COLOR_TYPE_GRAY && bitDepth < 8)
704         png_set_expand(m_png);
705
706     if (png_get_valid(m_png, m_info, PNG_INFO_tRNS))
707         png_set_expand(m_png);
708
709     if (bitDepth == 16)
710         png_set_strip_16(m_png);
711
712     if (colorType == PNG_COLOR_TYPE_GRAY || colorType == PNG_COLOR_TYPE_GRAY_ALPHA)
713         png_set_gray_to_rgb(m_png);
714
715     double gamma;
716     if (png_get_gAMA(m_png, m_info, &gamma))
717         png_set_gamma(m_png, cDefaultGamma, gamma);
718
719     png_set_interlace_handling(m_png);
720
721     png_read_update_info(m_png, m_info);
722 }
723
724 void PNGImageDecoder::init()
725 {
726     m_isAnimated = false;
727     m_frameInfo = false;
728     m_frameIsHidden = false;
729     m_hasInfo = false;
730     m_currentFrame = 0;
731     m_totalFrames = 0;
732     m_sequenceNumber = 0;
733 }
734
735 void PNGImageDecoder::clearFrameBufferCache(size_t clearBeforeFrame)
736 {
737     if (m_frameBufferCache.isEmpty())
738         return;
739
740     // See GIFImageDecoder for full explanation.
741     clearBeforeFrame = std::min(clearBeforeFrame, m_frameBufferCache.size() - 1);
742     const Vector<ImageFrame>::iterator end(m_frameBufferCache.begin() + clearBeforeFrame);
743
744     Vector<ImageFrame>::iterator i(end);
745     for (; (i != m_frameBufferCache.begin()) && (i->isEmpty() || (i->disposalMethod() == ImageFrame::DisposalMethod::RestoreToPrevious)); --i) {
746         if (i->isComplete() && (i != end))
747             i->clear();
748     }
749
750     // Now |i| holds the last frame we need to preserve; clear prior frames.
751     for (Vector<ImageFrame>::iterator j(m_frameBufferCache.begin()); j != i; ++j) {
752         ASSERT(!j->isPartial());
753         if (j->isEmpty())
754             j->clear();
755     }
756 }
757
758 void PNGImageDecoder::initFrameBuffer(size_t frameIndex)
759 {
760     if (frameIndex >= frameCount())
761         return;
762
763     ImageFrame& buffer = m_frameBufferCache[frameIndex];
764
765     // The starting state for this frame depends on the previous frame's
766     // disposal method.
767     //
768     // Frames that use the DisposalMethod::RestoreToPrevious method are effectively
769     // no-ops in terms of changing the starting state of a frame compared to
770     // the starting state of the previous frame, so skip over them.  (If the
771     // first frame specifies this method, it will get treated like
772     // DisposeOverwriteBgcolor below and reset to a completely empty image.)
773     const ImageFrame* prevBuffer = &m_frameBufferCache[--frameIndex];
774     ImageFrame::DisposalMethod prevMethod = prevBuffer->disposalMethod();
775     while (frameIndex && (prevMethod == ImageFrame::DisposalMethod::RestoreToPrevious)) {
776         prevBuffer = &m_frameBufferCache[--frameIndex];
777         prevMethod = prevBuffer->disposalMethod();
778     }
779
780     png_structp png = m_reader->pngPtr();
781     ASSERT(prevBuffer->isComplete());
782
783     if (prevMethod == ImageFrame::DisposalMethod::DoNotDispose) {
784         // Preserve the last frame as the starting state for this frame.
785         if (!prevBuffer->backingStore() || !buffer.initialize(*prevBuffer->backingStore()))
786             longjmp(JMPBUF(png), 1);
787     } else {
788         // We want to clear the previous frame to transparent, without
789         // affecting pixels in the image outside of the frame.
790         IntRect prevRect = prevBuffer->backingStore()->frameRect();
791         if (!frameIndex || prevRect.contains(IntRect(IntPoint(), scaledSize()))) {
792             // Clearing the first frame, or a frame the size of the whole
793             // image, results in a completely empty image.
794             buffer.backingStore()->clear();
795             buffer.setHasAlpha(true);
796         } else {
797             // Copy the whole previous buffer, then clear just its frame.
798             if (!prevBuffer->backingStore() || !buffer.initialize(*prevBuffer->backingStore())) {
799                 longjmp(JMPBUF(png), 1);
800                 return;
801             }
802             buffer.backingStore()->clearRect(prevRect);
803             buffer.setHasAlpha(true);
804         }
805     }
806     
807     IntRect frameRect(m_xOffset, m_yOffset, m_width, m_height);
808
809     // Make sure the frameRect doesn't extend outside the buffer.
810     if (frameRect.maxX() > size().width())
811         frameRect.setWidth(size().width() - m_xOffset);
812     if (frameRect.maxY() > size().height())
813         frameRect.setHeight(size().height() - m_yOffset);
814
815     int left = upperBoundScaledX(frameRect.x());
816     int right = lowerBoundScaledX(frameRect.maxX(), left);
817     int top = upperBoundScaledY(frameRect.y());
818     int bottom = lowerBoundScaledY(frameRect.maxY(), top);
819     buffer.backingStore()->setFrameRect(IntRect(left, top, right - left, bottom - top));
820 }
821
822 void PNGImageDecoder::frameComplete()
823 {
824     if (m_frameIsHidden || m_currentFrame >= frameCount())
825         return;
826
827     ImageFrame& buffer = m_frameBufferCache[m_currentFrame];
828     buffer.setDecoding(ImageFrame::Decoding::Complete);
829
830     png_bytep interlaceBuffer = m_reader->interlaceBuffer();
831
832     if (m_currentFrame && interlaceBuffer) {
833         IntRect rect = buffer.backingStore()->frameRect();
834         bool hasAlpha = m_reader->hasAlpha();
835         unsigned colorChannels = hasAlpha ? 4 : 3;
836         bool nonTrivialAlpha = false;
837         if (m_blend && !hasAlpha)
838             m_blend = 0;
839
840 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
841         for (int y = 0; y < rect.maxY() - rect.y(); ++y) {
842             png_bytep row = interlaceBuffer + (m_scaled ? m_scaledRows[y] : y) * colorChannels * size().width();
843             RGBA32* address = buffer.backingStore()->pixelAt(rect.x(), y + rect.y());
844             for (int x = 0; x < rect.maxX() - rect.x(); ++x) {
845                 png_bytep pixel = row + (m_scaled ? m_scaledColumns[x] : x) * colorChannels;
846                 unsigned alpha = hasAlpha ? pixel[3] : 255;
847                 nonTrivialAlpha |= alpha < 255;
848                 if (!m_blend)
849                     buffer.backingStore()->setPixel(address++, pixel[0], pixel[1], pixel[2], alpha);
850                 else
851                     buffer.backingStore()->blendPixel(address++, pixel[0], pixel[1], pixel[2], alpha);
852             }
853         }
854 #else
855         ASSERT(!m_scaled);
856         png_bytep row = interlaceBuffer;
857         for (int y = rect.y(); y < rect.maxY(); ++y, row += colorChannels * size().width()) {
858             png_bytep pixel = row;
859             RGBA32* address = buffer.backingStore()->pixelAt(rect.x(), y);
860             for (int x = rect.x(); x < rect.maxX(); ++x, pixel += colorChannels) {
861                 unsigned alpha = hasAlpha ? pixel[3] : 255;
862                 nonTrivialAlpha |= alpha < 255;
863                 if (!m_blend)
864                     buffer.backingStore()->setPixel(address++, pixel[0], pixel[1], pixel[2], alpha);
865                 else
866                     buffer.backingStore()->blendPixel(address++, pixel[0], pixel[1], pixel[2], alpha);
867             }
868         }
869 #endif
870
871         if (!nonTrivialAlpha) {
872             IntRect rect = buffer.backingStore()->frameRect();
873             if (rect.contains(IntRect(IntPoint(), scaledSize())))
874                 buffer.setHasAlpha(false);
875             else {
876                 size_t frameIndex = m_currentFrame;
877                 const ImageFrame* prevBuffer = &m_frameBufferCache[--frameIndex];
878                 while (frameIndex && (prevBuffer->disposalMethod() == ImageFrame::DisposalMethod::RestoreToPrevious))
879                     prevBuffer = &m_frameBufferCache[--frameIndex];
880
881                 IntRect prevRect = prevBuffer->backingStore()->frameRect();
882                 if ((prevBuffer->disposalMethod() == ImageFrame::DisposalMethod::RestoreToBackground) && !prevBuffer->hasAlpha() && rect.contains(prevRect))
883                     buffer.setHasAlpha(false);
884             }
885         } else if (!m_blend && !buffer.hasAlpha())
886             buffer.setHasAlpha(nonTrivialAlpha);
887     }
888     m_currentFrame++;
889 }
890
891 int PNGImageDecoder::processingStart(png_unknown_chunkp chunk)
892 {
893     static png_byte dataPNG[8] = {137, 80, 78, 71, 13, 10, 26, 10};
894     static png_byte datagAMA[16] = {0, 0, 0, 4, 103, 65, 77, 65};
895
896     if (!m_hasInfo)
897         return 0;
898
899     m_totalFrames++;
900
901     m_png = png_create_read_struct(PNG_LIBPNG_VER_STRING, 0, decodingFailed, 0);
902     m_info = png_create_info_struct(m_png);
903     if (setjmp(JMPBUF(m_png)))
904         return 1;
905
906     png_set_crc_action(m_png, PNG_CRC_QUIET_USE, PNG_CRC_QUIET_USE);
907     png_set_progressive_read_fn(m_png, static_cast<png_voidp>(this),
908         WebCore::frameHeader, WebCore::rowAvailable, 0);
909
910     memcpy(m_dataIHDR + 8, chunk->data + 4, 8);
911     png_save_uint_32(datagAMA + 8, m_gamma);
912
913     png_process_data(m_png, m_info, dataPNG, 8);
914     png_process_data(m_png, m_info, m_dataIHDR, 25);
915     png_process_data(m_png, m_info, datagAMA, 16);
916     if (m_sizePLTE > 0)
917         png_process_data(m_png, m_info, m_dataPLTE, m_sizePLTE);
918     if (m_sizetRNS > 0)
919         png_process_data(m_png, m_info, m_datatRNS, m_sizetRNS);
920
921     return 0;
922 }
923
924 int PNGImageDecoder::processingFinish()
925 {
926     static png_byte dataIEND[12] = {0, 0, 0, 0, 73, 69, 78, 68, 174, 66, 96, 130};
927
928     if (!m_hasInfo)
929         return 0;
930
931     if (m_totalFrames) {
932         if (setjmp(JMPBUF(m_png)))
933             return 1;
934
935         png_process_data(m_png, m_info, dataIEND, 12);
936         png_destroy_read_struct(&m_png, &m_info, 0);
937     }
938
939     frameComplete();
940     return 0;
941 }
942
943 void PNGImageDecoder::fallbackNotAnimated()
944 {
945     m_isAnimated = false;
946     m_playCount = 0;
947     m_currentFrame = 0;
948 }
949 #endif
950
951 } // namespace WebCore