images/io-libjpeg.c

   1 /*
   2  *      Image Library -- libjpeg
   3  *
   4  *      (c) 2006 Pavel Charvat <pchar@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #undef LOCAL_DEBUG
  11
  12 #include "lib/lib.h"
  13 #include "lib/mempool.h"
  14 #include "lib/fastbuf.h"
  15 #include "images/images.h"
  16 #include "images/error.h"
  17 #include "images/color.h"
  18 #include "images/io-main.h"
  19
  20 #include <stdio.h>
  21 #include <sys/types.h>
  22 #include <jpeglib.h>
  23 #include <jerror.h>
  24 #include <setjmp.h>
  25
  26 struct libjpeg_err {
  27   struct jpeg_error_mgr pub;
  28   jmp_buf setjmp_buf;
  29   struct image_io *io;
  30 };
  31
  32 struct libjpeg_read_internals {
  33   struct jpeg_decompress_struct cinfo;
  34   struct jpeg_source_mgr src;
  35   struct libjpeg_err err;
  36   struct fastbuf *fastbuf;
  37   byte *fastbuf_pos;
  38 };
  39
  40 struct libjpeg_write_internals {
  41   struct jpeg_compress_struct cinfo;
  42   struct jpeg_destination_mgr dest;
  43   struct libjpeg_err err;
  44   struct fastbuf *fastbuf;
  45   byte *fastbuf_pos;
  46 };
  47
  48 static void NONRET
  49 libjpeg_read_error_exit(j_common_ptr cinfo)
  50 {
  51   DBG("libjpeg_error_exit()");
  52   struct libjpeg_err *e = (struct libjpeg_err *)cinfo->err;
  53   byte buf[JMSG_LENGTH_MAX];
  54   e->pub.format_message(cinfo, buf);
  55   IMAGE_ERROR(e->io->context, IMAGE_ERROR_READ_FAILED, "%s", buf);
  56   longjmp(e->setjmp_buf, 1);
  57 }
  58
  59 static void NONRET
  60 libjpeg_write_error_exit(j_common_ptr cinfo)
  61 {
  62   DBG("libjpeg_error_exit()");
  63   struct libjpeg_err *e = (struct libjpeg_err *)cinfo->err;
  64   byte buf[JMSG_LENGTH_MAX];
  65   e->pub.format_message(cinfo, buf);
  66   IMAGE_ERROR(e->io->context, IMAGE_ERROR_WRITE_FAILED, "%s", buf);
  67   longjmp(e->setjmp_buf, 1);
  68 }
  69
  70 static void
  71 libjpeg_emit_message(j_common_ptr cinfo UNUSED, int msg_level UNUSED)
  72 {
  73 #ifdef LOCAL_DEBUG
  74   byte buf[JMSG_LENGTH_MAX];
  75   cinfo->err->format_message(cinfo, buf);
  76   DBG("libjpeg_emit_message(): [%d] %s", msg_level, buf);
  77 #endif
  78   if (unlikely(msg_level == -1))
  79     longjmp(((struct libjpeg_err *)(cinfo)->err)->setjmp_buf, 1);
  80 }
  81
  82 static inline uns
  83 libjpeg_fastbuf_read_prepare(struct libjpeg_read_internals *i)
  84 {
  85   byte *start;
  86   uns len = bdirect_read_prepare(i->fastbuf, &start);
  87   i->fastbuf_pos = start + len;
  88   i->src.next_input_byte = start;
  89   i->src.bytes_in_buffer = len;
  90   return len;
  91 }
  92
  93 static inline void
  94 libjpeg_fastbuf_read_commit(struct libjpeg_read_internals *i)
  95 {
  96   bdirect_read_commit(i->fastbuf, i->fastbuf_pos);
  97 }
  98
  99 static void
 100 libjpeg_init_source(j_decompress_ptr cinfo)
 101 {
 102   DBG("libjpeg_init_source()");
 103   libjpeg_fastbuf_read_prepare((struct libjpeg_read_internals *)cinfo);
 104 }
 105
 106 static void
 107 libjpeg_term_source(j_decompress_ptr cinfo UNUSED)
 108 {
 109   DBG("libjpeg_term_source()");
 110   //libjpeg_fastbuf_read_commit((struct libjpeg_read_internals *)cinfo);
 111 }
 112
 113 static boolean
 114 libjpeg_fill_input_buffer(j_decompress_ptr cinfo)
 115 {
 116   DBG("libjpeg_fill_input_buffer()");
 117   struct libjpeg_read_internals *i = (struct libjpeg_read_internals *)cinfo;
 118   libjpeg_fastbuf_read_commit(i);
 119   return !!libjpeg_fastbuf_read_prepare(i);
 120 }
 121
 122 static void
 123 libjpeg_skip_input_data(j_decompress_ptr cinfo, long num_bytes)
 124 {
 125   DBG("libjpeg_skip_input_data(num_bytes=%d)", (int)num_bytes);
 126   if (num_bytes > 0)
 127     {
 128       struct libjpeg_read_internals *i = (struct libjpeg_read_internals *)cinfo;
 129       if ((unsigned long)num_bytes <= i->src.bytes_in_buffer)
 130         {
 131           i->src.next_input_byte += num_bytes;
 132           i->src.bytes_in_buffer -= num_bytes;
 133         }
 134       else
 135         {
 136           num_bytes -= i->src.bytes_in_buffer;
 137           libjpeg_fastbuf_read_commit(i);
 138           if (!bskip(i->fastbuf, num_bytes))
 139             {
 140               IMAGE_ERROR(i->err.io->context, IMAGE_ERROR_READ_FAILED, "Incomplete JPEG file");
 141               longjmp(i->err.setjmp_buf, 1);
 142             }
 143           libjpeg_fastbuf_read_prepare(i);
 144         }
 145     }
 146 }
 147
 148 static inline void
 149 libjpeg_fastbuf_write_prepare(struct libjpeg_write_internals *i)
 150 {
 151   byte *start;
 152   uns len = bdirect_write_prepare(i->fastbuf, &start);
 153   i->fastbuf_pos = start + len;
 154   i->dest.next_output_byte = start;
 155   i->dest.free_in_buffer = len;
 156   if (!len)
 157     {
 158       IMAGE_ERROR(i->err.io->context, IMAGE_ERROR_WRITE_FAILED, "Unexpected end of stream");
 159       longjmp(i->err.setjmp_buf, 1);
 160     }
 161 }
 162
 163 static void
 164 libjpeg_init_destination(j_compress_ptr cinfo)
 165 {
 166   DBG("libjpeg_init_destination()");
 167   libjpeg_fastbuf_write_prepare((struct libjpeg_write_internals *)cinfo);
 168 }
 169
 170 static void
 171 libjpeg_term_destination(j_compress_ptr cinfo)
 172 {
 173   DBG("libjpeg_term_destination()");
 174   struct libjpeg_write_internals *i = (struct libjpeg_write_internals *)cinfo;
 175   bdirect_write_commit(i->fastbuf, (byte *)i->dest.next_output_byte);
 176 }
 177
 178 static boolean
 179 libjpeg_empty_output_buffer(j_compress_ptr cinfo)
 180 {
 181   DBG("libjpeg_empty_output_buffer()");
 182   struct libjpeg_write_internals *i = (struct libjpeg_write_internals *)cinfo;
 183   bdirect_write_commit(i->fastbuf, i->fastbuf_pos);
 184   libjpeg_fastbuf_write_prepare(i);
 185   return TRUE;
 186 }
 187
 188 static inline uns
 189 libjpeg_read_byte(struct libjpeg_read_internals *i)
 190 {
 191   DBG("libjpeg_read_byte()");
 192   if (!i->src.bytes_in_buffer)
 193     if (!libjpeg_fill_input_buffer(&i->cinfo))
 194       ERREXIT(&i->cinfo, JERR_CANT_SUSPEND);
 195   i->src.bytes_in_buffer--;
 196   return *i->src.next_input_byte++;
 197 }
 198
 199 static inline void
 200 libjpeg_read_buf(struct libjpeg_read_internals *i, byte *buf, uns len)
 201 {
 202   DBG("libjpeg_read_buf(len=%u)", len);
 203   while (len)
 204     {
 205       if (!i->src.bytes_in_buffer)
 206         if (!libjpeg_fill_input_buffer(&i->cinfo))
 207           ERREXIT(&i->cinfo, JERR_CANT_SUSPEND);
 208       uns buf_size = i->src.bytes_in_buffer;
 209       uns read_size = MIN(buf_size, len);
 210       memcpy(buf, i->src.next_input_byte, read_size);
 211       i->src.bytes_in_buffer -= read_size;
 212       i->src.next_input_byte += read_size;
 213       len -= read_size;
 214     }
 215 }
 216
 217 static byte libjpeg_exif_header[6] = { 'E', 'x', 'i', 'f', 0, 0 };
 218
 219 static boolean
 220 libjpeg_app1_preprocessor(j_decompress_ptr cinfo)
 221 {
 222   struct libjpeg_read_internals *i = (struct libjpeg_read_internals *)cinfo;
 223   struct image_io *io = i->err.io;
 224   uns len = libjpeg_read_byte(i) << 8;
 225   len += libjpeg_read_byte(i);
 226   DBG("Found APP1 marker, len=%u", len);
 227   if (len < 2)
 228     return TRUE;
 229   len -= 2;
 230   if (len < 7 /*|| io->exif_size*/)
 231     {
 232       libjpeg_skip_input_data(cinfo, len);
 233       return TRUE;
 234     }
 235   byte header[6];
 236   libjpeg_read_buf(i, header, 6);
 237   if (memcmp(header, libjpeg_exif_header, 6))
 238     {
 239       libjpeg_skip_input_data(cinfo, len - 6);
 240       return TRUE;
 241     }
 242   io->exif_size = len;
 243   io->exif_data = mp_alloc(io->internal_pool, len);
 244   memcpy(io->exif_data, header, 6);
 245   libjpeg_read_buf(i, io->exif_data + 6, len - 6);
 246   DBG("Parsed EXIF of length %u", len);
 247   return TRUE;
 248 }
 249
 250 static void
 251 libjpeg_read_cancel(struct image_io *io)
 252 {
 253   DBG("libjpeg_read_cancel()");
 254   struct libjpeg_read_internals *i = io->read_data;
 255   jpeg_destroy_decompress(&i->cinfo);
 256 }
 257
 258 int
 259 libjpeg_read_header(struct image_io *io)
 260 {
 261   DBG("libjpeg_read_header()");
 262   struct libjpeg_read_internals *i = io->read_data = mp_alloc(io->internal_pool, sizeof(*i));
 263   i->fastbuf = io->fastbuf;
 264
 265   /* Create libjpeg read structure */
 266   DBG("Creating libjpeg read structure");
 267   i->cinfo.err = jpeg_std_error(&i->err.pub);
 268   i->err.pub.error_exit = libjpeg_read_error_exit;
 269   i->err.pub.emit_message = libjpeg_emit_message;
 270   i->err.io = io;
 271   if (setjmp(i->err.setjmp_buf))
 272     {
 273       DBG("Libjpeg failed to read the image, longjump saved us");
 274       jpeg_destroy_decompress(&i->cinfo);
 275       return 0;
 276     }
 277   jpeg_create_decompress(&i->cinfo);
 278
 279   /* Initialize source manager */
 280   i->cinfo.src = &i->src;
 281   i->src.init_source = libjpeg_init_source;
 282   i->src.fill_input_buffer = libjpeg_fill_input_buffer;
 283   i->src.skip_input_data = libjpeg_skip_input_data;
 284   i->src.resync_to_restart = jpeg_resync_to_restart;
 285   i->src.term_source = libjpeg_term_source;
 286
 287   if (io->flags & IMAGE_IO_WANT_EXIF)
 288     jpeg_set_marker_processor(&i->cinfo, JPEG_APP0 + 1, libjpeg_app1_preprocessor);
 289
 290   /* Read JPEG header and setup decompression options */
 291   DBG("Reading image header");
 292   jpeg_read_header(&i->cinfo, TRUE);
 293   switch (i->cinfo.jpeg_color_space)
 294     {
 295       case JCS_GRAYSCALE:
 296         io->flags = COLOR_SPACE_GRAYSCALE;
 297         io->number_of_colors = 1 << 8;
 298         break;
 299       default:
 300         io->flags = COLOR_SPACE_RGB;
 301         io->number_of_colors = 1 << 24;
 302         break;
 303     }
 304   io->cols = i->cinfo.image_width;
 305   io->rows = i->cinfo.image_height;
 306
 307   io->read_cancel = libjpeg_read_cancel;
 308   return 1;
 309 }
 310
 311 int
 312 libjpeg_read_data(struct image_io *io)
 313 {
 314   DBG("libjpeg_read_data()");
 315
 316   struct libjpeg_read_internals *i = io->read_data;
 317
 318   /* Select color space */
 319   switch (io->flags & IMAGE_COLOR_SPACE)
 320     {
 321       case COLOR_SPACE_GRAYSCALE:
 322         i->cinfo.out_color_space = JCS_GRAYSCALE;
 323         break;
 324       case COLOR_SPACE_RGB:
 325         i->cinfo.out_color_space = JCS_RGB;
 326         break;
 327       default:
 328         jpeg_destroy_decompress(&i->cinfo);
 329         IMAGE_ERROR(io->context, IMAGE_ERROR_INVALID_PIXEL_FORMAT, "Unsupported color space.");
 330         return 0;
 331     }
 332
 333   /* Prepare the image  */
 334   struct image_io_read_data_internals rdi;
 335   if (io->cols <= (i->cinfo.image_width >> 3) && io->rows <= (i->cinfo.image_height >> 3))
 336     {
 337       DBG("Scaling to 1/8");
 338       i->cinfo.scale_num = 1;
 339       i->cinfo.scale_denom = 8;
 340     }
 341   else if (io->cols <= (i->cinfo.image_width >> 2) && io->rows <= (i->cinfo.image_height >> 2))
 342     {
 343       DBG("Scaling to 1/4");
 344       i->cinfo.scale_num = 1;
 345       i->cinfo.scale_denom = 4;
 346     }
 347   else if (io->cols <= (i->cinfo.image_width >> 1) && io->rows <= (i->cinfo.image_height >> 1))
 348     {
 349       DBG("Scaling to 1/2");
 350       i->cinfo.scale_num = 1;
 351       i->cinfo.scale_denom = 2;
 352     }
 353   jpeg_calc_output_dimensions(&i->cinfo);
 354   DBG("Output dimensions %ux%u", (uns)i->cinfo.output_width, (uns)i->cinfo.output_height);
 355   if (unlikely(!image_io_read_data_prepare(&rdi, io, i->cinfo.output_width, i->cinfo.output_height, io->flags)))
 356     {
 357       jpeg_destroy_decompress(&i->cinfo);
 358       return 0;
 359     }
 360
 361   /* Setup fallback */
 362   if (setjmp(i->err.setjmp_buf))
 363     {
 364       DBG("Libjpeg failed to read the image, longjump saved us");
 365       jpeg_destroy_decompress(&i->cinfo);
 366       image_io_read_data_break(&rdi, io);
 367       return 0;
 368     }
 369
 370   /* Decompress the image */
 371   struct image *img = rdi.image;
 372   jpeg_start_decompress(&i->cinfo);
 373   switch (img->pixel_size)
 374     {
 375       /* grayscale or RGB */
 376       case 1:
 377       case 3:
 378         {
 379           byte *pixels = img->pixels;
 380           for (uns r = img->rows; r--; )
 381             {
 382               jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&pixels, 1);
 383               pixels += img->row_size;
 384             }
 385         }
 386         break;
 387       /* grayscale with alpha */
 388       case 2:
 389         {
 390           byte buf[img->cols], *src;
 391 #         define IMAGE_WALK_PREFIX(x) walk_##x
 392 #         define IMAGE_WALK_INLINE
 393 #         define IMAGE_WALK_IMAGE img
 394 #         define IMAGE_WALK_UNROLL 4
 395 #         define IMAGE_WALK_COL_STEP 2
 396 #         define IMAGE_WALK_DO_ROW_START do{ src = buf; jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&src, 1); }while(0)
 397 #         define IMAGE_WALK_DO_STEP do{ walk_pos[0] = *src++; walk_pos[1] = 255; }while(0)
 398 #         include "images/image-walk.h"
 399         }
 400         break;
 401       /* RGBA or aligned RGB */
 402       case 4:
 403         {
 404           byte buf[img->cols * 3], *src;
 405 #         define IMAGE_WALK_PREFIX(x) walk_##x
 406 #         define IMAGE_WALK_INLINE
 407 #         define IMAGE_WALK_IMAGE img
 408 #         define IMAGE_WALK_UNROLL 4
 409 #         define IMAGE_WALK_COL_STEP 4
 410 #         define IMAGE_WALK_DO_ROW_START do{ src = buf; jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&src, 1); }while(0)
 411 #         define IMAGE_WALK_DO_STEP do{ *(u32 *)walk_pos = *(u32 *)src; walk_pos[3] = 255; src += 3; }while(0)
 412 #         include "images/image-walk.h"
 413         }
 414         break;
 415       default:
 416         ASSERT(0);
 417     }
 418   ASSERT(i->cinfo.output_scanline == i->cinfo.output_height);
 419
 420   /* Destroy libjpeg object */
 421   jpeg_finish_decompress(&i->cinfo);
 422   jpeg_destroy_decompress(&i->cinfo);
 423
 424   /* Finish the image */
 425   return image_io_read_data_finish(&rdi, io);
 426 }
 427
 428 int
 429 libjpeg_write(struct image_io *io)
 430 {
 431   DBG("libjpeg_write()");
 432   struct libjpeg_write_internals i;
 433   i.fastbuf = io->fastbuf;
 434
 435   /* Create libjpeg write structure */
 436   DBG("Creating libjpeg write structure");
 437   i.cinfo.err = jpeg_std_error(&i.err.pub);
 438   i.err.pub.error_exit = libjpeg_write_error_exit;
 439   i.err.pub.emit_message = libjpeg_emit_message;
 440   i.err.io = io;
 441   if (setjmp(i.err.setjmp_buf))
 442     {
 443       DBG("Libjpeg failed to write the image, longjump saved us");
 444       jpeg_destroy_compress(&i.cinfo);
 445       return 0;
 446     }
 447   jpeg_create_compress(&i.cinfo);
 448
 449   /* Initialize destination manager */
 450   i.cinfo.dest = &i.dest;
 451   i.dest.init_destination = libjpeg_init_destination;
 452   i.dest.term_destination = libjpeg_term_destination;
 453   i.dest.empty_output_buffer = libjpeg_empty_output_buffer;
 454
 455   /* Set output parameters */
 456   struct image *img = io->image;
 457   i.cinfo.image_width = img->cols;
 458   i.cinfo.image_height = img->rows;
 459   switch (img->flags & IMAGE_COLOR_SPACE)
 460     {
 461       case COLOR_SPACE_GRAYSCALE:
 462         i.cinfo.input_components = 1;
 463         i.cinfo.in_color_space = JCS_GRAYSCALE;
 464         break;
 465       case COLOR_SPACE_RGB:
 466         i.cinfo.input_components = 3;
 467         i.cinfo.in_color_space = JCS_RGB;
 468         break;
 469       default:
 470         jpeg_destroy_compress(&i.cinfo);
 471         IMAGE_ERROR(io->context, IMAGE_ERROR_INVALID_PIXEL_FORMAT, "Unsupported pixel format.");
 472         return 0;
 473     }
 474   jpeg_set_defaults(&i.cinfo);
 475   if (io->jpeg_quality)
 476     jpeg_set_quality(&i.cinfo, MIN(io->jpeg_quality, 100), 1);
 477   if (io->exif_size)
 478     {
 479       /* According to the Exif specification, the Exif APP1 marker has to follow immediately after the SOI,
 480        * just as the JFIF specification requires the same for the JFIF APP0 marker!
 481        * Therefore a JPEG file cannot legally be both Exif and JFIF.  */
 482       i.cinfo.write_JFIF_header = FALSE;
 483       i.cinfo.write_Adobe_marker = FALSE;
 484     }
 485
 486   /* Compress the image */
 487   jpeg_start_compress(&i.cinfo, TRUE);
 488   if (io->exif_size)
 489     {
 490       DBG("Writing EXIF");
 491       jpeg_write_marker(&i.cinfo, JPEG_APP0 + 1, io->exif_data, io->exif_size);
 492     }
 493   switch (img->pixel_size)
 494     {
 495       /* grayscale or RGB */
 496       case 1:
 497       case 3:
 498         {
 499           byte *pixels = img->pixels;
 500           for (uns r = img->rows; r--; )
 501             {
 502               jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&pixels, 1);
 503               pixels += img->row_size;
 504             }
 505         }
 506         break;
 507       /* grayscale with alpha (ignore alpha) */
 508       case 2:
 509         {
 510           byte buf[img->cols], *dest = buf;
 511 #         define IMAGE_WALK_PREFIX(x) walk_##x
 512 #         define IMAGE_WALK_INLINE
 513 #         define IMAGE_WALK_IMAGE img
 514 #         define IMAGE_WALK_UNROLL 4
 515 #         define IMAGE_WALK_COL_STEP 2
 516 #         define IMAGE_WALK_DO_ROW_END do{ dest = buf; jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&dest, 1); }while(0)
 517 #         define IMAGE_WALK_DO_STEP do{ *dest++ = walk_pos[0]; }while(0)
 518 #         include "images/image-walk.h"
 519         }
 520         break;
 521       /* RGBA (ignore alpha) or aligned RGB */
 522       case 4:
 523         {
 524           byte buf[img->cols * 3], *dest = buf;
 525 #         define IMAGE_WALK_PREFIX(x) walk_##x
 526 #         define IMAGE_WALK_INLINE
 527 #         define IMAGE_WALK_IMAGE img
 528 #         define IMAGE_WALK_UNROLL 4
 529 #         define IMAGE_WALK_COL_STEP 4
 530 #         define IMAGE_WALK_DO_ROW_END do{ dest = buf; jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&dest, 1); }while(0)
 531 #         define IMAGE_WALK_DO_STEP do{ *dest++ = walk_pos[0]; *dest++ = walk_pos[1]; *dest++ = walk_pos[2]; }while(0)
 532 #         include "images/image-walk.h"
 533         }
 534         break;
 535       default:
 536         ASSERT(0);
 537     }
 538   ASSERT(i.cinfo.next_scanline == i.cinfo.image_height);
 539   jpeg_finish_compress(&i.cinfo);
 540   jpeg_destroy_compress(&i.cinfo);
 541   return 1;
 542 }