]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/imagjpeg.cpp
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / src / common / imagjpeg.cpp
index 42b995aae9b664f0eacbe676ba1f53dd8b48d68b..88bcb4f313d4cdd54a4f2cfb8d1141ea8b003639 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imagjpeg.cpp
+// Name:        src/common/imagjpeg.cpp
 // Purpose:     wxImage JPEG handler
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
@@ -7,35 +7,35 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "imagjpeg.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
-#include "wx/defs.h"
-
 #if wxUSE_IMAGE && wxUSE_LIBJPEG
 
 #include "wx/imagjpeg.h"
-#include "wx/bitmap.h"
-#include "wx/debug.h"
-#include "wx/log.h"
-#include "wx/app.h"
-
-// NB: Some compilers define boolean type in Windows headers
-//     (e.g. Watcom C++, but not Open Watcom).
-//     This causes a conflict with jmorecfg.h header from libjpeg, so we have
-//     to make sure libjpeg won't try to define boolean itself. This is done by
-//     defining HAVE_BOOLEAN.
-#if defined(__WXMSW__) && (defined(__MWERKS__) || defined(__DIGITALMARS__) || (defined(__WATCOMC__) && __WATCOMC__ < 1200))
+#include "wx/versioninfo.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/intl.h"
+    #include "wx/bitmap.h"
+    #include "wx/module.h"
+#endif
+
+// A hack based on one from tif_jpeg.c to overcome the problem on Windows
+// of rpcndr.h defining boolean with a different type to the jpeg headers.
+//
+// This hack is only necessary for an external jpeg library, the builtin one
+// usually used on Windows doesn't use the type boolean, so always works.
+//
+#ifdef wxHACK_BOOLEAN
     #define HAVE_BOOLEAN
-    #include "wx/msw/wrapwin.h"
+    #define boolean wxHACK_BOOLEAN
 #endif
 
 extern "C"
@@ -46,20 +46,18 @@ extern "C"
     #include "jpeglib.h"
 }
 
+#ifndef HAVE_WXJPEG_BOOLEAN
+typedef boolean wxjpeg_boolean;
+#endif
+
 #include "wx/filefn.h"
 #include "wx/wfstream.h"
-#include "wx/intl.h"
-#include "wx/module.h"
 
 // For memcpy
 #include <string.h>
 // For JPEG library error handling
 #include <setjmp.h>
 
-#ifdef __SALFORDC__
-#undef FAR
-#endif
-
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
@@ -99,11 +97,14 @@ typedef struct {
 
 typedef wx_source_mgr * wx_src_ptr;
 
+extern "C"
+{
+
 CPP_METHODDEF(void) wx_init_source ( j_decompress_ptr WXUNUSED(cinfo) )
 {
 }
 
-CPP_METHODDEF(boolean) wx_fill_input_buffer ( j_decompress_ptr cinfo )
+CPP_METHODDEF(wxjpeg_boolean) wx_fill_input_buffer ( j_decompress_ptr cinfo )
 {
     wx_src_ptr src = (wx_src_ptr) cinfo->src;
 
@@ -148,14 +149,11 @@ CPP_METHODDEF(void) wx_term_source ( j_decompress_ptr cinfo )
 
 // JPEG error manager:
 
-struct wx_error_mgr {
-  struct jpeg_error_mgr pub;    /* "public" fields */
-
+struct wx_error_mgr : public jpeg_error_mgr
+{
   jmp_buf setjmp_buffer;    /* for return to caller */
 };
 
-typedef struct wx_error_mgr * wx_error_ptr;
-
 /*
  * Here's the routine that will replace the standard error_exit method:
  */
@@ -163,14 +161,24 @@ typedef struct wx_error_mgr * wx_error_ptr;
 CPP_METHODDEF(void) wx_error_exit (j_common_ptr cinfo)
 {
   /* cinfo->err really points to a wx_error_mgr struct, so coerce pointer */
-  wx_error_ptr myerr = (wx_error_ptr) cinfo->err;
+  wx_error_mgr * const jerr = (wx_error_mgr *) cinfo->err;
 
   /* Always display the message. */
   /* We could postpone this until after returning, if we chose. */
-  if (cinfo->err->output_message) (*cinfo->err->output_message) (cinfo);
+  (*cinfo->err->output_message) (cinfo);
 
   /* Return control to the setjmp point */
-  longjmp(myerr->setjmp_buffer, 1);
+  longjmp(jerr->setjmp_buffer, 1);
+}
+
+/*
+ * This will replace the standard output_message method when the user
+ * wants us to be silent (verbose==false). We must have such method instead of
+ * simply using NULL for cinfo->err->output_message because it's called
+ * unconditionally from within libjpeg when there's "garbage input".
+ */
+CPP_METHODDEF(void) wx_ignore_message (j_common_ptr WXUNUSED(cinfo))
+{
 }
 
 void wx_jpeg_io_src( j_decompress_ptr cinfo, wxInputStream& infile )
@@ -195,6 +203,23 @@ void wx_jpeg_io_src( j_decompress_ptr cinfo, wxInputStream& infile )
     src->pub.term_source = wx_term_source;
 }
 
+} // extern "C"
+
+static inline void wx_cmyk_to_rgb(unsigned char* rgb, const unsigned char* cmyk)
+{
+    register int k = 255 - cmyk[3];
+    register int k2 = cmyk[3];
+    register int c;
+
+    c = k + k2 * (255 - cmyk[0]) / 255;
+    rgb[0] = (unsigned char)((c > 255) ? 0 : (255 - c));
+
+    c = k + k2 * (255 - cmyk[1]) / 255;
+    rgb[1] = (unsigned char)((c > 255) ? 0 : (255 - c));
+
+    c = k + k2 * (255 - cmyk[2]) / 255;
+    rgb[2] = (unsigned char)((c > 255) ? 0 : (255 - c));
+}
 
 // temporarily disable the warning C4611 (interaction between '_setjmp' and
 // C++ object destruction is non-portable) - I don't see any dtors here
@@ -204,17 +229,22 @@ void wx_jpeg_io_src( j_decompress_ptr cinfo, wxInputStream& infile )
 
 bool wxJPEGHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbose, int WXUNUSED(index) )
 {
+    wxCHECK_MSG( image, false, "NULL image pointer" );
+
     struct jpeg_decompress_struct cinfo;
-    struct wx_error_mgr jerr;
-    JSAMPARRAY tempbuf;
+    wx_error_mgr jerr;
     unsigned char *ptr;
-    unsigned stride;
 
+    // save this before calling Destroy()
+    const unsigned maxWidth = image->GetOptionInt(wxIMAGE_OPTION_MAX_WIDTH),
+                   maxHeight = image->GetOptionInt(wxIMAGE_OPTION_MAX_HEIGHT);
     image->Destroy();
-    cinfo.err = jpeg_std_error( &jerr.pub );
-    jerr.pub.error_exit = wx_error_exit;
 
-    if (!verbose) cinfo.err->output_message=NULL;
+    cinfo.err = jpeg_std_error( &jerr );
+    jerr.error_exit = wx_error_exit;
+
+    if (!verbose)
+        cinfo.err->output_message = wx_ignore_message;
 
     /* Establish the setjmp return context for wx_error_exit to use. */
     if (setjmp(jerr.setjmp_buffer)) {
@@ -222,36 +252,95 @@ bool wxJPEGHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
        * We need to clean up the JPEG object, close the input file, and return.
        */
       if (verbose)
+      {
         wxLogError(_("JPEG: Couldn't load - file is probably corrupted."));
+      }
       (cinfo.src->term_source)(&cinfo);
       jpeg_destroy_decompress(&cinfo);
-      if (image->Ok()) image->Destroy();
+      if (image->IsOk()) image->Destroy();
       return false;
     }
 
     jpeg_create_decompress( &cinfo );
     wx_jpeg_io_src( &cinfo, stream );
     jpeg_read_header( &cinfo, TRUE );
-    cinfo.out_color_space = JCS_RGB;
+
+    int bytesPerPixel;
+    if ((cinfo.out_color_space == JCS_CMYK) || (cinfo.out_color_space == JCS_YCCK))
+    {
+        cinfo.out_color_space = JCS_CMYK;
+        bytesPerPixel = 4;
+    }
+    else // all the rest is treated as RGB
+    {
+        cinfo.out_color_space = JCS_RGB;
+        bytesPerPixel = 3;
+    }
+
+    // scale the picture to fit in the specified max size if necessary
+    if ( maxWidth > 0 || maxHeight > 0 )
+    {
+        unsigned& scale = cinfo.scale_denom;
+        while ( (maxWidth && (cinfo.image_width / scale > maxWidth)) ||
+                    (maxHeight && (cinfo.image_height / scale > maxHeight)) )
+        {
+            scale *= 2;
+        }
+    }
+
     jpeg_start_decompress( &cinfo );
 
-    image->Create( cinfo.image_width, cinfo.image_height );
-    if (!image->Ok()) {
+    image->Create( cinfo.output_width, cinfo.output_height );
+    if (!image->IsOk()) {
         jpeg_finish_decompress( &cinfo );
         jpeg_destroy_decompress( &cinfo );
         return false;
     }
     image->SetMask( false );
     ptr = image->GetData();
-    stride = cinfo.output_width * 3;
-    tempbuf = (*cinfo.mem->alloc_sarray)
-        ((j_common_ptr) &cinfo, JPOOL_IMAGE, stride, 1 );
 
-    while ( cinfo.output_scanline < cinfo.output_height ) {
+    unsigned stride = cinfo.output_width * bytesPerPixel;
+    JSAMPARRAY tempbuf = (*cinfo.mem->alloc_sarray)
+                            ((j_common_ptr) &cinfo, JPOOL_IMAGE, stride, 1 );
+
+    while ( cinfo.output_scanline < cinfo.output_height )
+    {
         jpeg_read_scanlines( &cinfo, tempbuf, 1 );
-        memcpy( ptr, tempbuf[0], stride );
-        ptr += stride;
+        if (cinfo.out_color_space == JCS_RGB)
+        {
+            memcpy( ptr, tempbuf[0], stride );
+            ptr += stride;
+        }
+        else // CMYK
+        {
+            const unsigned char* inptr = (const unsigned char*) tempbuf[0];
+            for (size_t i = 0; i < cinfo.output_width; i++)
+            {
+                wx_cmyk_to_rgb(ptr, inptr);
+                ptr += 3;
+                inptr += 4;
+            }
+        }
     }
+
+    // set up resolution if available: it's part of optional JFIF APP0 chunk
+    if ( cinfo.saw_JFIF_marker )
+    {
+        image->SetOption(wxIMAGE_OPTION_RESOLUTIONX, cinfo.X_density);
+        image->SetOption(wxIMAGE_OPTION_RESOLUTIONY, cinfo.Y_density);
+
+        // we use the same values for this option as libjpeg so we don't need
+        // any conversion here
+        image->SetOption(wxIMAGE_OPTION_RESOLUTIONUNIT, cinfo.density_unit);
+    }
+
+    if ( cinfo.image_width != cinfo.output_width || cinfo.image_height != cinfo.output_height )
+    {
+        // save the original image size
+        image->SetOption(wxIMAGE_OPTION_ORIGINAL_WIDTH, cinfo.image_width);
+        image->SetOption(wxIMAGE_OPTION_ORIGINAL_HEIGHT, cinfo.image_height);
+    }
+
     jpeg_finish_decompress( &cinfo );
     jpeg_destroy_decompress( &cinfo );
     return true;
@@ -268,6 +357,9 @@ typedef wx_destination_mgr * wx_dest_ptr;
 
 #define OUTPUT_BUF_SIZE  4096    /* choose an efficiently fwrite'able size */
 
+extern "C"
+{
+
 CPP_METHODDEF(void) wx_init_destination (j_compress_ptr cinfo)
 {
     wx_dest_ptr dest = (wx_dest_ptr) cinfo->dest;
@@ -280,7 +372,7 @@ CPP_METHODDEF(void) wx_init_destination (j_compress_ptr cinfo)
     dest->pub.free_in_buffer = OUTPUT_BUF_SIZE;
 }
 
-CPP_METHODDEF(boolean) wx_empty_output_buffer (j_compress_ptr cinfo)
+CPP_METHODDEF(wxjpeg_boolean) wx_empty_output_buffer (j_compress_ptr cinfo)
 {
     wx_dest_ptr dest = (wx_dest_ptr) cinfo->dest;
 
@@ -316,18 +408,21 @@ GLOBAL(void) wx_jpeg_io_dest (j_compress_ptr cinfo, wxOutputStream& outfile)
     dest->stream = &outfile;
 }
 
+} // extern "C"
+
 bool wxJPEGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbose )
 {
     struct jpeg_compress_struct cinfo;
-    struct wx_error_mgr jerr;
+    wx_error_mgr jerr;
     JSAMPROW row_pointer[1];    /* pointer to JSAMPLE row[s] */
     JSAMPLE *image_buffer;
     int stride;                /* physical row width in image buffer */
 
-    cinfo.err = jpeg_std_error(&jerr.pub);
-    jerr.pub.error_exit = wx_error_exit;
+    cinfo.err = jpeg_std_error(&jerr);
+    jerr.error_exit = wx_error_exit;
 
-    if (!verbose) cinfo.err->output_message=NULL;
+    if (!verbose)
+        cinfo.err->output_message = wx_ignore_message;
 
     /* Establish the setjmp return context for wx_error_exit to use. */
     if (setjmp(jerr.setjmp_buffer))
@@ -336,7 +431,9 @@ bool wxJPEGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
          * We need to clean up the JPEG object, close the input file, and return.
          */
          if (verbose)
+         {
             wxLogError(_("JPEG: Couldn't save image."));
+         }
          jpeg_destroy_compress(&cinfo);
          return false;
     }
@@ -356,41 +453,20 @@ bool wxJPEGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
     // 'Quality' is a number between 0 (terrible) and 100 (very good).
     // The default (in jcparam.c, jpeg_set_defaults) is 75,
     // and force_baseline is TRUE.
-    if (image->HasOption(wxT("quality")))
-        jpeg_set_quality(&cinfo, image->GetOptionInt(wxT("quality")), TRUE);
+    if (image->HasOption(wxIMAGE_OPTION_QUALITY))
+        jpeg_set_quality(&cinfo, image->GetOptionInt(wxIMAGE_OPTION_QUALITY), TRUE);
 
     // set the resolution fields in the output file
-    UINT16 resX,
-           resY;
-    if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONX) &&
-         image->HasOption(wxIMAGE_OPTION_RESOLUTIONY) )
-    {
-        resX = image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONX);
-        resY = image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONY);
-    }
-    else if ( image->HasOption(wxIMAGE_OPTION_RESOLUTION) )
-    {
-        resX =
-        resY = image->GetOptionInt(wxIMAGE_OPTION_RESOLUTION);
-    }
-    else
-    {
-        resX =
-        resY = 0;
-    }
-
-    if ( resX && resY )
+    int resX, resY;
+    wxImageResolution res = GetResolutionFromOptions(*image, &resX, &resY);
+    if ( res != wxIMAGE_RESOLUTION_NONE )
     {
         cinfo.X_density = resX;
         cinfo.Y_density = resY;
-    }
 
-    // sets the resolution unit field in the output file
-    // wxIMAGE_RESOLUTION_INCHES for inches
-    // wxIMAGE_RESOLUTION_CM for centimeters
-    if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONUNIT) )
-    {
-        cinfo.density_unit = (UINT8)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONUNIT);
+        // it so happens that wxIMAGE_RESOLUTION_INCHES/CM values are the same
+        // ones as used by libjpeg, so we can assign them directly
+        cinfo.density_unit = res;
     }
 
     jpeg_start_compress(&cinfo, TRUE);
@@ -415,7 +491,7 @@ bool wxJPEGHandler::DoCanRead( wxInputStream& stream )
 {
     unsigned char hdr[2];
 
-    if ( !stream.Read(hdr, WXSIZEOF(hdr)) )
+    if ( !stream.Read(hdr, WXSIZEOF(hdr)) )     // it's ok to modify the stream position here
         return false;
 
     return hdr[0] == 0xFF && hdr[1] == 0xD8;
@@ -423,10 +499,9 @@ bool wxJPEGHandler::DoCanRead( wxInputStream& stream )
 
 #endif   // wxUSE_STREAMS
 
-#endif   // wxUSE_LIBJPEG
-
-
-
-
-
+/*static*/ wxVersionInfo wxJPEGHandler::GetLibraryVersionInfo()
+{
+    return wxVersionInfo("libjpeg", JPEG_LIB_VERSION/10, JPEG_LIB_VERSION%10);
+}
 
+#endif   // wxUSE_LIBJPEG