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) + libjpeg_read_byte(i);
 225   DBG("Found APP1 marker, len=%u", len);
 226   if (len < 2)
 227     return TRUE;
 228   len -= 2;
 229   if (len < 7 /*|| io->exif_size*/)
 230     {
 231       libjpeg_skip_input_data(cinfo, len);
 232       return TRUE;
 233     }
 234   byte header[6];
 235   libjpeg_read_buf(i, header, 6);
 236   if (memcmp(header, libjpeg_exif_header, 6))
 237     {
 238       libjpeg_skip_input_data(cinfo, len - 6);
 239       return TRUE;
 240     }
 241   io->exif_size = len;
 242   io->exif_data = mp_alloc(io->internal_pool, len);
 243   memcpy(io->exif_data, header, 6);
 244   libjpeg_read_buf(i, io->exif_data + 6, len - 6);
 245   DBG("Parsed EXIF of length %u", len);
 246   return TRUE;
 247 }
 248
 249 static void
 250 libjpeg_read_cancel(struct image_io *io)
 251 {
 252   DBG("libjpeg_read_cancel()");
 253   struct libjpeg_read_internals *i = io->read_data;
 254   jpeg_destroy_decompress(&i->cinfo);
 255 }
 256
 257 int
 258 libjpeg_read_header(struct image_io *io)
 259 {
 260   DBG("libjpeg_read_header()");
 261   struct libjpeg_read_internals *i = io->read_data = mp_alloc(io->internal_pool, sizeof(*i));
 262   i->fastbuf = io->fastbuf;
 263
 264   /* Create libjpeg read structure */
 265   DBG("Creating libjpeg read structure");
 266   i->cinfo.err = jpeg_std_error(&i->err.pub);
 267   i->err.pub.error_exit = libjpeg_read_error_exit;
 268   i->err.pub.emit_message = libjpeg_emit_message;
 269   i->err.io = io;
 270   if (setjmp(i->err.setjmp_buf))
 271     {
 272       DBG("Libjpeg failed to read the image, longjump saved us");
 273       jpeg_destroy_decompress(&i->cinfo);
 274       return 0;
 275     }
 276   jpeg_create_decompress(&i->cinfo);
 277
 278   /* Initialize source manager */
 279   i->cinfo.src = &i->src;
 280   i->src.init_source = libjpeg_init_source;
 281   i->src.fill_input_buffer = libjpeg_fill_input_buffer;
 282   i->src.skip_input_data = libjpeg_skip_input_data;
 283   i->src.resync_to_restart = jpeg_resync_to_restart;
 284   i->src.term_source = libjpeg_term_source;
 285
 286   if (io->flags & IMAGE_IO_WANT_EXIF)
 287     jpeg_set_marker_processor(&i->cinfo, JPEG_APP0 + 1, libjpeg_app1_preprocessor);
 288
 289   /* Read JPEG header and setup decompression options */
 290   DBG("Reading image header");
 291   jpeg_read_header(&i->cinfo, TRUE);
 292   switch (i->cinfo.jpeg_color_space)
 293     {
 294       case JCS_GRAYSCALE:
 295         io->flags = COLOR_SPACE_GRAYSCALE;
 296         io->number_of_colors = 1 << 8;
 297         break;
 298       default:
 299         io->flags = COLOR_SPACE_RGB;
 300         io->number_of_colors = 1 << 24;
 301         break;
 302     }
 303   io->cols = i->cinfo.image_width;
 304   io->rows = i->cinfo.image_height;
 305
 306   io->read_cancel = libjpeg_read_cancel;
 307   return 1;
 308 }
 309
 310 int
 311 libjpeg_read_data(struct image_io *io)
 312 {
 313   DBG("libjpeg_read_data()");
 314
 315   struct libjpeg_read_internals *i = io->read_data;
 316
 317   /* Select color space */
 318   switch (io->flags & IMAGE_COLOR_SPACE)
 319     {
 320       case COLOR_SPACE_GRAYSCALE:
 321         i->cinfo.out_color_space = JCS_GRAYSCALE;
 322         break;
 323       case COLOR_SPACE_RGB:
 324         i->cinfo.out_color_space = JCS_RGB;
 325         break;
 326       default:
 327         jpeg_destroy_decompress(&i->cinfo);
 328         IMAGE_ERROR(io->context, IMAGE_ERROR_INVALID_PIXEL_FORMAT, "Unsupported color space.");
 329         return 0;
 330     }
 331
 332   /* Prepare the image  */
 333   struct image_io_read_data_internals rdi;
 334   if (io->cols <= (i->cinfo.image_width >> 3) && io->rows <= (i->cinfo.image_height >> 3))
 335     {
 336       DBG("Scaling to 1/8");
 337       i->cinfo.scale_num = 1;
 338       i->cinfo.scale_denom = 8;
 339     }
 340   else if (io->cols <= (i->cinfo.image_width >> 2) && io->rows <= (i->cinfo.image_height >> 2))
 341     {
 342       DBG("Scaling to 1/4");
 343       i->cinfo.scale_num = 1;
 344       i->cinfo.scale_denom = 4;
 345     }
 346   else if (io->cols <= (i->cinfo.image_width >> 1) && io->rows <= (i->cinfo.image_height >> 1))
 347     {
 348       DBG("Scaling to 1/2");
 349       i->cinfo.scale_num = 1;
 350       i->cinfo.scale_denom = 2;
 351     }
 352   jpeg_calc_output_dimensions(&i->cinfo);
 353   DBG("Output dimensions %ux%u", (uns)i->cinfo.output_width, (uns)i->cinfo.output_height);
 354   if (unlikely(!image_io_read_data_prepare(&rdi, io, i->cinfo.output_width, i->cinfo.output_height, io->flags)))
 355     {
 356       jpeg_destroy_decompress(&i->cinfo);
 357       return 0;
 358     }
 359
 360   /* Setup fallback */
 361   if (setjmp(i->err.setjmp_buf))
 362     {
 363       DBG("Libjpeg failed to read the image, longjump saved us");
 364       jpeg_destroy_decompress(&i->cinfo);
 365       image_io_read_data_break(&rdi, io);
 366       return 0;
 367     }
 368
 369   /* Decompress the image */
 370   struct image *img = rdi.image;
 371   jpeg_start_decompress(&i->cinfo);
 372   switch (img->pixel_size)
 373     {
 374       /* grayscale or RGB */
 375       case 1:
 376       case 3:
 377         {
 378           byte *pixels = img->pixels;
 379           for (uns r = img->rows; r--; )
 380             {
 381               jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&pixels, 1);
 382               pixels += img->row_size;
 383             }
 384         }
 385         break;
 386       /* grayscale with alpha */
 387       case 2:
 388         {
 389           byte buf[img->cols], *src;
 390 #         define IMAGE_WALK_PREFIX(x) walk_##x
 391 #         define IMAGE_WALK_INLINE
 392 #         define IMAGE_WALK_IMAGE img
 393 #         define IMAGE_WALK_UNROLL 4
 394 #         define IMAGE_WALK_COL_STEP 2
 395 #         define IMAGE_WALK_DO_ROW_START do{ src = buf; jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&src, 1); }while(0)
 396 #         define IMAGE_WALK_DO_STEP do{ walk_pos[0] = *src++; walk_pos[1] = 255; }while(0)
 397 #         include "images/image-walk.h"
 398         }
 399         break;
 400       /* RGBA or aligned RGB */
 401       case 4:
 402         {
 403           byte buf[img->cols * 3], *src;
 404 #         define IMAGE_WALK_PREFIX(x) walk_##x
 405 #         define IMAGE_WALK_INLINE
 406 #         define IMAGE_WALK_IMAGE img
 407 #         define IMAGE_WALK_UNROLL 4
 408 #         define IMAGE_WALK_COL_STEP 4
 409 #         define IMAGE_WALK_DO_ROW_START do{ src = buf; jpeg_read_scanlines(&i->cinfo, (JSAMPLE **)&src, 1); }while(0)
 410 #         define IMAGE_WALK_DO_STEP do{ *(u32 *)walk_pos = *(u32 *)src; walk_pos[3] = 255; src += 3; }while(0)
 411 #         include "images/image-walk.h"
 412         }
 413         break;
 414       default:
 415         ASSERT(0);
 416     }
 417   ASSERT(i->cinfo.output_scanline == i->cinfo.output_height);
 418
 419   /* Destroy libjpeg object */
 420   jpeg_finish_decompress(&i->cinfo);
 421   jpeg_destroy_decompress(&i->cinfo);
 422
 423   /* Finish the image */
 424   return image_io_read_data_finish(&rdi, io);
 425 }
 426
 427 int
 428 libjpeg_write(struct image_io *io)
 429 {
 430   DBG("libjpeg_write()");
 431   struct libjpeg_write_internals i;
 432   i.fastbuf = io->fastbuf;
 433
 434   /* Create libjpeg write structure */
 435   DBG("Creating libjpeg write structure");
 436   i.cinfo.err = jpeg_std_error(&i.err.pub);
 437   i.err.pub.error_exit = libjpeg_write_error_exit;
 438   i.err.pub.emit_message = libjpeg_emit_message;
 439   i.err.io = io;
 440   if (setjmp(i.err.setjmp_buf))
 441     {
 442       DBG("Libjpeg failed to write the image, longjump saved us");
 443       jpeg_destroy_compress(&i.cinfo);
 444       return 0;
 445     }
 446   jpeg_create_compress(&i.cinfo);
 447
 448   /* Initialize destination manager */
 449   i.cinfo.dest = &i.dest;
 450   i.dest.init_destination = libjpeg_init_destination;
 451   i.dest.term_destination = libjpeg_term_destination;
 452   i.dest.empty_output_buffer = libjpeg_empty_output_buffer;
 453
 454   /* Set output parameters */
 455   struct image *img = io->image;
 456   i.cinfo.image_width = img->cols;
 457   i.cinfo.image_height = img->rows;
 458   switch (img->flags & IMAGE_COLOR_SPACE)
 459     {
 460       case COLOR_SPACE_GRAYSCALE:
 461         i.cinfo.input_components = 1;
 462         i.cinfo.in_color_space = JCS_GRAYSCALE;
 463         break;
 464       case COLOR_SPACE_RGB:
 465         i.cinfo.input_components = 3;
 466         i.cinfo.in_color_space = JCS_RGB;
 467         break;
 468       default:
 469         jpeg_destroy_compress(&i.cinfo);
 470         IMAGE_ERROR(io->context, IMAGE_ERROR_INVALID_PIXEL_FORMAT, "Unsupported pixel format.");
 471         return 0;
 472     }
 473   jpeg_set_defaults(&i.cinfo);
 474   if (io->jpeg_quality)
 475     jpeg_set_quality(&i.cinfo, MIN(io->jpeg_quality, 100), 1);
 476   if (io->exif_size)
 477     {
 478       /* According to the Exif specification, the Exif APP1 marker has to follow immediately after the SOI,
 479        * just as the JFIF specification requires the same for the JFIF APP0 marker!
 480        * Therefore a JPEG file cannot legally be both Exif and JFIF.  */
 481       i.cinfo.write_JFIF_header = FALSE;
 482       i.cinfo.write_Adobe_marker = FALSE;
 483     }
 484
 485   /* Compress the image */
 486   jpeg_start_compress(&i.cinfo, TRUE);
 487   if (io->exif_size)
 488     {
 489       DBG("Writing EXIF");
 490       jpeg_write_marker(&i.cinfo, JPEG_APP0 + 1, io->exif_data, io->exif_size);
 491     }
 492   switch (img->pixel_size)
 493     {
 494       /* grayscale or RGB */
 495       case 1:
 496       case 3:
 497         {
 498           byte *pixels = img->pixels;
 499           for (uns r = img->rows; r--; )
 500             {
 501               jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&pixels, 1);
 502               pixels += img->row_size;
 503             }
 504         }
 505         break;
 506       /* grayscale with alpha (ignore alpha) */
 507       case 2:
 508         {
 509           byte buf[img->cols], *dest = buf;
 510 #         define IMAGE_WALK_PREFIX(x) walk_##x
 511 #         define IMAGE_WALK_INLINE
 512 #         define IMAGE_WALK_IMAGE img
 513 #         define IMAGE_WALK_UNROLL 4
 514 #         define IMAGE_WALK_COL_STEP 2
 515 #         define IMAGE_WALK_DO_ROW_END do{ dest = buf; jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&dest, 1); }while(0)
 516 #         define IMAGE_WALK_DO_STEP do{ *dest++ = walk_pos[0]; }while(0)
 517 #         include "images/image-walk.h"
 518         }
 519         break;
 520       /* RGBA (ignore alpha) or aligned RGB */
 521       case 4:
 522         {
 523           byte buf[img->cols * 3], *dest = buf;
 524 #         define IMAGE_WALK_PREFIX(x) walk_##x
 525 #         define IMAGE_WALK_INLINE
 526 #         define IMAGE_WALK_IMAGE img
 527 #         define IMAGE_WALK_UNROLL 4
 528 #         define IMAGE_WALK_COL_STEP 4
 529 #         define IMAGE_WALK_DO_ROW_END do{ dest = buf; jpeg_write_scanlines(&i.cinfo, (JSAMPLE **)&dest, 1); }while(0)
 530 #         define IMAGE_WALK_DO_STEP do{ *dest++ = walk_pos[0]; *dest++ = walk_pos[1]; *dest++ = walk_pos[2]; }while(0)
 531 #         include "images/image-walk.h"
 532         }
 533         break;
 534       default:
 535         ASSERT(0);
 536     }
 537   ASSERT(i.cinfo.next_scanline == i.cinfo.image_height);
 538   jpeg_finish_compress(&i.cinfo);
 539   jpeg_destroy_compress(&i.cinfo);
 540   return 1;
 541 }