src/common/imagjpeg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/imagjpeg.cpp
   3 // Purpose:     wxImage JPEG handler
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Vaclav Slavik
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #ifdef __BORLANDC__
  14 #pragma hdrstop
  15 #endif
  16
  17 #include "wx/defs.h"
  18
  19 #if wxUSE_IMAGE && wxUSE_LIBJPEG
  20
  21 #include "wx/imagjpeg.h"
  22 #include "wx/bitmap.h"
  23 #include "wx/debug.h"
  24 #include "wx/log.h"
  25 #include "wx/app.h"
  26
  27 // NB: Some compilers define boolean type in Windows headers
  28 //     (e.g. Watcom C++, but not Open Watcom).
  29 //     This causes a conflict with jmorecfg.h header from libjpeg, so we have
  30 //     to make sure libjpeg won't try to define boolean itself. This is done by
  31 //     defining HAVE_BOOLEAN.
  32 #if defined(__WXMSW__) && (defined(__MWERKS__) || defined(__DIGITALMARS__))
  33     #define HAVE_BOOLEAN
  34     #include "wx/msw/wrapwin.h"
  35 #endif
  36
  37 extern "C"
  38 {
  39     #if defined(__WXMSW__)
  40         #define XMD_H
  41     #endif
  42     #include "jpeglib.h"
  43 }
  44
  45 #include "wx/filefn.h"
  46 #include "wx/wfstream.h"
  47 #include "wx/intl.h"
  48 #include "wx/module.h"
  49
  50 // For memcpy
  51 #include <string.h>
  52 // For JPEG library error handling
  53 #include <setjmp.h>
  54
  55 #ifdef __SALFORDC__
  56 #undef FAR
  57 #endif
  58
  59 // ----------------------------------------------------------------------------
  60 // types
  61 // ----------------------------------------------------------------------------
  62
  63 // the standard definition of METHODDEF(type) from jmorecfg.h is "static type"
  64 // which means that we can't declare the method functions as extern "C" - the
  65 // compiler (rightfully) complains about the multiple storage classes in
  66 // declaration
  67 //
  68 // so we only add extern "C" when using our own, modified, jmorecfg.h - and use
  69 // whatever we have in the system headers if this is what we use hoping that it
  70 // should be ok (can't do anything else)
  71 #ifdef JPEG_METHOD_LINKAGE
  72     #define CPP_METHODDEF(type) extern "C" METHODDEF(type)
  73 #else // not using our jmorecfg.h header
  74     #define CPP_METHODDEF(type) METHODDEF(type)
  75 #endif
  76
  77 //-----------------------------------------------------------------------------
  78 // wxJPEGHandler
  79 //-----------------------------------------------------------------------------
  80
  81 IMPLEMENT_DYNAMIC_CLASS(wxJPEGHandler,wxImageHandler)
  82
  83 #if wxUSE_STREAMS
  84
  85 //------------- JPEG Data Source Manager
  86
  87 #define JPEG_IO_BUFFER_SIZE   2048
  88
  89 typedef struct {
  90     struct jpeg_source_mgr pub;   /* public fields */
  91
  92     JOCTET* buffer;               /* start of buffer */
  93     wxInputStream *stream;
  94 } wx_source_mgr;
  95
  96 typedef wx_source_mgr * wx_src_ptr;
  97
  98 CPP_METHODDEF(void) wx_init_source ( j_decompress_ptr WXUNUSED(cinfo) )
  99 {
 100 }
 101
 102 CPP_METHODDEF(boolean) wx_fill_input_buffer ( j_decompress_ptr cinfo )
 103 {
 104     wx_src_ptr src = (wx_src_ptr) cinfo->src;
 105
 106     src->pub.next_input_byte = src->buffer;
 107     src->pub.bytes_in_buffer = src->stream->Read(src->buffer, JPEG_IO_BUFFER_SIZE).LastRead();
 108
 109     if (src->pub.bytes_in_buffer == 0) // check for end-of-stream
 110     {
 111         // Insert a fake EOI marker
 112         src->buffer[0] = 0xFF;
 113         src->buffer[1] = JPEG_EOI;
 114         src->pub.bytes_in_buffer = 2;
 115     }
 116     return TRUE;
 117 }
 118
 119 CPP_METHODDEF(void) wx_skip_input_data ( j_decompress_ptr cinfo, long num_bytes )
 120 {
 121     if (num_bytes > 0)
 122     {
 123         wx_src_ptr src = (wx_src_ptr) cinfo->src;
 124
 125         while (num_bytes > (long)src->pub.bytes_in_buffer)
 126         {
 127             num_bytes -= (long) src->pub.bytes_in_buffer;
 128             src->pub.fill_input_buffer(cinfo);
 129         }
 130         src->pub.next_input_byte += (size_t) num_bytes;
 131         src->pub.bytes_in_buffer -= (size_t) num_bytes;
 132     }
 133 }
 134
 135 CPP_METHODDEF(void) wx_term_source ( j_decompress_ptr cinfo )
 136 {
 137     wx_src_ptr src = (wx_src_ptr) cinfo->src;
 138
 139     if (src->pub.bytes_in_buffer > 0)
 140         src->stream->SeekI(-(long)src->pub.bytes_in_buffer, wxFromCurrent);
 141     delete[] src->buffer;
 142 }
 143
 144
 145 // JPEG error manager:
 146
 147 struct wx_error_mgr {
 148   struct jpeg_error_mgr pub;    /* "public" fields */
 149
 150   jmp_buf setjmp_buffer;    /* for return to caller */
 151 };
 152
 153 typedef struct wx_error_mgr * wx_error_ptr;
 154
 155 /*
 156  * Here's the routine that will replace the standard error_exit method:
 157  */
 158
 159 CPP_METHODDEF(void) wx_error_exit (j_common_ptr cinfo)
 160 {
 161   /* cinfo->err really points to a wx_error_mgr struct, so coerce pointer */
 162   wx_error_ptr myerr = (wx_error_ptr) cinfo->err;
 163
 164   /* Always display the message. */
 165   /* We could postpone this until after returning, if we chose. */
 166   (*cinfo->err->output_message) (cinfo);
 167
 168   /* Return control to the setjmp point */
 169   longjmp(myerr->setjmp_buffer, 1);
 170 }
 171
 172 /*
 173  * This will replace the standard output_message method when the user
 174  * wants us to be silent (verbose==false). We must have such method instead of
 175  * simply using NULL for cinfo->err->output_message because it's called
 176  * unconditionally from within libjpeg when there's "garbage input".
 177  */
 178 CPP_METHODDEF(void) wx_ignore_message (j_common_ptr WXUNUSED(cinfo))
 179 {
 180 }
 181
 182 void wx_jpeg_io_src( j_decompress_ptr cinfo, wxInputStream& infile )
 183 {
 184     wx_src_ptr src;
 185
 186     if (cinfo->src == NULL) {    /* first time for this JPEG object? */
 187         cinfo->src = (struct jpeg_source_mgr *)
 188             (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
 189             sizeof(wx_source_mgr));
 190     }
 191     src = (wx_src_ptr) cinfo->src;
 192     src->pub.bytes_in_buffer = 0; /* forces fill_input_buffer on first read */
 193     src->buffer = new JOCTET[JPEG_IO_BUFFER_SIZE];
 194     src->pub.next_input_byte = NULL; /* until buffer loaded */
 195     src->stream = &infile;
 196
 197     src->pub.init_source = wx_init_source;
 198     src->pub.fill_input_buffer = wx_fill_input_buffer;
 199     src->pub.skip_input_data = wx_skip_input_data;
 200     src->pub.resync_to_restart = jpeg_resync_to_restart; /* use default method */
 201     src->pub.term_source = wx_term_source;
 202 }
 203
 204
 205 // temporarily disable the warning C4611 (interaction between '_setjmp' and
 206 // C++ object destruction is non-portable) - I don't see any dtors here
 207 #ifdef __VISUALC__
 208     #pragma warning(disable:4611)
 209 #endif /* VC++ */
 210
 211 bool wxJPEGHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbose, int WXUNUSED(index) )
 212 {
 213     struct jpeg_decompress_struct cinfo;
 214     struct wx_error_mgr jerr;
 215     JSAMPARRAY tempbuf;
 216     unsigned char *ptr;
 217     unsigned stride;
 218
 219     image->Destroy();
 220     cinfo.err = jpeg_std_error( &jerr.pub );
 221     jerr.pub.error_exit = wx_error_exit;
 222
 223     if (!verbose)
 224         cinfo.err->output_message = wx_ignore_message;
 225
 226     /* Establish the setjmp return context for wx_error_exit to use. */
 227     if (setjmp(jerr.setjmp_buffer)) {
 228       /* If we get here, the JPEG code has signaled an error.
 229        * We need to clean up the JPEG object, close the input file, and return.
 230        */
 231       if (verbose)
 232         wxLogError(_("JPEG: Couldn't load - file is probably corrupted."));
 233       (cinfo.src->term_source)(&cinfo);
 234       jpeg_destroy_decompress(&cinfo);
 235       if (image->Ok()) image->Destroy();
 236       return false;
 237     }
 238
 239     jpeg_create_decompress( &cinfo );
 240     wx_jpeg_io_src( &cinfo, stream );
 241     jpeg_read_header( &cinfo, TRUE );
 242     cinfo.out_color_space = JCS_RGB;
 243     jpeg_start_decompress( &cinfo );
 244
 245     image->Create( cinfo.image_width, cinfo.image_height );
 246     if (!image->Ok()) {
 247         jpeg_finish_decompress( &cinfo );
 248         jpeg_destroy_decompress( &cinfo );
 249         return false;
 250     }
 251     image->SetMask( false );
 252     ptr = image->GetData();
 253     stride = cinfo.output_width * 3;
 254     tempbuf = (*cinfo.mem->alloc_sarray)
 255         ((j_common_ptr) &cinfo, JPOOL_IMAGE, stride, 1 );
 256
 257     while ( cinfo.output_scanline < cinfo.output_height ) {
 258         jpeg_read_scanlines( &cinfo, tempbuf, 1 );
 259         memcpy( ptr, tempbuf[0], stride );
 260         ptr += stride;
 261     }
 262     jpeg_finish_decompress( &cinfo );
 263     jpeg_destroy_decompress( &cinfo );
 264     return true;
 265 }
 266
 267 typedef struct {
 268     struct jpeg_destination_mgr pub;
 269
 270     wxOutputStream *stream;
 271     JOCTET * buffer;
 272 } wx_destination_mgr;
 273
 274 typedef wx_destination_mgr * wx_dest_ptr;
 275
 276 #define OUTPUT_BUF_SIZE  4096    /* choose an efficiently fwrite'able size */
 277
 278 CPP_METHODDEF(void) wx_init_destination (j_compress_ptr cinfo)
 279 {
 280     wx_dest_ptr dest = (wx_dest_ptr) cinfo->dest;
 281
 282     /* Allocate the output buffer --- it will be released when done with image */
 283     dest->buffer = (JOCTET *)
 284         (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
 285         OUTPUT_BUF_SIZE * sizeof(JOCTET));
 286     dest->pub.next_output_byte = dest->buffer;
 287     dest->pub.free_in_buffer = OUTPUT_BUF_SIZE;
 288 }
 289
 290 CPP_METHODDEF(boolean) wx_empty_output_buffer (j_compress_ptr cinfo)
 291 {
 292     wx_dest_ptr dest = (wx_dest_ptr) cinfo->dest;
 293
 294     dest->stream->Write(dest->buffer, OUTPUT_BUF_SIZE);
 295     dest->pub.next_output_byte = dest->buffer;
 296     dest->pub.free_in_buffer = OUTPUT_BUF_SIZE;
 297     return TRUE;
 298 }
 299
 300 CPP_METHODDEF(void) wx_term_destination (j_compress_ptr cinfo)
 301 {
 302     wx_dest_ptr dest = (wx_dest_ptr) cinfo->dest;
 303     size_t datacount = OUTPUT_BUF_SIZE - dest->pub.free_in_buffer;
 304     /* Write any data remaining in the buffer */
 305     if (datacount > 0)
 306         dest->stream->Write(dest->buffer, datacount);
 307 }
 308
 309 GLOBAL(void) wx_jpeg_io_dest (j_compress_ptr cinfo, wxOutputStream& outfile)
 310 {
 311     wx_dest_ptr dest;
 312
 313     if (cinfo->dest == NULL) {    /* first time for this JPEG object? */
 314         cinfo->dest = (struct jpeg_destination_mgr *)
 315             (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
 316             sizeof(wx_destination_mgr));
 317     }
 318
 319     dest = (wx_dest_ptr) cinfo->dest;
 320     dest->pub.init_destination = wx_init_destination;
 321     dest->pub.empty_output_buffer = wx_empty_output_buffer;
 322     dest->pub.term_destination = wx_term_destination;
 323     dest->stream = &outfile;
 324 }
 325
 326 bool wxJPEGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbose )
 327 {
 328     struct jpeg_compress_struct cinfo;
 329     struct wx_error_mgr jerr;
 330     JSAMPROW row_pointer[1];    /* pointer to JSAMPLE row[s] */
 331     JSAMPLE *image_buffer;
 332     int stride;                /* physical row width in image buffer */
 333
 334     cinfo.err = jpeg_std_error(&jerr.pub);
 335     jerr.pub.error_exit = wx_error_exit;
 336
 337     if (!verbose)
 338         cinfo.err->output_message = wx_ignore_message;
 339
 340     /* Establish the setjmp return context for wx_error_exit to use. */
 341     if (setjmp(jerr.setjmp_buffer))
 342     {
 343         /* If we get here, the JPEG code has signaled an error.
 344          * We need to clean up the JPEG object, close the input file, and return.
 345          */
 346          if (verbose)
 347             wxLogError(_("JPEG: Couldn't save image."));
 348          jpeg_destroy_compress(&cinfo);
 349          return false;
 350     }
 351
 352     jpeg_create_compress(&cinfo);
 353     wx_jpeg_io_dest(&cinfo, stream);
 354
 355     cinfo.image_width = image->GetWidth();
 356     cinfo.image_height = image->GetHeight();
 357     cinfo.input_components = 3;
 358     cinfo.in_color_space = JCS_RGB;
 359     jpeg_set_defaults(&cinfo);
 360
 361     // TODO: 3rd parameter is force_baseline, what value should this be?
 362     // Code says: "If force_baseline is TRUE, the computed quantization table entries
 363     // are limited to 1..255 for JPEG baseline compatibility."
 364     // 'Quality' is a number between 0 (terrible) and 100 (very good).
 365     // The default (in jcparam.c, jpeg_set_defaults) is 75,
 366     // and force_baseline is TRUE.
 367     if (image->HasOption(wxIMAGE_OPTION_QUALITY))
 368         jpeg_set_quality(&cinfo, image->GetOptionInt(wxIMAGE_OPTION_QUALITY), TRUE);
 369
 370     // set the resolution fields in the output file
 371     UINT16 resX,
 372            resY;
 373     if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONX) &&
 374          image->HasOption(wxIMAGE_OPTION_RESOLUTIONY) )
 375     {
 376         resX = (UINT16)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONX);
 377         resY = (UINT16)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONY);
 378     }
 379     else if ( image->HasOption(wxIMAGE_OPTION_RESOLUTION) )
 380     {
 381         resX =
 382         resY = (UINT16)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTION);
 383     }
 384     else
 385     {
 386         resX =
 387         resY = 0;
 388     }
 389
 390     if ( resX && resY )
 391     {
 392         cinfo.X_density = resX;
 393         cinfo.Y_density = resY;
 394     }
 395
 396     // sets the resolution unit field in the output file
 397     // wxIMAGE_RESOLUTION_INCHES for inches
 398     // wxIMAGE_RESOLUTION_CM for centimeters
 399     if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONUNIT) )
 400     {
 401         cinfo.density_unit = (UINT8)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONUNIT);
 402     }
 403
 404     jpeg_start_compress(&cinfo, TRUE);
 405
 406     stride = cinfo.image_width * 3;    /* JSAMPLEs per row in image_buffer */
 407     image_buffer = image->GetData();
 408     while (cinfo.next_scanline < cinfo.image_height) {
 409         row_pointer[0] = &image_buffer[cinfo.next_scanline * stride];
 410         jpeg_write_scanlines( &cinfo, row_pointer, 1 );
 411     }
 412     jpeg_finish_compress(&cinfo);
 413     jpeg_destroy_compress(&cinfo);
 414
 415     return true;
 416 }
 417
 418 #ifdef __VISUALC__
 419     #pragma warning(default:4611)
 420 #endif /* VC++ */
 421
 422 bool wxJPEGHandler::DoCanRead( wxInputStream& stream )
 423 {
 424     unsigned char hdr[2];
 425
 426     if ( !stream.Read(hdr, WXSIZEOF(hdr)) )
 427         return false;
 428
 429     return hdr[0] == 0xFF && hdr[1] == 0xD8;
 430 }
 431
 432 #endif   // wxUSE_STREAMS
 433
 434 #endif   // wxUSE_LIBJPEG