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"
32 #include "wx/palette.h"
33 #include "wx/stream.h"
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 // image can not have any transparent pixels at all, have only 100% opaque
46 // and/or 100% transparent pixels in which case a simple mask is enough to
47 // store this information in wxImage or have a real alpha channel in which case
48 // we need to have it in wxImage as well
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 // return the kind of transparency needed for this image assuming that it does
61 // have transparent pixels, i.e. either Transparency_Alpha or Transparency_Mask
63 CheckTransparency(unsigned char **lines
,
64 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
67 // init the alpha channel for the image and fill it with 1s up to (x, y)
68 static unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
);
70 // find a free colour for the mask in the PNG data array
72 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
73 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
);
75 // is the pixel with this value of alpha a fully opaque one?
77 bool IsOpaque(unsigned char a
)
82 // is the pixel with this value of alpha a fully transparent one?
84 bool IsTransparent(unsigned char a
)
89 // ============================================================================
90 // wxPNGHandler implementation
91 // ============================================================================
93 IMPLEMENT_DYNAMIC_CLASS(wxPNGHandler
,wxImageHandler
)
97 #ifndef PNGLINKAGEMODE
99 #define PNGLINKAGEMODE PNGAPI
100 #elif defined(__WATCOMC__)
101 // we need an explicit cdecl for Watcom, at least according to
103 // http://sf.net/tracker/index.php?func=detail&aid=651492&group_id=9863&atid=109863
105 // more testing is needed for this however, please remove this comment
106 // if you can confirm that my fix works with Watcom 11
107 #define PNGLINKAGEMODE cdecl
109 #define PNGLINKAGEMODE LINKAGEMODE
114 // VS: wxPNGInfoStruct declared below is a hack that needs some explanation.
115 // First, let me describe what's the problem: libpng uses jmp_buf in
116 // its png_struct structure. Unfortunately, this structure is
117 // compiler-specific and may vary in size, so if you use libpng compiled
118 // as DLL with another compiler than the main executable, it may not work
119 // (this is for example the case with wxMGL port and SciTech MGL library
120 // that provides custom runtime-loadable libpng implementation with jmpbuf
121 // disabled altogether). Luckily, it is still possible to use setjmp() &
122 // longjmp() as long as the structure is not part of png_struct.
124 // Sadly, there's no clean way to attach user-defined data to png_struct.
125 // There is only one customizable place, png_struct.io_ptr, which is meant
126 // only for I/O routines and is set with png_set_read_fn or
127 // png_set_write_fn. The hacky part is that we use io_ptr to store
128 // a pointer to wxPNGInfoStruct that holds I/O structures _and_ jmp_buf.
130 struct wxPNGInfoStruct
142 #define WX_PNG_INFO(png_ptr) ((wxPNGInfoStruct*)png_get_io_ptr(png_ptr))
144 // ----------------------------------------------------------------------------
146 // ----------------------------------------------------------------------------
151 static void PNGLINKAGEMODE
wx_PNG_stream_reader( png_structp png_ptr
, png_bytep data
,
154 WX_PNG_INFO(png_ptr
)->stream
.in
->Read(data
, length
);
157 static void PNGLINKAGEMODE
wx_PNG_stream_writer( png_structp png_ptr
, png_bytep data
,
160 WX_PNG_INFO(png_ptr
)->stream
.out
->Write(data
, length
);
164 PNGLINKAGEMODE
wx_png_warning(png_structp png_ptr
, png_const_charp message
)
166 wxPNGInfoStruct
*info
= png_ptr
? WX_PNG_INFO(png_ptr
) : NULL
;
167 if ( !info
|| info
->verbose
)
168 wxLogWarning( wxString::FromAscii(message
) );
172 // so that the libpng doesn't send anything on stderr
174 PNGLINKAGEMODE
wx_png_error(png_structp png_ptr
, png_const_charp message
)
176 wx_png_warning(NULL
, message
);
178 // we're not using libpng built-in jump buffer (see comment before
179 // wxPNGInfoStruct above) so we have to return ourselves, otherwise libpng
181 longjmp(WX_PNG_INFO(png_ptr
)->jmpbuf
, 1);
186 // ----------------------------------------------------------------------------
187 // LoadFile() helpers
188 // ----------------------------------------------------------------------------
190 // determine the kind of transparency we need for this image: if the only alpha
191 // values it has are 0 (transparent) and 0xff (opaque) then we can simply
192 // create a mask for it, we should be ok with a simple mask but otherwise we
193 // need a full blown alpha channel in wxImage
196 // lines raw PNG data
197 // x, y starting position
198 // w, h size of the image
199 // numColBytes number of colour bytes (1 for grey scale, 3 for RGB)
200 // (NB: alpha always follows the colour bytes)
202 CheckTransparency(unsigned char **lines
,
203 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
206 // suppose that a mask will suffice and check all the remaining alpha
207 // values to see if it does
210 // each pixel is numColBytes+1 bytes, offset into the current line by
211 // the current x position
212 unsigned const char *ptr
= lines
[y
] + (x
* (numColBytes
+ 1));
214 for ( png_uint_32 x2
= x
; x2
< w
; x2
++ )
216 // skip the grey or colour byte(s)
219 unsigned char a2
= *ptr
++;
221 if ( !IsTransparent(a2
) && !IsOpaque(a2
) )
223 // not fully opaque nor fully transparent, hence need alpha
224 return Transparency_Alpha
;
228 // during the next loop iteration check all the pixels in the row
232 // mask will be enough
233 return Transparency_Mask
;
236 unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
)
238 // create alpha channel
241 unsigned char *alpha
= image
->GetAlpha();
243 // set alpha for the pixels we had so far
244 png_uint_32 end
= y
* image
->GetWidth() + x
;
245 for ( png_uint_32 i
= 0; i
< end
; i
++ )
247 // all the previous pixels were opaque
255 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
256 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
)
258 // choosing the colour for the mask is more
259 // difficult: we need to iterate over the entire
260 // image for this in order to choose an unused
261 // colour (this is not very efficient but what else
264 unsigned nentries
= 0;
265 unsigned char r2
, g2
, b2
;
266 for ( png_uint_32 y2
= 0; y2
< height
; y2
++ )
268 const unsigned char *p
= lines
[y2
];
269 for ( png_uint_32 x2
= 0; x2
< width
; x2
++ )
274 ++p
; // jump over alpha
276 wxImageHistogramEntry
&
277 entry
= h
[wxImageHistogram:: MakeKey(r2
, g2
, b2
)];
279 if ( entry
.value
++ == 0 )
280 entry
.index
= nentries
++;
284 if ( !h
.FindFirstUnusedColour(&rMask
, &gMask
, &bMask
) )
286 wxLogWarning(_("Too many colours in PNG, the image may be slightly blurred."));
288 // use a fixed mask colour and we'll fudge
289 // the real pixels with this colour (see
297 // ----------------------------------------------------------------------------
299 // ----------------------------------------------------------------------------
301 bool wxPNGHandler::DoCanRead( wxInputStream
& stream
)
303 unsigned char hdr
[4];
305 if ( !stream
.Read(hdr
, WXSIZEOF(hdr
)) ) // it's ok to modify the stream position here
308 return memcmp(hdr
, "\211PNG", WXSIZEOF(hdr
)) == 0;
311 // convert data from RGB to wxImage format
313 void CopyDataFromPNG(wxImage
*image
,
314 unsigned char **lines
,
319 Transparency transparency
= Transparency_None
;
321 // only non NULL if transparency == Transparency_Alpha
322 unsigned char *alpha
= NULL
;
324 // RGB of the mask colour if transparency == Transparency_Mask
325 // (but init them anyhow to avoid compiler warnings)
326 unsigned char rMask
= 0,
330 unsigned char *ptrDst
= image
->GetData();
331 if ( !(color_type
& PNG_COLOR_MASK_COLOR
) )
333 // grey image: GAGAGA... where G == grey component and A == alpha
334 for ( png_uint_32 y
= 0; y
< height
; y
++ )
336 const unsigned char *ptrSrc
= lines
[y
];
337 for ( png_uint_32 x
= 0; x
< width
; x
++ )
339 unsigned char g
= *ptrSrc
++;
340 unsigned char a
= *ptrSrc
++;
342 // the first time we encounter a transparent pixel we must
343 // decide about what to do about them
344 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
346 // we'll need at least the mask for this image and
347 // maybe even full alpha channel info: the former is
348 // only enough if we have alpha values of 0 and 0xff
349 // only, otherwisewe need the latter
350 transparency
= CheckTransparency
358 if ( transparency
== Transparency_Mask
)
360 // let's choose this colour for the mask: this is
361 // not a problem here as all the other pixels are
362 // grey, i.e. R == G == B which is not the case for
363 // this one so no confusion is possible
368 else // transparency == Transparency_Alpha
370 alpha
= InitAlpha(image
, x
, y
);
374 switch ( transparency
)
376 case Transparency_Mask
:
377 if ( IsTransparent(a
) )
384 // else: !transparent
386 // must be opaque then as otherwise we shouldn't be
387 // using the mask at all
388 wxASSERT_MSG( IsOpaque(a
), _T("logic error") );
392 case Transparency_Alpha
:
397 case Transparency_None
:
406 else // colour image: RGBRGB...
408 for ( png_uint_32 y
= 0; y
< height
; y
++ )
410 const unsigned char *ptrSrc
= lines
[y
];
411 for ( png_uint_32 x
= 0; x
< width
; x
++ )
413 unsigned char r
= *ptrSrc
++;
414 unsigned char g
= *ptrSrc
++;
415 unsigned char b
= *ptrSrc
++;
416 unsigned char a
= *ptrSrc
++;
418 // the logic here is the same as for the grey case except
420 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
422 transparency
= CheckTransparency
430 if ( transparency
== Transparency_Mask
)
432 FindMaskColour(lines
, width
, height
,
433 rMask
, gMask
, bMask
);
435 else // transparency == Transparency_Alpha
437 alpha
= InitAlpha(image
, x
, y
);
442 switch ( transparency
)
444 case Transparency_Mask
:
445 if ( IsTransparent(a
) )
454 // must be opaque then as otherwise we shouldn't be
455 // using the mask at all
456 wxASSERT_MSG( IsOpaque(a
), _T("logic error") );
458 // if we couldn't find a unique colour for the
459 // mask, we can have real pixels with the same
460 // value as the mask and it's better to slightly
461 // change their colour than to make them
463 if ( r
== rMask
&& g
== gMask
&& b
== bMask
)
471 case Transparency_Alpha
:
476 case Transparency_None
:
486 if ( transparency
== Transparency_Mask
)
488 image
->SetMaskColour(rMask
, gMask
, bMask
);
492 // temporarily disable the warning C4611 (interaction between '_setjmp' and
493 // C++ object destruction is non-portable) - I don't see any dtors here
495 #pragma warning(disable:4611)
499 wxPNGHandler::LoadFile(wxImage
*image
,
500 wxInputStream
& stream
,
504 // VZ: as this function uses setjmp() the only fool-proof error handling
505 // method is to use goto (setjmp is not really C++ dtors friendly...)
507 unsigned char **lines
= NULL
;
508 png_infop info_ptr
= (png_infop
) NULL
;
509 wxPNGInfoStruct wxinfo
;
511 png_uint_32 i
, width
, height
= 0;
512 int bit_depth
, color_type
, interlace_type
;
514 wxinfo
.verbose
= verbose
;
515 wxinfo
.stream
.in
= &stream
;
519 png_structp png_ptr
= png_create_read_struct
521 PNG_LIBPNG_VER_STRING
,
529 // NB: please see the comment near wxPNGInfoStruct declaration for
530 // explanation why this line is mandatory
531 png_set_read_fn( png_ptr
, &wxinfo
, wx_PNG_stream_reader
);
533 info_ptr
= png_create_info_struct( png_ptr
);
537 if (setjmp(wxinfo
.jmpbuf
))
540 png_read_info( png_ptr
, info_ptr
);
541 png_get_IHDR( png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
, &interlace_type
, NULL
, NULL
);
543 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
544 png_set_expand( png_ptr
);
546 // Fix for Bug [ 439207 ] Monochrome PNG images come up black
548 png_set_expand( png_ptr
);
550 png_set_strip_16( png_ptr
);
551 png_set_packing( png_ptr
);
552 if (png_get_valid( png_ptr
, info_ptr
, PNG_INFO_tRNS
))
553 png_set_expand( png_ptr
);
554 png_set_filler( png_ptr
, 0xff, PNG_FILLER_AFTER
);
556 image
->Create((int)width
, (int)height
, (bool) false /* no need to init pixels */);
561 // initialize all line pointers to NULL to ensure that they can be safely
562 // free()d if an error occurs before all of them could be allocated
563 lines
= (unsigned char **)calloc(height
, sizeof(unsigned char *));
567 for (i
= 0; i
< height
; i
++)
569 if ((lines
[i
] = (unsigned char *)malloc( (size_t)(width
* (sizeof(unsigned char) * 4)))) == NULL
)
573 png_read_image( png_ptr
, lines
);
574 png_read_end( png_ptr
, info_ptr
);
577 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
579 const size_t ncolors
= info_ptr
->num_palette
;
580 unsigned char* r
= new unsigned char[ncolors
];
581 unsigned char* g
= new unsigned char[ncolors
];
582 unsigned char* b
= new unsigned char[ncolors
];
584 for (size_t j
= 0; j
< ncolors
; j
++)
586 r
[j
] = info_ptr
->palette
[j
].red
;
587 g
[j
] = info_ptr
->palette
[j
].green
;
588 b
[j
] = info_ptr
->palette
[j
].blue
;
591 image
->SetPalette(wxPalette(ncolors
, r
, g
, b
));
596 #endif // wxUSE_PALETTE
598 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
600 // loaded successfully, now init wxImage with this data
601 CopyDataFromPNG(image
, lines
, width
, height
, color_type
);
603 for ( i
= 0; i
< height
; i
++ )
611 wxLogError(_("Couldn't load a PNG image - file is corrupted or not enough memory."));
620 for ( unsigned int n
= 0; n
< height
; n
++ )
630 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
634 png_destroy_read_struct( &png_ptr
, (png_infopp
) NULL
, (png_infopp
) NULL
);
639 // ----------------------------------------------------------------------------
641 // ----------------------------------------------------------------------------
643 bool wxPNGHandler::SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
)
645 wxPNGInfoStruct wxinfo
;
647 wxinfo
.verbose
= verbose
;
648 wxinfo
.stream
.out
= &stream
;
650 png_structp png_ptr
= png_create_write_struct
652 PNG_LIBPNG_VER_STRING
,
660 wxLogError(_("Couldn't save PNG image."));
664 png_infop info_ptr
= png_create_info_struct(png_ptr
);
665 if (info_ptr
== NULL
)
667 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
669 wxLogError(_("Couldn't save PNG image."));
673 if (setjmp(wxinfo
.jmpbuf
))
675 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
677 wxLogError(_("Couldn't save PNG image."));
681 // NB: please see the comment near wxPNGInfoStruct declaration for
682 // explanation why this line is mandatory
683 png_set_write_fn( png_ptr
, &wxinfo
, wx_PNG_stream_writer
, NULL
);
685 const int iColorType
= image
->HasOption(wxIMAGE_OPTION_PNG_FORMAT
)
686 ? image
->GetOptionInt(wxIMAGE_OPTION_PNG_FORMAT
)
688 const int iBitDepth
= image
->HasOption(wxIMAGE_OPTION_PNG_BITDEPTH
)
689 ? image
->GetOptionInt(wxIMAGE_OPTION_PNG_BITDEPTH
)
692 bool bHasAlpha
= image
->HasAlpha();
693 bool bHasMask
= image
->HasMask();
694 bool bUseAlpha
= bHasAlpha
|| bHasMask
;
697 if ( iColorType
==wxPNG_TYPE_COLOUR
)
699 iPngColorType
= bUseAlpha
? PNG_COLOR_TYPE_RGB_ALPHA
700 : PNG_COLOR_TYPE_RGB
;
704 iPngColorType
= bUseAlpha
? PNG_COLOR_TYPE_GRAY_ALPHA
705 : PNG_COLOR_TYPE_GRAY
;
708 if (image
->HasOption(wxIMAGE_OPTION_PNG_FILTER
))
709 png_set_filter( png_ptr
, PNG_FILTER_TYPE_BASE
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_FILTER
) );
711 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL
))
712 png_set_compression_level( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL
) );
714 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL
))
715 png_set_compression_mem_level( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL
) );
717 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY
))
718 png_set_compression_strategy( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY
) );
720 if (image
->HasOption(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE
))
721 png_set_compression_buffer_size( png_ptr
, image
->GetOptionInt(wxIMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE
) );
723 png_set_IHDR( png_ptr
, info_ptr
, image
->GetWidth(), image
->GetHeight(),
724 iBitDepth
, iPngColorType
,
725 PNG_INTERLACE_NONE
, PNG_COMPRESSION_TYPE_BASE
,
726 PNG_FILTER_TYPE_BASE
);
731 if ( iPngColorType
& PNG_COLOR_MASK_COLOR
)
735 sig_bit
.blue
= (png_byte
)iBitDepth
;
740 sig_bit
.gray
= (png_byte
)iBitDepth
;
744 if ( iPngColorType
& PNG_COLOR_MASK_ALPHA
)
746 sig_bit
.alpha
= (png_byte
)iBitDepth
;
750 if ( iBitDepth
== 16 )
753 // save the image resolution if we have it
755 switch ( GetResolutionFromOptions(*image
, &resX
, &resY
) )
757 case wxIMAGE_RESOLUTION_INCHES
:
759 const double INCHES_IN_METER
= 10000.0 / 254;
760 resX
= int(resX
* INCHES_IN_METER
);
761 resY
= int(resY
* INCHES_IN_METER
);
765 case wxIMAGE_RESOLUTION_CM
:
770 case wxIMAGE_RESOLUTION_NONE
:
774 wxFAIL_MSG( _T("unsupported image resolution units") );
778 png_set_pHYs( png_ptr
, info_ptr
, resX
, resY
, PNG_RESOLUTION_METER
);
780 png_set_sBIT( png_ptr
, info_ptr
, &sig_bit
);
781 png_write_info( png_ptr
, info_ptr
);
782 png_set_shift( png_ptr
, &sig_bit
);
783 png_set_packing( png_ptr
);
786 data
= (unsigned char *)malloc( image
->GetWidth() * iElements
);
789 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
794 pAlpha
= (unsigned char *)(bHasAlpha
? image
->GetAlpha() : NULL
);
795 int iHeight
= image
->GetHeight();
796 int iWidth
= image
->GetWidth();
798 unsigned char uchMaskRed
= 0, uchMaskGreen
= 0, uchMaskBlue
= 0;
802 uchMaskRed
= image
->GetMaskRed();
803 uchMaskGreen
= image
->GetMaskGreen();
804 uchMaskBlue
= image
->GetMaskBlue();
807 unsigned char *pColors
= image
->GetData();
809 for (int y
= 0; y
!= iHeight
; ++y
)
811 unsigned char *pData
= data
;
812 for (int x
= 0; x
!= iWidth
; x
++)
814 unsigned char uchRed
= *pColors
++;
815 unsigned char uchGreen
= *pColors
++;
816 unsigned char uchBlue
= *pColors
++;
818 switch ( iColorType
)
821 wxFAIL_MSG( _T("unknown wxPNG_TYPE_XXX") );
824 case wxPNG_TYPE_COLOUR
:
826 if ( iBitDepth
== 16 )
829 if ( iBitDepth
== 16 )
832 if ( iBitDepth
== 16 )
836 case wxPNG_TYPE_GREY
:
838 // where do these coefficients come from? maybe we
839 // should have image options for them as well?
841 (unsigned) (76.544*(unsigned)uchRed
+
842 150.272*(unsigned)uchGreen
+
843 36.864*(unsigned)uchBlue
);
845 *pData
++ = (unsigned char)((uiColor
>> 8) & 0xFF);
846 if ( iBitDepth
== 16 )
847 *pData
++ = (unsigned char)(uiColor
& 0xFF);
851 case wxPNG_TYPE_GREY_RED
:
853 if ( iBitDepth
== 16 )
860 unsigned char uchAlpha
= 255;
862 uchAlpha
= *pAlpha
++;
866 if ( (uchRed
== uchMaskRed
)
867 && (uchGreen
== uchMaskGreen
)
868 && (uchBlue
== uchMaskBlue
) )
873 if ( iBitDepth
== 16 )
878 png_bytep row_ptr
= data
;
879 png_write_rows( png_ptr
, &row_ptr
, 1 );
883 png_write_end( png_ptr
, info_ptr
);
884 png_destroy_write_struct( &png_ptr
, (png_infopp
)&info_ptr
);
890 #pragma warning(default:4611)
893 #endif // wxUSE_STREAMS
895 #endif // wxUSE_LIBPNG