]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/imagpng.cpp
Fix wxDocManager::GetLastDirectory() when there is no history.
[wxWidgets.git] / src / common / imagpng.cpp
index 66e917422ac619472ba14fdff90bba0a21471017..14fd9eddb1bae5669b911390af956e76c83d9942 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        src/common/imagepng.cpp
+// Name:        src/common/imagpng.cpp
 // Purpose:     wxImage PNG handler
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // declarations
 // ============================================================================
 
-#ifdef __GNUG__
-#pragma implementation "imagpng.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-  #pragma hdrstop
-#endif
-
-#ifndef WX_PRECOMP
-  #include "wx/defs.h"
+    #pragma hdrstop
 #endif
 
 #if wxUSE_IMAGE && wxUSE_LIBPNG
 
 #include "wx/imagpng.h"
-#include "wx/bitmap.h"
-#include "wx/debug.h"
-#include "wx/log.h"
-#include "wx/app.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/intl.h"
+    #include "wx/palette.h"
+    #include "wx/stream.h"
+#endif
+
 #include "png.h"
-#include "wx/filefn.h"
-#include "wx/wfstream.h"
-#include "wx/intl.h"
-#include "wx/module.h"
 
 // For memcpy
 #include <string.h>
 
-#ifdef __SALFORDC__
-#ifdef FAR
-#undef FAR
-#endif
-#endif
-
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -109,7 +95,9 @@ IMPLEMENT_DYNAMIC_CLASS(wxPNGHandler,wxImageHandler)
 #if wxUSE_STREAMS
 
 #ifndef PNGLINKAGEMODE
-    #ifdef __WATCOMC__
+    #ifdef PNGAPI
+        #define PNGLINKAGEMODE PNGAPI
+    #elif defined(__WATCOMC__)
         // we need an explicit cdecl for Watcom, at least according to
         //
         // http://sf.net/tracker/index.php?func=detail&aid=651492&group_id=9863&atid=109863
@@ -160,42 +148,39 @@ struct wxPNGInfoStruct
 extern "C"
 {
 
-void PNGLINKAGEMODE _PNG_stream_reader( png_structp png_ptr, png_bytep data, png_size_t length )
+static void PNGLINKAGEMODE wx_PNG_stream_reader( png_structp png_ptr, png_bytep data,
+                                                 png_size_t length )
 {
     WX_PNG_INFO(png_ptr)->stream.in->Read(data, length);
 }
 
-void PNGLINKAGEMODE _PNG_stream_writer( png_structp png_ptr, png_bytep data, png_size_t length )
+static void PNGLINKAGEMODE wx_PNG_stream_writer( png_structp png_ptr, png_bytep data,
+                                                 png_size_t length )
 {
     WX_PNG_INFO(png_ptr)->stream.out->Write(data, length);
 }
 
-// from pngerror.c
-// so that the libpng doesn't send anything on stderr
-void
-PNGLINKAGEMODE wx_png_error(png_structp png_ptr, png_const_charp message)
+static void
+PNGLINKAGEMODE wx_png_warning(png_structp png_ptr, png_const_charp message)
 {
-    wxPNGInfoStruct *info = WX_PNG_INFO(png_ptr);
-    if (info->verbose)
-        wxLogError( wxString::FromAscii(message) );
-
-#ifdef USE_FAR_KEYWORD
+    wxPNGInfoStruct *info = png_ptr ? WX_PNG_INFO(png_ptr) : NULL;
+    if ( !info || info->verbose )
     {
-       jmp_buf jmpbuf;
-       png_memcpy(jmpbuf,info->jmpbuf,sizeof(jmp_buf));
-       longjmp(jmpbuf, 1);
+        wxLogWarning( wxString::FromAscii(message) );
     }
-#else
-    longjmp(info->jmpbuf, 1);
-#endif
 }
 
-void
-PNGLINKAGEMODE wx_png_warning(png_structp png_ptr, png_const_charp message)
+// from pngerror.c
+// so that the libpng doesn't send anything on stderr
+static void
+PNGLINKAGEMODE wx_png_error(png_structp png_ptr, png_const_charp message)
 {
-    wxPNGInfoStruct *info = WX_PNG_INFO(png_ptr);
-    if (info->verbose)
-        wxLogWarning( wxString::FromAscii(message) );
+    wx_png_warning(NULL, message);
+
+    // we're not using libpng built-in jump buffer (see comment before
+    // wxPNGInfoStruct above) so we have to return ourselves, otherwise libpng
+    // would just abort
+    longjmp(WX_PNG_INFO(png_ptr)->jmpbuf, 1);
 }
 
 } // extern "C"
@@ -220,14 +205,13 @@ CheckTransparency(unsigned char **lines,
                   png_uint_32 x, png_uint_32 y, png_uint_32 w, png_uint_32 h,
                   size_t numColBytes)
 {
-    // we start from (x + 1, y)
-    x++;
-
     // suppose that a mask will suffice and check all the remaining alpha
     // values to see if it does
     for ( ; y < h; y++ )
     {
-        unsigned const char *ptr = lines[y] + x;
+        // each pixel is numColBytes+1 bytes, offset into the current line by
+        // the current x position
+        unsigned const char *ptr = lines[y] + (x * (numColBytes + 1));
 
         for ( png_uint_32 x2 = x; x2 < w; x2++ )
         {
@@ -289,6 +273,7 @@ FindMaskColour(unsigned char **lines, png_uint_32 width, png_uint_32 height,
             r2 = *p++;
             g2 = *p++;
             b2 = *p++;
+            ++p; // jump over alpha
 
             wxImageHistogramEntry&
                 entry = h[wxImageHistogram:: MakeKey(r2, g2, b2)];
@@ -319,8 +304,8 @@ bool wxPNGHandler::DoCanRead( wxInputStream& stream )
 {
     unsigned char hdr[4];
 
-    if ( !stream.Read(hdr, WXSIZEOF(hdr)) )
-        return FALSE;
+    if ( !stream.Read(hdr, WXSIZEOF(hdr)) )     // it's ok to modify the stream position here
+        return false;
 
     return memcmp(hdr, "\211PNG", WXSIZEOF(hdr)) == 0;
 }
@@ -394,15 +379,15 @@ void CopyDataFromPNG(wxImage *image,
                         if ( IsTransparent(a) )
                         {
                             *ptrDst++ = rMask;
-                            *ptrDst++ = bMask;
                             *ptrDst++ = gMask;
+                            *ptrDst++ = bMask;
                             break;
                         }
                         // else: !transparent
 
                         // must be opaque then as otherwise we shouldn't be
                         // using the mask at all
-                        wxASSERT_MSG( IsOpaque(a), _T("logic error") );
+                        wxASSERT_MSG( IsOpaque(a), wxT("logic error") );
 
                         // fall through
 
@@ -461,25 +446,27 @@ void CopyDataFromPNG(wxImage *image,
                     case Transparency_Mask:
                         if ( IsTransparent(a) )
                         {
-                            // if we couldn't find a unique colour for the mask, we
-                            // can have real pixels with the same value as the mask
-                            // and it's better to slightly change their colour than
-                            // to make them transparent
+                            *ptrDst++ = rMask;
+                            *ptrDst++ = gMask;
+                            *ptrDst++ = bMask;
+                            break;
+                        }
+                        else // !transparent
+                        {
+                            // must be opaque then as otherwise we shouldn't be
+                            // using the mask at all
+                            wxASSERT_MSG( IsOpaque(a), wxT("logic error") );
+
+                            // if we couldn't find a unique colour for the
+                            // mask, we can have real pixels with the same
+                            // value as the mask and it's better to slightly
+                            // change their colour than to make them
+                            // transparent
                             if ( r == rMask && g == gMask && b == bMask )
                             {
                                 r++;
                             }
-
-                            *ptrDst++ = rMask;
-                            *ptrDst++ = bMask;
-                            *ptrDst++ = gMask;
-                            break;
                         }
-                        // else: !transparent
-
-                        // must be opaque then as otherwise we shouldn't be
-                        // using the mask at all
-                        wxASSERT_MSG( IsOpaque(a), _T("logic error") );
 
                         // fall through
 
@@ -516,30 +503,34 @@ wxPNGHandler::LoadFile(wxImage *image,
                        bool verbose,
                        int WXUNUSED(index))
 {
-    // VZ: as this function uses setjmp() the only fool proof error handling
+    // VZ: as this function uses setjmp() the only fool-proof error handling
     //     method is to use goto (setjmp is not really C++ dtors friendly...)
 
     unsigned char **lines = NULL;
     png_infop info_ptr = (png_infop) NULL;
     wxPNGInfoStruct wxinfo;
 
+    png_uint_32 i, width, height = 0;
+    int bit_depth, color_type, interlace_type;
+
     wxinfo.verbose = verbose;
     wxinfo.stream.in = &stream;
 
     image->Destroy();
 
-    png_structp png_ptr = png_create_read_struct( PNG_LIBPNG_VER_STRING,
-        (voidp) NULL,
-        (png_error_ptr) NULL,
-        (png_error_ptr) NULL );
+    png_structp png_ptr = png_create_read_struct
+                          (
+                            PNG_LIBPNG_VER_STRING,
+                            (voidp) NULL,
+                            wx_png_error,
+                            wx_png_warning
+                          );
     if (!png_ptr)
         goto error;
 
-    png_set_error_fn(png_ptr, (png_voidp)NULL, wx_png_error, wx_png_warning);
-
     // NB: please see the comment near wxPNGInfoStruct declaration for
     //     explanation why this line is mandatory
-    png_set_read_fn( png_ptr, &wxinfo, _PNG_stream_reader);
+    png_set_read_fn( png_ptr, &wxinfo, wx_PNG_stream_reader);
 
     info_ptr = png_create_info_struct( png_ptr );
     if (!info_ptr)
@@ -548,11 +539,8 @@ wxPNGHandler::LoadFile(wxImage *image,
     if (setjmp(wxinfo.jmpbuf))
         goto error;
 
-    png_uint_32 i, width, height;
-    int bit_depth, color_type, interlace_type;
-
     png_read_info( png_ptr, info_ptr );
-    png_get_IHDR( png_ptr, info_ptr, &width, &height, &bit_depth, &color_type, &interlace_type, (int*) NULL, (int*) NULL );
+    png_get_IHDR( png_ptr, info_ptr, &width, &height, &bit_depth, &color_type, &interlace_type, NULL, NULL );
 
     if (color_type == PNG_COLOR_TYPE_PALETTE)
         png_set_expand( png_ptr );
@@ -567,27 +555,48 @@ wxPNGHandler::LoadFile(wxImage *image,
         png_set_expand( png_ptr );
     png_set_filler( png_ptr, 0xff, PNG_FILLER_AFTER );
 
-    image->Create( (int)width, (int)height );
+    image->Create((int)width, (int)height, (bool) false /* no need to init pixels */);
 
     if (!image->Ok())
         goto error;
 
-    lines = (unsigned char **)malloc( (size_t)(height * sizeof(unsigned char *)) );
+    // initialize all line pointers to NULL to ensure that they can be safely
+    // free()d if an error occurs before all of them could be allocated
+    lines = (unsigned char **)calloc(height, sizeof(unsigned char *));
     if ( !lines )
         goto error;
 
     for (i = 0; i < height; i++)
     {
         if ((lines[i] = (unsigned char *)malloc( (size_t)(width * (sizeof(unsigned char) * 4)))) == NULL)
-        {
-            for ( unsigned int n = 0; n < i; n++ )
-                free( lines[n] );
             goto error;
-        }
     }
 
     png_read_image( png_ptr, lines );
     png_read_end( png_ptr, info_ptr );
+
+#if wxUSE_PALETTE
+    if (color_type == PNG_COLOR_TYPE_PALETTE)
+    {
+        const size_t ncolors = info_ptr->num_palette;
+        unsigned char* r = new unsigned char[ncolors];
+        unsigned char* g = new unsigned char[ncolors];
+        unsigned char* b = new unsigned char[ncolors];
+
+        for (size_t j = 0; j < ncolors; j++)
+        {
+            r[j] = info_ptr->palette[j].red;
+            g[j] = info_ptr->palette[j].green;
+            b[j] = info_ptr->palette[j].blue;
+        }
+
+        image->SetPalette(wxPalette(ncolors, r, g, b));
+        delete[] r;
+        delete[] g;
+        delete[] b;
+    }
+#endif // wxUSE_PALETTE
+
     png_destroy_read_struct( &png_ptr, &info_ptr, (png_infopp) NULL );
 
     // loaded successfully, now init wxImage with this data
@@ -597,11 +606,13 @@ wxPNGHandler::LoadFile(wxImage *image,
         free( lines[i] );
     free( lines );
 
-    return TRUE;
+    return true;
 
 error:
     if (verbose)
+    {
        wxLogError(_("Couldn't load a PNG image - file is corrupted or not enough memory."));
+    }
 
     if ( image->Ok() )
     {
@@ -610,6 +621,9 @@ error:
 
     if ( lines )
     {
+        for ( unsigned int n = 0; n < height; n++ )
+            free( lines[n] );
+
         free( lines );
     }
 
@@ -623,7 +637,7 @@ error:
         else
             png_destroy_read_struct( &png_ptr, (png_infopp) NULL, (png_infopp) NULL );
     }
-    return FALSE;
+    return false;
 }
 
 // ----------------------------------------------------------------------------
@@ -637,78 +651,240 @@ bool wxPNGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbos
     wxinfo.verbose = verbose;
     wxinfo.stream.out = &stream;
 
-    png_structp png_ptr = png_create_write_struct( PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
+    png_structp png_ptr = png_create_write_struct
+                          (
+                            PNG_LIBPNG_VER_STRING,
+                            NULL,
+                            wx_png_error,
+                            wx_png_warning
+                          );
     if (!png_ptr)
     {
         if (verbose)
+        {
            wxLogError(_("Couldn't save PNG image."));
-        return FALSE;
+        }
+        return false;
     }
 
-    png_set_error_fn(png_ptr, (png_voidp)NULL, wx_png_error, wx_png_warning);
-
     png_infop info_ptr = png_create_info_struct(png_ptr);
     if (info_ptr == NULL)
     {
         png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
         if (verbose)
+        {
            wxLogError(_("Couldn't save PNG image."));
-        return FALSE;
+        }
+        return false;
     }
 
     if (setjmp(wxinfo.jmpbuf))
     {
         png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
         if (verbose)
+        {
            wxLogError(_("Couldn't save PNG image."));
-        return FALSE;
+        }
+        return false;
     }
 
     // NB: please see the comment near wxPNGInfoStruct declaration for
     //     explanation why this line is mandatory
-    png_set_write_fn( png_ptr, &wxinfo, _PNG_stream_writer, NULL);
+    png_set_write_fn( png_ptr, &wxinfo, wx_PNG_stream_writer, NULL);
+
+    const int iColorType = image->HasOption(wxIMAGE_OPTION_PNG_FORMAT)
+                            ? image->GetOptionInt(wxIMAGE_OPTION_PNG_FORMAT)
+                            : wxPNG_TYPE_COLOUR;
+    const int iBitDepth = image->HasOption(wxIMAGE_OPTION_PNG_BITDEPTH)
+                            ? image->GetOptionInt(wxIMAGE_OPTION_PNG_BITDEPTH)
+                            : 8;
+
+    bool bHasAlpha = image->HasAlpha();
+    bool bHasMask = image->HasMask();
+    bool bUseAlpha = bHasAlpha || bHasMask;
 
-    png_set_IHDR( png_ptr, info_ptr, image->GetWidth(), image->GetHeight(), 8,
-        PNG_COLOR_TYPE_RGB_ALPHA, PNG_INTERLACE_NONE,
-        PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
+    int iPngColorType;
+    if ( iColorType==wxPNG_TYPE_COLOUR )
+    {
+        iPngColorType = bUseAlpha ? PNG_COLOR_TYPE_RGB_ALPHA
+                                  : PNG_COLOR_TYPE_RGB;
+    }
+    else
+    {
+        iPngColorType = bUseAlpha ? PNG_COLOR_TYPE_GRAY_ALPHA
+                                  : PNG_COLOR_TYPE_GRAY;
+    }
+
+    if (image->HasOption(wxIMAGE_OPTION_PNG_FILTER))
+        png_set_filter( png_ptr, PNG_FILTER_TYPE_BASE, image->GetOptionInt(wxIMAGE_OPTION_PNG_FILTER) );
+
+    if (image->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL))
+        png_set_compression_level( png_ptr, image->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL) );
+
+    if (image->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL))
+        png_set_compression_mem_level( png_ptr, image->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL) );
+
+    if (image->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY))
+        png_set_compression_strategy( png_ptr, image->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY) );
 
+    if (image->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE))
+        png_set_compression_buffer_size( png_ptr, image->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE) );
+
+    png_set_IHDR( png_ptr, info_ptr, image->GetWidth(), image->GetHeight(),
+                  iBitDepth, iPngColorType,
+                  PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_BASE,
+                  PNG_FILTER_TYPE_BASE);
+
+    int iElements;
     png_color_8 sig_bit;
-    sig_bit.red = 8;
-    sig_bit.green = 8;
-    sig_bit.blue = 8;
-    sig_bit.alpha = 8;
+
+    if ( iPngColorType & PNG_COLOR_MASK_COLOR )
+    {
+        sig_bit.red =
+        sig_bit.green =
+        sig_bit.blue = (png_byte)iBitDepth;
+        iElements = 3;
+    }
+    else // grey
+    {
+        sig_bit.gray = (png_byte)iBitDepth;
+        iElements = 1;
+    }
+
+    if ( iPngColorType & PNG_COLOR_MASK_ALPHA )
+    {
+        sig_bit.alpha = (png_byte)iBitDepth;
+        iElements++;
+    }
+
+    if ( iBitDepth == 16 )
+        iElements *= 2;
+
+    // save the image resolution if we have it
+    int resX, resY;
+    switch ( GetResolutionFromOptions(*image, &resX, &resY) )
+    {
+        case wxIMAGE_RESOLUTION_INCHES:
+            {
+                const double INCHES_IN_METER = 10000.0 / 254;
+                resX = int(resX * INCHES_IN_METER);
+                resY = int(resY * INCHES_IN_METER);
+            }
+            break;
+
+        case wxIMAGE_RESOLUTION_CM:
+            resX *= 100;
+            resY *= 100;
+            break;
+
+        case wxIMAGE_RESOLUTION_NONE:
+            break;
+
+        default:
+            wxFAIL_MSG( wxT("unsupported image resolution units") );
+    }
+
+    if ( resX && resY )
+        png_set_pHYs( png_ptr, info_ptr, resX, resY, PNG_RESOLUTION_METER );
+
     png_set_sBIT( png_ptr, info_ptr, &sig_bit );
     png_write_info( png_ptr, info_ptr );
     png_set_shift( png_ptr, &sig_bit );
     png_set_packing( png_ptr );
 
-    unsigned char *data = (unsigned char *)malloc( image->GetWidth()*4 );
-    if (!data)
+    unsigned char *
+        data = (unsigned char *)malloc( image->GetWidth() * iElements );
+    if ( !data )
     {
         png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
-        return FALSE;
+        return false;
+    }
+
+    unsigned char *
+        pAlpha = (unsigned char *)(bHasAlpha ? image->GetAlpha() : NULL);
+    int iHeight = image->GetHeight();
+    int iWidth = image->GetWidth();
+
+    unsigned char uchMaskRed = 0, uchMaskGreen = 0, uchMaskBlue = 0;
+
+    if ( bHasMask )
+    {
+        uchMaskRed = image->GetMaskRed();
+        uchMaskGreen = image->GetMaskGreen();
+        uchMaskBlue = image->GetMaskBlue();
     }
 
-    for (int y = 0; y < image->GetHeight(); y++)
+    unsigned char *pColors = image->GetData();
+
+    for (int y = 0; y != iHeight; ++y)
     {
-        unsigned char *ptr = image->GetData() + (y * image->GetWidth() * 3);
-        for (int x = 0; x < image->GetWidth(); x++)
+        unsigned char *pData = data;
+        for (int x = 0; x != iWidth; x++)
         {
-            data[(x << 2) + 0] = *ptr++;
-            data[(x << 2) + 1] = *ptr++;
-            data[(x << 2) + 2] = *ptr++;
-            if (( !image->HasMask() ) || \
-                (data[(x << 2) + 0] != image->GetMaskRed()) || \
-                (data[(x << 2) + 1] != image->GetMaskGreen()) || \
-                (data[(x << 2) + 2] != image->GetMaskBlue()))
+            unsigned char uchRed = *pColors++;
+            unsigned char uchGreen = *pColors++;
+            unsigned char uchBlue = *pColors++;
+
+            switch ( iColorType )
             {
-                data[(x << 2) + 3] = 255;
+                default:
+                    wxFAIL_MSG( wxT("unknown wxPNG_TYPE_XXX") );
+                    // fall through
+
+                case wxPNG_TYPE_COLOUR:
+                    *pData++ = uchRed;
+                    if ( iBitDepth == 16 )
+                        *pData++ = 0;
+                    *pData++ = uchGreen;
+                    if ( iBitDepth == 16 )
+                        *pData++ = 0;
+                    *pData++ = uchBlue;
+                    if ( iBitDepth == 16 )
+                        *pData++ = 0;
+                    break;
+
+                case wxPNG_TYPE_GREY:
+                    {
+                        // where do these coefficients come from? maybe we
+                        // should have image options for them as well?
+                        unsigned uiColor =
+                            (unsigned) (76.544*(unsigned)uchRed +
+                                        150.272*(unsigned)uchGreen +
+                                        36.864*(unsigned)uchBlue);
+
+                        *pData++ = (unsigned char)((uiColor >> 8) & 0xFF);
+                        if ( iBitDepth == 16 )
+                            *pData++ = (unsigned char)(uiColor & 0xFF);
+                    }
+                    break;
+
+                case wxPNG_TYPE_GREY_RED:
+                    *pData++ = uchRed;
+                    if ( iBitDepth == 16 )
+                        *pData++ = 0;
+                    break;
             }
-            else
+
+            if ( bUseAlpha )
             {
-                data[(x << 2) + 3] = 0;
+                unsigned char uchAlpha = 255;
+                if ( bHasAlpha )
+                    uchAlpha = *pAlpha++;
+
+                if ( bHasMask )
+                {
+                    if ( (uchRed == uchMaskRed)
+                            && (uchGreen == uchMaskGreen)
+                                && (uchBlue == uchMaskBlue) )
+                        uchAlpha = 0;
+                }
+
+                *pData++ = uchAlpha;
+                if ( iBitDepth == 16 )
+                    *pData++ = 0;
             }
         }
+
         png_bytep row_ptr = data;
         png_write_rows( png_ptr, &row_ptr, 1 );
     }
@@ -717,7 +893,7 @@ bool wxPNGHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbos
     png_write_end( png_ptr, info_ptr );
     png_destroy_write_struct( &png_ptr, (png_infopp)&info_ptr );
 
-    return TRUE;
+    return true;
 }
 
 #ifdef __VISUALC__