/////////////////////////////////////////////////////////////////////////////
-// Name: src/common/imagepng.cpp
+// Name: src/common/imagpng.cpp
// Purpose: wxImage PNG handler
// Author: Robert Roebling
// RCS-ID: $Id$
// declarations
// ============================================================================
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#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"
+#include "wx/versioninfo.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
// ----------------------------------------------------------------------------
#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
extern "C"
{
-void PNGLINKAGEMODE wx_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 wx_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)
-{
- wxLogFatalError( wxString::FromAscii(message) );
-}
-
-void
+static void
PNGLINKAGEMODE wx_png_warning(png_structp png_ptr, png_const_charp message)
{
wxPNGInfoStruct *info = png_ptr ? WX_PNG_INFO(png_ptr) : NULL;
if ( !info || info->verbose )
+ {
wxLogWarning( wxString::FromAscii(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)
+{
+ 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"
r2 = *p++;
g2 = *p++;
b2 = *p++;
+ ++p; // jump over alpha
wxImageHistogramEntry&
entry = h[wxImageHistogram:: MakeKey(r2, g2, b2)];
{
unsigned char hdr[4];
- if ( !stream.Read(hdr, WXSIZEOF(hdr)) )
+ if ( !stream.Read(hdr, WXSIZEOF(hdr)) ) // it's ok to modify the stream position here
return false;
return memcmp(hdr, "\211PNG", WXSIZEOF(hdr)) == 0;
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
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") );
// if we couldn't find a unique colour for the
// mask, we can have real pixels with the same
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;
png_structp png_ptr = png_create_read_struct
(
PNG_LIBPNG_VER_STRING,
- (voidp) NULL,
+ NULL,
wx_png_error,
wx_png_warning
);
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 );
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)
+ {
+ png_colorp palette = NULL;
+ int numPalette = 0;
+
+ (void) png_get_PLTE(png_ptr, info_ptr, &palette, &numPalette);
+
+ unsigned char* r = new unsigned char[numPalette];
+ unsigned char* g = new unsigned char[numPalette];
+ unsigned char* b = new unsigned char[numPalette];
+
+ for (int j = 0; j < numPalette; j++)
+ {
+ r[j] = palette[j].red;
+ g[j] = palette[j].green;
+ b[j] = palette[j].blue;
+ }
+
+ image->SetPalette(wxPalette(numPalette, 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
error:
if (verbose)
+ {
wxLogError(_("Couldn't load a PNG image - file is corrupted or not enough memory."));
+ }
if ( image->Ok() )
{
if ( lines )
{
+ for ( unsigned int n = 0; n < height; n++ )
+ free( lines[n] );
+
free( lines );
}
return false;
}
+// ----------------------------------------------------------------------------
+// SaveFile() helpers
+// ----------------------------------------------------------------------------
+
+#if wxUSE_PALETTE
+
+static int PaletteFind(const png_color& clr, const png_color *pal, int palCount)
+{
+ for (int i = 0; i < palCount; ++i)
+ {
+ if ( (clr.red == pal[i].red)
+ && (clr.green == pal[i].green)
+ && (clr.blue == pal[i].blue))
+ {
+ return i;
+ }
+ }
+
+ return wxNOT_FOUND;
+}
+
+#endif // wxUSE_PALETTE
+
// ----------------------------------------------------------------------------
// writing PNGs
// ----------------------------------------------------------------------------
if (!png_ptr)
{
if (verbose)
+ {
wxLogError(_("Couldn't save PNG image."));
+ }
return false;
}
{
png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
if (verbose)
+ {
wxLogError(_("Couldn't save PNG image."));
+ }
return false;
}
{
png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
if (verbose)
+ {
wxLogError(_("Couldn't save PNG image."));
+ }
return false;
}
// explanation why this line is mandatory
png_set_write_fn( png_ptr, &wxinfo, wx_PNG_stream_writer, NULL);
- 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);
+ const bool bHasPngFormatOption
+ = image->HasOption(wxIMAGE_OPTION_PNG_FORMAT);
+
+ int iColorType = bHasPngFormatOption
+ ? image->GetOptionInt(wxIMAGE_OPTION_PNG_FORMAT)
+ : wxPNG_TYPE_COLOUR;
+
+ bool bHasAlpha = image->HasAlpha();
+ bool bHasMask = image->HasMask();
+
+#if wxUSE_PALETTE
+ /*
+ Only save as an indexed image if the number of palette entries does not
+ exceed libpng's limit (256).
+ We assume here that we will need an extra palette entry if there's an
+ alpha or mask, regardless of whether a possibly needed conversion from
+ alpha to a mask fails (unlikely), or whether the mask colour already
+ can be found in the palette (more likely). In the latter case an extra
+ palette entry would not be required later on and the image could actually
+ be saved as a palettised PNG (instead now it will be saved as true colour).
+ A little bit of precision is lost, but at the benefit of a lot more
+ simplified code.
+ */
+ bool bUsePalette =
+ (!bHasPngFormatOption || iColorType == wxPNG_TYPE_PALETTE)
+ && image->HasPalette()
+ && image->GetPalette().GetColoursCount()
+ + ((bHasAlpha || bHasMask) ? 1 : 0) <= PNG_MAX_PALETTE_LENGTH;
+
+ wxImage temp_image(*image);
+ if (bUsePalette && image->HasAlpha() && !bHasMask)
+ {
+ /*
+ Only convert alpha to mask if saving as a palettised image was
+ explicitly requested. We don't want to lose alpha's precision
+ by converting to a mask just to be able to save palettised.
+ */
+ if (iColorType == wxPNG_TYPE_PALETTE
+ && temp_image.ConvertAlphaToMask())
+ {
+ image = &temp_image;
+ bHasMask = true;
+ bHasAlpha = image->HasAlpha();
+ }
+ else
+ {
+ bUsePalette = false;
+ iColorType = wxPNG_TYPE_COLOUR;
+ }
+ }
+#else
+ bool bUsePalette = false;
+#endif // wxUSE_PALETTE
+
+ /*
+ If saving palettised was requested but it was decided we can't use a
+ palette then reset the colour type to RGB.
+ */
+ if (!bUsePalette && iColorType == wxPNG_TYPE_PALETTE)
+ {
+ iColorType = wxPNG_TYPE_COLOUR;
+ }
+
+ bool bUseAlpha = !bUsePalette && (bHasAlpha || bHasMask);
+
+ png_color mask;
+ if (bHasMask)
+ {
+ mask.red = image->GetMaskRed();
+ mask.green = image->GetMaskGreen();
+ mask.blue = image->GetMaskBlue();
+ }
+
+
+ int iPngColorType;
+
+#if wxUSE_PALETTE
+ if (bUsePalette)
+ {
+ iPngColorType = PNG_COLOR_TYPE_PALETTE;
+ iColorType = wxPNG_TYPE_PALETTE;
+ }
+ else
+#endif // wxUSE_PALETTE
+ 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) );
+
+ int iBitDepth = !bUsePalette && image->HasOption(wxIMAGE_OPTION_PNG_BITDEPTH)
+ ? image->GetOptionInt(wxIMAGE_OPTION_PNG_BITDEPTH)
+ : 8;
+
+ png_set_IHDR( png_ptr, info_ptr, image->GetWidth(), image->GetHeight(),
+ iBitDepth, iPngColorType,
+ PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_BASE,
+ PNG_FILTER_TYPE_BASE);
+#if wxUSE_PALETTE
+ png_colorp palette = NULL;
+ int numPalette = 0;
+
+ if (bUsePalette)
+ {
+ const wxPalette& pal = image->GetPalette();
+ const int palCount = pal.GetColoursCount();
+ palette = (png_colorp) malloc(
+ (palCount + 1 /*headroom for trans */) * sizeof(png_color));
+
+ if (!palette)
+ {
+ png_destroy_write_struct( &png_ptr, (png_infopp)NULL );
+ if (verbose)
+ {
+ wxLogError(_("Couldn't save PNG image."));
+ }
+ return false;
+ }
+
+ for (int i = 0; i < palCount; ++i)
+ {
+ pal.GetRGB(i, &palette[i].red, &palette[i].green, &palette[i].blue);
+ }
+
+ numPalette = palCount;
+ if (bHasMask)
+ {
+ int index = PaletteFind(mask, palette, numPalette);
+
+ if (index)
+ {
+ if (index == wxNOT_FOUND)
+ {
+ numPalette++;
+ index = palCount;
+ palette[index] = mask;
+ }
+
+ wxSwap(palette[0], palette[index]);
+ }
+
+ png_byte trans = 0;
+ png_set_tRNS(png_ptr, info_ptr, &trans, 1, NULL);
+ }
+
+ png_set_PLTE(png_ptr, info_ptr, palette, numPalette);
+ free (palette);
+ palette = NULL;
+
+ // Let palette point to libpng's copy of the palette.
+ (void) png_get_PLTE(png_ptr, info_ptr, &palette, &numPalette);
+ }
+#endif // wxUSE_PALETTE
+
+ 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;
}
- for (int y = 0; y < image->GetHeight(); y++)
+ unsigned char *
+ pAlpha = (unsigned char *)(bHasAlpha ? image->GetAlpha() : NULL);
+ int iHeight = image->GetHeight();
+ int iWidth = image->GetWidth();
+
+ 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->HasAlpha() )
- {
- data[(x << 2) + 3] = image->GetAlpha(x, y);
- }
- else if (( !image->HasMask() ) || \
- (data[(x << 2) + 0] != image->GetMaskRed()) || \
- (data[(x << 2) + 1] != image->GetMaskGreen()) || \
- (data[(x << 2) + 2] != image->GetMaskBlue()))
+ png_color clr;
+ clr.red = *pColors++;
+ clr.green = *pColors++;
+ clr.blue = *pColors++;
+
+ switch ( iColorType )
{
- data[(x << 2) + 3] = 255;
+ default:
+ wxFAIL_MSG( wxT("unknown wxPNG_TYPE_XXX") );
+ // fall through
+
+ case wxPNG_TYPE_COLOUR:
+ *pData++ = clr.red;
+ if ( iBitDepth == 16 )
+ *pData++ = 0;
+ *pData++ = clr.green;
+ if ( iBitDepth == 16 )
+ *pData++ = 0;
+ *pData++ = clr.blue;
+ 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)clr.red +
+ 150.272*(unsigned)clr.green +
+ 36.864*(unsigned)clr.blue);
+
+ *pData++ = (unsigned char)((uiColor >> 8) & 0xFF);
+ if ( iBitDepth == 16 )
+ *pData++ = (unsigned char)(uiColor & 0xFF);
+ }
+ break;
+
+ case wxPNG_TYPE_GREY_RED:
+ *pData++ = clr.red;
+ if ( iBitDepth == 16 )
+ *pData++ = 0;
+ break;
+
+#if wxUSE_PALETTE
+ case wxPNG_TYPE_PALETTE:
+ *pData++ = (unsigned char) PaletteFind(clr,
+ palette, numPalette);
+ break;
+#endif // wxUSE_PALETTE
}
- else
+
+ if ( bUseAlpha )
{
- data[(x << 2) + 3] = 0;
+ unsigned char uchAlpha = 255;
+ if ( bHasAlpha )
+ uchAlpha = *pAlpha++;
+
+ if ( bHasMask )
+ {
+ if ( (clr.red == mask.red)
+ && (clr.green == mask.green)
+ && (clr.blue == mask.blue) )
+ uchAlpha = 0;
+ }
+
+ *pData++ = uchAlpha;
+ if ( iBitDepth == 16 )
+ *pData++ = 0;
}
}
+
png_bytep row_ptr = data;
png_write_rows( png_ptr, &row_ptr, 1 );
}
#endif // wxUSE_STREAMS
+/*static*/ wxVersionInfo wxPNGHandler::GetLibraryVersionInfo()
+{
+ // The version string seems to always have a leading space and a trailing
+ // new line, get rid of them both.
+ wxString str = png_get_header_version(NULL) + 1;
+ str.Replace("\n", "");
+
+ return wxVersionInfo("libpng",
+ PNG_LIBPNG_VER_MAJOR,
+ PNG_LIBPNG_VER_MINOR,
+ PNG_LIBPNG_VER_RELEASE,
+ str);
+}
+
#endif // wxUSE_LIBPNG