e88ff1d2193b56a1999d16bf3f502f1cd140c3c6
[WebKit.git] / Source / WebCore / platform / image-decoders / jpeg / JPEGImageDecoder.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.
3  *
4  * Portions are Copyright (C) 2001-6 mozilla.org
5  *
6  * Other contributors:
7  *   Stuart Parmenter <stuart@mozilla.com>
8  *
9  * Copyright (C) 2007-2009 Torch Mobile, Inc.
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 "JPEGImageDecoder.h"
42 #include <stdio.h>  // Needed by jpeglib.h for FILE.
43
44 #if OS(WINCE) || PLATFORM(BREWMP_SIMULATOR)
45 // Remove warning: 'FAR' macro redefinition
46 #undef FAR
47
48 // jmorecfg.h in libjpeg checks for XMD_H with the comment: "X11/xmd.h correctly defines INT32"
49 // fix INT32 redefinition error by pretending we are X11/xmd.h
50 #define XMD_H
51 #endif
52
53 extern "C" {
54
55 #include "jpeglib.h"
56
57 #if USE(ICCJPEG)
58 #include "iccjpeg.h"
59 #endif
60
61 }
62
63 #include <setjmp.h>
64
65 namespace WebCore {
66
67 struct decoder_error_mgr {
68     struct jpeg_error_mgr pub; // "public" fields for IJG library
69     jmp_buf setjmp_buffer;     // For handling catastropic errors
70 };
71
72 enum jstate {
73     JPEG_HEADER,                 // Reading JFIF headers
74     JPEG_START_DECOMPRESS,
75     JPEG_DECOMPRESS_PROGRESSIVE, // Output progressive pixels
76     JPEG_DECOMPRESS_SEQUENTIAL,  // Output sequential pixels
77     JPEG_DONE,
78     JPEG_ERROR    
79 };
80
81 void init_source(j_decompress_ptr jd);
82 boolean fill_input_buffer(j_decompress_ptr jd);
83 void skip_input_data(j_decompress_ptr jd, long num_bytes);
84 void term_source(j_decompress_ptr jd);
85 void error_exit(j_common_ptr cinfo);
86
87 // Implementation of a JPEG src object that understands our state machine
88 struct decoder_source_mgr {
89     // public fields; must be first in this struct!
90     struct jpeg_source_mgr pub;
91
92     JPEGImageReader* decoder;
93 };
94
95 static ColorProfile readColorProfile(jpeg_decompress_struct* info)
96 {
97 #if USE(ICCJPEG)
98     JOCTET* profile;
99     unsigned int profileLength;
100
101     if (!read_icc_profile(info, &profile, &profileLength))
102         return ColorProfile();
103
104     ColorProfile colorProfile;
105     colorProfile.append(reinterpret_cast<char*>(profile), profileLength);
106     free(profile);
107     return colorProfile;
108 #else
109     return ColorProfile();
110 #endif
111 }
112
113 class JPEGImageReader
114 {
115 public:
116     JPEGImageReader(JPEGImageDecoder* decoder)
117         : m_decoder(decoder)
118         , m_bufferLength(0)
119         , m_bytesToSkip(0)
120         , m_state(JPEG_HEADER)
121         , m_samples(0)
122     {
123         memset(&m_info, 0, sizeof(jpeg_decompress_struct));
124  
125         // We set up the normal JPEG error routines, then override error_exit.
126         m_info.err = jpeg_std_error(&m_err.pub);
127         m_err.pub.error_exit = error_exit;
128
129         // Allocate and initialize JPEG decompression object.
130         jpeg_create_decompress(&m_info);
131   
132         decoder_source_mgr* src = 0;
133         if (!m_info.src) {
134             src = (decoder_source_mgr*)fastCalloc(sizeof(decoder_source_mgr), 1);
135             if (!src) {
136                 m_state = JPEG_ERROR;
137                 return;
138             }
139         }
140
141         m_info.src = (jpeg_source_mgr*)src;
142
143         // Set up callback functions.
144         src->pub.init_source = init_source;
145         src->pub.fill_input_buffer = fill_input_buffer;
146         src->pub.skip_input_data = skip_input_data;
147         src->pub.resync_to_restart = jpeg_resync_to_restart;
148         src->pub.term_source = term_source;
149         src->decoder = this;
150
151         // Enable these markers for the ICC color profile.
152         // Apparently there are 16 of these markers.  I don't see anywhere in the header with this constant.
153         for (unsigned i = 0; i < 0xF; ++i)
154             jpeg_save_markers(&m_info, JPEG_APP0 + i, 0xFFFF);
155     }
156
157     ~JPEGImageReader()
158     {
159         close();
160     }
161
162     void close()
163     {
164         decoder_source_mgr* src = (decoder_source_mgr*)m_info.src;
165         if (src)
166             fastFree(src);
167         m_info.src = 0;
168
169         jpeg_destroy_decompress(&m_info);
170     }
171
172     void skipBytes(long numBytes)
173     {
174         decoder_source_mgr* src = (decoder_source_mgr*)m_info.src;
175         long bytesToSkip = std::min(numBytes, (long)src->pub.bytes_in_buffer);
176         src->pub.bytes_in_buffer -= (size_t)bytesToSkip;
177         src->pub.next_input_byte += bytesToSkip;
178
179         m_bytesToSkip = std::max(numBytes - bytesToSkip, static_cast<long>(0));
180     }
181
182     bool decode(const Vector<char>& data, bool onlySize)
183     {
184         m_decodingSizeOnly = onlySize;
185
186         unsigned newByteCount = data.size() - m_bufferLength;
187         unsigned readOffset = m_bufferLength - m_info.src->bytes_in_buffer;
188
189         m_info.src->bytes_in_buffer += newByteCount;
190         m_info.src->next_input_byte = (JOCTET*)(data.data()) + readOffset;
191
192         // If we still have bytes to skip, try to skip those now.
193         if (m_bytesToSkip)
194             skipBytes(m_bytesToSkip);
195
196         m_bufferLength = data.size();
197         
198         // We need to do the setjmp here. Otherwise bad things will happen
199         if (setjmp(m_err.setjmp_buffer))
200             return m_decoder->setFailed();
201
202         switch (m_state) {
203         case JPEG_HEADER:
204             // Read file parameters with jpeg_read_header().
205             if (jpeg_read_header(&m_info, true) == JPEG_SUSPENDED)
206                 return false; // I/O suspension.
207
208             // Let libjpeg take care of gray->RGB and YCbCr->RGB conversions.
209             switch (m_info.jpeg_color_space) {
210             case JCS_GRAYSCALE:
211             case JCS_YCbCr:
212                 // Grayscale images get "upsampled" by libjpeg.  If we use
213                 // their color profile, CoreGraphics will "upsample" them
214                 // again, resulting in horizontal distortions.
215                 m_decoder->setIgnoreGammaAndColorProfile(true);
216                 // Note fall-through!
217             case JCS_RGB:
218                 m_info.out_color_space = JCS_RGB;
219                 break;
220             case JCS_CMYK:
221             case JCS_YCCK:
222                 // jpeglib cannot convert these to rgb, but it can convert ycck
223                 // to cmyk.
224                 m_info.out_color_space = JCS_CMYK;
225                 break;
226             default:
227                 return m_decoder->setFailed();
228             }
229
230             // Don't allocate a giant and superfluous memory buffer when the
231             // image is a sequential JPEG.
232             m_info.buffered_image = jpeg_has_multiple_scans(&m_info);
233
234             // Used to set up image size so arrays can be allocated.
235             jpeg_calc_output_dimensions(&m_info);
236
237             // Make a one-row-high sample array that will go away when done with
238             // image. Always make it big enough to hold an RGB row.  Since this
239             // uses the IJG memory manager, it must be allocated before the call
240             // to jpeg_start_compress().
241             m_samples = (*m_info.mem->alloc_sarray)((j_common_ptr) &m_info, JPOOL_IMAGE, m_info.output_width * 4, 1);
242
243             m_state = JPEG_START_DECOMPRESS;
244
245             // We can fill in the size now that the header is available.
246             if (!m_decoder->setSize(m_info.image_width, m_info.image_height))
247                 return false;
248
249             if (!m_decoder->ignoresGammaAndColorProfile())
250                 m_decoder->setColorProfile(readColorProfile(info()));
251
252             if (m_decodingSizeOnly) {
253                 // We can stop here.  Reduce our buffer length and available
254                 // data.
255                 m_bufferLength -= m_info.src->bytes_in_buffer;
256                 m_info.src->bytes_in_buffer = 0;
257                 return true;
258             }
259         // FALL THROUGH
260
261         case JPEG_START_DECOMPRESS:
262             // Set parameters for decompression.
263             // FIXME -- Should reset dct_method and dither mode for final pass
264             // of progressive JPEG.
265             m_info.dct_method =  JDCT_ISLOW;
266             m_info.dither_mode = JDITHER_FS;
267             m_info.do_fancy_upsampling = true;
268             m_info.enable_2pass_quant = false;
269             m_info.do_block_smoothing = true;
270
271             // Start decompressor.
272             if (!jpeg_start_decompress(&m_info))
273                 return false; // I/O suspension.
274
275             // If this is a progressive JPEG ...
276             m_state = (m_info.buffered_image) ? JPEG_DECOMPRESS_PROGRESSIVE : JPEG_DECOMPRESS_SEQUENTIAL;
277         // FALL THROUGH
278
279         case JPEG_DECOMPRESS_SEQUENTIAL:
280             if (m_state == JPEG_DECOMPRESS_SEQUENTIAL) {
281   
282                 if (!m_decoder->outputScanlines())
283                     return false; // I/O suspension.
284   
285                 // If we've completed image output...
286                 ASSERT(m_info.output_scanline == m_info.output_height);
287                 m_state = JPEG_DONE;
288             }
289         // FALL THROUGH
290
291         case JPEG_DECOMPRESS_PROGRESSIVE:
292             if (m_state == JPEG_DECOMPRESS_PROGRESSIVE) {
293                 int status;
294                 do {
295                     status = jpeg_consume_input(&m_info);
296                 } while ((status != JPEG_SUSPENDED) && (status != JPEG_REACHED_EOI));
297
298                 for (;;) {
299                     if (!m_info.output_scanline) {
300                         int scan = m_info.input_scan_number;
301
302                         // If we haven't displayed anything yet
303                         // (output_scan_number == 0) and we have enough data for
304                         // a complete scan, force output of the last full scan.
305                         if (!m_info.output_scan_number && (scan > 1) && (status != JPEG_REACHED_EOI))
306                             --scan;
307
308                         if (!jpeg_start_output(&m_info, scan))
309                             return false; // I/O suspension.
310                     }
311
312                     if (m_info.output_scanline == 0xffffff)
313                         m_info.output_scanline = 0;
314
315                     if (!m_decoder->outputScanlines()) {
316                         if (!m_info.output_scanline)
317                             // Didn't manage to read any lines - flag so we
318                             // don't call jpeg_start_output() multiple times for
319                             // the same scan.
320                             m_info.output_scanline = 0xffffff;
321                         return false; // I/O suspension.
322                     }
323
324                     if (m_info.output_scanline == m_info.output_height) {
325                         if (!jpeg_finish_output(&m_info))
326                             return false; // I/O suspension.
327
328                         if (jpeg_input_complete(&m_info) && (m_info.input_scan_number == m_info.output_scan_number))
329                             break;
330
331                         m_info.output_scanline = 0;
332                     }
333                 }
334
335                 m_state = JPEG_DONE;
336             }
337         // FALL THROUGH
338
339         case JPEG_DONE:
340             // Finish decompression.
341             return jpeg_finish_decompress(&m_info);
342
343         case JPEG_ERROR:
344             // We can get here if the constructor failed.
345             return m_decoder->setFailed();
346         }
347
348         return true;
349     }
350
351     jpeg_decompress_struct* info() { return &m_info; }
352     JSAMPARRAY samples() const { return m_samples; }
353     JPEGImageDecoder* decoder() { return m_decoder; }
354
355 private:
356     JPEGImageDecoder* m_decoder;
357     unsigned m_bufferLength;
358     int m_bytesToSkip;
359     bool m_decodingSizeOnly;
360     bool m_initialized;
361
362     jpeg_decompress_struct m_info;
363     decoder_error_mgr m_err;
364     jstate m_state;
365
366     JSAMPARRAY m_samples;
367 };
368
369 // Override the standard error method in the IJG JPEG decoder code.
370 void error_exit(j_common_ptr cinfo)
371 {
372     // Return control to the setjmp point.
373     decoder_error_mgr *err = (decoder_error_mgr *) cinfo->err;
374     longjmp(err->setjmp_buffer, -1);
375 }
376
377 void init_source(j_decompress_ptr jd)
378 {
379 }
380
381 void skip_input_data(j_decompress_ptr jd, long num_bytes)
382 {
383     decoder_source_mgr *src = (decoder_source_mgr *)jd->src;
384     src->decoder->skipBytes(num_bytes);
385 }
386
387 boolean fill_input_buffer(j_decompress_ptr jd)
388 {
389     // Our decode step always sets things up properly, so if this method is ever
390     // called, then we have hit the end of the buffer.  A return value of false
391     // indicates that we have no data to supply yet.
392     return false;
393 }
394
395 void term_source(j_decompress_ptr jd)
396 {
397     decoder_source_mgr *src = (decoder_source_mgr *)jd->src;
398     src->decoder->decoder()->jpegComplete();
399 }
400
401 JPEGImageDecoder::JPEGImageDecoder(ImageSource::AlphaOption alphaOption,
402                                    ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
403     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
404 {
405 }
406
407 JPEGImageDecoder::~JPEGImageDecoder()
408 {
409 }
410
411 bool JPEGImageDecoder::isSizeAvailable()
412 {
413     if (!ImageDecoder::isSizeAvailable())
414          decode(true);
415
416     return ImageDecoder::isSizeAvailable();
417 }
418
419 bool JPEGImageDecoder::setSize(unsigned width, unsigned height)
420 {
421     if (!ImageDecoder::setSize(width, height))
422         return false;
423
424     prepareScaleDataIfNecessary();
425     return true;
426 }
427
428 ImageFrame* JPEGImageDecoder::frameBufferAtIndex(size_t index)
429 {
430     if (index)
431         return 0;
432
433     if (m_frameBufferCache.isEmpty()) {
434         m_frameBufferCache.resize(1);
435         m_frameBufferCache[0].setPremultiplyAlpha(m_premultiplyAlpha);
436     }
437
438     ImageFrame& frame = m_frameBufferCache[0];
439     if (frame.status() != ImageFrame::FrameComplete)
440         decode(false);
441     return &frame;
442 }
443
444 bool JPEGImageDecoder::setFailed()
445 {
446     m_reader.clear();
447     return ImageDecoder::setFailed();
448 }
449
450 bool JPEGImageDecoder::outputScanlines()
451 {
452     if (m_frameBufferCache.isEmpty())
453         return false;
454
455     // Initialize the framebuffer if needed.
456     ImageFrame& buffer = m_frameBufferCache[0];
457     if (buffer.status() == ImageFrame::FrameEmpty) {
458         if (!buffer.setSize(scaledSize().width(), scaledSize().height()))
459             return setFailed();
460         buffer.setStatus(ImageFrame::FramePartial);
461         buffer.setHasAlpha(false);
462         buffer.setColorProfile(m_colorProfile);
463
464         // For JPEGs, the frame always fills the entire image.
465         buffer.setOriginalFrameRect(IntRect(IntPoint(), size()));
466     }
467
468     jpeg_decompress_struct* info = m_reader->info();
469     JSAMPARRAY samples = m_reader->samples();
470
471     while (info->output_scanline < info->output_height) {
472         // jpeg_read_scanlines will increase the scanline counter, so we
473         // save the scanline before calling it.
474         int sourceY = info->output_scanline;
475         /* Request one scanline.  Returns 0 or 1 scanlines. */
476         if (jpeg_read_scanlines(info, samples, 1) != 1)
477             return false;
478
479         int destY = scaledY(sourceY);
480         if (destY < 0)
481             continue;
482         int width = m_scaled ? m_scaledColumns.size() : info->output_width;
483         for (int x = 0; x < width; ++x) {
484             JSAMPLE* jsample = *samples + (m_scaled ? m_scaledColumns[x] : x) * ((info->out_color_space == JCS_RGB) ? 3 : 4);
485             if (info->out_color_space == JCS_RGB)
486                 buffer.setRGBA(x, destY, jsample[0], jsample[1], jsample[2], 0xFF);
487             else if (info->out_color_space == JCS_CMYK) {
488                 // Source is 'Inverted CMYK', output is RGB.
489                 // See: http://www.easyrgb.com/math.php?MATH=M12#text12
490                 // Or:  http://www.ilkeratalay.com/colorspacesfaq.php#rgb
491                 // From CMYK to CMY:
492                 // X =   X    * (1 -   K   ) +   K  [for X = C, M, or Y]
493                 // Thus, from Inverted CMYK to CMY is:
494                 // X = (1-iX) * (1 - (1-iK)) + (1-iK) => 1 - iX*iK
495                 // From CMY (0..1) to RGB (0..1):
496                 // R = 1 - C => 1 - (1 - iC*iK) => iC*iK  [G and B similar]
497                 unsigned k = jsample[3];
498                 buffer.setRGBA(x, destY, jsample[0] * k / 255, jsample[1] * k / 255, jsample[2] * k / 255, 0xFF);
499             } else {
500                 ASSERT_NOT_REACHED();
501                 return setFailed();
502             }
503         }
504     }
505
506     return true;
507 }
508
509 void JPEGImageDecoder::jpegComplete()
510 {
511     if (m_frameBufferCache.isEmpty())
512         return;
513
514     // Hand back an appropriately sized buffer, even if the image ended up being
515     // empty.
516     m_frameBufferCache[0].setStatus(ImageFrame::FrameComplete);
517 }
518
519 void JPEGImageDecoder::decode(bool onlySize)
520 {
521     if (failed())
522         return;
523
524     if (!m_reader)
525         m_reader.set(new JPEGImageReader(this));
526
527     // If we couldn't decode the image but we've received all the data, decoding
528     // has failed.
529     if (!m_reader->decode(m_data->buffer(), onlySize) && isAllDataReceived())
530         setFailed();
531     // If we're done decoding the image, we don't need the JPEGImageReader
532     // anymore.  (If we failed, |m_reader| has already been cleared.)
533     else if (!m_frameBufferCache.isEmpty() && (m_frameBufferCache[0].status() == ImageFrame::FrameComplete))
534         m_reader.clear();
535 }
536
537 }