1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/imagpng.cpp
3 // Purpose: wxImage PNG handler
4 // Author: Robert Roebling
6 // Copyright: (c) Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // ============================================================================
12 // ============================================================================
14 // ----------------------------------------------------------------------------
16 // ----------------------------------------------------------------------------
18 // For compilers that support precompilation, includes "wx.h".
19 #include "wx/wxprec.h"
25 #if wxUSE_IMAGE && wxUSE_LIBPNG
27 #include "wx/imagpng.h"
28 #include "wx/versioninfo.h"
33 #include "wx/palette.h"
34 #include "wx/stream.h"
42 // ----------------------------------------------------------------------------
44 // ----------------------------------------------------------------------------
46 // image can not have any transparent pixels at all, have only 100% opaque
47 // and/or 100% transparent pixels in which case a simple mask is enough to
48 // store this information in wxImage or have a real alpha channel in which case
49 // we need to have it in wxImage as well
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
61 // return the kind of transparency needed for this image assuming that it does
62 // have transparent pixels, i.e. either Transparency_Alpha or Transparency_Mask
64 CheckTransparency(unsigned char **lines
,
65 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
68 // init the alpha channel for the image and fill it with 1s up to (x, y)
69 static unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
);
71 // find a free colour for the mask in the PNG data array
73 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
74 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
);
76 // is the pixel with this value of alpha a fully opaque one?
78 bool IsOpaque(unsigned char a
)
83 // is the pixel with this value of alpha a fully transparent one?
85 bool IsTransparent(unsigned char a
)
90 // ============================================================================
91 // wxPNGHandler implementation
92 // ============================================================================
94 IMPLEMENT_DYNAMIC_CLASS(wxPNGHandler
,wxImageHandler
)
98 #ifndef PNGLINKAGEMODE
100 #define PNGLINKAGEMODE PNGAPI
101 #elif defined(__WATCOMC__)
102 // we need an explicit cdecl for Watcom, at least according to
104 // http://sf.net/tracker/index.php?func=detail&aid=651492&group_id=9863&atid=109863
106 // more testing is needed for this however, please remove this comment
107 // if you can confirm that my fix works with Watcom 11
108 #define PNGLINKAGEMODE cdecl
110 #define PNGLINKAGEMODE LINKAGEMODE
115 // VS: wxPNGInfoStruct declared below is a hack that needs some explanation.
116 // First, let me describe what's the problem: libpng uses jmp_buf in
117 // its png_struct structure. Unfortunately, this structure is
118 // compiler-specific and may vary in size, so if you use libpng compiled
119 // as DLL with another compiler than the main executable, it may not work
120 // (this is for example the case with wxMGL port and SciTech MGL library
121 // that provides custom runtime-loadable libpng implementation with jmpbuf
122 // disabled altogether). Luckily, it is still possible to use setjmp() &
123 // longjmp() as long as the structure is not part of png_struct.
125 // Sadly, there's no clean way to attach user-defined data to png_struct.
126 // There is only one customizable place, png_struct.io_ptr, which is meant
127 // only for I/O routines and is set with png_set_read_fn or
128 // png_set_write_fn. The hacky part is that we use io_ptr to store
129 // a pointer to wxPNGInfoStruct that holds I/O structures _and_ jmp_buf.
131 struct wxPNGInfoStruct
143 #define WX_PNG_INFO(png_ptr) ((wxPNGInfoStruct*)png_get_io_ptr(png_ptr))
145 // ----------------------------------------------------------------------------
147 // ----------------------------------------------------------------------------
152 static void PNGLINKAGEMODE
wx_PNG_stream_reader( png_structp png_ptr
, png_bytep data
,
155 WX_PNG_INFO(png_ptr
)->stream
.in
->Read(data
, length
);
158 static void PNGLINKAGEMODE
wx_PNG_stream_writer( png_structp png_ptr
, png_bytep data
,
161 WX_PNG_INFO(png_ptr
)->stream
.out
->Write(data
, length
);
165 PNGLINKAGEMODE
wx_png_warning(png_structp png_ptr
, png_const_charp message
)
167 wxPNGInfoStruct
*info
= png_ptr
? WX_PNG_INFO(png_ptr
) : NULL
;
168 if ( !info
|| info
->verbose
)
170 wxLogWarning( wxString::FromAscii(message
) );
175 // so that the libpng doesn't send anything on stderr
177 PNGLINKAGEMODE
wx_png_error(png_structp png_ptr
, png_const_charp message
)
179 wx_png_warning(NULL
, message
);
181 // we're not using libpng built-in jump buffer (see comment before
182 // wxPNGInfoStruct above) so we have to return ourselves, otherwise libpng
184 longjmp(WX_PNG_INFO(png_ptr
)->jmpbuf
, 1);
189 // ----------------------------------------------------------------------------
190 // LoadFile() helpers
191 // ----------------------------------------------------------------------------
193 // determine the kind of transparency we need for this image: if the only alpha
194 // values it has are 0 (transparent) and 0xff (opaque) then we can simply
195 // create a mask for it, we should be ok with a simple mask but otherwise we
196 // need a full blown alpha channel in wxImage
199 // lines raw PNG data
200 // x, y starting position
201 // w, h size of the image
202 // numColBytes number of colour bytes (1 for grey scale, 3 for RGB)
203 // (NB: alpha always follows the colour bytes)
205 CheckTransparency(unsigned char **lines
,
206 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
209 // suppose that a mask will suffice and check all the remaining alpha
210 // values to see if it does
213 // each pixel is numColBytes+1 bytes, offset into the current line by
214 // the current x position
215 unsigned const char *ptr
= lines
[y
] + (x
* (numColBytes
+ 1));
217 for ( png_uint_32 x2
= x
; x2
< w
; x2
++ )
219 // skip the grey or colour byte(s)
222 unsigned char a2
= *ptr
++;
224 if ( !IsTransparent(a2
) && !IsOpaque(a2
) )
226 // not fully opaque nor fully transparent, hence need alpha
227 return Transparency_Alpha
;
231 // during the next loop iteration check all the pixels in the row
235 // mask will be enough
236 return Transparency_Mask
;
239 unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
)
241 // create alpha channel
244 unsigned char *alpha
= image
->GetAlpha();
246 // set alpha for the pixels we had so far
247 png_uint_32 end
= y
* image
->GetWidth() + x
;
248 for ( png_uint_32 i
= 0; i
< end
; i
++ )
250 // all the previous pixels were opaque
258 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
259 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
)
261 // choosing the colour for the mask is more
262 // difficult: we need to iterate over the entire
263 // image for this in order to choose an unused
264 // colour (this is not very efficient but what else
267 unsigned nentries
= 0;
268 unsigned char r2
, g2
, b2
;
269 for ( png_uint_32 y2
= 0; y2
< height
; y2
++ )
271 const unsigned char *p
= lines
[y2
];
272 for ( png_uint_32 x2
= 0; x2
< width
; x2
++ )
277 ++p
; // jump over alpha
279 wxImageHistogramEntry
&
280 entry
= h
[wxImageHistogram:: MakeKey(r2
, g2
, b2
)];
282 if ( entry
.value
++ == 0 )
283 entry
.index
= nentries
++;
287 if ( !h
.FindFirstUnusedColour(&rMask
, &gMask
, &bMask
) )
289 wxLogWarning(_("Too many colours in PNG, the image may be slightly blurred."));
291 // use a fixed mask colour and we'll fudge
292 // the real pixels with this colour (see
300 // ----------------------------------------------------------------------------
302 // ----------------------------------------------------------------------------
304 bool wxPNGHandler::DoCanRead( wxInputStream
& stream
)
306 unsigned char hdr
[4];
308 if ( !stream
.Read(hdr
, WXSIZEOF(hdr
)) ) // it's ok to modify the stream position here
311 return memcmp(hdr
, "\211PNG", WXSIZEOF(hdr
)) == 0;
314 // convert data from RGB to wxImage format
316 void CopyDataFromPNG(wxImage
*image
,
317 unsigned char **lines
,
322 Transparency transparency
= Transparency_None
;
324 // only non NULL if transparency == Transparency_Alpha
325 unsigned char *alpha
= NULL
;
327 // RGB of the mask colour if transparency == Transparency_Mask
328 // (but init them anyhow to avoid compiler warnings)
329 unsigned char rMask
= 0,
333 unsigned char *ptrDst
= image
->GetData();
334 if ( !(color_type
& PNG_COLOR_MASK_COLOR
) )
336 // grey image: GAGAGA... where G == grey component and A == alpha
337 for ( png_uint_32 y
= 0; y
< height
; y
++ )
339 const unsigned char *ptrSrc
= lines
[y
];
340 for ( png_uint_32 x
= 0; x
< width
; x
++ )
342 unsigned char g
= *ptrSrc
++;
343 unsigned char a
= *ptrSrc
++;
345 // the first time we encounter a transparent pixel we must
346 // decide about what to do about them
347 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
349 // we'll need at least the mask for this image and
350 // maybe even full alpha channel info: the former is
351 // only enough if we have alpha values of 0 and 0xff
352 // only, otherwisewe need the latter
353 transparency
= CheckTransparency
361 if ( transparency
== Transparency_Mask
)
363 // let's choose this colour for the mask: this is
364 // not a problem here as all the other pixels are
365 // grey, i.e. R == G == B which is not the case for
366 // this one so no confusion is possible
371 else // transparency == Transparency_Alpha
373 alpha
= InitAlpha(image
, x
, y
);
377 switch ( transparency
)
379 case Transparency_Mask
:
380 if ( IsTransparent(a
) )
387 // else: !transparent
389 // must be opaque then as otherwise we shouldn't be
390 // using the mask at all
391 wxASSERT_MSG( IsOpaque(a
), wxT("logic error") );
395 case Transparency_Alpha
:
400 case Transparency_None
:
409 else // colour image: RGBRGB...
411 for ( png_uint_32 y
= 0; y
< height
; y
++ )
413 const unsigned char *ptrSrc
= lines
[y
];
414 for ( png_uint_32 x
= 0; x
< width
; x
++ )
416 unsigned char r
= *ptrSrc
++;
417 unsigned char g
= *ptrSrc
++;
418 unsigned char b
= *ptrSrc
++;
419 unsigned char a
= *ptrSrc
++;
421 // the logic here is the same as for the grey case except
423 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
425 transparency
= CheckTransparency
433 if ( transparency
== Transparency_Mask
)
435 FindMaskColour(lines
, width
, height
,
436 rMask
, gMask
, bMask
);
438 else // transparency == Transparency_Alpha
440 alpha
= InitAlpha(image
, x
, y
);
445 switch ( transparency
)
447 case Transparency_Mask
:
448 if ( IsTransparent(a
) )
457 // must be opaque then as otherwise we shouldn't be
458 // using the mask at all
459 wxASSERT_MSG( IsOpaque(a
), wxT("logic error") );
461 // if we couldn't find a unique colour for the
462 // mask, we can have real pixels with the same
463 // value as the mask and it's better to slightly
464 // change their colour than to make them
466 if ( r
== rMask
&& g
== gMask
&& b
== bMask
)
474 case Transparency_Alpha
:
479 case Transparency_None
:
489 if ( transparency
== Transparency_Mask
)
491 image
->SetMaskColour(rMask
, gMask
, bMask
);
495 // temporarily disable the warning C4611 (interaction between '_setjmp' and
496 // C++ object destruction is non-portable) - I don't see any dtors here
498 #pragma warning(disable:4611)
502 wxPNGHandler::LoadFile(wxImage
*image
,
503 wxInputStream
& stream
,
507 // VZ: as this function uses setjmp() the only fool-proof error handling
508 // method is to use goto (setjmp is not really C++ dtors friendly...)
510 unsigned char **lines
= NULL
;
511 png_infop info_ptr
= (png_infop
) NULL
;
512 wxPNGInfoStruct wxinfo
;
514 png_uint_32 i
, width
, height
= 0;
515 int bit_depth
, color_type
, interlace_type
;
517 wxinfo
.verbose
= verbose
;
518 wxinfo
.stream
.in
= &stream
;
522 png_structp png_ptr
= png_create_read_struct
524 PNG_LIBPNG_VER_STRING
,
532 // NB: please see the comment near wxPNGInfoStruct declaration for
533 // explanation why this line is mandatory
534 png_set_read_fn( png_ptr
, &wxinfo
, wx_PNG_stream_reader
);
536 info_ptr
= png_create_info_struct( png_ptr
);
540 if (setjmp(wxinfo
.jmpbuf
))
543 png_read_info( png_ptr
, info_ptr
);
544 png_get_IHDR( png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
, &interlace_type
, NULL
, NULL
);
546 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
547 png_set_expand( png_ptr
);
549 // Fix for Bug [ 439207 ] Monochrome PNG images come up black
551 png_set_expand( png_ptr
);
553 png_set_strip_16( png_ptr
);
554 png_set_packing( png_ptr
);
555 if (png_get_valid( png_ptr
, info_ptr
, PNG_INFO_tRNS
))
556 png_set_expand( png_ptr
);
557 png_set_filler( png_ptr
, 0xff, PNG_FILLER_AFTER
);
559 image
->Create((int)width
, (int)height
, (bool) false /* no need to init pixels */);
564 // initialize all line pointers to NULL to ensure that they can be safely
565 // free()d if an error occurs before all of them could be allocated
566 lines
= (unsigned char **)calloc(height
, sizeof(unsigned char *));
570 for (i
= 0; i
< height
; i
++)
572 if ((lines
[i
] = (unsigned char *)malloc( (size_t)(width
* (sizeof(unsigned char) * 4)))) == NULL
)
576 png_read_image( png_ptr
, lines
);
577 png_read_end( png_ptr
, info_ptr
);
580 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
582 const size_t ncolors
= info_ptr
->num_palette
;
583 unsigned char* r
= new unsigned char[ncolors
];
584 unsigned char* g
= new unsigned char[ncolors
];
585 unsigned char* b
= new unsigned char[ncolors
];
587 for (size_t j
= 0; j
< ncolors
; j
++)
589 r
[j
] = info_ptr
->palette
[j
].red
;
590 g
[j
] = info_ptr
->palette
[j
].green
;
591 b
[j
] = info_ptr
->palette
[j
].blue
;
594 image
->SetPalette(wxPalette(ncolors
, r
, g
, b
));
599 #endif // wxUSE_PALETTE
601 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
603 // loaded successfully, now init wxImage with this data
604 CopyDataFromPNG(image
, lines
, width
, height
, color_type
);
606 for ( i
= 0; i
< height
; i
++ )
615 wxLogError(_("Couldn't load a PNG image - file is corrupted or not enough memory."));
625 for ( unsigned int n
= 0; n
< height
; n
++ )
635 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
639 png_destroy_read_struct( &png_ptr
, (png_infopp
) NULL
, (png_infopp
) NULL
);
644 // ----------------------------------------------------------------------------
646 // ----------------------------------------------------------------------------
648 bool wxPNGHandler::SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
)
650 wxPNGInfoStruct wxinfo
;
652 wxinfo
.verbose
= verbose
;
653 wxinfo
.stream
.out
= &stream
;
655 png_structp png_ptr
= png_create_write_struct
657 PNG_LIBPNG_VER_STRING
,
666 wxLogError(_("Couldn't save PNG image."));
671 png_infop info_ptr
= png_create_info_struct(png_ptr
);
672 if (info_ptr
== NULL
)
674 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
677 wxLogError(_("Couldn't save PNG image."));
682 if (setjmp(wxinfo
.jmpbuf
))
684 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
687 wxLogError(_("Couldn't save PNG image."));
692 // NB: please see the comment near wxPNGInfoStruct declaration for
693 // explanation why this line is mandatory
694 png_set_write_fn( png_ptr
, &wxinfo
, wx_PNG_stream_writer
, NULL
);
696 const int iColorType
= image
->HasOption(wxIMAGE_OPTION_PNG_FORMAT
)
697 ? image
->GetOptionInt(wxIMAGE_OPTION_PNG_FORMAT
)
699 const int iBitDepth
= image
->HasOption(wxIMAGE_OPTION_PNG_BITDEPTH
)
700 ? image
->GetOptionInt(wxIMAGE_OPTION_PNG_BITDEPTH
)
703 bool bHasAlpha
= image
->HasAlpha();
704 bool bHasMask
= image
->HasMask();
705 bool bUseAlpha
= bHasAlpha
|| bHasMask
;
708 if ( iColorType
==wxPNG_TYPE_COLOUR
)
710 iPngColorType
= bUseAlpha
? PNG_COLOR_TYPE_RGB_ALPHA
711 : PNG_COLOR_TYPE_RGB
;
715 iPngColorType
= bUseAlpha
? PNG_COLOR_TYPE_GRAY_ALPHA
716 : PNG_COLOR_TYPE_GRAY
;
719 if (image
->HasOption(wxIMAGE_OPTION_PNG_FILTER
))
720 png_set_filter( png_ptr
, PNG_FILTER_TYPE_BASE
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_FILTER
) );
722 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL
))
723 png_set_compression_level( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL
) );
725 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL
))
726 png_set_compression_mem_level( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL
) );
728 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY
))
729 png_set_compression_strategy( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY
) );
731 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE
))
732 png_set_compression_buffer_size( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE
) );
734 png_set_IHDR( png_ptr
, info_ptr
, image
->GetWidth(), image
->GetHeight(),
735 iBitDepth
, iPngColorType
,
736 PNG_INTERLACE_NONE
, PNG_COMPRESSION_TYPE_BASE
,
737 PNG_FILTER_TYPE_BASE
);
742 if ( iPngColorType
& PNG_COLOR_MASK_COLOR
)
746 sig_bit
.blue
= (png_byte
)iBitDepth
;
751 sig_bit
.gray
= (png_byte
)iBitDepth
;
755 if ( iPngColorType
& PNG_COLOR_MASK_ALPHA
)
757 sig_bit
.alpha
= (png_byte
)iBitDepth
;
761 if ( iBitDepth
== 16 )
764 // save the image resolution if we have it
766 switch ( GetResolutionFromOptions(*image
, &resX
, &resY
) )
768 case wxIMAGE_RESOLUTION_INCHES
:
770 const double INCHES_IN_METER
= 10000.0 / 254;
771 resX
= int(resX
* INCHES_IN_METER
);
772 resY
= int(resY
* INCHES_IN_METER
);
776 case wxIMAGE_RESOLUTION_CM
:
781 case wxIMAGE_RESOLUTION_NONE
:
785 wxFAIL_MSG( wxT("unsupported image resolution units") );
789 png_set_pHYs( png_ptr
, info_ptr
, resX
, resY
, PNG_RESOLUTION_METER
);
791 png_set_sBIT( png_ptr
, info_ptr
, &sig_bit
);
792 png_write_info( png_ptr
, info_ptr
);
793 png_set_shift( png_ptr
, &sig_bit
);
794 png_set_packing( png_ptr
);
797 data
= (unsigned char *)malloc( image
->GetWidth() * iElements
);
800 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
805 pAlpha
= (unsigned char *)(bHasAlpha
? image
->GetAlpha() : NULL
);
806 int iHeight
= image
->GetHeight();
807 int iWidth
= image
->GetWidth();
809 unsigned char uchMaskRed
= 0, uchMaskGreen
= 0, uchMaskBlue
= 0;
813 uchMaskRed
= image
->GetMaskRed();
814 uchMaskGreen
= image
->GetMaskGreen();
815 uchMaskBlue
= image
->GetMaskBlue();
818 unsigned char *pColors
= image
->GetData();
820 for (int y
= 0; y
!= iHeight
; ++y
)
822 unsigned char *pData
= data
;
823 for (int x
= 0; x
!= iWidth
; x
++)
825 unsigned char uchRed
= *pColors
++;
826 unsigned char uchGreen
= *pColors
++;
827 unsigned char uchBlue
= *pColors
++;
829 switch ( iColorType
)
832 wxFAIL_MSG( wxT("unknown wxPNG_TYPE_XXX") );
835 case wxPNG_TYPE_COLOUR
:
837 if ( iBitDepth
== 16 )
840 if ( iBitDepth
== 16 )
843 if ( iBitDepth
== 16 )
847 case wxPNG_TYPE_GREY
:
849 // where do these coefficients come from? maybe we
850 // should have image options for them as well?
852 (unsigned) (76.544*(unsigned)uchRed
+
853 150.272*(unsigned)uchGreen
+
854 36.864*(unsigned)uchBlue
);
856 *pData
++ = (unsigned char)((uiColor
>> 8) & 0xFF);
857 if ( iBitDepth
== 16 )
858 *pData
++ = (unsigned char)(uiColor
& 0xFF);
862 case wxPNG_TYPE_GREY_RED
:
864 if ( iBitDepth
== 16 )
871 unsigned char uchAlpha
= 255;
873 uchAlpha
= *pAlpha
++;
877 if ( (uchRed
== uchMaskRed
)
878 && (uchGreen
== uchMaskGreen
)
879 && (uchBlue
== uchMaskBlue
) )
884 if ( iBitDepth
== 16 )
889 png_bytep row_ptr
= data
;
890 png_write_rows( png_ptr
, &row_ptr
, 1 );
894 png_write_end( png_ptr
, info_ptr
);
895 png_destroy_write_struct( &png_ptr
, (png_infopp
)&info_ptr
);
901 #pragma warning(default:4611)
904 #endif // wxUSE_STREAMS
906 /*static*/ wxVersionInfo
wxPNGHandler::GetLibraryVersionInfo()
908 // The version string seems to always have a leading space and a trailing
909 // new line, get rid of them both.
910 wxString str
= png_get_header_version(NULL
) + 1;
911 str
.Replace("\n", "");
913 return wxVersionInfo("libpng",
914 PNG_LIBPNG_VER_MAJOR
,
915 PNG_LIBPNG_VER_MINOR
,
916 PNG_LIBPNG_VER_RELEASE
,
920 #endif // wxUSE_LIBPNG