1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/imagepng.cpp
3 // Purpose: wxImage PNG handler
4 // Author: Robert Roebling
6 // Copyright: (c) Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // ============================================================================
12 // ============================================================================
15 #pragma implementation "imagpng.h"
18 // ----------------------------------------------------------------------------
20 // ----------------------------------------------------------------------------
22 // For compilers that support precompilation, includes "wx.h".
23 #include "wx/wxprec.h"
33 #if wxUSE_IMAGE && wxUSE_LIBPNG
35 #include "wx/imagpng.h"
36 #include "wx/bitmap.h"
41 #include "wx/filefn.h"
42 #include "wx/wfstream.h"
44 #include "wx/module.h"
55 // ----------------------------------------------------------------------------
57 // ----------------------------------------------------------------------------
59 // image can not have any transparent pixels at all, have only 100% opaque
60 // and/or 100% transparent pixels in which case a simple mask is enough to
61 // store this information in wxImage or have a real alpha channel in which case
62 // we need to have it in wxImage as well
70 // ----------------------------------------------------------------------------
72 // ----------------------------------------------------------------------------
74 // return the kind of transparency needed for this image assuming that it does
75 // have transparent pixels, i.e. either Transparency_Alpha or Transparency_Mask
77 CheckTransparency(unsigned char **lines
,
78 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
81 // init the alpha channel for the image and fill it with 1s up to (x, y)
82 static unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
);
84 // find a free colour for the mask in the PNG data array
86 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
87 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
);
89 // is the pixel with this value of alpha a fully opaque one?
91 bool IsOpaque(unsigned char a
)
96 // is the pixel with this value of alpha a fully transparent one?
98 bool IsTransparent(unsigned char a
)
103 // ============================================================================
104 // wxPNGHandler implementation
105 // ============================================================================
107 IMPLEMENT_DYNAMIC_CLASS(wxPNGHandler
,wxImageHandler
)
111 #ifndef PNGLINKAGEMODE
113 // we need an explicit cdecl for Watcom, at least according to
115 // http://sf.net/tracker/index.php?func=detail&aid=651492&group_id=9863&atid=109863
117 // more testing is needed for this however, please remove this comment
118 // if you can confirm that my fix works with Watcom 11
119 #define PNGLINKAGEMODE cdecl
121 #define PNGLINKAGEMODE LINKAGEMODE
126 // VS: wxPNGInfoStruct declared below is a hack that needs some explanation.
127 // First, let me describe what's the problem: libpng uses jmp_buf in
128 // its png_struct structure. Unfortunately, this structure is
129 // compiler-specific and may vary in size, so if you use libpng compiled
130 // as DLL with another compiler than the main executable, it may not work
131 // (this is for example the case with wxMGL port and SciTech MGL library
132 // that provides custom runtime-loadable libpng implementation with jmpbuf
133 // disabled altogether). Luckily, it is still possible to use setjmp() &
134 // longjmp() as long as the structure is not part of png_struct.
136 // Sadly, there's no clean way to attach user-defined data to png_struct.
137 // There is only one customizable place, png_struct.io_ptr, which is meant
138 // only for I/O routines and is set with png_set_read_fn or
139 // png_set_write_fn. The hacky part is that we use io_ptr to store
140 // a pointer to wxPNGInfoStruct that holds I/O structures _and_ jmp_buf.
142 struct wxPNGInfoStruct
154 #define WX_PNG_INFO(png_ptr) ((wxPNGInfoStruct*)png_get_io_ptr(png_ptr))
156 // ----------------------------------------------------------------------------
158 // ----------------------------------------------------------------------------
163 void PNGLINKAGEMODE
_PNG_stream_reader( png_structp png_ptr
, png_bytep data
, png_size_t length
)
165 WX_PNG_INFO(png_ptr
)->stream
.in
->Read(data
, length
);
168 void PNGLINKAGEMODE
_PNG_stream_writer( png_structp png_ptr
, png_bytep data
, png_size_t length
)
170 WX_PNG_INFO(png_ptr
)->stream
.out
->Write(data
, length
);
174 // so that the libpng doesn't send anything on stderr
176 PNGLINKAGEMODE
wx_png_error(png_structp png_ptr
, png_const_charp message
)
178 wxPNGInfoStruct
*info
= WX_PNG_INFO(png_ptr
);
180 wxLogError( wxString::FromAscii(message
) );
182 #ifdef USE_FAR_KEYWORD
185 png_memcpy(jmpbuf
,info
->jmpbuf
,sizeof(jmp_buf));
189 longjmp(info
->jmpbuf
, 1);
194 PNGLINKAGEMODE
wx_png_warning(png_structp png_ptr
, png_const_charp message
)
196 wxPNGInfoStruct
*info
= WX_PNG_INFO(png_ptr
);
198 wxLogWarning( wxString::FromAscii(message
) );
203 // ----------------------------------------------------------------------------
204 // LoadFile() helpers
205 // ----------------------------------------------------------------------------
207 // determine the kind of transparency we need for this image: if the only alpha
208 // values it has are 0 (transparent) and 0xff (opaque) then we can simply
209 // create a mask for it, we should be ok with a simple mask but otherwise we
210 // need a full blown alpha channel in wxImage
213 // lines raw PNG data
214 // x, y starting position
215 // w, h size of the image
216 // numColBytes number of colour bytes (1 for grey scale, 3 for RGB)
217 // (NB: alpha always follows the colour bytes)
219 CheckTransparency(unsigned char **lines
,
220 png_uint_32 x
, png_uint_32 y
, png_uint_32 w
, png_uint_32 h
,
223 // we start from (x + 1, y)
226 // suppose that a mask will suffice and check all the remaining alpha
227 // values to see if it does
230 unsigned const char *ptr
= lines
[y
] + x
;
232 for ( png_uint_32 x2
= x
; x2
< w
; x2
++ )
234 // skip the grey or colour byte(s)
237 unsigned char a2
= *ptr
++;
239 if ( !IsTransparent(a2
) && !IsOpaque(a2
) )
241 // not fully opaque nor fully transparent, hence need alpha
242 return Transparency_Alpha
;
246 // during the next loop iteration check all the pixels in the row
250 // mask will be enough
251 return Transparency_Mask
;
254 unsigned char *InitAlpha(wxImage
*image
, png_uint_32 x
, png_uint_32 y
)
256 // create alpha channel
259 unsigned char *alpha
= image
->GetAlpha();
261 // set alpha for the pixels we had so far
262 png_uint_32 end
= y
* image
->GetWidth() + x
;
263 for ( png_uint_32 i
= 0; i
< end
; i
++ )
265 // all the previous pixels were opaque
273 FindMaskColour(unsigned char **lines
, png_uint_32 width
, png_uint_32 height
,
274 unsigned char& rMask
, unsigned char& gMask
, unsigned char& bMask
)
276 // choosing the colour for the mask is more
277 // difficult: we need to iterate over the entire
278 // image for this in order to choose an unused
279 // colour (this is not very efficient but what else
282 unsigned nentries
= 0;
283 unsigned char r2
, g2
, b2
;
284 for ( png_uint_32 y2
= 0; y2
< height
; y2
++ )
286 const unsigned char *p
= lines
[y2
];
287 for ( png_uint_32 x2
= 0; x2
< width
; x2
++ )
293 wxImageHistogramEntry
&
294 entry
= h
[wxImageHistogram:: MakeKey(r2
, g2
, b2
)];
296 if ( entry
.value
++ == 0 )
297 entry
.index
= nentries
++;
301 if ( !h
.FindFirstUnusedColour(&rMask
, &gMask
, &bMask
) )
303 wxLogWarning(_("Too many colours in PNG, the image may be slightly blurred."));
305 // use a fixed mask colour and we'll fudge
306 // the real pixels with this colour (see
314 // ----------------------------------------------------------------------------
316 // ----------------------------------------------------------------------------
318 bool wxPNGHandler::DoCanRead( wxInputStream
& stream
)
320 unsigned char hdr
[4];
322 if ( !stream
.Read(hdr
, WXSIZEOF(hdr
)) )
325 return memcmp(hdr
, "\211PNG", WXSIZEOF(hdr
)) == 0;
328 // convert data from RGB to wxImage format
330 void CopyDataFromPNG(wxImage
*image
,
331 unsigned char **lines
,
336 Transparency transparency
= Transparency_None
;
338 // only non NULL if transparency == Transparency_Alpha
339 unsigned char *alpha
= NULL
;
341 // RGB of the mask colour if transparency == Transparency_Mask
342 // (but init them anyhow to avoid compiler warnings)
343 unsigned char rMask
= 0,
347 unsigned char *ptrDst
= image
->GetData();
348 if ( !(color_type
& PNG_COLOR_MASK_COLOR
) )
350 // grey image: GAGAGA... where G == grey component and A == alpha
351 for ( png_uint_32 y
= 0; y
< height
; y
++ )
353 const unsigned char *ptrSrc
= lines
[y
];
354 for ( png_uint_32 x
= 0; x
< width
; x
++ )
356 unsigned char g
= *ptrSrc
++;
357 unsigned char a
= *ptrSrc
++;
359 // the first time we encounter a transparent pixel we must
360 // decide about what to do about them
361 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
363 // we'll need at least the mask for this image and
364 // maybe even full alpha channel info: the former is
365 // only enough if we have alpha values of 0 and 0xff
366 // only, otherwisewe need the latter
367 transparency
= CheckTransparency
375 if ( transparency
== Transparency_Mask
)
377 // let's choose this colour for the mask: this is
378 // not a problem here as all the other pixels are
379 // grey, i.e. R == G == B which is not the case for
380 // this one so no confusion is possible
385 else // transparency == Transparency_Alpha
387 alpha
= InitAlpha(image
, x
, y
);
391 switch ( transparency
)
393 case Transparency_Mask
:
394 if ( IsTransparent(a
) )
401 // else: !transparent
403 // must be opaque then as otherwise we shouldn't be
404 // using the mask at all
405 wxASSERT_MSG( IsOpaque(a
), _T("logic error") );
409 case Transparency_Alpha
:
414 case Transparency_None
:
423 else // colour image: RGBRGB...
425 for ( png_uint_32 y
= 0; y
< height
; y
++ )
427 const unsigned char *ptrSrc
= lines
[y
];
428 for ( png_uint_32 x
= 0; x
< width
; x
++ )
430 unsigned char r
= *ptrSrc
++;
431 unsigned char g
= *ptrSrc
++;
432 unsigned char b
= *ptrSrc
++;
433 unsigned char a
= *ptrSrc
++;
435 // the logic here is the same as for the grey case except
437 if ( !IsOpaque(a
) && transparency
== Transparency_None
)
439 transparency
= CheckTransparency
447 if ( transparency
== Transparency_Mask
)
449 FindMaskColour(lines
, width
, height
,
450 rMask
, gMask
, bMask
);
452 else // transparency == Transparency_Alpha
454 alpha
= InitAlpha(image
, x
, y
);
459 switch ( transparency
)
461 case Transparency_Mask
:
462 if ( IsTransparent(a
) )
464 // if we couldn't find a unique colour for the mask, we
465 // can have real pixels with the same value as the mask
466 // and it's better to slightly change their colour than
467 // to make them transparent
468 if ( r
== rMask
&& g
== gMask
&& b
== bMask
)
478 // else: !transparent
480 // must be opaque then as otherwise we shouldn't be
481 // using the mask at all
482 wxASSERT_MSG( IsOpaque(a
), _T("logic error") );
486 case Transparency_Alpha
:
491 case Transparency_None
:
501 if ( transparency
== Transparency_Mask
)
503 image
->SetMaskColour(rMask
, gMask
, bMask
);
507 // temporarily disable the warning C4611 (interaction between '_setjmp' and
508 // C++ object destruction is non-portable) - I don't see any dtors here
510 #pragma warning(disable:4611)
514 wxPNGHandler::LoadFile(wxImage
*image
,
515 wxInputStream
& stream
,
519 // VZ: as this function uses setjmp() the only fool proof error handling
520 // method is to use goto (setjmp is not really C++ dtors friendly...)
522 unsigned char **lines
= NULL
;
523 png_infop info_ptr
= (png_infop
) NULL
;
524 wxPNGInfoStruct wxinfo
;
526 wxinfo
.verbose
= verbose
;
527 wxinfo
.stream
.in
= &stream
;
531 png_structp png_ptr
= png_create_read_struct( PNG_LIBPNG_VER_STRING
,
533 (png_error_ptr
) NULL
,
534 (png_error_ptr
) NULL
);
538 png_set_error_fn(png_ptr
, (png_voidp
)NULL
, wx_png_error
, wx_png_warning
);
540 // NB: please see the comment near wxPNGInfoStruct declaration for
541 // explanation why this line is mandatory
542 png_set_read_fn( png_ptr
, &wxinfo
, _PNG_stream_reader
);
544 info_ptr
= png_create_info_struct( png_ptr
);
548 if (setjmp(wxinfo
.jmpbuf
))
551 png_uint_32 i
, width
, height
;
552 int bit_depth
, color_type
, interlace_type
;
554 png_read_info( png_ptr
, info_ptr
);
555 png_get_IHDR( png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
, &interlace_type
, (int*) NULL
, (int*) NULL
);
557 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
558 png_set_expand( png_ptr
);
560 // Fix for Bug [ 439207 ] Monochrome PNG images come up black
562 png_set_expand( png_ptr
);
564 png_set_strip_16( png_ptr
);
565 png_set_packing( png_ptr
);
566 if (png_get_valid( png_ptr
, info_ptr
, PNG_INFO_tRNS
))
567 png_set_expand( png_ptr
);
568 png_set_filler( png_ptr
, 0xff, PNG_FILLER_AFTER
);
570 image
->Create( (int)width
, (int)height
);
575 lines
= (unsigned char **)malloc( (size_t)(height
* sizeof(unsigned char *)) );
579 for (i
= 0; i
< height
; i
++)
581 if ((lines
[i
] = (unsigned char *)malloc( (size_t)(width
* (sizeof(unsigned char) * 4)))) == NULL
)
583 for ( unsigned int n
= 0; n
< i
; n
++ )
589 png_read_image( png_ptr
, lines
);
590 png_read_end( png_ptr
, info_ptr
);
591 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
593 // loaded successfully, now init wxImage with this data
594 CopyDataFromPNG(image
, lines
, width
, height
, color_type
);
596 for ( i
= 0; i
< height
; i
++ )
604 wxLogError(_("Couldn't load a PNG image - file is corrupted or not enough memory."));
620 png_destroy_read_struct( &png_ptr
, &info_ptr
, (png_infopp
) NULL
);
624 png_destroy_read_struct( &png_ptr
, (png_infopp
) NULL
, (png_infopp
) NULL
);
629 // ----------------------------------------------------------------------------
631 // ----------------------------------------------------------------------------
633 bool wxPNGHandler::SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
)
635 wxPNGInfoStruct wxinfo
;
637 wxinfo
.verbose
= verbose
;
638 wxinfo
.stream
.out
= &stream
;
640 png_structp png_ptr
= png_create_write_struct( PNG_LIBPNG_VER_STRING
, NULL
, NULL
, NULL
);
644 wxLogError(_("Couldn't save PNG image."));
648 png_set_error_fn(png_ptr
, (png_voidp
)NULL
, wx_png_error
, wx_png_warning
);
650 png_infop info_ptr
= png_create_info_struct(png_ptr
);
651 if (info_ptr
== NULL
)
653 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
655 wxLogError(_("Couldn't save PNG image."));
659 if (setjmp(wxinfo
.jmpbuf
))
661 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
663 wxLogError(_("Couldn't save PNG image."));
667 // NB: please see the comment near wxPNGInfoStruct declaration for
668 // explanation why this line is mandatory
669 png_set_write_fn( png_ptr
, &wxinfo
, _PNG_stream_writer
, NULL
);
671 png_set_IHDR( png_ptr
, info_ptr
, image
->GetWidth(), image
->GetHeight(), 8,
672 PNG_COLOR_TYPE_RGB_ALPHA
, PNG_INTERLACE_NONE
,
673 PNG_COMPRESSION_TYPE_BASE
, PNG_FILTER_TYPE_BASE
);
680 png_set_sBIT( png_ptr
, info_ptr
, &sig_bit
);
681 png_write_info( png_ptr
, info_ptr
);
682 png_set_shift( png_ptr
, &sig_bit
);
683 png_set_packing( png_ptr
);
685 unsigned char *data
= (unsigned char *)malloc( image
->GetWidth()*4 );
688 png_destroy_write_struct( &png_ptr
, (png_infopp
)NULL
);
692 for (int y
= 0; y
< image
->GetHeight(); y
++)
694 unsigned char *ptr
= image
->GetData() + (y
* image
->GetWidth() * 3);
695 for (int x
= 0; x
< image
->GetWidth(); x
++)
697 data
[(x
<< 2) + 0] = *ptr
++;
698 data
[(x
<< 2) + 1] = *ptr
++;
699 data
[(x
<< 2) + 2] = *ptr
++;
700 if (( !image
->HasMask() ) || \
701 (data
[(x
<< 2) + 0] != image
->GetMaskRed()) || \
702 (data
[(x
<< 2) + 1] != image
->GetMaskGreen()) || \
703 (data
[(x
<< 2) + 2] != image
->GetMaskBlue()))
705 data
[(x
<< 2) + 3] = 255;
709 data
[(x
<< 2) + 3] = 0;
712 png_bytep row_ptr
= data
;
713 png_write_rows( png_ptr
, &row_ptr
, 1 );
717 png_write_end( png_ptr
, info_ptr
);
718 png_destroy_write_struct( &png_ptr
, (png_infopp
)&info_ptr
);
724 #pragma warning(default:4611)
727 #endif // wxUSE_STREAMS
729 #endif // wxUSE_LIBPNG