[Chromium] Add trace events for decoding and drawing images.
[WebKit-https.git] / Source / WebCore / platform / image-decoders / png / PNGImageDecoder.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, 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  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with this library; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
24  *
25  * Alternatively, the contents of this file may be used under the terms
26  * of either the Mozilla Public License Version 1.1, found at
27  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
28  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
29  * (the "GPL"), in which case the provisions of the MPL or the GPL are
30  * applicable instead of those above.  If you wish to allow use of your
31  * version of this file only under the terms of one of those two
32  * licenses (the MPL or the GPL) and not to allow others to use your
33  * version of this file under the LGPL, indicate your decision by
34  * deletingthe provisions above and replace them with the notice and
35  * other provisions required by the MPL or the GPL, as the case may be.
36  * If you do not delete the provisions above, a recipient may use your
37  * version of this file under any of the LGPL, the MPL or the GPL.
38  */
39
40 #include "config.h"
41 #include "PNGImageDecoder.h"
42
43 #include "png.h"
44 #include <wtf/PassOwnPtr.h>
45
46 #if PLATFORM(CHROMIUM)
47 #include "TraceEvent.h"
48 #endif
49
50 #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))
51 #define JMPBUF(png_ptr) png_jmpbuf(png_ptr)
52 #else
53 #define JMPBUF(png_ptr) png_ptr->jmpbuf
54 #endif
55
56 namespace WebCore {
57
58 // Gamma constants.
59 const double cMaxGamma = 21474.83;
60 const double cDefaultGamma = 2.2;
61 const double cInverseGamma = 0.45455;
62
63 // Protect against large PNGs. See Mozilla's bug #251381 for more info.
64 const unsigned long cMaxPNGSize = 1000000UL;
65
66 // Called if the decoding of the image fails.
67 static void PNGAPI decodingFailed(png_structp png, png_const_charp)
68 {
69     longjmp(JMPBUF(png), 1);
70 }
71
72 // Callbacks given to the read struct.  The first is for warnings (we want to
73 // treat a particular warning as an error, which is why we have to register this
74 // callback).
75 static void PNGAPI decodingWarning(png_structp png, png_const_charp warningMsg)
76 {
77     // Mozilla did this, so we will too.
78     // Convert a tRNS warning to be an error (see
79     // http://bugzilla.mozilla.org/show_bug.cgi?id=251381 )
80     if (!strncmp(warningMsg, "Missing PLTE before tRNS", 24))
81         png_error(png, warningMsg);
82 }
83
84 // Called when we have obtained the header information (including the size).
85 static void PNGAPI headerAvailable(png_structp png, png_infop)
86 {
87     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->headerAvailable();
88 }
89
90 // Called when a row is ready.
91 static void PNGAPI rowAvailable(png_structp png, png_bytep rowBuffer, png_uint_32 rowIndex, int interlacePass)
92 {
93     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->rowAvailable(rowBuffer, rowIndex, interlacePass);
94 }
95
96 // Called when we have completely finished decoding the image.
97 static void PNGAPI pngComplete(png_structp png, png_infop)
98 {
99     static_cast<PNGImageDecoder*>(png_get_progressive_ptr(png))->pngComplete();
100 }
101
102 class PNGImageReader
103 {
104 public:
105     PNGImageReader(PNGImageDecoder* decoder)
106         : m_readOffset(0)
107         , m_decodingSizeOnly(false)
108         , m_interlaceBuffer(0)
109         , m_hasAlpha(false)
110         , m_currentBufferSize(0)
111     {
112         m_png = png_create_read_struct(PNG_LIBPNG_VER_STRING, 0, decodingFailed, decodingWarning);
113         m_info = png_create_info_struct(m_png);
114         png_set_progressive_read_fn(m_png, decoder, headerAvailable, rowAvailable, pngComplete);
115     }
116
117     ~PNGImageReader()
118     {
119         close();
120     }
121
122     void close()
123     {
124         if (m_png && m_info)
125             // This will zero the pointers.
126             png_destroy_read_struct(&m_png, &m_info, 0);
127         delete[] m_interlaceBuffer;
128         m_interlaceBuffer = 0;
129         m_readOffset = 0;
130     }
131
132     unsigned currentBufferSize() const { return m_currentBufferSize; }
133
134     bool decode(const SharedBuffer& data, bool sizeOnly)
135     {
136         m_decodingSizeOnly = sizeOnly;
137         PNGImageDecoder* decoder = static_cast<PNGImageDecoder*>(png_get_progressive_ptr(m_png));
138
139         // We need to do the setjmp here. Otherwise bad things will happen.
140         if (setjmp(JMPBUF(m_png)))
141             return decoder->setFailed();
142
143         const char* segment;
144         while (unsigned segmentLength = data.getSomeData(segment, m_readOffset)) {
145             m_readOffset += segmentLength;
146             m_currentBufferSize = m_readOffset;
147             png_process_data(m_png, m_info, reinterpret_cast<png_bytep>(const_cast<char*>(segment)), segmentLength);
148             // We explicitly specify the superclass isSizeAvailable() because we
149             // merely want to check if we've managed to set the size, not
150             // (recursively) trigger additional decoding if we haven't.
151             if (sizeOnly ? decoder->ImageDecoder::isSizeAvailable() : decoder->isComplete())
152                 return true;
153         }
154         return false;
155     }
156
157     bool decodingSizeOnly() const { return m_decodingSizeOnly; }
158     png_structp pngPtr() const { return m_png; }
159     png_infop infoPtr() const { return m_info; }
160     png_bytep interlaceBuffer() const { return m_interlaceBuffer; }
161     bool hasAlpha() const { return m_hasAlpha; }
162
163     void setReadOffset(unsigned offset) { m_readOffset = offset; }
164     void setHasAlpha(bool b) { m_hasAlpha = b; }
165
166     void createInterlaceBuffer(int size) { m_interlaceBuffer = new png_byte[size]; }
167
168 private:
169     unsigned m_readOffset;
170     bool m_decodingSizeOnly;
171     png_structp m_png;
172     png_infop m_info;
173     png_bytep m_interlaceBuffer;
174     bool m_hasAlpha;
175     unsigned m_currentBufferSize;
176 };
177
178 PNGImageDecoder::PNGImageDecoder(ImageSource::AlphaOption alphaOption,
179                                  ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
180     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
181     , m_doNothingOnFailure(false)
182 {
183 }
184
185 PNGImageDecoder::~PNGImageDecoder()
186 {
187 }
188
189 bool PNGImageDecoder::isSizeAvailable()
190 {
191     if (!ImageDecoder::isSizeAvailable())
192          decode(true);
193
194     return ImageDecoder::isSizeAvailable();
195 }
196
197 bool PNGImageDecoder::setSize(unsigned width, unsigned height)
198 {
199     if (!ImageDecoder::setSize(width, height))
200         return false;
201
202     prepareScaleDataIfNecessary();
203     return true;
204 }
205
206 ImageFrame* PNGImageDecoder::frameBufferAtIndex(size_t index)
207 {
208     if (index)
209         return 0;
210
211     if (m_frameBufferCache.isEmpty()) {
212         m_frameBufferCache.resize(1);
213         m_frameBufferCache[0].setPremultiplyAlpha(m_premultiplyAlpha);
214     }
215
216     ImageFrame& frame = m_frameBufferCache[0];
217     if (frame.status() != ImageFrame::FrameComplete)
218         decode(false);
219     return &frame;
220 }
221
222 bool PNGImageDecoder::setFailed()
223 {
224     if (m_doNothingOnFailure)
225         return false;
226     m_reader.clear();
227     return ImageDecoder::setFailed();
228 }
229
230 static ColorProfile readColorProfile(png_structp png, png_infop info)
231 {
232 #ifdef PNG_iCCP_SUPPORTED
233     char* profileName;
234     int compressionType;
235 #if (PNG_LIBPNG_VER < 10500)
236     png_charp profile;
237 #else
238     png_bytep profile;
239 #endif
240     png_uint_32 profileLength;
241     if (png_get_iCCP(png, info, &profileName, &compressionType, &profile, &profileLength)) {
242         ColorProfile colorProfile;
243         colorProfile.append(profile, profileLength);
244         return colorProfile;
245     }
246 #endif
247     return ColorProfile();
248 }
249
250 void PNGImageDecoder::headerAvailable()
251 {
252     png_structp png = m_reader->pngPtr();
253     png_infop info = m_reader->infoPtr();
254     png_uint_32 width = png_get_image_width(png, info);
255     png_uint_32 height = png_get_image_height(png, info);
256     
257     // Protect against large images.
258     if (width > cMaxPNGSize || height > cMaxPNGSize) {
259         longjmp(JMPBUF(png), 1);
260         return;
261     }
262     
263     // We can fill in the size now that the header is available.  Avoid memory
264     // corruption issues by neutering setFailed() during this call; if we don't
265     // do this, failures will cause |m_reader| to be deleted, and our jmpbuf
266     // will cease to exist.  Note that we'll still properly set the failure flag
267     // in this case as soon as we longjmp().
268     m_doNothingOnFailure = true;
269     bool result = setSize(width, height);
270     m_doNothingOnFailure = false;
271     if (!result) {
272         longjmp(JMPBUF(png), 1);
273         return;
274     }
275
276     int bitDepth, colorType, interlaceType, compressionType, filterType, channels;
277     png_get_IHDR(png, info, &width, &height, &bitDepth, &colorType, &interlaceType, &compressionType, &filterType);
278
279     if ((colorType == PNG_COLOR_TYPE_RGB || colorType == PNG_COLOR_TYPE_RGB_ALPHA) && !m_ignoreGammaAndColorProfile) {
280         // We currently support color profiles only for RGB and RGBA PNGs.  Supporting
281         // color profiles for gray-scale images is slightly tricky, at least using the
282         // CoreGraphics ICC library, because we expand gray-scale images to RGB but we
283         // don't similarly transform the color profile.  We'd either need to transform
284         // the color profile or we'd need to decode into a gray-scale image buffer and
285         // hand that to CoreGraphics.
286         m_colorProfile = readColorProfile(png, info);
287     }
288
289     // The options we set here match what Mozilla does.
290
291     // Expand to ensure we use 24-bit for RGB and 32-bit for RGBA.
292     if (colorType == PNG_COLOR_TYPE_PALETTE || (colorType == PNG_COLOR_TYPE_GRAY && bitDepth < 8))
293         png_set_expand(png);
294     
295     png_bytep trns = 0;
296     int trnsCount = 0;
297     if (png_get_valid(png, info, PNG_INFO_tRNS)) {
298         png_get_tRNS(png, info, &trns, &trnsCount, 0);
299         png_set_expand(png);
300     }
301
302     if (bitDepth == 16)
303         png_set_strip_16(png);
304
305     if (colorType == PNG_COLOR_TYPE_GRAY || colorType == PNG_COLOR_TYPE_GRAY_ALPHA)
306         png_set_gray_to_rgb(png);
307
308     // Deal with gamma and keep it under our control.
309     double gamma;
310     if (!m_ignoreGammaAndColorProfile && png_get_gAMA(png, info, &gamma)) {
311         if ((gamma <= 0.0) || (gamma > cMaxGamma)) {
312             gamma = cInverseGamma;
313             png_set_gAMA(png, info, gamma);
314         }
315         png_set_gamma(png, cDefaultGamma, gamma);
316     } else
317         png_set_gamma(png, cDefaultGamma, cInverseGamma);
318
319     // Tell libpng to send us rows for interlaced pngs.
320     if (interlaceType == PNG_INTERLACE_ADAM7)
321         png_set_interlace_handling(png);
322
323     // Update our info now.
324     png_read_update_info(png, info);
325     channels = png_get_channels(png, info);
326     ASSERT(channels == 3 || channels == 4);
327
328     m_reader->setHasAlpha(channels == 4);
329
330     if (m_reader->decodingSizeOnly()) {
331         // If we only needed the size, halt the reader.
332 #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))
333         // '0' argument to png_process_data_pause means: Do not cache unprocessed data.
334         m_reader->setReadOffset(m_reader->currentBufferSize() - png_process_data_pause(png, 0));
335 #else
336         m_reader->setReadOffset(m_reader->currentBufferSize() - png->buffer_size);
337         png->buffer_size = 0;
338 #endif
339     }
340 }
341
342 void PNGImageDecoder::rowAvailable(unsigned char* rowBuffer, unsigned rowIndex, int interlacePass)
343 {
344     if (m_frameBufferCache.isEmpty())
345         return;
346
347     // Initialize the framebuffer if needed.
348     ImageFrame& buffer = m_frameBufferCache[0];
349     if (buffer.status() == ImageFrame::FrameEmpty) {
350         if (!buffer.setSize(scaledSize().width(), scaledSize().height())) {
351             longjmp(JMPBUF(m_reader->pngPtr()), 1);
352             return;
353         }
354         buffer.setStatus(ImageFrame::FramePartial);
355         buffer.setHasAlpha(false);
356         buffer.setColorProfile(m_colorProfile);
357
358         // For PNGs, the frame always fills the entire image.
359         buffer.setOriginalFrameRect(IntRect(IntPoint(), size()));
360
361         if (png_get_interlace_type(m_reader->pngPtr(), m_reader->infoPtr()) != PNG_INTERLACE_NONE)
362             m_reader->createInterlaceBuffer((m_reader->hasAlpha() ? 4 : 3) * size().width() * size().height());
363     }
364
365     if (!rowBuffer)
366         return;
367
368     // libpng comments (pasted in here to explain what follows)
369     /*
370      * this function is called for every row in the image.  If the
371      * image is interlacing, and you turned on the interlace handler,
372      * this function will be called for every row in every pass.
373      * Some of these rows will not be changed from the previous pass.
374      * When the row is not changed, the new_row variable will be NULL.
375      * The rows and passes are called in order, so you don't really
376      * need the row_num and pass, but I'm supplying them because it
377      * may make your life easier.
378      *
379      * For the non-NULL rows of interlaced images, you must call
380      * png_progressive_combine_row() passing in the row and the
381      * old row.  You can call this function for NULL rows (it will
382      * just return) and for non-interlaced images (it just does the
383      * memcpy for you) if it will make the code easier.  Thus, you
384      * can just do this for all cases:
385      *
386      *    png_progressive_combine_row(png_ptr, old_row, new_row);
387      *
388      * where old_row is what was displayed for previous rows.  Note
389      * that the first pass (pass == 0 really) will completely cover
390      * the old row, so the rows do not have to be initialized.  After
391      * the first pass (and only for interlaced images), you will have
392      * to pass the current row, and the function will combine the
393      * old row and the new row.
394      */
395
396     png_structp png = m_reader->pngPtr();
397     bool hasAlpha = m_reader->hasAlpha();
398     unsigned colorChannels = hasAlpha ? 4 : 3;
399     png_bytep row;
400     png_bytep interlaceBuffer = m_reader->interlaceBuffer();
401     if (interlaceBuffer) {
402         row = interlaceBuffer + (rowIndex * colorChannels * size().width());
403         png_progressive_combine_row(png, row, rowBuffer);
404     } else
405         row = rowBuffer;
406
407     // Copy the data into our buffer.
408     int width = scaledSize().width();
409     int destY = scaledY(rowIndex);
410
411     // Check that the row is within the image bounds. LibPNG may supply an extra row.
412     if (destY < 0 || destY >= scaledSize().height())
413         return;
414     bool nonTrivialAlpha = false;
415     for (int x = 0; x < width; ++x) {
416         png_bytep pixel = row + (m_scaled ? m_scaledColumns[x] : x) * colorChannels;
417         unsigned alpha = hasAlpha ? pixel[3] : 255;
418         buffer.setRGBA(x, destY, pixel[0], pixel[1], pixel[2], alpha);
419         nonTrivialAlpha |= alpha < 255;
420     }
421     if (nonTrivialAlpha && !buffer.hasAlpha())
422         buffer.setHasAlpha(nonTrivialAlpha);
423 }
424
425 void PNGImageDecoder::pngComplete()
426 {
427     if (!m_frameBufferCache.isEmpty())
428         m_frameBufferCache.first().setStatus(ImageFrame::FrameComplete);
429 }
430
431 void PNGImageDecoder::decode(bool onlySize)
432 {
433 #if PLATFORM(CHROMIUM)
434     TRACE_EVENT("PNGImageDecoder::decode", this, 0);
435 #endif
436     if (failed())
437         return;
438
439     if (!m_reader)
440         m_reader = adoptPtr(new PNGImageReader(this));
441
442     // If we couldn't decode the image but we've received all the data, decoding
443     // has failed.
444     if (!m_reader->decode(*m_data, onlySize) && isAllDataReceived())
445         setFailed();
446     // If we're done decoding the image, we don't need the PNGImageReader
447     // anymore.  (If we failed, |m_reader| has already been cleared.)
448     else if (isComplete())
449         m_reader.clear();
450 }
451
452 } // namespace WebCore