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