1 .TH LIBPNG 3 "February 6, 2014"
3 libpng \- Portable Network Graphics (PNG) Reference Library 1.2.51
8 \fBpng_uint_32 png_access_version_number \fI(void\fP\fB);\fP
10 \fBint png_check_sig (png_bytep \fP\fIsig\fP\fB, int \fInum\fP\fB);\fP
12 \fBvoid png_chunk_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
14 \fBvoid png_chunk_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
16 \fBvoid png_convert_from_struct_tm (png_timep \fP\fIptime\fP\fB, struct tm FAR * \fIttime\fP\fB);\fP
18 \fBvoid png_convert_from_time_t (png_timep \fP\fIptime\fP\fB, time_t \fIttime\fP\fB);\fP
20 \fBpng_charp png_convert_to_rfc1123 (png_structp \fP\fIpng_ptr\fP\fB, png_timep \fIptime\fP\fB);\fP
22 \fBpng_infop png_create_info_struct (png_structp \fIpng_ptr\fP\fB);\fP
24 \fBpng_structp png_create_read_struct (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarn_fn\fP\fB);\fP
26 \fBpng_structp png_create_read_struct_2(png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fP\fIwarn_fn\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
28 \fBpng_structp png_create_write_struct (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarn_fn\fP\fB);\fP
30 \fBpng_structp png_create_write_struct_2(png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fP\fIwarn_fn\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
32 \fBint png_debug(int \fP\fIlevel\fP\fB, png_const_charp \fImessage\fP\fB);\fP
34 \fBint png_debug1(int \fP\fIlevel\fP\fB, png_const_charp \fP\fImessage\fP\fB, \fIp1\fP\fB);\fP
36 \fBint png_debug2(int \fP\fIlevel\fP\fB, png_const_charp \fP\fImessage\fP\fB, \fP\fIp1\fP\fB, \fIp2\fP\fB);\fP
38 \fBvoid png_destroy_info_struct (png_structp \fP\fIpng_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
40 \fBvoid png_destroy_read_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fP\fIinfo_ptr_ptr\fP\fB, png_infopp \fIend_info_ptr_ptr\fP\fB);\fP
42 \fBvoid png_destroy_write_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
44 \fBvoid png_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
46 \fBvoid png_free (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
48 \fBvoid png_free_chunk_list (png_structp \fIpng_ptr\fP\fB);\fP
50 \fBvoid png_free_default(png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
52 \fBvoid png_free_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fInum\fP\fB);\fP
54 \fBpng_byte png_get_bit_depth (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
56 \fBpng_uint_32 png_get_bKGD (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_16p \fI*background\fP\fB);\fP
58 \fBpng_byte png_get_channels (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
60 \fBpng_uint_32 png_get_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fP\fI*white_x\fP\fB, double \fP\fI*white_y\fP\fB, double \fP\fI*red_x\fP\fB, double \fP\fI*red_y\fP\fB, double \fP\fI*green_x\fP\fB, double \fP\fI*green_y\fP\fB, double \fP\fI*blue_x\fP\fB, double \fI*blue_y\fP\fB);\fP
62 \fBpng_uint_32 png_get_cHRM_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*white_x\fP\fB, png_uint_32 \fP\fI*white_y\fP\fB, png_uint_32 \fP\fI*red_x\fP\fB, png_uint_32 \fP\fI*red_y\fP\fB, png_uint_32 \fP\fI*green_x\fP\fB, png_uint_32 \fP\fI*green_y\fP\fB, png_uint_32 \fP\fI*blue_x\fP\fB, png_uint_32 \fI*blue_y\fP\fB);\fP
64 \fBpng_byte png_get_color_type (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
66 \fBpng_byte png_get_compression_type (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
68 \fBpng_byte png_get_copyright (png_structp \fIpng_ptr\fP\fB);\fP
70 \fBpng_voidp png_get_error_ptr (png_structp \fIpng_ptr\fP\fB);\fP
72 \fBpng_byte png_get_filter_type (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
74 \fBpng_uint_32 png_get_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fI*file_gamma\fP\fB);\fP
76 \fBpng_uint_32 png_get_gAMA_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fI*int_file_gamma\fP\fB);\fP
78 \fBpng_byte png_get_header_ver (png_structp \fIpng_ptr\fP\fB);\fP
80 \fBpng_byte png_get_header_version (png_structp \fIpng_ptr\fP\fB);\fP
82 \fBpng_uint_32 png_get_hIST (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_16p \fI*hist\fP\fB);\fP
84 \fBpng_uint_32 png_get_iCCP (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charpp \fP\fIname\fP\fB, int \fP\fI*compression_type\fP\fB, png_charpp \fP\fIprofile\fP\fB, png_uint_32 \fI*proflen\fP\fB);\fP
86 \fBpng_uint_32 png_get_IHDR (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*width\fP\fB, png_uint_32 \fP\fI*height\fP\fB, int \fP\fI*bit_depth\fP\fB, int \fP\fI*color_type\fP\fB, int \fP\fI*interlace_type\fP\fB, int \fP\fI*compression_type\fP\fB, int \fI*filter_type\fP\fB);\fP
88 \fBpng_uint_32 png_get_image_height (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
90 \fBpng_uint_32 png_get_image_width (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
92 \fB#if !defined(PNG_1_0_X) png_int_32 png_get_int_32 (png_bytep buf); \fI#endif
94 \fBpng_byte png_get_interlace_type (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
96 \fBpng_voidp png_get_io_ptr (png_structp \fIpng_ptr\fP\fB);\fP
98 \fBpng_byte png_get_libpng_ver (png_structp \fIpng_ptr\fP\fB);\fP
100 \fBpng_voidp png_get_mem_ptr(png_structp \fIpng_ptr\fP\fB);\fP
102 \fBpng_uint_32 png_get_oFFs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*offset_x\fP\fB, png_uint_32 \fP\fI*offset_y\fP\fB, int \fI*unit_type\fP\fB);\fP
104 \fBpng_uint_32 png_get_pCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fI*purpose\fP\fB, png_int_32 \fP\fI*X0\fP\fB, png_int_32 \fP\fI*X1\fP\fB, int \fP\fI*type\fP\fB, int \fP\fI*nparams\fP\fB, png_charp \fP\fI*units\fP\fB, png_charpp \fI*params\fP\fB);\fP
106 \fBpng_uint_32 png_get_pHYs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*res_x\fP\fB, png_uint_32 \fP\fI*res_y\fP\fB, int \fI*unit_type\fP\fB);\fP
108 \fBfloat png_get_pixel_aspect_ratio (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
110 \fBpng_uint_32 png_get_pixels_per_meter (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
112 \fBpng_voidp png_get_progressive_ptr (png_structp \fIpng_ptr\fP\fB);\fP
114 \fBpng_uint_32 png_get_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_colorp \fP\fI*palette\fP\fB, int \fI*num_palette\fP\fB);\fP
116 \fBpng_byte png_get_rgb_to_gray_status (png_structp png_ptr) png_uint_32 png_get_rowbytes (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
118 \fBpng_bytepp png_get_rows (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
120 \fBpng_uint_32 png_get_sBIT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_8p \fI*sig_bit\fP\fB);\fP
122 \fBpng_bytep png_get_signature (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
124 \fBpng_uint_32 png_get_sPLT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_spalette_p \fI*splt_ptr\fP\fB);\fP
126 \fBpng_uint_32 png_get_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fI*intent\fP\fB);\fP
128 \fBpng_uint_32 png_get_text (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_textp \fP\fI*text_ptr\fP\fB, int \fI*num_text\fP\fB);\fP
130 \fBpng_uint_32 png_get_tIME (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_timep \fI*mod_time\fP\fB);\fP
132 \fBpng_uint_32 png_get_tRNS (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fI*trans\fP\fB, int \fP\fI*num_trans\fP\fB, png_color_16p \fI*trans_values\fP\fB);\fP
134 \fB#if !defined(PNG_1_0_X) png_uint_16 png_get_uint_16 (png_bytep \fIbuf\fP\fB);\fP
136 \fBpng_uint_32 png_get_uint_31 (png_bytep \fIbuf\fP\fB);\fP
138 \fBpng_uint_32 png_get_uint_32 (png_bytep buf); \fI#endif
140 \fBpng_uint_32 png_get_unknown_chunks (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_unknown_chunkpp \fIunknowns\fP\fB);\fP
142 \fBpng_voidp png_get_user_chunk_ptr (png_structp \fIpng_ptr\fP\fB);\fP
144 \fBpng_uint_32 png_get_user_height_max( png_structp \fIpng_ptr\fP\fB);\fP
146 \fBpng_voidp png_get_user_transform_ptr (png_structp \fIpng_ptr\fP\fB);\fP
148 \fBpng_uint_32 png_get_user_width_max (png_structp \fIpng_ptr\fP\fB);\fP
150 \fBpng_uint_32 png_get_valid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fIflag\fP\fB);\fP
152 \fBpng_int_32 png_get_x_offset_microns (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
154 \fBpng_int_32 png_get_x_offset_pixels (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
156 \fBpng_uint_32 png_get_x_pixels_per_meter (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
158 \fBpng_int_32 png_get_y_offset_microns (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
160 \fBpng_int_32 png_get_y_offset_pixels (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
162 \fBpng_uint_32 png_get_y_pixels_per_meter (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
164 \fBpng_uint_32 png_get_compression_buffer_size (png_structp \fIpng_ptr\fP\fB);\fP
166 \fBint png_handle_as_unknown (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIchunk_name\fP\fB);\fP
168 \fBvoid png_init_io (png_structp \fP\fIpng_ptr\fP\fB, FILE \fI*fp\fP\fB);\fP
170 \fBDEPRECATED void png_info_init (png_infop \fIinfo_ptr\fP\fB);\fP
172 \fBDEPRECATED void png_info_init_2 (png_infopp \fP\fIptr_ptr\fP\fB, png_size_t \fIpng_info_struct_size\fP\fB);\fP
174 \fBpng_voidp png_malloc (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
176 \fBpng_voidp png_malloc_default(png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
178 \fBvoidp png_memcpy (png_voidp \fP\fIs1\fP\fB, png_voidp \fP\fIs2\fP\fB, png_size_t \fIsize\fP\fB);\fP
180 \fBpng_voidp png_memcpy_check (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIs1\fP\fB, png_voidp \fP\fIs2\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
182 \fBvoidp png_memset (png_voidp \fP\fIs1\fP\fB, int \fP\fIvalue\fP\fB, png_size_t \fIsize\fP\fB);\fP
184 \fBpng_voidp png_memset_check (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIs1\fP\fB, int \fP\fIvalue\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
186 \fBDEPRECATED void png_permit_empty_plte (png_structp \fP\fIpng_ptr\fP\fB, int \fIempty_plte_permitted\fP\fB);\fP
188 \fBvoid png_process_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fIbuffer\fP\fB, png_size_t \fIbuffer_size\fP\fB);\fP
190 \fBvoid png_progressive_combine_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIold_row\fP\fB, png_bytep \fInew_row\fP\fB);\fP
192 \fBvoid png_read_destroy (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_infop \fIend_info_ptr\fP\fB);\fP
194 \fBvoid png_read_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
196 \fBvoid png_read_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
198 \fBDEPRECATED void png_read_init (png_structp \fIpng_ptr\fP\fB);\fP
200 \fBDEPRECATED void png_read_init_2 (png_structpp \fP\fIptr_ptr\fP\fB, png_const_charp \fP\fIuser_png_ver\fP\fB, png_size_t \fP\fIpng_struct_size\fP\fB, png_size_t \fIpng_info_size\fP\fB);\fP
202 \fBvoid png_read_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
204 \fBvoid png_read_png (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fItransforms\fP\fB, png_voidp \fIparams\fP\fB);\fP
206 \fBvoid png_read_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIrow\fP\fB, png_bytep \fIdisplay_row\fP\fB);\fP
208 \fBvoid png_read_rows (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fP\fIrow\fP\fB, png_bytepp \fP\fIdisplay_row\fP\fB, png_uint_32 \fInum_rows\fP\fB);\fP
210 \fBvoid png_read_update_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
212 \fB#if !defined(PNG_1_0_X) png_save_int_32 (png_bytep \fP\fIbuf\fP\fB, png_int_32 \fIi\fP\fB);\fP
214 \fBvoid png_save_uint_16 (png_bytep \fP\fIbuf\fP\fB, unsigned int \fIi\fP\fB);\fP
216 \fBvoid png_save_uint_32 (png_bytep \fP\fIbuf\fP\fB, png_uint_32 \fIi\fP\fB);\fP
218 \fBvoid png_set_add_alpha (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int flags); \fI#endif
220 \fBvoid png_set_background (png_structp \fP\fIpng_ptr\fP\fB, png_color_16p \fP\fIbackground_color\fP\fB, int \fP\fIbackground_gamma_code\fP\fB, int \fP\fIneed_expand\fP\fB, double \fIbackground_gamma\fP\fB);\fP
222 \fBvoid png_set_bgr (png_structp \fIpng_ptr\fP\fB);\fP
224 \fBvoid png_set_bKGD (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_16p \fIbackground\fP\fB);\fP
226 \fBvoid png_set_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fP\fIwhite_x\fP\fB, double \fP\fIwhite_y\fP\fB, double \fP\fIred_x\fP\fB, double \fP\fIred_y\fP\fB, double \fP\fIgreen_x\fP\fB, double \fP\fIgreen_y\fP\fB, double \fP\fIblue_x\fP\fB, double \fIblue_y\fP\fB);\fP
228 \fBvoid png_set_cHRM_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIwhite_x\fP\fB, png_uint_32 \fP\fIwhite_y\fP\fB, png_uint_32 \fP\fIred_x\fP\fB, png_uint_32 \fP\fIred_y\fP\fB, png_uint_32 \fP\fIgreen_x\fP\fB, png_uint_32 \fP\fIgreen_y\fP\fB, png_uint_32 \fP\fIblue_x\fP\fB, png_uint_32 \fIblue_y\fP\fB);\fP
230 \fBvoid png_set_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
232 \fBvoid png_set_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
234 \fBvoid png_set_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
236 \fBvoid png_set_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
238 \fBvoid png_set_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
240 \fBvoid png_set_crc_action (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIcrit_action\fP\fB, int \fIancil_action\fP\fB);\fP
242 \fBvoid png_set_dither (png_structp \fP\fIpng_ptr\fP\fB, png_colorp \fP\fIpalette\fP\fB, int \fP\fInum_palette\fP\fB, int \fP\fImaximum_colors\fP\fB, png_uint_16p \fP\fIhistogram\fP\fB, int \fIfull_dither\fP\fB);\fP
244 \fBvoid png_set_error_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarning_fn\fP\fB);\fP
246 \fBvoid png_set_expand (png_structp \fIpng_ptr\fP\fB);\fP
248 \fBvoid png_set_expand_gray_1_2_4_to_8(png_structp \fIpng_ptr\fP\fB);\fP
250 \fBvoid png_set_filler (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
252 \fBvoid png_set_filter (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImethod\fP\fB, int \fIfilters\fP\fB);\fP
254 \fBvoid png_set_filter_heuristics (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIheuristic_method\fP\fB, int \fP\fInum_weights\fP\fB, png_doublep \fP\fIfilter_weights\fP\fB, png_doublep \fIfilter_costs\fP\fB);\fP
256 \fBvoid png_set_flush (png_structp \fP\fIpng_ptr\fP\fB, int \fInrows\fP\fB);\fP
258 \fBvoid png_set_gamma (png_structp \fP\fIpng_ptr\fP\fB, double \fP\fIscreen_gamma\fP\fB, double \fIdefault_file_gamma\fP\fB);\fP
260 \fBvoid png_set_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fIfile_gamma\fP\fB);\fP
262 \fBvoid png_set_gAMA_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fIfile_gamma\fP\fB);\fP
264 \fBvoid png_set_gray_1_2_4_to_8(png_structp \fIpng_ptr\fP\fB);\fP
266 \fBvoid png_set_gray_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
268 \fBvoid png_set_hIST (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_16p \fIhist\fP\fB);\fP
270 \fBvoid png_set_iCCP (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fIname\fP\fB, int \fP\fIcompression_type\fP\fB, png_charp \fP\fIprofile\fP\fB, png_uint_32 \fIproflen\fP\fB);\fP
272 \fBint png_set_interlace_handling (png_structp \fIpng_ptr\fP\fB);\fP
274 \fBvoid png_set_invalid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fImask\fP\fB);\fP
276 \fBvoid png_set_invert_alpha (png_structp \fIpng_ptr\fP\fB);\fP
278 \fBvoid png_set_invert_mono (png_structp \fIpng_ptr\fP\fB);\fP
280 \fBvoid png_set_IHDR (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIwidth\fP\fB, png_uint_32 \fP\fIheight\fP\fB, int \fP\fIbit_depth\fP\fB, int \fP\fIcolor_type\fP\fB, int \fP\fIinterlace_type\fP\fB, int \fP\fIcompression_type\fP\fB, int \fIfilter_type\fP\fB);\fP
282 \fBvoid png_set_keep_unknown_chunks (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIkeep\fP\fB, png_bytep \fP\fIchunk_list\fP\fB, int \fInum_chunks\fP\fB);\fP
284 \fBvoid png_set_mem_fn(png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
286 \fBvoid png_set_oFFs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIoffset_x\fP\fB, png_uint_32 \fP\fIoffset_y\fP\fB, int \fIunit_type\fP\fB);\fP
288 \fBvoid png_set_packing (png_structp \fIpng_ptr\fP\fB);\fP
290 \fBvoid png_set_packswap (png_structp \fIpng_ptr\fP\fB);\fP
292 \fBvoid png_set_palette_to_rgb(png_structp \fIpng_ptr\fP\fB);\fP
294 \fBvoid png_set_pCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fIpurpose\fP\fB, png_int_32 \fP\fIX0\fP\fB, png_int_32 \fP\fIX1\fP\fB, int \fP\fItype\fP\fB, int \fP\fInparams\fP\fB, png_charp \fP\fIunits\fP\fB, png_charpp \fIparams\fP\fB);\fP
296 \fBvoid png_set_pHYs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIres_x\fP\fB, png_uint_32 \fP\fIres_y\fP\fB, int \fIunit_type\fP\fB);\fP
298 \fBvoid png_set_progressive_read_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIprogressive_ptr\fP\fB, png_progressive_info_ptr \fP\fIinfo_fn\fP\fB, png_progressive_row_ptr \fP\fIrow_fn\fP\fB, png_progressive_end_ptr \fIend_fn\fP\fB);\fP
300 \fBvoid png_set_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_colorp \fP\fIpalette\fP\fB, int \fInum_palette\fP\fB);\fP
302 \fBvoid png_set_read_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIio_ptr\fP\fB, png_rw_ptr \fIread_data_fn\fP\fB);\fP
304 \fBvoid png_set_read_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_read_status_ptr \fIread_row_fn\fP\fB);\fP
306 \fBvoid png_set_read_user_transform_fn (png_structp \fP\fIpng_ptr\fP\fB, png_user_transform_ptr \fIread_user_transform_fn\fP\fB);\fP
308 \fBvoid png_set_rgb_to_gray (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIerror_action\fP\fB, double \fP\fIred\fP\fB, double \fIgreen\fP\fB);\fP
310 \fBvoid png_set_rgb_to_gray_fixed (png_structp \fP\fIpng_ptr\fP\fB, int error_action png_fixed_point \fP\fIred\fP\fB, png_fixed_point \fIgreen\fP\fB);\fP
312 \fBvoid png_set_rows (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytepp \fIrow_pointers\fP\fB);\fP
314 \fBvoid png_set_sBIT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_8p \fIsig_bit\fP\fB);\fP
316 \fBvoid png_set_sCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fIunit\fP\fB, double \fP\fIwidth\fP\fB, double \fIheight\fP\fB);\fP
318 \fBvoid png_set_shift (png_structp \fP\fIpng_ptr\fP\fB, png_color_8p \fItrue_bits\fP\fB);\fP
320 \fBvoid png_set_sig_bytes (png_structp \fP\fIpng_ptr\fP\fB, int \fInum_bytes\fP\fB);\fP
322 \fBvoid png_set_sPLT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_spalette_p \fP\fIsplt_ptr\fP\fB, int \fInum_spalettes\fP\fB);\fP
324 \fBvoid png_set_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIintent\fP\fB);\fP
326 \fBvoid png_set_sRGB_gAMA_and_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIintent\fP\fB);\fP
328 \fBvoid png_set_strip_16 (png_structp \fIpng_ptr\fP\fB);\fP
330 \fBvoid png_set_strip_alpha (png_structp \fIpng_ptr\fP\fB);\fP
332 \fBvoid png_set_swap (png_structp \fIpng_ptr\fP\fB);\fP
334 \fBvoid png_set_swap_alpha (png_structp \fIpng_ptr\fP\fB);\fP
336 \fBvoid png_set_text (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_textp \fP\fItext_ptr\fP\fB, int \fInum_text\fP\fB);\fP
338 \fBvoid png_set_tIME (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_timep \fImod_time\fP\fB);\fP
340 \fBvoid png_set_tRNS (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fItrans\fP\fB, int \fP\fInum_trans\fP\fB, png_color_16p \fItrans_values\fP\fB);\fP
342 \fBvoid png_set_tRNS_to_alpha(png_structp \fIpng_ptr\fP\fB);\fP
344 \fBpng_uint_32 png_set_unknown_chunks (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_unknown_chunkp \fP\fIunknowns\fP\fB, int \fP\fInum\fP\fB, int \fIlocation\fP\fB);\fP
346 \fBvoid png_set_unknown_chunk_location(png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIchunk\fP\fB, int \fIlocation\fP\fB);\fP
348 \fBvoid png_set_read_user_chunk_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIuser_chunk_ptr\fP\fB, png_user_chunk_ptr \fIread_user_chunk_fn\fP\fB);\fP
350 \fBvoid png_set_user_limits (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIuser_width_max\fP\fB, png_uint_32 \fIuser_height_max\fP\fB);\fP
352 \fBvoid png_set_user_transform_info (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIuser_transform_ptr\fP\fB, int \fP\fIuser_transform_depth\fP\fB, int \fIuser_transform_channels\fP\fB);\fP
354 \fBvoid png_set_write_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIio_ptr\fP\fB, png_rw_ptr \fP\fIwrite_data_fn\fP\fB, png_flush_ptr \fIoutput_flush_fn\fP\fB);\fP
356 \fBvoid png_set_write_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_write_status_ptr \fIwrite_row_fn\fP\fB);\fP
358 \fBvoid png_set_write_user_transform_fn (png_structp \fP\fIpng_ptr\fP\fB, png_user_transform_ptr \fIwrite_user_transform_fn\fP\fB);\fP
360 \fBvoid png_set_compression_buffer_size(png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
362 \fBint png_sig_cmp (png_bytep \fP\fIsig\fP\fB, png_size_t \fP\fIstart\fP\fB, png_size_t \fInum_to_check\fP\fB);\fP
364 \fBvoid png_start_read_image (png_structp \fIpng_ptr\fP\fB);\fP
366 \fBvoid png_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
368 \fBvoid png_write_chunk (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIchunk_name\fP\fB, png_bytep \fP\fIdata\fP\fB, png_size_t \fIlength\fP\fB);\fP
370 \fBvoid png_write_chunk_data (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIdata\fP\fB, png_size_t \fIlength\fP\fB);\fP
372 \fBvoid png_write_chunk_end (png_structp \fIpng_ptr\fP\fB);\fP
374 \fBvoid png_write_chunk_start (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIchunk_name\fP\fB, png_uint_32 \fIlength\fP\fB);\fP
376 \fBvoid png_write_destroy (png_structp \fIpng_ptr\fP\fB);\fP
378 \fBvoid png_write_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
380 \fBvoid png_write_flush (png_structp \fIpng_ptr\fP\fB);\fP
382 \fBvoid png_write_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
384 \fBDEPRECATED void png_write_init (png_structp \fIpng_ptr\fP\fB);\fP
386 \fBDEPRECATED void png_write_init_2 (png_structpp \fP\fIptr_ptr\fP\fB, png_const_charp \fP\fIuser_png_ver\fP\fB, png_size_t \fP\fIpng_struct_size\fP\fB, png_size_t \fIpng_info_size\fP\fB);\fP
388 \fBvoid png_write_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
390 \fBvoid png_write_info_before_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
392 \fBvoid png_write_png (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fItransforms\fP\fB, png_voidp \fIparams\fP\fB);\fP
394 \fBvoid png_write_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIrow\fP\fB);\fP
396 \fBvoid png_write_rows (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fP\fIrow\fP\fB, png_uint_32 \fInum_rows\fP\fB);\fP
398 \fBvoidpf png_zalloc (voidpf \fP\fIpng_ptr\fP\fB, uInt \fP\fIitems\fP\fB, uInt \fIsize\fP\fB);\fP
400 \fBvoid png_zfree (voidpf \fP\fIpng_ptr\fP\fB, voidpf \fIptr\fP\fB);\fP
405 library supports encoding, decoding, and various manipulations of
406 the Portable Network Graphics (PNG) format image files. It uses the
409 Following is a copy of the libpng.txt file that accompanies libpng.
411 libpng.txt - A description on how to use and modify libpng
413 libpng version 1.2.51 - February 6, 2014
414 Updated and distributed by Glenn Randers-Pehrson
415 <glennrp at users.sourceforge.net>
416 Copyright (c) 1998-2014 Glenn Randers-Pehrson
418 This document is released under the libpng license.
419 For conditions of distribution and use, see the disclaimer
424 libpng versions 0.97, January 1998, through 1.2.51 - February 6, 2014
425 Updated and distributed by Glenn Randers-Pehrson
426 Copyright (c) 1998-2014 Glenn Randers-Pehrson
428 libpng 1.0 beta 6 version 0.96 May 28, 1997
429 Updated and distributed by Andreas Dilger
430 Copyright (c) 1996, 1997 Andreas Dilger
432 libpng 1.0 beta 2 - version 0.88 January 26, 1996
433 For conditions of distribution and use, see copyright
434 notice in png.h. Copyright (c) 1995, 1996 Guy Eric
435 Schalnat, Group 42, Inc.
437 Updated/rewritten per request in the libpng FAQ
438 Copyright (c) 1995, 1996 Frank J. T. Wojcik
439 December 18, 1995 & January 20, 1996
443 This file describes how to use and modify the PNG reference library
444 (known as libpng) for your own use. There are five sections to this
445 file: introduction, structures, reading, writing, and modification and
446 configuration notes for various special platforms. In addition to this
447 file, example.c is a good starting point for using the library, as
448 it is heavily commented and should include everything most people
449 will need. We assume that libpng is already installed; see the
450 INSTALL file for instructions on how to install libpng.
452 For examples of libpng usage, see the files "example.c", "pngtest.c",
453 and the files in the "contrib" directory, all of which are included in
454 the libpng distribution.
456 Libpng was written as a companion to the PNG specification, as a way
457 of reducing the amount of time and effort it takes to support the PNG
458 file format in application programs.
460 The PNG specification (second edition), November 2003, is available as
461 a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2003 (E)) at
462 <http://www.w3.org/TR/2003/REC-PNG-20031110/
463 The W3C and ISO documents have identical technical content.
465 The PNG-1.2 specification is available at
466 <http://www.libpng.org/pub/png/documents/>. It is technically equivalent
467 to the PNG specification (second edition) but has some additional material.
469 The PNG-1.0 specification is available
470 as RFC 2083 <http://www.libpng.org/pub/png/documents/> and as a
471 W3C Recommendation <http://www.w3.org/TR/REC.png.html>.
473 Some additional chunks are described in the special-purpose public chunks
474 documents at <http://www.libpng.org/pub/png/documents/>.
477 about PNG, and the latest version of libpng, can be found at the PNG home
478 page, <http://www.libpng.org/pub/png/>.
480 Most users will not have to modify the library significantly; advanced
481 users may want to modify it more. All attempts were made to make it as
482 complete as possible, while keeping the code easy to understand.
483 Currently, this library only supports C. Support for other languages
486 Libpng has been designed to handle multiple sessions at one time,
487 to be easily modifiable, to be portable to the vast majority of
488 machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
489 to use. The ultimate goal of libpng is to promote the acceptance of
490 the PNG file format in whatever way possible. While there is still
491 work to be done (see the TODO file), libpng should cover the
492 majority of the needs of its users.
494 Libpng uses zlib for its compression and decompression of PNG files.
495 Further information about zlib, and the latest version of zlib, can
496 be found at the zlib home page, <http://www.info-zip.org/pub/infozip/zlib/>.
497 The zlib compression utility is a general purpose utility that is
498 useful for more than PNG files, and can be used without libpng.
499 See the documentation delivered with zlib for more details.
500 You can usually find the source files for the zlib utility wherever you
501 find the libpng source files.
503 Libpng is thread safe, provided the threads are using different
504 instances of the structures. Each thread should have its own
505 png_struct and png_info instances, and thus its own image.
506 Libpng does not protect itself against two threads using the
507 same instance of a structure.
511 There are two main structures that are important to libpng, png_struct
512 and png_info. The first, png_struct, is an internal structure that
513 will not, for the most part, be used by a user except as the first
514 variable passed to every libpng function call.
516 The png_info structure is designed to provide information about the
517 PNG file. At one time, the fields of png_info were intended to be
518 directly accessible to the user. However, this tended to cause problems
519 with applications using dynamically loaded libraries, and as a result
520 a set of interface functions for png_info (the png_get_*() and png_set_*()
521 functions) was developed. The fields of png_info are still available for
522 older applications, but it is suggested that applications use the new
523 interfaces if at all possible.
525 Applications that do make direct access to the members of png_struct (except
526 for png_ptr->jmpbuf) must be recompiled whenever the library is updated,
527 and applications that make direct access to the members of png_info must
528 be recompiled if they were compiled or loaded with libpng version 1.0.6,
529 in which the members were in a different order. In version 1.0.7, the
530 members of the png_info structure reverted to the old order, as they were
531 in versions 0.97c through 1.0.5. Starting with version 2.0.0, both
532 structures are going to be hidden, and the contents of the structures will
533 only be accessible through the png_get/png_set functions.
535 The png.h header file is an invaluable reference for programming with libpng.
536 And while I'm on the topic, make sure you include the libpng header file:
542 We'll now walk you through the possible functions to call when reading
543 in a PNG file sequentially, briefly explaining the syntax and purpose
544 of each one. See example.c and png.h for more detail. While
545 progressive reading is covered in the next section, you will still
546 need some of the functions discussed in this section to read a PNG
551 You will want to do the I/O initialization(*) before you get into libpng,
552 so if it doesn't work, you don't have much to undo. Of course, you
553 will also want to insure that you are, in fact, dealing with a PNG
554 file. Libpng provides a simple check to see if a file is a PNG file.
555 To use it, pass in the first 1 to 8 bytes of the file to the function
556 png_sig_cmp(), and it will return 0 (false) if the bytes match the
557 corresponding bytes of the PNG signature, or nonzero (true) otherwise.
558 Of course, the more bytes you pass in, the greater the accuracy of the
561 If you are intending to keep the file pointer open for use in libpng,
562 you must ensure you don't read more than 8 bytes from the beginning
563 of the file, and you also have to make a call to png_set_sig_bytes_read()
564 with the number of bytes you read from the beginning. Libpng will
565 then only check the bytes (if any) that your program didn't read.
567 (*): If you are not using the standard I/O functions, you will need
568 to replace them with custom functions. See the discussion under
572 FILE *fp = fopen(file_name, "rb");
577 fread(header, 1, number, fp);
578 is_png = !png_sig_cmp(header, 0, number);
585 Next, png_struct and png_info need to be allocated and initialized. In
586 order to ensure that the size of these structures is correct even with a
587 dynamically linked libpng, there are functions to initialize and
588 allocate the structures. We also pass the library version, optional
589 pointers to error handling functions, and a pointer to a data struct for
590 use by the error functions, if necessary (the pointer and functions can
591 be NULL if the default error handlers are to be used). See the section
592 on Changes to Libpng below regarding the old initialization functions.
593 The structure allocation functions quietly return NULL if they fail to
594 create the structure, so your application should check for that.
596 png_structp png_ptr = png_create_read_struct
597 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
598 user_error_fn, user_warning_fn);
602 png_infop info_ptr = png_create_info_struct(png_ptr);
605 png_destroy_read_struct(&png_ptr,
606 (png_infopp)NULL, (png_infopp)NULL);
610 png_infop end_info = png_create_info_struct(png_ptr);
613 png_destroy_read_struct(&png_ptr, &info_ptr,
618 If you want to use your own memory allocation routines,
619 define PNG_USER_MEM_SUPPORTED and use
620 png_create_read_struct_2() instead of png_create_read_struct():
622 png_structp png_ptr = png_create_read_struct_2
623 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
624 user_error_fn, user_warning_fn, (png_voidp)
625 user_mem_ptr, user_malloc_fn, user_free_fn);
627 The error handling routines passed to png_create_read_struct()
628 and the memory alloc/free routines passed to png_create_struct_2()
629 are only necessary if you are not using the libpng supplied error
630 handling and memory alloc/free functions.
632 When libpng encounters an error, it expects to longjmp back
633 to your routine. Therefore, you will need to call setjmp and pass
634 your png_jmpbuf(png_ptr). If you read the file from different
635 routines, you will need to update the jmpbuf field every time you enter
636 a new routine that will call a png_*() function.
638 See your documentation of setjmp/longjmp for your compiler for more
639 information on setjmp/longjmp. See the discussion on libpng error
640 handling in the Customizing Libpng section below for more information
641 on the libpng error handling. If an error occurs, and libpng longjmp's
642 back to your setjmp, you will want to call png_destroy_read_struct() to
645 if (setjmp(png_jmpbuf(png_ptr)))
647 png_destroy_read_struct(&png_ptr, &info_ptr,
653 If you would rather avoid the complexity of setjmp/longjmp issues,
654 you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
655 errors will result in a call to PNG_ABORT() which defaults to abort().
657 Now you need to set up the input code. The default for libpng is to
658 use the C function fread(). If you use this, you will need to pass a
659 valid FILE * in the function png_init_io(). Be sure that the file is
660 opened in binary mode. If you wish to handle reading data in another
661 way, you need not call the png_init_io() function, but you must then
662 implement the libpng I/O methods discussed in the Customizing Libpng
665 png_init_io(png_ptr, fp);
667 If you had previously opened the file and read any of the signature from
668 the beginning in order to see if this was a PNG file, you need to let
669 libpng know that there are some bytes missing from the start of the file.
671 png_set_sig_bytes(png_ptr, number);
673 .SS Setting up callback code
675 You can set up a callback function to handle any unknown chunks in the
676 input stream. You must supply the function
678 read_chunk_callback(png_ptr ptr,
679 png_unknown_chunkp chunk);
681 /* The unknown chunk structure contains your
682 chunk data, along with similar data for any other
689 /* Note that libpng has already taken care of
692 /* put your code here. Search for your chunk in the
693 unknown chunk structure, process it, and return one
696 return (\-n); /* chunk had an error */
697 return (0); /* did not recognize */
698 return (n); /* success */
701 (You can give your function another name that you like instead of
702 "read_chunk_callback")
704 To inform libpng about your function, use
706 png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
707 read_chunk_callback);
709 This names not only the callback function, but also a user pointer that
710 you can retrieve with
712 png_get_user_chunk_ptr(png_ptr);
714 If you call the png_set_read_user_chunk_fn() function, then all unknown
715 chunks will be saved when read, in case your callback function will need
716 one or more of them. This behavior can be changed with the
717 png_set_keep_unknown_chunks() function, described below.
719 At this point, you can set up a callback function that will be
720 called after each row has been read, which you can use to control
721 a progress meter or the like. It's demonstrated in pngtest.c.
722 You must supply a function
724 void read_row_callback(png_ptr ptr, png_uint_32 row,
727 /* put your code here */
730 (You can give it another name that you like instead of "read_row_callback")
732 To inform libpng about your function, use
734 png_set_read_status_fn(png_ptr, read_row_callback);
736 .SS Unknown-chunk handling
738 Now you get to set the way the library processes unknown chunks in the
739 input PNG stream. Both known and unknown chunks will be read. Normal
740 behavior is that known chunks will be parsed into information in
741 various info_ptr members while unknown chunks will be discarded. This
742 behavior can be wasteful if your application will never use some known
743 chunk types. To change this, you can call:
745 png_set_keep_unknown_chunks(png_ptr, keep,
746 chunk_list, num_chunks);
747 keep - 0: default unknown chunk handling
748 1: ignore; do not keep
749 2: keep only if safe-to-copy
750 3: keep even if unsafe-to-copy
751 You can use these definitions:
752 PNG_HANDLE_CHUNK_AS_DEFAULT 0
753 PNG_HANDLE_CHUNK_NEVER 1
754 PNG_HANDLE_CHUNK_IF_SAFE 2
755 PNG_HANDLE_CHUNK_ALWAYS 3
756 chunk_list - list of chunks affected (a byte string,
757 five bytes per chunk, NULL or '\0' if
759 num_chunks - number of chunks affected; if 0, all
760 unknown chunks are affected. If nonzero,
761 only the chunks in the list are affected
763 Unknown chunks declared in this way will be saved as raw data onto a
764 list of png_unknown_chunk structures. If a chunk that is normally
765 known to libpng is named in the list, it will be handled as unknown,
766 according to the "keep" directive. If a chunk is named in successive
767 instances of png_set_keep_unknown_chunks(), the final instance will
768 take precedence. The IHDR and IEND chunks should not be named in
769 chunk_list; if they are, libpng will process them normally anyway.
771 Here is an example of the usage of png_set_keep_unknown_chunks(),
772 where the private "vpAg" chunk will later be processed by a user chunk
775 png_byte vpAg[5]={118, 112, 65, 103, (png_byte) '\0'};
777 #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
778 png_byte unused_chunks[]=
780 104, 73, 83, 84, (png_byte) '\0', /* hIST */
781 105, 84, 88, 116, (png_byte) '\0', /* iTXt */
782 112, 67, 65, 76, (png_byte) '\0', /* pCAL */
783 115, 67, 65, 76, (png_byte) '\0', /* sCAL */
784 115, 80, 76, 84, (png_byte) '\0', /* sPLT */
785 116, 73, 77, 69, (png_byte) '\0', /* tIME */
791 #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
792 /* ignore all unknown chunks: */
793 png_set_keep_unknown_chunks(read_ptr, 1, NULL, 0);
794 /* except for vpAg: */
795 png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
796 /* also ignore unused known chunks: */
797 png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
798 (int)sizeof(unused_chunks)/5);
803 The PNG specification allows the width and height of an image to be as
804 large as 2^(31\-1 (0x7fffffff), or about 2.147 billion rows and columns.
805 Since very few applications really need to process such large images,
806 we have imposed an arbitrary 1-million limit on rows and columns.
807 Larger images will be rejected immediately with a png_error() call. If
808 you wish to override this limit, you can use
810 png_set_user_limits(png_ptr, width_max, height_max);
812 to set your own limits, or use width_max = height_max = 0x7fffffffL
813 to allow all valid dimensions (libpng may reject some very large images
814 anyway because of potential buffer overflow conditions).
816 You should put this statement after you create the PNG structure and
817 before calling png_read_info(), png_read_png(), or png_process_data().
818 If you need to retrieve the limits that are being applied, use
820 width_max = png_get_user_width_max(png_ptr);
821 height_max = png_get_user_height_max(png_ptr);
823 The PNG specification sets no limit on the number of ancillary chunks
824 allowed in a PNG datastream. You can impose a limit on the total number
825 of sPLT, tEXt, iTXt, zTXt, and unknown chunks that will be stored, with
827 png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);
829 where 0x7fffffffL means unlimited. You can retrieve this limit with
831 chunk_cache_max = png_get_chunk_cache_max(png_ptr);
833 This limit also applies to the number of buffers that can be allocated
834 by png_decompress_chunk() while decompressing iTXt, zTXt, and iCCP chunks.
836 .SS The high-level read interface
838 At this point there are two ways to proceed; through the high-level
839 read interface, or through a sequence of low-level read operations.
840 You can use the high-level interface if (a) you are willing to read
841 the entire image into memory, and (b) the input transformations
842 you want to do are limited to the following set:
844 PNG_TRANSFORM_IDENTITY No transformation
845 PNG_TRANSFORM_STRIP_16 Strip 16-bit samples to
847 PNG_TRANSFORM_STRIP_ALPHA Discard the alpha channel
848 PNG_TRANSFORM_PACKING Expand 1, 2 and 4-bit
850 PNG_TRANSFORM_PACKSWAP Change order of packed
852 PNG_TRANSFORM_EXPAND Perform set_expand()
853 PNG_TRANSFORM_INVERT_MONO Invert monochrome images
854 PNG_TRANSFORM_SHIFT Normalize pixels to the
856 PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
858 PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
860 PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
862 PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
863 PNG_TRANSFORM_GRAY_TO_RGB Expand grayscale samples
864 to RGB (or GA to RGBA)
866 (This excludes setting a background color, doing gamma transformation,
867 dithering, and setting filler.) If this is the case, simply do this:
869 png_read_png(png_ptr, info_ptr, png_transforms, NULL)
871 where png_transforms is an integer containing the bitwise OR of some
872 set of transformation flags. This call is equivalent to png_read_info(),
873 followed the set of transformations indicated by the transform mask,
874 then png_read_image(), and finally png_read_end().
876 (The final parameter of this call is not yet used. Someday it might point
877 to transformation parameters required by some future input transform.)
879 You must use png_transforms and not call any png_set_transform() functions
880 when you use png_read_png().
882 After you have called png_read_png(), you can retrieve the image data
885 row_pointers = png_get_rows(png_ptr, info_ptr);
887 where row_pointers is an array of pointers to the pixel data for each row:
889 png_bytep row_pointers[height];
891 If you know your image size and pixel size ahead of time, you can allocate
892 row_pointers prior to calling png_read_png() with
894 if (height > PNG_UINT_32_MAX/png_sizeof(png_byte))
896 "Image is too tall to process in memory");
897 if (width > PNG_UINT_32_MAX/pixel_size)
899 "Image is too wide to process in memory");
900 row_pointers = png_malloc(png_ptr,
901 height*png_sizeof(png_bytep));
902 for (int i=0; i<height, i++)
903 row_pointers[i]=NULL; /* security precaution */
904 for (int i=0; i<height, i++)
905 row_pointers[i]=png_malloc(png_ptr,
907 png_set_rows(png_ptr, info_ptr, &row_pointers);
909 Alternatively you could allocate your image in one big block and define
910 row_pointers[i] to point into the proper places in your block.
912 If you use png_set_rows(), the application is responsible for freeing
913 row_pointers (and row_pointers[i], if they were separately allocated).
915 If you don't allocate row_pointers ahead of time, png_read_png() will
916 do it, and it'll be free'ed when you call png_destroy_*().
918 .SS The low-level read interface
920 If you are going the low-level route, you are now ready to read all
921 the file information up to the actual image data. You do this with a
922 call to png_read_info().
924 png_read_info(png_ptr, info_ptr);
926 This will process all chunks up to but not including the image data.
928 .SS Querying the info structure
930 Functions are used to get the information from the info_ptr once it
931 has been read. Note that these fields may not be completely filled
932 in until png_read_end() has read the chunk data following the image.
934 png_get_IHDR(png_ptr, info_ptr, &width, &height,
935 &bit_depth, &color_type, &interlace_type,
936 &compression_type, &filter_method);
938 width - holds the width of the image
939 in pixels (up to 2^31).
940 height - holds the height of the image
941 in pixels (up to 2^31).
942 bit_depth - holds the bit depth of one of the
943 image channels. (valid values are
944 1, 2, 4, 8, 16 and depend also on
945 the color_type. See also
946 significant bits (sBIT) below).
947 color_type - describes which color/alpha channels
950 (bit depths 1, 2, 4, 8, 16)
951 PNG_COLOR_TYPE_GRAY_ALPHA
953 PNG_COLOR_TYPE_PALETTE
954 (bit depths 1, 2, 4, 8)
957 PNG_COLOR_TYPE_RGB_ALPHA
960 PNG_COLOR_MASK_PALETTE
964 filter_method - (must be PNG_FILTER_TYPE_BASE
965 for PNG 1.0, and can also be
966 PNG_INTRAPIXEL_DIFFERENCING if
967 the PNG datastream is embedded in
968 a MNG-1.0 datastream)
969 compression_type - (must be PNG_COMPRESSION_TYPE_BASE
971 interlace_type - (PNG_INTERLACE_NONE or
974 Any or all of interlace_type, compression_type, or
975 filter_method can be NULL if you are
976 not interested in their values.
978 Note that png_get_IHDR() returns 32-bit data into
979 the application's width and height variables.
980 This is an unsafe situation if these are 16-bit
981 variables. In such situations, the
982 png_get_image_width() and png_get_image_height()
983 functions described below are safer.
985 width = png_get_image_width(png_ptr,
987 height = png_get_image_height(png_ptr,
989 bit_depth = png_get_bit_depth(png_ptr,
991 color_type = png_get_color_type(png_ptr,
993 filter_method = png_get_filter_type(png_ptr,
995 compression_type = png_get_compression_type(png_ptr,
997 interlace_type = png_get_interlace_type(png_ptr,
1000 channels = png_get_channels(png_ptr, info_ptr);
1001 channels - number of channels of info for the
1002 color type (valid values are 1 (GRAY,
1003 PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
1004 4 (RGB_ALPHA or RGB + filler byte))
1005 rowbytes = png_get_rowbytes(png_ptr, info_ptr);
1006 rowbytes - number of bytes needed to hold a row
1008 signature = png_get_signature(png_ptr, info_ptr);
1009 signature - holds the signature read from the
1010 file (if any). The data is kept in
1011 the same offset it would be if the
1012 whole signature were read (i.e. if an
1013 application had already read in 4
1014 bytes of signature before starting
1015 libpng, the remaining 4 bytes would
1016 be in signature[4] through signature[7]
1017 (see png_set_sig_bytes())).
1019 These are also important, but their validity depends on whether the chunk
1020 has been read. The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
1021 png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
1022 data has been read, or zero if it is missing. The parameters to the
1023 png_get_<chunk> are set directly if they are simple data types, or a
1024 pointer into the info_ptr is returned for any complex types.
1026 png_get_PLTE(png_ptr, info_ptr, &palette,
1028 palette - the palette for the file
1029 (array of png_color)
1030 num_palette - number of entries in the palette
1032 png_get_gAMA(png_ptr, info_ptr, &gamma);
1033 gamma - the gamma the file is written
1036 png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
1037 srgb_intent - the rendering intent (PNG_INFO_sRGB)
1038 The presence of the sRGB chunk
1039 means that the pixel data is in the
1040 sRGB color space. This chunk also
1041 implies specific values of gAMA and
1044 png_get_iCCP(png_ptr, info_ptr, &name,
1045 &compression_type, &profile, &proflen);
1046 name - The profile name.
1047 compression - The compression type; always
1048 PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
1049 You may give NULL to this argument to
1051 profile - International Color Consortium color
1052 profile data. May contain NULs.
1053 proflen - length of profile data in bytes.
1055 png_get_sBIT(png_ptr, info_ptr, &sig_bit);
1056 sig_bit - the number of significant bits for
1057 (PNG_INFO_sBIT) each of the gray,
1058 red, green, and blue channels,
1059 whichever are appropriate for the
1060 given color type (png_color_16)
1062 png_get_tRNS(png_ptr, info_ptr, &trans, &num_trans,
1064 trans - array of transparent
1065 entries for palette (PNG_INFO_tRNS)
1066 trans_values - graylevel or color sample values of
1067 the single transparent color for
1068 non-paletted images (PNG_INFO_tRNS)
1069 num_trans - number of transparent entries
1072 png_get_hIST(png_ptr, info_ptr, &hist);
1074 hist - histogram of palette (array of
1077 png_get_tIME(png_ptr, info_ptr, &mod_time);
1078 mod_time - time image was last modified
1081 png_get_bKGD(png_ptr, info_ptr, &background);
1082 background - background color (PNG_VALID_bKGD)
1083 valid 16-bit red, green and blue
1084 values, regardless of color_type
1086 num_comments = png_get_text(png_ptr, info_ptr,
1087 &text_ptr, &num_text);
1088 num_comments - number of comments
1089 text_ptr - array of png_text holding image
1091 text_ptr[i].compression - type of compression used
1092 on "text" PNG_TEXT_COMPRESSION_NONE
1093 PNG_TEXT_COMPRESSION_zTXt
1094 PNG_ITXT_COMPRESSION_NONE
1095 PNG_ITXT_COMPRESSION_zTXt
1096 text_ptr[i].key - keyword for comment. Must contain
1098 text_ptr[i].text - text comments for current
1099 keyword. Can be empty.
1100 text_ptr[i].text_length - length of text string,
1101 after decompression, 0 for iTXt
1102 text_ptr[i].itxt_length - length of itxt string,
1103 after decompression, 0 for tEXt/zTXt
1104 text_ptr[i].lang - language of comment (empty
1105 string for unknown).
1106 text_ptr[i].lang_key - keyword in UTF-8
1107 (empty string for unknown).
1108 Note that the itxt_length, lang, and lang_key
1109 members of the text_ptr structure only exist
1110 when the library is built with iTXt chunk support.
1112 num_text - number of comments (same as
1113 num_comments; you can put NULL here
1114 to avoid the duplication)
1115 Note while png_set_text() will accept text, language,
1116 and translated keywords that can be NULL pointers, the
1117 structure returned by png_get_text will always contain
1118 regular zero-terminated C strings. They might be
1119 empty strings but they will never be NULL pointers.
1121 num_spalettes = png_get_sPLT(png_ptr, info_ptr,
1123 palette_ptr - array of palette structures holding
1124 contents of one or more sPLT chunks
1126 num_spalettes - number of sPLT chunks read.
1128 png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
1130 offset_x - positive offset from the left edge
1132 offset_y - positive offset from the top edge
1134 unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
1136 png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
1138 res_x - pixels/unit physical resolution in
1140 res_y - pixels/unit physical resolution in
1142 unit_type - PNG_RESOLUTION_UNKNOWN,
1143 PNG_RESOLUTION_METER
1145 png_get_sCAL(png_ptr, info_ptr, &unit, &width,
1147 unit - physical scale units (an integer)
1148 width - width of a pixel in physical scale units
1149 height - height of a pixel in physical scale units
1150 (width and height are doubles)
1152 png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
1154 unit - physical scale units (an integer)
1155 width - width of a pixel in physical scale units
1156 height - height of a pixel in physical scale units
1157 (width and height are strings like "2.54")
1159 num_unknown_chunks = png_get_unknown_chunks(png_ptr,
1160 info_ptr, &unknowns)
1161 unknowns - array of png_unknown_chunk
1162 structures holding unknown chunks
1163 unknowns[i].name - name of unknown chunk
1164 unknowns[i].data - data of unknown chunk
1165 unknowns[i].size - size of unknown chunk's data
1166 unknowns[i].location - position of chunk in file
1168 The value of "i" corresponds to the order in which the
1169 chunks were read from the PNG file or inserted with the
1170 png_set_unknown_chunks() function.
1172 The data from the pHYs chunk can be retrieved in several convenient
1175 res_x = png_get_x_pixels_per_meter(png_ptr,
1177 res_y = png_get_y_pixels_per_meter(png_ptr,
1179 res_x_and_y = png_get_pixels_per_meter(png_ptr,
1181 res_x = png_get_x_pixels_per_inch(png_ptr,
1183 res_y = png_get_y_pixels_per_inch(png_ptr,
1185 res_x_and_y = png_get_pixels_per_inch(png_ptr,
1187 aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
1190 (Each of these returns 0 [signifying "unknown"] if
1191 the data is not present or if res_x is 0;
1192 res_x_and_y is 0 if res_x != res_y)
1194 The data from the oFFs chunk can be retrieved in several convenient
1197 x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
1198 y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
1199 x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
1200 y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
1202 (Each of these returns 0 [signifying "unknown" if both
1203 x and y are 0] if the data is not present or if the
1204 chunk is present but the unit is the pixel)
1206 For more information, see the png_info definition in png.h and the
1207 PNG specification for chunk contents. Be careful with trusting
1208 rowbytes, as some of the transformations could increase the space
1209 needed to hold a row (expand, filler, gray_to_rgb, etc.).
1210 See png_read_update_info(), below.
1212 A quick word about text_ptr and num_text. PNG stores comments in
1213 keyword/text pairs, one pair per chunk, with no limit on the number
1214 of text chunks, and a 2^31 byte limit on their size. While there are
1215 suggested keywords, there is no requirement to restrict the use to these
1216 strings. It is strongly suggested that keywords and text be sensible
1217 to humans (that's the point), so don't use abbreviations. Non-printing
1218 symbols are not allowed. See the PNG specification for more details.
1219 There is also no requirement to have text after the keyword.
1221 Keywords should be limited to 79 Latin-1 characters without leading or
1222 trailing spaces, but non-consecutive spaces are allowed within the
1223 keyword. It is possible to have the same keyword any number of times.
1224 The text_ptr is an array of png_text structures, each holding a
1225 pointer to a language string, a pointer to a keyword and a pointer to
1226 a text string. The text string, language code, and translated
1227 keyword may be empty or NULL pointers. The keyword/text
1228 pairs are put into the array in the order that they are received.
1229 However, some or all of the text chunks may be after the image, so, to
1230 make sure you have read all the text chunks, don't mess with these
1231 until after you read the stuff after the image. This will be
1232 mentioned again below in the discussion that goes with png_read_end().
1234 .SS Input transformations
1236 After you've read the header information, you can set up the library
1237 to handle any special transformations of the image data. The various
1238 ways to transform the data will be described in the order that they
1239 should occur. This is important, as some of these change the color
1240 type and/or bit depth of the data, and some others only work on
1241 certain color types and bit depths. Even though each transformation
1242 checks to see if it has data that it can do something with, you should
1243 make sure to only enable a transformation if it will be valid for the
1244 data. For example, don't swap red and blue on grayscale data.
1246 The colors used for the background and transparency values should be
1247 supplied in the same format/depth as the current image data. They
1248 are stored in the same format/depth as the image data in a bKGD or tRNS
1249 chunk, so this is what libpng expects for this data. The colors are
1250 transformed to keep in sync with the image data when an application
1251 calls the png_read_update_info() routine (see below).
1253 Data will be decoded into the supplied row buffers packed into bytes
1254 unless the library has been told to transform it into another format.
1255 For example, 4 bit/pixel paletted or grayscale data will be returned
1256 2 pixels/byte with the leftmost pixel in the high-order bits of the
1257 byte, unless png_set_packing() is called. 8-bit RGB data will be stored
1258 in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
1259 is called to insert filler bytes, either before or after each RGB triplet.
1260 16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
1261 byte of the color value first, unless png_set_strip_16() is called to
1262 transform it to regular RGB RGB triplets, or png_set_filler() or
1263 png_set_add alpha() is called to insert filler bytes, either before or
1264 after each RRGGBB triplet. Similarly, 8-bit or 16-bit grayscale data can
1266 png_set_filler(), png_set_add_alpha(), or png_set_strip_16().
1268 The following code transforms grayscale images of less than 8 to 8 bits,
1269 changes paletted images to RGB, and adds a full alpha channel if there is
1270 transparency information in a tRNS chunk. This is most useful on
1271 grayscale images with bit depths of 2 or 4 or if there is a multiple-image
1272 viewing application that wishes to treat all images in the same way.
1274 if (color_type == PNG_COLOR_TYPE_PALETTE)
1275 png_set_palette_to_rgb(png_ptr);
1277 if (color_type == PNG_COLOR_TYPE_GRAY &&
1278 bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
1280 if (png_get_valid(png_ptr, info_ptr,
1281 PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
1283 These three functions are actually aliases for png_set_expand(), added
1284 in libpng version 1.0.4, with the function names expanded to improve code
1285 readability. In some future version they may actually do different
1288 As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
1289 added. It expands the sample depth without changing tRNS to alpha.
1291 As of libpng version 1.2.51, not all possible expansions are supported.
1293 In the following table, the 01 means grayscale with depth<8, 31 means
1294 indexed with depth<8, other numerals represent the color type, "T" means
1295 the tRNS chunk is present, A means an alpha channel is present, and O
1296 means tRNS or alpha is present but all pixels in the image are opaque.
1298 FROM 01 31 0 0T 0O 2 2T 2O 3 3T 3O 4A 4O 6A 6O
1317 "-" means the transformation is not supported.
1318 "X" means the transformation is obtained by png_set_expand().
1319 "1" means the transformation is obtained by
1320 png_set_expand_gray_1_2_4_to_8
1321 "G" means the transformation is obtained by
1322 png_set_gray_to_rgb().
1323 "P" means the transformation is obtained by
1324 png_set_expand_palette_to_rgb().
1325 "T" means the transformation is obtained by
1326 png_set_tRNS_to_alpha().
1328 PNG can have files with 16 bits per channel. If you only can handle
1329 8 bits per channel, this will strip the pixels down to 8 bit.
1331 if (bit_depth == 16)
1332 png_set_strip_16(png_ptr);
1334 If, for some reason, you don't need the alpha channel on an image,
1335 and you want to remove it rather than combining it with the background
1336 (but the image author certainly had in mind that you *would* combine
1337 it with the background, so that's what you should probably do):
1339 if (color_type & PNG_COLOR_MASK_ALPHA)
1340 png_set_strip_alpha(png_ptr);
1342 In PNG files, the alpha channel in an image
1343 is the level of opacity. If you need the alpha channel in an image to
1344 be the level of transparency instead of opacity, you can invert the
1345 alpha channel (or the tRNS chunk data) after it's read, so that 0 is
1346 fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
1347 images) is fully transparent, with
1349 png_set_invert_alpha(png_ptr);
1351 The PNG format only supports pixels with postmultiplied alpha.
1352 If you want to replace the pixels, after reading them, with pixels
1353 that have premultiplied color samples, you can do this with
1355 png_set_premultiply_alpha(png_ptr);
1357 If you do this, any input with a tRNS chunk will be expanded to
1358 have an alpha channel.
1360 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
1361 they can, resulting in, for example, 8 pixels per byte for 1 bit
1362 files. This code expands to 1 pixel per byte without changing the
1363 values of the pixels:
1366 png_set_packing(png_ptr);
1368 PNG files have possible bit depths of 1, 2, 4, 8, and 16. All pixels
1369 stored in a PNG image have been "scaled" or "shifted" up to the next
1370 higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
1371 to 8 bits/sample in the range [0, 255]). However, it is also possible
1372 to convert the PNG pixel data back to the original bit depth of the
1373 image. This call reduces the pixels back down to the original bit depth:
1375 png_color_8p sig_bit;
1377 if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
1378 png_set_shift(png_ptr, sig_bit);
1380 PNG files store 3-color pixels in red, green, blue order. This code
1381 changes the storage of the pixels to blue, green, red:
1383 if (color_type == PNG_COLOR_TYPE_RGB ||
1384 color_type == PNG_COLOR_TYPE_RGB_ALPHA)
1385 png_set_bgr(png_ptr);
1387 PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
1388 into 4 or 8 bytes for windowing systems that need them in this format:
1390 if (color_type == PNG_COLOR_TYPE_RGB)
1391 png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
1393 where "filler" is the 8 or 16-bit number to fill with, and the location is
1394 either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
1395 you want the filler before the RGB or after. This transformation
1396 does not affect images that already have full alpha channels. To add an
1397 opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER which
1398 will generate RGBA pixels.
1400 Note that png_set_filler() does not change the color type. If you want
1401 to do that, you can add a true alpha channel with
1403 if (color_type == PNG_COLOR_TYPE_RGB ||
1404 color_type == PNG_COLOR_TYPE_GRAY)
1405 png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
1407 where "filler" contains the alpha value to assign to each pixel.
1408 This function was added in libpng-1.2.7.
1410 If you are reading an image with an alpha channel, and you need the
1411 data as ARGB instead of the normal PNG format RGBA:
1413 if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
1414 png_set_swap_alpha(png_ptr);
1416 For some uses, you may want a grayscale image to be represented as
1417 RGB. This code will do that conversion:
1419 if (color_type == PNG_COLOR_TYPE_GRAY ||
1420 color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
1421 png_set_gray_to_rgb(png_ptr);
1423 Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
1426 if (color_type == PNG_COLOR_TYPE_RGB ||
1427 color_type == PNG_COLOR_TYPE_RGB_ALPHA)
1428 png_set_rgb_to_gray_fixed(png_ptr, error_action,
1429 int red_weight, int green_weight);
1431 error_action = 1: silently do the conversion
1432 error_action = 2: issue a warning if the original
1433 image has any pixel where
1434 red != green or red != blue
1435 error_action = 3: issue an error and abort the
1436 conversion if the original
1437 image has any pixel where
1438 red != green or red != blue
1440 red_weight: weight of red component times 100000
1441 green_weight: weight of green component times 100000
1442 If either weight is negative, default
1443 weights (21268, 71514) are used.
1445 If you have set error_action = 1 or 2, you can
1446 later check whether the image really was gray, after processing
1447 the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
1448 It will return a png_byte that is zero if the image was gray or
1449 1 if there were any non-gray pixels. bKGD and sBIT data
1450 will be silently converted to grayscale, using the green channel
1451 data, regardless of the error_action setting.
1453 With red_weight+green_weight<=100000,
1454 the normalized graylevel is computed:
1456 int rw = red_weight * 65536;
1457 int gw = green_weight * 65536;
1458 int bw = 65536 - (rw + gw);
1459 gray = (rw*red + gw*green + bw*blue)/65536;
1461 The default values approximate those recommended in the Charles
1462 Poynton's Color FAQ, <http://www.inforamp.net/~poynton/>
1463 Copyright (c) 1998-01-04 Charles Poynton <poynton at inforamp.net>
1465 Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
1467 Libpng approximates this with
1469 Y = 0.21268 * R + 0.7151 * G + 0.07217 * B
1471 which can be expressed with integers as
1473 Y = (6969 * R + 23434 * G + 2365 * B)/32768
1475 The calculation is done in a linear colorspace, if the image gamma
1478 If you have a grayscale and you are using png_set_expand_depth(),
1479 png_set_expand(), or png_set_gray_to_rgb to change to truecolor or to
1480 a higher bit-depth, you must either supply the background color as a gray
1481 value at the original file bit-depth (need_expand = 1) or else supply the
1482 background color as an RGB triplet at the final, expanded bit depth
1483 (need_expand = 0). Similarly, if you are reading a paletted image, you
1484 must either supply the background color as a palette index (need_expand = 1)
1485 or as an RGB triplet that may or may not be in the palette (need_expand = 0).
1487 png_color_16 my_background;
1488 png_color_16p image_background;
1490 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
1491 png_set_background(png_ptr, image_background,
1492 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
1494 png_set_background(png_ptr, &my_background,
1495 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
1497 The png_set_background() function tells libpng to composite images
1498 with alpha or simple transparency against the supplied background
1499 color. If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
1500 you may use this color, or supply another color more suitable for
1501 the current display (e.g., the background color from a web page). You
1502 need to tell libpng whether the color is in the gamma space of the
1503 display (PNG_BACKGROUND_GAMMA_SCREEN for colors you supply), the file
1504 (PNG_BACKGROUND_GAMMA_FILE for colors from the bKGD chunk), or one
1505 that is neither of these gammas (PNG_BACKGROUND_GAMMA_UNIQUE - I don't
1506 know why anyone would use this, but it's here).
1508 To properly display PNG images on any kind of system, the application needs
1509 to know what the display gamma is. Ideally, the user will know this, and
1510 the application will allow them to set it. One method of allowing the user
1511 to set the display gamma separately for each system is to check for a
1512 SCREEN_GAMMA or DISPLAY_GAMMA environment variable, which will hopefully be
1515 Note that display_gamma is the overall gamma correction required to produce
1516 pleasing results, which depends on the lighting conditions in the surrounding
1517 environment. In a dim or brightly lit room, no compensation other than
1518 the physical gamma exponent of the monitor is needed, while in a dark room
1519 a slightly smaller exponent is better.
1521 double gamma, screen_gamma;
1523 if (/* We have a user-defined screen
1526 screen_gamma = user_defined_screen_gamma;
1528 /* One way that applications can share the same
1529 screen gamma value */
1530 else if ((gamma_str = getenv("SCREEN_GAMMA"))
1533 screen_gamma = (double)atof(gamma_str);
1535 /* If we don't have another value */
1538 screen_gamma = 2.2; /* A good guess for a
1539 PC monitor in a bright office or a dim room */
1540 screen_gamma = 2.0; /* A good guess for a
1541 PC monitor in a dark room */
1542 screen_gamma = 1.7 or 1.0; /* A good
1543 guess for Mac systems */
1546 The png_set_gamma() function handles gamma transformations of the data.
1547 Pass both the file gamma and the current screen_gamma. If the file does
1548 not have a gamma value, you can pass one anyway if you have an idea what
1549 it is (usually 0.45455 is a good guess for GIF images on PCs). Note
1550 that file gammas are inverted from screen gammas. See the discussions
1551 on gamma in the PNG specification for an excellent description of what
1552 gamma is, and why all applications should support it. It is strongly
1553 recommended that PNG viewers support gamma correction.
1555 if (png_get_gAMA(png_ptr, info_ptr, &gamma))
1556 png_set_gamma(png_ptr, screen_gamma, gamma);
1558 png_set_gamma(png_ptr, screen_gamma, 0.45455);
1560 If you need to reduce an RGB file to a paletted file, or if a paletted
1561 file has more entries then will fit on your screen, png_set_dither()
1562 will do that. Note that this is a simple match dither that merely
1563 finds the closest color available. This should work fairly well with
1564 optimized palettes, and fairly badly with linear color cubes. If you
1565 pass a palette that is larger then maximum_colors, the file will
1566 reduce the number of colors in the palette so it will fit into
1567 maximum_colors. If there is a histogram, it will use it to make
1568 more intelligent choices when reducing the palette. If there is no
1569 histogram, it may not do as good a job.
1571 if (color_type & PNG_COLOR_MASK_COLOR)
1573 if (png_get_valid(png_ptr, info_ptr,
1576 png_uint_16p histogram = NULL;
1578 png_get_hIST(png_ptr, info_ptr,
1580 png_set_dither(png_ptr, palette, num_palette,
1581 max_screen_colors, histogram, 1);
1585 png_color std_color_cube[MAX_SCREEN_COLORS] =
1588 png_set_dither(png_ptr, std_color_cube,
1589 MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
1594 PNG files describe monochrome as black being zero and white being one.
1595 The following code will reverse this (make black be one and white be
1598 if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
1599 png_set_invert_mono(png_ptr);
1601 This function can also be used to invert grayscale and gray-alpha images:
1603 if (color_type == PNG_COLOR_TYPE_GRAY ||
1604 color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
1605 png_set_invert_mono(png_ptr);
1607 PNG files store 16 bit pixels in network byte order (big-endian,
1608 ie. most significant bits first). This code changes the storage to the
1609 other way (little-endian, i.e. least significant bits first, the
1610 way PCs store them):
1612 if (bit_depth == 16)
1613 png_set_swap(png_ptr);
1615 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
1616 need to change the order the pixels are packed into bytes, you can use:
1619 png_set_packswap(png_ptr);
1621 Finally, you can write your own transformation function if none of
1622 the existing ones meets your needs. This is done by setting a callback
1625 png_set_read_user_transform_fn(png_ptr,
1628 You must supply the function
1630 void read_transform_fn(png_ptr ptr, row_info_ptr
1631 row_info, png_bytep data)
1633 See pngtest.c for a working example. Your function will be called
1634 after all of the other transformations have been processed.
1636 You can also set up a pointer to a user structure for use by your
1637 callback function, and you can inform libpng that your transform
1638 function will change the number of channels or bit depth with the
1641 png_set_user_transform_info(png_ptr, user_ptr,
1642 user_depth, user_channels);
1644 The user's application, not libpng, is responsible for allocating and
1645 freeing any memory required for the user structure.
1647 You can retrieve the pointer via the function
1648 png_get_user_transform_ptr(). For example:
1650 voidp read_user_transform_ptr =
1651 png_get_user_transform_ptr(png_ptr);
1653 The last thing to handle is interlacing; this is covered in detail below,
1654 but you must call the function here if you want libpng to handle expansion
1655 of the interlaced image.
1657 number_of_passes = png_set_interlace_handling(png_ptr);
1659 After setting the transformations, libpng can update your png_info
1660 structure to reflect any transformations you've requested with this
1661 call. This is most useful to update the info structure's rowbytes
1662 field so you can use it to allocate your image memory. This function
1663 will also update your palette with the correct screen_gamma and
1664 background if these have been given with the calls above.
1666 png_read_update_info(png_ptr, info_ptr);
1668 After you call png_read_update_info(), you can allocate any
1669 memory you need to hold the image. The row data is simply
1670 raw byte data for all forms of images. As the actual allocation
1671 varies among applications, no example will be given. If you
1672 are allocating one large chunk, you will need to build an
1673 array of pointers to each row, as it will be needed for some
1674 of the functions below.
1676 .SS Reading image data
1678 After you've allocated memory, you can read the image data.
1679 The simplest way to do this is in one function call. If you are
1680 allocating enough memory to hold the whole image, you can just
1681 call png_read_image() and libpng will read in all the image data
1682 and put it in the memory area supplied. You will need to pass in
1683 an array of pointers to each row.
1685 This function automatically handles interlacing, so you don't need
1686 to call png_set_interlace_handling() or call this function multiple
1687 times, or any of that other stuff necessary with png_read_rows().
1689 png_read_image(png_ptr, row_pointers);
1691 where row_pointers is:
1693 png_bytep row_pointers[height];
1695 You can point to void or char or whatever you use for pixels.
1697 If you don't want to read in the whole image at once, you can
1698 use png_read_rows() instead. If there is no interlacing (check
1699 interlace_type == PNG_INTERLACE_NONE), this is simple:
1701 png_read_rows(png_ptr, row_pointers, NULL,
1704 where row_pointers is the same as in the png_read_image() call.
1706 If you are doing this just one row at a time, you can do this with
1707 a single row_pointer instead of an array of row_pointers:
1709 png_bytep row_pointer = row;
1710 png_read_row(png_ptr, row_pointer, NULL);
1712 If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
1713 get somewhat harder. The only current (PNG Specification version 1.2)
1714 interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7)
1715 is a somewhat complicated 2D interlace scheme, known as Adam7, that
1716 breaks down an image into seven smaller images of varying size, based
1719 libpng can fill out those images or it can give them to you "as is".
1720 If you want them filled out, there are two ways to do that. The one
1721 mentioned in the PNG specification is to expand each pixel to cover
1722 those pixels that have not been read yet (the "rectangle" method).
1723 This results in a blocky image for the first pass, which gradually
1724 smooths out as more pixels are read. The other method is the "sparkle"
1725 method, where pixels are drawn only in their final locations, with the
1726 rest of the image remaining whatever colors they were initialized to
1727 before the start of the read. The first method usually looks better,
1728 but tends to be slower, as there are more pixels to put in the rows.
1730 If you don't want libpng to handle the interlacing details, just call
1731 png_read_rows() seven times to read in all seven images. Each of the
1732 images is a valid image by itself, or they can all be combined on an
1733 8x8 grid to form a single image (although if you intend to combine them
1734 you would be far better off using the libpng interlace handling).
1736 The first pass will return an image 1/8 as wide as the entire image
1737 (every 8th column starting in column 0) and 1/8 as high as the original
1738 (every 8th row starting in row 0), the second will be 1/8 as wide
1739 (starting in column 4) and 1/8 as high (also starting in row 0). The
1740 third pass will be 1/4 as wide (every 4th pixel starting in column 0) and
1741 1/8 as high (every 8th row starting in row 4), and the fourth pass will
1742 be 1/4 as wide and 1/4 as high (every 4th column starting in column 2,
1743 and every 4th row starting in row 0). The fifth pass will return an
1744 image 1/2 as wide, and 1/4 as high (starting at column 0 and row 2),
1745 while the sixth pass will be 1/2 as wide and 1/2 as high as the original
1746 (starting in column 1 and row 0). The seventh and final pass will be as
1747 wide as the original, and 1/2 as high, containing all of the odd
1748 numbered scanlines. Phew!
1750 If you want libpng to expand the images, call this before calling
1751 png_start_read_image() or png_read_update_info():
1753 if (interlace_type == PNG_INTERLACE_ADAM7)
1755 = png_set_interlace_handling(png_ptr);
1757 This will return the number of passes needed. Currently, this
1758 is seven, but may change if another interlace type is added.
1759 This function can be called even if the file is not interlaced,
1760 where it will return one pass.
1762 If you are not going to display the image after each pass, but are
1763 going to wait until the entire image is read in, use the sparkle
1764 effect. This effect is faster and the end result of either method
1765 is exactly the same. If you are planning on displaying the image
1766 after each pass, the "rectangle" effect is generally considered the
1769 If you only want the "sparkle" effect, just call png_read_rows() as
1770 normal, with the third parameter NULL. Make sure you make pass over
1771 the image number_of_passes times, and you don't change the data in the
1772 rows between calls. You can change the locations of the data, just
1773 not the data. Each pass only writes the pixels appropriate for that
1774 pass, and assumes the data from previous passes is still valid.
1776 png_read_rows(png_ptr, row_pointers, NULL,
1779 If you only want the first effect (the rectangles), do the same as
1780 before except pass the row buffer in the third parameter, and leave
1781 the second parameter NULL.
1783 png_read_rows(png_ptr, NULL, row_pointers,
1786 .SS Finishing a sequential read
1788 After you are finished reading the image through the
1789 low-level interface, you can finish reading the file. If you are
1790 interested in comments or time, which may be stored either before or
1791 after the image data, you should pass the separate png_info struct if
1792 you want to keep the comments from before and after the image
1793 separate. If you are not interested, you can pass NULL.
1795 png_read_end(png_ptr, end_info);
1797 When you are done, you can free all memory allocated by libpng like this:
1799 png_destroy_read_struct(&png_ptr, &info_ptr,
1802 It is also possible to individually free the info_ptr members that
1803 point to libpng-allocated storage with the following function:
1805 png_free_data(png_ptr, info_ptr, mask, seq)
1806 mask - identifies data to be freed, a mask
1807 containing the bitwise OR of one or
1809 PNG_FREE_PLTE, PNG_FREE_TRNS,
1810 PNG_FREE_HIST, PNG_FREE_ICCP,
1811 PNG_FREE_PCAL, PNG_FREE_ROWS,
1812 PNG_FREE_SCAL, PNG_FREE_SPLT,
1813 PNG_FREE_TEXT, PNG_FREE_UNKN,
1814 or simply PNG_FREE_ALL
1815 seq - sequence number of item to be freed
1818 This function may be safely called when the relevant storage has
1819 already been freed, or has not yet been allocated, or was allocated
1820 by the user and not by libpng, and will in those cases do nothing.
1821 The "seq" parameter is ignored if only one item of the selected data
1822 type, such as PLTE, is allowed. If "seq" is not \-1, and multiple items
1823 are allowed for the data type identified in the mask, such as text or
1824 sPLT, only the n'th item in the structure is freed, where n is "seq".
1826 The default behavior is only to free data that was allocated internally
1827 by libpng. This can be changed, so that libpng will not free the data,
1828 or so that it will free data that was allocated by the user with png_malloc()
1829 or png_zalloc() and passed in via a png_set_*() function, with
1831 png_data_freer(png_ptr, info_ptr, freer, mask)
1832 mask - which data elements are affected
1833 same choices as in png_free_data()
1835 PNG_DESTROY_WILL_FREE_DATA
1836 PNG_SET_WILL_FREE_DATA
1837 PNG_USER_WILL_FREE_DATA
1839 This function only affects data that has already been allocated.
1840 You can call this function after reading the PNG data but before calling
1841 any png_set_*() functions, to control whether the user or the png_set_*()
1842 function is responsible for freeing any existing data that might be present,
1843 and again after the png_set_*() functions to control whether the user
1844 or png_destroy_*() is supposed to free the data. When the user assumes
1845 responsibility for libpng-allocated data, the application must use
1846 png_free() to free it, and when the user transfers responsibility to libpng
1847 for data that the user has allocated, the user must have used png_malloc()
1848 or png_zalloc() to allocate it.
1850 If you allocated your row_pointers in a single block, as suggested above in
1851 the description of the high level read interface, you must not transfer
1852 responsibility for freeing it to the png_set_rows or png_read_destroy function,
1853 because they would also try to free the individual row_pointers[i].
1855 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
1856 separately, do not transfer responsibility for freeing text_ptr to libpng,
1857 because when libpng fills a png_text structure it combines these members with
1858 the key member, and png_free_data() will free only text_ptr.key. Similarly,
1859 if you transfer responsibility for free'ing text_ptr from libpng to your
1860 application, your application must not separately free those members.
1862 The png_free_data() function will turn off the "valid" flag for anything
1863 it frees. If you need to turn the flag off for a chunk that was freed by
1864 your application instead of by libpng, you can use
1866 png_set_invalid(png_ptr, info_ptr, mask);
1867 mask - identifies the chunks to be made invalid,
1868 containing the bitwise OR of one or
1870 PNG_INFO_gAMA, PNG_INFO_sBIT,
1871 PNG_INFO_cHRM, PNG_INFO_PLTE,
1872 PNG_INFO_tRNS, PNG_INFO_bKGD,
1873 PNG_INFO_hIST, PNG_INFO_pHYs,
1874 PNG_INFO_oFFs, PNG_INFO_tIME,
1875 PNG_INFO_pCAL, PNG_INFO_sRGB,
1876 PNG_INFO_iCCP, PNG_INFO_sPLT,
1877 PNG_INFO_sCAL, PNG_INFO_IDAT
1879 For a more compact example of reading a PNG image, see the file example.c.
1881 .SS Reading PNG files progressively
1883 The progressive reader is slightly different then the non-progressive
1884 reader. Instead of calling png_read_info(), png_read_rows(), and
1885 png_read_end(), you make one call to png_process_data(), which calls
1886 callbacks when it has the info, a row, or the end of the image. You
1887 set up these callbacks with png_set_progressive_read_fn(). You don't
1888 have to worry about the input/output functions of libpng, as you are
1889 giving the library the data directly in png_process_data(). I will
1890 assume that you have read the section on reading PNG files above,
1891 so I will only highlight the differences (although I will show
1894 png_structp png_ptr;
1897 /* An example code fragment of how you would
1898 initialize the progressive reader in your
1901 initialize_png_reader()
1903 png_ptr = png_create_read_struct
1904 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
1905 user_error_fn, user_warning_fn);
1908 info_ptr = png_create_info_struct(png_ptr);
1911 png_destroy_read_struct(&png_ptr, (png_infopp)NULL,
1916 if (setjmp(png_jmpbuf(png_ptr)))
1918 png_destroy_read_struct(&png_ptr, &info_ptr,
1923 /* This one's new. You can provide functions
1924 to be called when the header info is valid,
1925 when each row is completed, and when the image
1926 is finished. If you aren't using all functions,
1927 you can specify NULL parameters. Even when all
1928 three functions are NULL, you need to call
1929 png_set_progressive_read_fn(). You can use
1930 any struct as the user_ptr (cast to a void pointer
1931 for the function call), and retrieve the pointer
1932 from inside the callbacks using the function
1934 png_get_progressive_ptr(png_ptr);
1936 which will return a void pointer, which you have
1937 to cast appropriately.
1939 png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
1940 info_callback, row_callback, end_callback);
1945 /* A code fragment that you call as you receive blocks
1948 process_data(png_bytep buffer, png_uint_32 length)
1950 if (setjmp(png_jmpbuf(png_ptr)))
1952 png_destroy_read_struct(&png_ptr, &info_ptr,
1957 /* This one's new also. Simply give it a chunk
1958 of data from the file stream (in order, of
1959 course). On machines with segmented memory
1960 models machines, don't give it any more than
1961 64K. The library seems to run fine with sizes
1962 of 4K. Although you can give it much less if
1963 necessary (I assume you can give it chunks of
1964 1 byte, I haven't tried less then 256 bytes
1965 yet). When this function returns, you may
1966 want to display any rows that were generated
1967 in the row callback if you don't already do
1970 png_process_data(png_ptr, info_ptr, buffer, length);
1974 /* This function is called (as set by
1975 png_set_progressive_read_fn() above) when enough data
1976 has been supplied so all of the header has been
1980 info_callback(png_structp png_ptr, png_infop info)
1982 /* Do any setup here, including setting any of
1983 the transformations mentioned in the Reading
1984 PNG files section. For now, you _must_ call
1985 either png_start_read_image() or
1986 png_read_update_info() after all the
1987 transformations are set (even if you don't set
1988 any). You may start getting rows before
1989 png_process_data() returns, so this is your
1990 last chance to prepare for that.
1994 /* This function is called when each row of image
1997 row_callback(png_structp png_ptr, png_bytep new_row,
1998 png_uint_32 row_num, int pass)
2000 /* If the image is interlaced, and you turned
2001 on the interlace handler, this function will
2002 be called for every row in every pass. Some
2003 of these rows will not be changed from the
2004 previous pass. When the row is not changed,
2005 the new_row variable will be NULL. The rows
2006 and passes are called in order, so you don't
2007 really need the row_num and pass, but I'm
2008 supplying them because it may make your life
2011 For the non-NULL rows of interlaced images,
2012 you must call png_progressive_combine_row()
2013 passing in the row and the old row. You can
2014 call this function for NULL rows (it will just
2015 return) and for non-interlaced images (it just
2016 does the memcpy for you) if it will make the
2017 code easier. Thus, you can just do this for
2021 png_progressive_combine_row(png_ptr, old_row,
2024 /* where old_row is what was displayed for
2025 previously for the row. Note that the first
2026 pass (pass == 0, really) will completely cover
2027 the old row, so the rows do not have to be
2028 initialized. After the first pass (and only
2029 for interlaced images), you will have to pass
2030 the current row, and the function will combine
2031 the old row and the new row.
2036 end_callback(png_structp png_ptr, png_infop info)
2038 /* This function is called after the whole image
2039 has been read, including any chunks after the
2040 image (up to and including the IEND). You
2041 will usually have the same info chunk as you
2042 had in the header, although some data may have
2043 been added to the comments and time fields.
2045 Most people won't do much here, perhaps setting
2046 a flag that marks the image as finished.
2054 Much of this is very similar to reading. However, everything of
2055 importance is repeated here, so you won't have to constantly look
2056 back up in the reading section to understand writing.
2060 You will want to do the I/O initialization before you get into libpng,
2061 so if it doesn't work, you don't have anything to undo. If you are not
2062 using the standard I/O functions, you will need to replace them with
2063 custom writing functions. See the discussion under Customizing libpng.
2065 FILE *fp = fopen(file_name, "wb");
2071 Next, png_struct and png_info need to be allocated and initialized.
2072 As these can be both relatively large, you may not want to store these
2073 on the stack, unless you have stack space to spare. Of course, you
2074 will want to check if they return NULL. If you are also reading,
2075 you won't want to name your read structure and your write structure
2076 both "png_ptr"; you can call them anything you like, such as
2077 "read_ptr" and "write_ptr". Look at pngtest.c, for example.
2079 png_structp png_ptr = png_create_write_struct
2080 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
2081 user_error_fn, user_warning_fn);
2085 png_infop info_ptr = png_create_info_struct(png_ptr);
2088 png_destroy_write_struct(&png_ptr,
2093 If you want to use your own memory allocation routines,
2094 define PNG_USER_MEM_SUPPORTED and use
2095 png_create_write_struct_2() instead of png_create_write_struct():
2097 png_structp png_ptr = png_create_write_struct_2
2098 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
2099 user_error_fn, user_warning_fn, (png_voidp)
2100 user_mem_ptr, user_malloc_fn, user_free_fn);
2102 After you have these structures, you will need to set up the
2103 error handling. When libpng encounters an error, it expects to
2104 longjmp() back to your routine. Therefore, you will need to call
2105 setjmp() and pass the png_jmpbuf(png_ptr). If you
2106 write the file from different routines, you will need to update
2107 the png_jmpbuf(png_ptr) every time you enter a new routine that will
2108 call a png_*() function. See your documentation of setjmp/longjmp
2109 for your compiler for more information on setjmp/longjmp. See
2110 the discussion on libpng error handling in the Customizing Libpng
2111 section below for more information on the libpng error handling.
2113 if (setjmp(png_jmpbuf(png_ptr)))
2115 png_destroy_write_struct(&png_ptr, &info_ptr);
2122 If you would rather avoid the complexity of setjmp/longjmp issues,
2123 you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
2124 errors will result in a call to PNG_ABORT() which defaults to abort().
2126 Now you need to set up the output code. The default for libpng is to
2127 use the C function fwrite(). If you use this, you will need to pass a
2128 valid FILE * in the function png_init_io(). Be sure that the file is
2129 opened in binary mode. Again, if you wish to handle writing data in
2130 another way, see the discussion on libpng I/O handling in the Customizing
2131 Libpng section below.
2133 png_init_io(png_ptr, fp);
2135 If you are embedding your PNG into a datastream such as MNG, and don't
2136 want libpng to write the 8-byte signature, or if you have already
2137 written the signature in your application, use
2139 png_set_sig_bytes(png_ptr, 8);
2141 to inform libpng that it should not write a signature.
2145 At this point, you can set up a callback function that will be
2146 called after each row has been written, which you can use to control
2147 a progress meter or the like. It's demonstrated in pngtest.c.
2148 You must supply a function
2150 void write_row_callback(png_ptr, png_uint_32 row,
2153 /* put your code here */
2156 (You can give it another name that you like instead of "write_row_callback")
2158 To inform libpng about your function, use
2160 png_set_write_status_fn(png_ptr, write_row_callback);
2162 You now have the option of modifying how the compression library will
2163 run. The following functions are mainly for testing, but may be useful
2164 in some cases, like if you need to write PNG files extremely fast and
2165 are willing to give up some compression, or if you want to get the
2166 maximum possible compression at the expense of slower writing. If you
2167 have no special needs in this area, let the library do what it wants by
2168 not calling this function at all, as it has been tuned to deliver a good
2169 speed/compression ratio. The second parameter to png_set_filter() is
2170 the filter method, for which the only valid values are 0 (as of the
2171 July 1999 PNG specification, version 1.2) or 64 (if you are writing
2172 a PNG datastream that is to be embedded in a MNG datastream). The third
2173 parameter is a flag that indicates which filter type(s) are to be tested
2174 for each scanline. See the PNG specification for details on the specific
2178 /* turn on or off filtering, and/or choose
2179 specific filters. You can use either a single
2180 PNG_FILTER_VALUE_NAME or the bitwise OR of one
2181 or more PNG_FILTER_NAME masks. */
2182 png_set_filter(png_ptr, 0,
2183 PNG_FILTER_NONE | PNG_FILTER_VALUE_NONE |
2184 PNG_FILTER_SUB | PNG_FILTER_VALUE_SUB |
2185 PNG_FILTER_UP | PNG_FILTER_VALUE_UP |
2186 PNG_FILTER_AVG | PNG_FILTER_VALUE_AVG |
2187 PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
2191 wants to start and stop using particular filters during compression,
2192 it should start out with all of the filters (to ensure that the previous
2193 row of pixels will be stored in case it's needed later), and then add
2194 and remove them after the start of compression.
2196 If you are writing a PNG datastream that is to be embedded in a MNG
2197 datastream, the second parameter can be either 0 or 64.
2199 The png_set_compression_*() functions interface to the zlib compression
2200 library, and should mostly be ignored unless you really know what you are
2201 doing. The only generally useful call is png_set_compression_level()
2202 which changes how much time zlib spends on trying to compress the image
2203 data. See the Compression Library (zlib.h and algorithm.txt, distributed
2204 with zlib) for details on the compression levels.
2206 /* set the zlib compression level */
2207 png_set_compression_level(png_ptr,
2208 Z_BEST_COMPRESSION);
2210 /* set other zlib parameters */
2211 png_set_compression_mem_level(png_ptr, 8);
2212 png_set_compression_strategy(png_ptr,
2213 Z_DEFAULT_STRATEGY);
2214 png_set_compression_window_bits(png_ptr, 15);
2215 png_set_compression_method(png_ptr, 8);
2216 png_set_compression_buffer_size(png_ptr, 8192)
2218 extern PNG_EXPORT(void,png_set_zbuf_size)
2220 .SS Setting the contents of info for output
2222 You now need to fill in the png_info structure with all the data you
2223 wish to write before the actual image. Note that the only thing you
2224 are allowed to write after the image is the text chunks and the time
2225 chunk (as of PNG Specification 1.2, anyway). See png_write_end() and
2226 the latest PNG specification for more information on that. If you
2227 wish to write them before the image, fill them in now, and flag that
2228 data as being valid. If you want to wait until after the data, don't
2229 fill them until png_write_end(). For all the fields in png_info and
2230 their data types, see png.h. For explanations of what the fields
2231 contain, see the PNG specification.
2233 Some of the more important parts of the png_info are:
2235 png_set_IHDR(png_ptr, info_ptr, width, height,
2236 bit_depth, color_type, interlace_type,
2237 compression_type, filter_method)
2238 width - holds the width of the image
2239 in pixels (up to 2^31).
2240 height - holds the height of the image
2241 in pixels (up to 2^31).
2242 bit_depth - holds the bit depth of one of the
2244 (valid values are 1, 2, 4, 8, 16
2245 and depend also on the
2246 color_type. See also significant
2248 color_type - describes which color/alpha
2249 channels are present.
2251 (bit depths 1, 2, 4, 8, 16)
2252 PNG_COLOR_TYPE_GRAY_ALPHA
2254 PNG_COLOR_TYPE_PALETTE
2255 (bit depths 1, 2, 4, 8)
2258 PNG_COLOR_TYPE_RGB_ALPHA
2261 PNG_COLOR_MASK_PALETTE
2262 PNG_COLOR_MASK_COLOR
2263 PNG_COLOR_MASK_ALPHA
2265 interlace_type - PNG_INTERLACE_NONE or
2267 compression_type - (must be
2268 PNG_COMPRESSION_TYPE_DEFAULT)
2269 filter_method - (must be PNG_FILTER_TYPE_DEFAULT
2270 or, if you are writing a PNG to
2271 be embedded in a MNG datastream,
2273 PNG_INTRAPIXEL_DIFFERENCING)
2275 If you call png_set_IHDR(), the call must appear before any of the
2276 other png_set_*() functions, because they might require access to some of
2277 the IHDR settings. The remaining png_set_*() functions can be called
2280 If you wish, you can reset the compression_type, interlace_type, or
2281 filter_method later by calling png_set_IHDR() again; if you do this, the
2282 width, height, bit_depth, and color_type must be the same in each call.
2284 png_set_PLTE(png_ptr, info_ptr, palette,
2286 palette - the palette for the file
2287 (array of png_color)
2288 num_palette - number of entries in the palette
2290 png_set_gAMA(png_ptr, info_ptr, gamma);
2291 gamma - the gamma the image was created
2294 png_set_sRGB(png_ptr, info_ptr, srgb_intent);
2295 srgb_intent - the rendering intent
2296 (PNG_INFO_sRGB) The presence of
2297 the sRGB chunk means that the pixel
2298 data is in the sRGB color space.
2299 This chunk also implies specific
2300 values of gAMA and cHRM. Rendering
2301 intent is the CSS-1 property that
2302 has been defined by the International
2304 (http://www.color.org).
2306 PNG_sRGB_INTENT_SATURATION,
2307 PNG_sRGB_INTENT_PERCEPTUAL,
2308 PNG_sRGB_INTENT_ABSOLUTE, or
2309 PNG_sRGB_INTENT_RELATIVE.
2312 png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
2314 srgb_intent - the rendering intent
2315 (PNG_INFO_sRGB) The presence of the
2316 sRGB chunk means that the pixel
2317 data is in the sRGB color space.
2318 This function also causes gAMA and
2319 cHRM chunks with the specific values
2320 that are consistent with sRGB to be
2323 png_set_iCCP(png_ptr, info_ptr, name, compression_type,
2325 name - The profile name.
2326 compression - The compression type; always
2327 PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
2328 You may give NULL to this argument to
2330 profile - International Color Consortium color
2331 profile data. May contain NULs.
2332 proflen - length of profile data in bytes.
2334 png_set_sBIT(png_ptr, info_ptr, sig_bit);
2335 sig_bit - the number of significant bits for
2336 (PNG_INFO_sBIT) each of the gray, red,
2337 green, and blue channels, whichever are
2338 appropriate for the given color type
2341 png_set_tRNS(png_ptr, info_ptr, trans, num_trans,
2343 trans - array of transparent
2344 entries for palette (PNG_INFO_tRNS)
2345 trans_values - graylevel or color sample values
2346 (in order red, green, blue) of the
2347 single transparent color for
2348 non-paletted images (PNG_INFO_tRNS)
2349 num_trans - number of transparent entries
2352 png_set_hIST(png_ptr, info_ptr, hist);
2354 hist - histogram of palette (array of
2357 png_set_tIME(png_ptr, info_ptr, mod_time);
2358 mod_time - time image was last modified
2361 png_set_bKGD(png_ptr, info_ptr, background);
2362 background - background color (PNG_VALID_bKGD)
2364 png_set_text(png_ptr, info_ptr, text_ptr, num_text);
2365 text_ptr - array of png_text holding image
2367 text_ptr[i].compression - type of compression used
2368 on "text" PNG_TEXT_COMPRESSION_NONE
2369 PNG_TEXT_COMPRESSION_zTXt
2370 PNG_ITXT_COMPRESSION_NONE
2371 PNG_ITXT_COMPRESSION_zTXt
2372 text_ptr[i].key - keyword for comment. Must contain
2374 text_ptr[i].text - text comments for current
2375 keyword. Can be NULL or empty.
2376 text_ptr[i].text_length - length of text string,
2377 after decompression, 0 for iTXt
2378 text_ptr[i].itxt_length - length of itxt string,
2379 after decompression, 0 for tEXt/zTXt
2380 text_ptr[i].lang - language of comment (NULL or
2382 text_ptr[i].translated_keyword - keyword in UTF-8 (NULL
2383 or empty for unknown).
2384 Note that the itxt_length, lang, and lang_key
2385 members of the text_ptr structure only exist
2386 when the library is built with iTXt chunk support.
2388 num_text - number of comments
2390 png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
2392 palette_ptr - array of png_sPLT_struct structures
2393 to be added to the list of palettes
2394 in the info structure.
2395 num_spalettes - number of palette structures to be
2398 png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
2400 offset_x - positive offset from the left
2402 offset_y - positive offset from the top
2404 unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
2406 png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
2408 res_x - pixels/unit physical resolution
2410 res_y - pixels/unit physical resolution
2412 unit_type - PNG_RESOLUTION_UNKNOWN,
2413 PNG_RESOLUTION_METER
2415 png_set_sCAL(png_ptr, info_ptr, unit, width, height)
2416 unit - physical scale units (an integer)
2417 width - width of a pixel in physical scale units
2418 height - height of a pixel in physical scale units
2419 (width and height are doubles)
2421 png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
2422 unit - physical scale units (an integer)
2423 width - width of a pixel in physical scale units
2424 height - height of a pixel in physical scale units
2425 (width and height are strings like "2.54")
2427 png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
2429 unknowns - array of png_unknown_chunk
2430 structures holding unknown chunks
2431 unknowns[i].name - name of unknown chunk
2432 unknowns[i].data - data of unknown chunk
2433 unknowns[i].size - size of unknown chunk's data
2434 unknowns[i].location - position to write chunk in file
2435 0: do not write chunk
2436 PNG_HAVE_IHDR: before PLTE
2437 PNG_HAVE_PLTE: before IDAT
2438 PNG_AFTER_IDAT: after IDAT
2440 The "location" member is set automatically according to
2441 what part of the output file has already been written.
2442 You can change its value after calling png_set_unknown_chunks()
2443 as demonstrated in pngtest.c. Within each of the "locations",
2444 the chunks are sequenced according to their position in the
2445 structure (that is, the value of "i", which is the order in which
2446 the chunk was either read from the input file or defined with
2447 png_set_unknown_chunks).
2449 A quick word about text and num_text. text is an array of png_text
2450 structures. num_text is the number of valid structures in the array.
2451 Each png_text structure holds a language code, a keyword, a text value,
2452 and a compression type.
2454 The compression types have the same valid numbers as the compression
2455 types of the image data. Currently, the only valid number is zero.
2456 However, you can store text either compressed or uncompressed, unlike
2457 images, which always have to be compressed. So if you don't want the
2458 text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
2459 Because tEXt and zTXt chunks don't have a language field, if you
2460 specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
2461 any language code or translated keyword will not be written out.
2463 Until text gets around 1000 bytes, it is not worth compressing it.
2464 After the text has been written out to the file, the compression type
2465 is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
2466 so that it isn't written out again at the end (in case you are calling
2467 png_write_end() with the same struct.
2469 The keywords that are given in the PNG Specification are:
2471 Title Short (one line) title or
2473 Author Name of image's creator
2474 Description Description of image (possibly long)
2475 Copyright Copyright notice
2476 Creation Time Time of original image creation
2477 (usually RFC 1123 format, see below)
2478 Software Software used to create the image
2479 Disclaimer Legal disclaimer
2480 Warning Warning of nature of content
2481 Source Device used to create the image
2482 Comment Miscellaneous comment; conversion
2483 from other image format
2485 The keyword-text pairs work like this. Keywords should be short
2486 simple descriptions of what the comment is about. Some typical
2487 keywords are found in the PNG specification, as is some recommendations
2488 on keywords. You can repeat keywords in a file. You can even write
2489 some text before the image and some after. For example, you may want
2490 to put a description of the image before the image, but leave the
2491 disclaimer until after, so viewers working over modem connections
2492 don't have to wait for the disclaimer to go over the modem before
2493 they start seeing the image. Finally, keywords should be full
2494 words, not abbreviations. Keywords and text are in the ISO 8859-1
2495 (Latin-1) character set (a superset of regular ASCII) and can not
2496 contain NUL characters, and should not contain control or other
2497 unprintable characters. To make the comments widely readable, stick
2498 with basic ASCII, and avoid machine specific character set extensions
2499 like the IBM-PC character set. The keyword must be present, but
2500 you can leave off the text string on non-compressed pairs.
2501 Compressed pairs must have a text string, as only the text string
2502 is compressed anyway, so the compression would be meaningless.
2504 PNG supports modification time via the png_time structure. Two
2505 conversion routines are provided, png_convert_from_time_t() for
2506 time_t and png_convert_from_struct_tm() for struct tm. The
2507 time_t routine uses gmtime(). You don't have to use either of
2508 these, but if you wish to fill in the png_time structure directly,
2509 you should provide the time in universal time (GMT) if possible
2510 instead of your local time. Note that the year number is the full
2511 year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
2512 that months start with 1.
2514 If you want to store the time of the original image creation, you should
2515 use a plain tEXt chunk with the "Creation Time" keyword. This is
2516 necessary because the "creation time" of a PNG image is somewhat vague,
2517 depending on whether you mean the PNG file, the time the image was
2518 created in a non-PNG format, a still photo from which the image was
2519 scanned, or possibly the subject matter itself. In order to facilitate
2520 machine-readable dates, it is recommended that the "Creation Time"
2521 tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
2522 although this isn't a requirement. Unlike the tIME chunk, the
2523 "Creation Time" tEXt chunk is not expected to be automatically changed
2524 by the software. To facilitate the use of RFC 1123 dates, a function
2525 png_convert_to_rfc1123(png_timep) is provided to convert from PNG
2526 time to an RFC 1123 format string.
2528 .SS Writing unknown chunks
2530 You can use the png_set_unknown_chunks function to queue up chunks
2531 for writing. You give it a chunk name, raw data, and a size; that's
2532 all there is to it. The chunks will be written by the next following
2533 png_write_info_before_PLTE, png_write_info, or png_write_end function.
2534 Any chunks previously read into the info structure's unknown-chunk
2535 list will also be written out in a sequence that satisfies the PNG
2536 specification's ordering rules.
2538 .SS The high-level write interface
2540 At this point there are two ways to proceed; through the high-level
2541 write interface, or through a sequence of low-level write operations.
2542 You can use the high-level interface if your image data is present
2543 in the info structure. All defined output
2544 transformations are permitted, enabled by the following masks.
2546 PNG_TRANSFORM_IDENTITY No transformation
2547 PNG_TRANSFORM_PACKING Pack 1, 2 and 4-bit samples
2548 PNG_TRANSFORM_PACKSWAP Change order of packed
2550 PNG_TRANSFORM_INVERT_MONO Invert monochrome images
2551 PNG_TRANSFORM_SHIFT Normalize pixels to the
2553 PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
2555 PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
2557 PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
2559 PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
2560 PNG_TRANSFORM_STRIP_FILLER Strip out filler
2562 PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
2564 PNG_TRANSFORM_STRIP_FILLER_AFTER Strip out trailing
2567 If you have valid image data in the info structure (you can use
2568 png_set_rows() to put image data in the info structure), simply do this:
2570 png_write_png(png_ptr, info_ptr, png_transforms, NULL)
2572 where png_transforms is an integer containing the bitwise OR of some set of
2573 transformation flags. This call is equivalent to png_write_info(),
2574 followed the set of transformations indicated by the transform mask,
2575 then png_write_image(), and finally png_write_end().
2577 (The final parameter of this call is not yet used. Someday it might point
2578 to transformation parameters required by some future output transform.)
2580 You must use png_transforms and not call any png_set_transform() functions
2581 when you use png_write_png().
2583 .SS The low-level write interface
2585 If you are going the low-level route instead, you are now ready to
2586 write all the file information up to the actual image data. You do
2587 this with a call to png_write_info().
2589 png_write_info(png_ptr, info_ptr);
2591 Note that there is one transformation you may need to do before
2592 png_write_info(). In PNG files, the alpha channel in an image is the
2593 level of opacity. If your data is supplied as a level of transparency,
2594 you can invert the alpha channel before you write it, so that 0 is
2595 fully transparent and 255 (in 8-bit or paletted images) or 65535
2596 (in 16-bit images) is fully opaque, with
2598 png_set_invert_alpha(png_ptr);
2600 This must appear before png_write_info() instead of later with the
2601 other transformations because in the case of paletted images the tRNS
2602 chunk data has to be inverted before the tRNS chunk is written. If
2603 your image is not a paletted image, the tRNS data (which in such cases
2604 represents a single color to be rendered as transparent) won't need to
2605 be changed, and you can safely do this transformation after your
2606 png_write_info() call.
2608 If you need to write a private chunk that you want to appear before
2609 the PLTE chunk when PLTE is present, you can write the PNG info in
2610 two steps, and insert code to write your own chunk between them:
2612 png_write_info_before_PLTE(png_ptr, info_ptr);
2613 png_set_unknown_chunks(png_ptr, info_ptr, ...);
2614 png_write_info(png_ptr, info_ptr);
2616 After you've written the file information, you can set up the library
2617 to handle any special transformations of the image data. The various
2618 ways to transform the data will be described in the order that they
2619 should occur. This is important, as some of these change the color
2620 type and/or bit depth of the data, and some others only work on
2621 certain color types and bit depths. Even though each transformation
2622 checks to see if it has data that it can do something with, you should
2623 make sure to only enable a transformation if it will be valid for the
2624 data. For example, don't swap red and blue on grayscale data.
2626 PNG files store RGB pixels packed into 3 or 6 bytes. This code tells
2627 the library to strip input data that has 4 or 8 bytes per pixel down
2628 to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
2631 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
2633 where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
2634 PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
2635 is stored XRGB or RGBX.
2637 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
2638 they can, resulting in, for example, 8 pixels per byte for 1 bit files.
2639 If the data is supplied at 1 pixel per byte, use this code, which will
2640 correctly pack the pixels into a single byte:
2642 png_set_packing(png_ptr);
2644 PNG files reduce possible bit depths to 1, 2, 4, 8, and 16. If your
2645 data is of another bit depth, you can write an sBIT chunk into the
2646 file so that decoders can recover the original data if desired.
2648 /* Set the true bit depth of the image data */
2649 if (color_type & PNG_COLOR_MASK_COLOR)
2651 sig_bit.red = true_bit_depth;
2652 sig_bit.green = true_bit_depth;
2653 sig_bit.blue = true_bit_depth;
2657 sig_bit.gray = true_bit_depth;
2659 if (color_type & PNG_COLOR_MASK_ALPHA)
2661 sig_bit.alpha = true_bit_depth;
2664 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
2666 If the data is stored in the row buffer in a bit depth other than
2667 one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
2668 this will scale the values to appear to be the correct bit depth as
2671 png_set_shift(png_ptr, &sig_bit);
2673 PNG files store 16 bit pixels in network byte order (big-endian,
2674 ie. most significant bits first). This code would be used if they are
2675 supplied the other way (little-endian, i.e. least significant bits
2676 first, the way PCs store them):
2679 png_set_swap(png_ptr);
2681 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
2682 need to change the order the pixels are packed into bytes, you can use:
2685 png_set_packswap(png_ptr);
2687 PNG files store 3 color pixels in red, green, blue order. This code
2688 would be used if they are supplied as blue, green, red:
2690 png_set_bgr(png_ptr);
2692 PNG files describe monochrome as black being zero and white being
2693 one. This code would be used if the pixels are supplied with this reversed
2694 (black being one and white being zero):
2696 png_set_invert_mono(png_ptr);
2698 Finally, you can write your own transformation function if none of
2699 the existing ones meets your needs. This is done by setting a callback
2702 png_set_write_user_transform_fn(png_ptr,
2703 write_transform_fn);
2705 You must supply the function
2707 void write_transform_fn(png_ptr ptr, row_info_ptr
2708 row_info, png_bytep data)
2710 See pngtest.c for a working example. Your function will be called
2711 before any of the other transformations are processed.
2713 You can also set up a pointer to a user structure for use by your
2716 png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
2718 The user_channels and user_depth parameters of this function are ignored
2719 when writing; you can set them to zero as shown.
2721 You can retrieve the pointer via the function png_get_user_transform_ptr().
2724 voidp write_user_transform_ptr =
2725 png_get_user_transform_ptr(png_ptr);
2727 It is possible to have libpng flush any pending output, either manually,
2728 or automatically after a certain number of lines have been written. To
2729 flush the output stream a single time call:
2731 png_write_flush(png_ptr);
2733 and to have libpng flush the output stream periodically after a certain
2734 number of scanlines have been written, call:
2736 png_set_flush(png_ptr, nrows);
2738 Note that the distance between rows is from the last time png_write_flush()
2739 was called, or the first row of the image if it has never been called.
2740 So if you write 50 lines, and then png_set_flush 25, it will flush the
2741 output on the next scanline, and every 25 lines thereafter, unless
2742 png_write_flush() is called before 25 more lines have been written.
2743 If nrows is too small (less than about 10 lines for a 640 pixel wide
2744 RGB image) the image compression may decrease noticeably (although this
2745 may be acceptable for real-time applications). Infrequent flushing will
2746 only degrade the compression performance by a few percent over images
2747 that do not use flushing.
2749 .SS Writing the image data
2751 That's it for the transformations. Now you can write the image data.
2752 The simplest way to do this is in one function call. If you have the
2753 whole image in memory, you can just call png_write_image() and libpng
2754 will write the image. You will need to pass in an array of pointers to
2755 each row. This function automatically handles interlacing, so you don't
2756 need to call png_set_interlace_handling() or call this function multiple
2757 times, or any of that other stuff necessary with png_write_rows().
2759 png_write_image(png_ptr, row_pointers);
2761 where row_pointers is:
2763 png_byte *row_pointers[height];
2765 You can point to void or char or whatever you use for pixels.
2767 If you don't want to write the whole image at once, you can
2768 use png_write_rows() instead. If the file is not interlaced,
2771 png_write_rows(png_ptr, row_pointers,
2774 row_pointers is the same as in the png_write_image() call.
2776 If you are just writing one row at a time, you can do this with
2777 a single row_pointer instead of an array of row_pointers:
2779 png_bytep row_pointer = row;
2781 png_write_row(png_ptr, row_pointer);
2783 When the file is interlaced, things can get a good deal more complicated.
2784 The only currently (as of the PNG Specification version 1.2, dated July
2785 1999) defined interlacing scheme for PNG files is the "Adam7" interlace
2786 scheme, that breaks down an image into seven smaller images of varying
2787 size. libpng will build these images for you, or you can do them
2788 yourself. If you want to build them yourself, see the PNG specification
2789 for details of which pixels to write when.
2791 If you don't want libpng to handle the interlacing details, just
2792 use png_set_interlace_handling() and call png_write_rows() the
2793 correct number of times to write all seven sub-images.
2795 If you want libpng to build the sub-images, call this before you start
2799 png_set_interlace_handling(png_ptr);
2801 This will return the number of passes needed. Currently, this is seven,
2802 but may change if another interlace type is added.
2804 Then write the complete image number_of_passes times.
2806 png_write_rows(png_ptr, row_pointers,
2809 As some of these rows are not used, and thus return immediately, you may
2810 want to read about interlacing in the PNG specification, and only update
2811 the rows that are actually used.
2813 .SS Finishing a sequential write
2815 After you are finished writing the image, you should finish writing
2816 the file. If you are interested in writing comments or time, you should
2817 pass an appropriately filled png_info pointer. If you are not interested,
2820 png_write_end(png_ptr, info_ptr);
2822 When you are done, you can free all memory used by libpng like this:
2824 png_destroy_write_struct(&png_ptr, &info_ptr);
2826 It is also possible to individually free the info_ptr members that
2827 point to libpng-allocated storage with the following function:
2829 png_free_data(png_ptr, info_ptr, mask, seq)
2830 mask - identifies data to be freed, a mask
2831 containing the bitwise OR of one or
2833 PNG_FREE_PLTE, PNG_FREE_TRNS,
2834 PNG_FREE_HIST, PNG_FREE_ICCP,
2835 PNG_FREE_PCAL, PNG_FREE_ROWS,
2836 PNG_FREE_SCAL, PNG_FREE_SPLT,
2837 PNG_FREE_TEXT, PNG_FREE_UNKN,
2838 or simply PNG_FREE_ALL
2839 seq - sequence number of item to be freed
2842 This function may be safely called when the relevant storage has
2843 already been freed, or has not yet been allocated, or was allocated
2844 by the user and not by libpng, and will in those cases do nothing.
2845 The "seq" parameter is ignored if only one item of the selected data
2846 type, such as PLTE, is allowed. If "seq" is not \-1, and multiple items
2847 are allowed for the data type identified in the mask, such as text or
2848 sPLT, only the n'th item in the structure is freed, where n is "seq".
2850 If you allocated data such as a palette that you passed in to libpng
2851 with png_set_*, you must not free it until just before the call to
2852 png_destroy_write_struct().
2854 The default behavior is only to free data that was allocated internally
2855 by libpng. This can be changed, so that libpng will not free the data,
2856 or so that it will free data that was allocated by the user with png_malloc()
2857 or png_zalloc() and passed in via a png_set_*() function, with
2859 png_data_freer(png_ptr, info_ptr, freer, mask)
2860 mask - which data elements are affected
2861 same choices as in png_free_data()
2863 PNG_DESTROY_WILL_FREE_DATA
2864 PNG_SET_WILL_FREE_DATA
2865 PNG_USER_WILL_FREE_DATA
2867 For example, to transfer responsibility for some data from a read structure
2868 to a write structure, you could use
2870 png_data_freer(read_ptr, read_info_ptr,
2871 PNG_USER_WILL_FREE_DATA,
2872 PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
2873 png_data_freer(write_ptr, write_info_ptr,
2874 PNG_DESTROY_WILL_FREE_DATA,
2875 PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
2877 thereby briefly reassigning responsibility for freeing to the user but
2878 immediately afterwards reassigning it once more to the write_destroy
2879 function. Having done this, it would then be safe to destroy the read
2880 structure and continue to use the PLTE, tRNS, and hIST data in the write
2883 This function only affects data that has already been allocated.
2884 You can call this function before calling after the png_set_*() functions
2885 to control whether the user or png_destroy_*() is supposed to free the data.
2886 When the user assumes responsibility for libpng-allocated data, the
2887 application must use
2888 png_free() to free it, and when the user transfers responsibility to libpng
2889 for data that the user has allocated, the user must have used png_malloc()
2890 or png_zalloc() to allocate it.
2892 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
2893 separately, do not transfer responsibility for freeing text_ptr to libpng,
2894 because when libpng fills a png_text structure it combines these members with
2895 the key member, and png_free_data() will free only text_ptr.key. Similarly,
2896 if you transfer responsibility for free'ing text_ptr from libpng to your
2897 application, your application must not separately free those members.
2898 For a more compact example of writing a PNG image, see the file example.c.
2900 .SH V. Modifying/Customizing libpng:
2902 There are two issues here. The first is changing how libpng does
2903 standard things like memory allocation, input/output, and error handling.
2904 The second deals with more complicated things like adding new chunks,
2905 adding new transformations, and generally changing how libpng works.
2906 Both of those are compile-time issues; that is, they are generally
2907 determined at the time the code is written, and there is rarely a need
2908 to provide the user with a means of changing them.
2910 Memory allocation, input/output, and error handling
2912 All of the memory allocation, input/output, and error handling in libpng
2913 goes through callbacks that are user-settable. The default routines are
2914 in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively. To change
2915 these functions, call the appropriate png_set_*_fn() function.
2917 Memory allocation is done through the functions png_malloc(), png_calloc(),
2918 and png_free(). These currently just call the standard C functions.
2919 png_calloc() calls png_malloc() and then png_memset() to clear the newly
2920 allocated memory to zero. If your pointers can't access more then 64K
2921 at a time, you will want to set MAXSEG_64K in zlib.h. Since it is
2922 unlikely that the method of handling memory allocation on a platform
2923 will change between applications, these functions must be modified in
2924 the library at compile time. If you prefer to use a different method
2925 of allocating and freeing data, you can use png_create_read_struct_2() or
2926 png_create_write_struct_2() to register your own functions as described
2927 above. These functions also provide a void pointer that can be retrieved
2930 mem_ptr=png_get_mem_ptr(png_ptr);
2932 Your replacement memory functions must have prototypes as follows:
2934 png_voidp malloc_fn(png_structp png_ptr,
2936 void free_fn(png_structp png_ptr, png_voidp ptr);
2938 Your malloc_fn() must return NULL in case of failure. The png_malloc()
2939 function will normally call png_error() if it receives a NULL from the
2940 system memory allocator or from your replacement malloc_fn().
2942 Your free_fn() will never be called with a NULL ptr, since libpng's
2943 png_free() checks for NULL before calling free_fn().
2945 Input/Output in libpng is done through png_read() and png_write(),
2946 which currently just call fread() and fwrite(). The FILE * is stored in
2947 png_struct and is initialized via png_init_io(). If you wish to change
2948 the method of I/O, the library supplies callbacks that you can set
2949 through the function png_set_read_fn() and png_set_write_fn() at run
2950 time, instead of calling the png_init_io() function. These functions
2951 also provide a void pointer that can be retrieved via the function
2952 png_get_io_ptr(). For example:
2954 png_set_read_fn(png_structp read_ptr,
2955 voidp read_io_ptr, png_rw_ptr read_data_fn)
2957 png_set_write_fn(png_structp write_ptr,
2958 voidp write_io_ptr, png_rw_ptr write_data_fn,
2959 png_flush_ptr output_flush_fn);
2961 voidp read_io_ptr = png_get_io_ptr(read_ptr);
2962 voidp write_io_ptr = png_get_io_ptr(write_ptr);
2964 The replacement I/O functions must have prototypes as follows:
2966 void user_read_data(png_structp png_ptr,
2967 png_bytep data, png_size_t length);
2968 void user_write_data(png_structp png_ptr,
2969 png_bytep data, png_size_t length);
2970 void user_flush_data(png_structp png_ptr);
2972 The user_read_data() function is responsible for detecting and
2973 handling end-of-data errors.
2975 Supplying NULL for the read, write, or flush functions sets them back
2976 to using the default C stream functions, which expect the io_ptr to
2977 point to a standard *FILE structure. It is probably a mistake
2978 to use NULL for one of write_data_fn and output_flush_fn but not both
2979 of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
2980 It is an error to read from a write stream, and vice versa.
2982 Error handling in libpng is done through png_error() and png_warning().
2983 Errors handled through png_error() are fatal, meaning that png_error()
2984 should never return to its caller. Currently, this is handled via
2985 setjmp() and longjmp() (unless you have compiled libpng with
2986 PNG_SETJMP_NOT_SUPPORTED, in which case it is handled via PNG_ABORT()),
2987 but you could change this to do things like exit() if you should wish.
2989 On non-fatal errors, png_warning() is called
2990 to print a warning message, and then control returns to the calling code.
2991 By default png_error() and png_warning() print a message on stderr via
2992 fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
2993 (because you don't want the messages) or PNG_NO_STDIO defined (because
2994 fprintf() isn't available). If you wish to change the behavior of the error
2995 functions, you will need to set up your own message callbacks. These
2996 functions are normally supplied at the time that the png_struct is created.
2997 It is also possible to redirect errors and warnings to your own replacement
2998 functions after png_create_*_struct() has been called by calling:
3000 png_set_error_fn(png_structp png_ptr,
3001 png_voidp error_ptr, png_error_ptr error_fn,
3002 png_error_ptr warning_fn);
3004 png_voidp error_ptr = png_get_error_ptr(png_ptr);
3006 If NULL is supplied for either error_fn or warning_fn, then the libpng
3007 default function will be used, calling fprintf() and/or longjmp() if a
3008 problem is encountered. The replacement error functions should have
3009 parameters as follows:
3011 void user_error_fn(png_structp png_ptr,
3012 png_const_charp error_msg);
3013 void user_warning_fn(png_structp png_ptr,
3014 png_const_charp warning_msg);
3016 The motivation behind using setjmp() and longjmp() is the C++ throw and
3017 catch exception handling methods. This makes the code much easier to write,
3018 as there is no need to check every return code of every function call.
3019 However, there are some uncertainties about the status of local variables
3020 after a longjmp, so the user may want to be careful about doing anything
3021 after setjmp returns non-zero besides returning itself. Consult your
3022 compiler documentation for more details. For an alternative approach, you
3023 may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net).
3027 If you need to read or write custom chunks, you may need to get deeper
3028 into the libpng code. The library now has mechanisms for storing
3029 and writing chunks of unknown type; you can even declare callbacks
3030 for custom chunks. However, this may not be good enough if the
3031 library code itself needs to know about interactions between your
3032 chunk and existing `intrinsic' chunks.
3034 If you need to write a new intrinsic chunk, first read the PNG
3035 specification. Acquire a first level of understanding of how it works.
3036 Pay particular attention to the sections that describe chunk names,
3037 and look at how other chunks were designed, so you can do things
3038 similarly. Second, check out the sections of libpng that read and
3039 write chunks. Try to find a chunk that is similar to yours and use
3040 it as a template. More details can be found in the comments inside
3041 the code. It is best to handle unknown chunks in a generic method,
3042 via callback functions, instead of by modifying libpng functions.
3044 If you wish to write your own transformation for the data, look through
3045 the part of the code that does the transformations, and check out some of
3046 the simpler ones to get an idea of how they work. Try to find a similar
3047 transformation to the one you want to add and copy off of it. More details
3048 can be found in the comments inside the code itself.
3050 .SS Configuring for 16 bit platforms
3052 You will want to look into zconf.h to tell zlib (and thus libpng) that
3053 it cannot allocate more then 64K at a time. Even if you can, the memory
3054 won't be accessible. So limit zlib and libpng to 64K by defining MAXSEG_64K.
3056 .SS Configuring for DOS
3058 For DOS users who only have access to the lower 640K, you will
3059 have to limit zlib's memory usage via a png_set_compression_mem_level()
3060 call. See zlib.h or zconf.h in the zlib library for more information.
3062 .SS Configuring for Medium Model
3064 Libpng's support for medium model has been tested on most of the popular
3065 compilers. Make sure MAXSEG_64K gets defined, USE_FAR_KEYWORD gets
3066 defined, and FAR gets defined to far in pngconf.h, and you should be
3067 all set. Everything in the library (except for zlib's structure) is
3068 expecting far data. You must use the typedefs with the p or pp on
3069 the end for pointers (or at least look at them and be careful). Make
3070 note that the rows of data are defined as png_bytepp, which is an
3071 unsigned char far * far *.
3073 .SS Configuring for gui/windowing platforms:
3075 You will need to write new error and warning functions that use the GUI
3076 interface, as described previously, and set them to be the error and
3077 warning functions at the time that png_create_*_struct() is called,
3078 in order to have them available during the structure initialization.
3079 They can be changed later via png_set_error_fn(). On some compilers,
3080 you may also have to change the memory allocators (png_malloc, etc.).
3082 .SS Configuring for compiler xxx:
3084 All includes for libpng are in pngconf.h. If you need to add, change
3085 or delete an include, this is the place to do it.
3086 The includes that are not needed outside libpng are protected by the
3087 PNG_INTERNAL definition, which is only defined for those routines inside
3088 libpng itself. The files in libpng proper only include png.h, which
3091 .SS Configuring zlib:
3093 There are special functions to configure the compression. Perhaps the
3094 most useful one changes the compression level, which currently uses
3095 input compression values in the range 0 - 9. The library normally
3096 uses the default compression level (Z_DEFAULT_COMPRESSION = 6). Tests
3097 have shown that for a large majority of images, compression values in
3098 the range 3-6 compress nearly as well as higher levels, and do so much
3099 faster. For online applications it may be desirable to have maximum speed
3100 (Z_BEST_SPEED = 1). With versions of zlib after v0.99, you can also
3101 specify no compression (Z_NO_COMPRESSION = 0), but this would create
3102 files larger than just storing the raw bitmap. You can specify the
3103 compression level by calling:
3105 png_set_compression_level(png_ptr, level);
3107 Another useful one is to reduce the memory level used by the library.
3108 The memory level defaults to 8, but it can be lowered if you are
3109 short on memory (running DOS, for example, where you only have 640K).
3110 Note that the memory level does have an effect on compression; among
3111 other things, lower levels will result in sections of incompressible
3112 data being emitted in smaller stored blocks, with a correspondingly
3113 larger relative overhead of up to 15% in the worst case.
3115 png_set_compression_mem_level(png_ptr, level);
3117 The other functions are for configuring zlib. They are not recommended
3118 for normal use and may result in writing an invalid PNG file. See
3119 zlib.h for more information on what these mean.
3121 png_set_compression_strategy(png_ptr,
3123 png_set_compression_window_bits(png_ptr,
3125 png_set_compression_method(png_ptr, method);
3126 png_set_compression_buffer_size(png_ptr, size);
3128 .SS Controlling row filtering
3130 If you want to control whether libpng uses filtering or not, which
3131 filters are used, and how it goes about picking row filters, you
3132 can call one of these functions. The selection and configuration
3133 of row filters can have a significant impact on the size and
3134 encoding speed and a somewhat lesser impact on the decoding speed
3135 of an image. Filtering is enabled by default for RGB and grayscale
3136 images (with and without alpha), but not for paletted images nor
3137 for any images with bit depths less than 8 bits/pixel.
3139 The 'method' parameter sets the main filtering method, which is
3140 currently only '0' in the PNG 1.2 specification. The 'filters'
3141 parameter sets which filter(s), if any, should be used for each
3142 scanline. Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS
3143 to turn filtering on and off, respectively.
3145 Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
3146 PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
3147 ORed together with '|' to specify one or more filters to use.
3148 These filters are described in more detail in the PNG specification.
3149 If you intend to change the filter type during the course of writing
3150 the image, you should start with flags set for all of the filters
3151 you intend to use so that libpng can initialize its internal
3152 structures appropriately for all of the filter types. (Note that this
3153 means the first row must always be adaptively filtered, because libpng
3154 currently does not allocate the filter buffers until png_write_row()
3155 is called for the first time.)
3157 filters = PNG_FILTER_NONE | PNG_FILTER_SUB
3158 PNG_FILTER_UP | PNG_FILTER_AVG |
3159 PNG_FILTER_PAETH | PNG_ALL_FILTERS;
3161 png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
3163 The second parameter can also be
3164 PNG_INTRAPIXEL_DIFFERENCING if you are
3165 writing a PNG to be embedded in a MNG
3166 datastream. This parameter must be the
3167 same as the value of filter_method used
3170 It is also possible to influence how libpng chooses from among the
3171 available filters. This is done in one or both of two ways - by
3172 telling it how important it is to keep the same filter for successive
3173 rows, and by telling it the relative computational costs of the filters.
3175 double weights[3] = {1.5, 1.3, 1.1},
3176 costs[PNG_FILTER_VALUE_LAST] =
3177 {1.0, 1.3, 1.3, 1.5, 1.7};
3179 png_set_filter_heuristics(png_ptr,
3180 PNG_FILTER_HEURISTIC_WEIGHTED, 3,
3183 The weights are multiplying factors that indicate to libpng that the
3184 row filter should be the same for successive rows unless another row filter
3185 is that many times better than the previous filter. In the above example,
3186 if the previous 3 filters were SUB, SUB, NONE, the SUB filter could have a
3187 "sum of absolute differences" 1.5 x 1.3 times higher than other filters
3188 and still be chosen, while the NONE filter could have a sum 1.1 times
3189 higher than other filters and still be chosen. Unspecified weights are
3190 taken to be 1.0, and the specified weights should probably be declining
3191 like those above in order to emphasize recent filters over older filters.
3193 The filter costs specify for each filter type a relative decoding cost
3194 to be considered when selecting row filters. This means that filters
3195 with higher costs are less likely to be chosen over filters with lower
3196 costs, unless their "sum of absolute differences" is that much smaller.
3197 The costs do not necessarily reflect the exact computational speeds of
3198 the various filters, since this would unduly influence the final image
3201 Note that the numbers above were invented purely for this example and
3202 are given only to help explain the function usage. Little testing has
3203 been done to find optimum values for either the costs or the weights.
3205 .SS Removing unwanted object code
3207 There are a bunch of #define's in pngconf.h that control what parts of
3208 libpng are compiled. All the defines end in _SUPPORTED. If you are
3209 never going to use a capability, you can change the #define to #undef
3210 before recompiling libpng and save yourself code and data space, or
3211 you can turn off individual capabilities with defines that begin with
3214 You can also turn all of the transforms and ancillary chunk capabilities
3215 off en masse with compiler directives that define
3216 PNG_NO_READ[or WRITE]_TRANSFORMS, or PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS,
3218 along with directives to turn on any of the capabilities that you do
3219 want. The PNG_NO_READ[or WRITE]_TRANSFORMS directives disable the extra
3220 transformations but still leave the library fully capable of reading
3221 and writing PNG files with all known public chunks. Use of the
3222 PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS directive produces a library
3223 that is incapable of reading or writing ancillary chunks. If you are
3224 not using the progressive reading capability, you can turn that off
3225 with PNG_NO_PROGRESSIVE_READ (don't confuse this with the INTERLACING
3226 capability, which you'll still have).
3228 All the reading and writing specific code are in separate files, so the
3229 linker should only grab the files it needs. However, if you want to
3230 make sure, or if you are building a stand alone library, all the
3231 reading files start with pngr and all the writing files start with
3232 pngw. The files that don't match either (like png.c, pngtrans.c, etc.)
3233 are used for both reading and writing, and always need to be included.
3234 The progressive reader is in pngpread.c
3236 If you are creating or distributing a dynamically linked library (a .so
3237 or DLL file), you should not remove or disable any parts of the library,
3238 as this will cause applications linked with different versions of the
3239 library to fail if they call functions not available in your library.
3240 The size of the library itself should not be an issue, because only
3241 those sections that are actually used will be loaded into memory.
3243 .SS Requesting debug printout
3245 The macro definition PNG_DEBUG can be used to request debugging
3246 printout. Set it to an integer value in the range 0 to 3. Higher
3247 numbers result in increasing amounts of debugging information. The
3248 information is printed to the "stderr" file, unless another file
3249 name is specified in the PNG_DEBUG_FILE macro definition.
3251 When PNG_DEBUG > 0, the following functions (macros) become available:
3253 png_debug(level, message)
3254 png_debug1(level, message, p1)
3255 png_debug2(level, message, p1, p2)
3257 in which "level" is compared to PNG_DEBUG to decide whether to print
3258 the message, "message" is the formatted string to be printed,
3259 and p1 and p2 are parameters that are to be embedded in the string
3260 according to printf-style formatting directives. For example,
3262 png_debug1(2, "foo=%d", foo);
3267 fprintf(PNG_DEBUG_FILE, "foo=%d\en", foo);
3269 When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
3270 can still use PNG_DEBUG to control your own debugging:
3276 When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
3277 having level = 0 will be printed. There aren't any such statements in
3278 this version of libpng, but if you insert some they will be printed.
3282 The MNG specification (available at http://www.libpng.org/pub/mng) allows
3283 certain extensions to PNG for PNG images that are embedded in MNG datastreams.
3284 Libpng can support some of these extensions. To enable them, use the
3285 png_permit_mng_features() function:
3287 feature_set = png_permit_mng_features(png_ptr, mask)
3288 mask is a png_uint_32 containing the bitwise OR of the
3289 features you want to enable. These include
3290 PNG_FLAG_MNG_EMPTY_PLTE
3291 PNG_FLAG_MNG_FILTER_64
3292 PNG_ALL_MNG_FEATURES
3293 feature_set is a png_uint_32 that is the bitwise AND of
3294 your mask with the set of MNG features that is
3295 supported by the version of libpng that you are using.
3297 It is an error to use this function when reading or writing a standalone
3298 PNG file with the PNG 8-byte signature. The PNG datastream must be wrapped
3299 in a MNG datastream. As a minimum, it must have the MNG 8-byte signature
3300 and the MHDR and MEND chunks. Libpng does not provide support for these
3301 or any other MNG chunks; your application must provide its own support for
3302 them. You may wish to consider using libmng (available at
3303 http://www.libmng.com) instead.
3305 .SH VII. Changes to Libpng from version 0.88
3307 It should be noted that versions of libpng later than 0.96 are not
3308 distributed by the original libpng author, Guy Schalnat, nor by
3309 Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
3310 distributed versions 0.89 through 0.96, but rather by another member
3311 of the original PNG Group, Glenn Randers-Pehrson. Guy and Andreas are
3312 still alive and well, but they have moved on to other things.
3314 The old libpng functions png_read_init(), png_write_init(),
3315 png_info_init(), png_read_destroy(), and png_write_destroy() have been
3316 moved to PNG_INTERNAL in version 0.95 to discourage their use. These
3317 functions will be removed from libpng version 2.0.0.
3319 The preferred method of creating and initializing the libpng structures is
3320 via the png_create_read_struct(), png_create_write_struct(), and
3321 png_create_info_struct() because they isolate the size of the structures
3322 from the application, allow version error checking, and also allow the
3323 use of custom error handling routines during the initialization, which
3324 the old functions do not. The functions png_read_destroy() and
3325 png_write_destroy() do not actually free the memory that libpng
3326 allocated for these structs, but just reset the data structures, so they
3327 can be used instead of png_destroy_read_struct() and
3328 png_destroy_write_struct() if you feel there is too much system overhead
3329 allocating and freeing the png_struct for each image read.
3331 Setting the error callbacks via png_set_message_fn() before
3332 png_read_init() as was suggested in libpng-0.88 is no longer supported
3333 because this caused applications that do not use custom error functions
3334 to fail if the png_ptr was not initialized to zero. It is still possible
3335 to set the error callbacks AFTER png_read_init(), or to change them with
3336 png_set_error_fn(), which is essentially the same function, but with a new
3337 name to force compilation errors with applications that try to use the old
3340 Support for the sCAL, iCCP, iTXt, and sPLT chunks was added at libpng-1.0.6;
3341 however, iTXt support was not enabled by default.
3343 Starting with version 1.0.7, you can find out which version of the library
3344 you are using at run-time:
3346 png_uint_32 libpng_vn = png_access_version_number();
3348 The number libpng_vn is constructed from the major version, minor
3349 version with leading zero, and release number with leading zero,
3350 (e.g., libpng_vn for version 1.0.7 is 10007).
3352 You can also check which version of png.h you used when compiling your
3355 png_uint_32 application_vn = PNG_LIBPNG_VER;
3357 .SH VIII. Changes to Libpng from version 1.0.x to 1.2.x
3359 Support for user memory management was enabled by default. To
3360 accomplish this, the functions png_create_read_struct_2(),
3361 png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
3362 png_malloc_default(), and png_free_default() were added.
3364 Support for the iTXt chunk has been enabled by default as of
3367 Support for certain MNG features was enabled.
3369 Support for numbered error messages was added. However, we never got
3370 around to actually numbering the error messages. The function
3371 png_set_strip_error_numbers() was added (Note: the prototype for this
3372 function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
3373 builds of libpng-1.2.15. It was restored in libpng-1.2.36).
3375 The png_malloc_warn() function was added at libpng-1.2.3. This issues
3376 a png_warning and returns NULL instead of aborting when it fails to
3377 acquire the requested memory allocation.
3379 Support for setting user limits on image width and height was enabled
3380 by default. The functions png_set_user_limits(), png_get_user_width_max(),
3381 and png_get_user_height_max() were added at libpng-1.2.6.
3383 The png_set_add_alpha() function was added at libpng-1.2.7.
3385 The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
3386 Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
3387 tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
3390 A number of macro definitions in support of runtime selection of
3391 assembler code features (especially Intel MMX code support) were
3392 added at libpng-1.2.0:
3394 PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
3395 PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
3396 PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
3397 PNG_ASM_FLAG_MMX_READ_INTERLACE
3398 PNG_ASM_FLAG_MMX_READ_FILTER_SUB
3399 PNG_ASM_FLAG_MMX_READ_FILTER_UP
3400 PNG_ASM_FLAG_MMX_READ_FILTER_AVG
3401 PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
3402 PNG_ASM_FLAGS_INITIALIZED
3408 We added the following functions in support of runtime
3409 selection of assembler code features:
3411 png_get_mmx_flagmask()
3412 png_set_mmx_thresholds()
3414 png_get_mmx_bitdepth_threshold()
3415 png_get_mmx_rowbytes_threshold()
3418 We replaced all of these functions with simple stubs in libpng-1.2.20,
3419 when the Intel assembler code was removed due to a licensing issue.
3421 These macros are deprecated:
3423 PNG_READ_TRANSFORMS_NOT_SUPPORTED
3424 PNG_PROGRESSIVE_READ_NOT_SUPPORTED
3425 PNG_NO_SEQUENTIAL_READ_SUPPORTED
3426 PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
3427 PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
3428 PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
3430 They have been replaced, respectively, by:
3432 PNG_NO_READ_TRANSFORMS
3433 PNG_NO_PROGRESSIVE_READ
3434 PNG_NO_SEQUENTIAL_READ
3435 PNG_NO_WRITE_TRANSFORMS
3436 PNG_NO_READ_ANCILLARY_CHUNKS
3437 PNG_NO_WRITE_ANCILLARY_CHUNKS
3439 PNG_MAX_UINT was replaced with PNG_UINT_31_MAX. It has been
3440 deprecated since libpng-1.0.16 and libpng-1.2.6.
3443 png_check_sig(sig, num)
3445 !png_sig_cmp(sig, 0, num)
3446 It has been deprecated since libpng-0.90.
3449 png_set_gray_1_2_4_to_8()
3450 which also expands tRNS to alpha was replaced with
3451 png_set_expand_gray_1_2_4_to_8()
3452 which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
3457 .SH X. Detecting libpng
3459 The png_get_io_ptr() function has been present since libpng-0.88, has never
3460 changed, and is unaffected by conditional compilation macros. It is the
3461 best choice for use in configure scripts for detecting the presence of any
3462 libpng version since 0.88. In an autoconf "configure.in" you could use
3464 AC_CHECK_LIB(png, png_get_io_ptr, ...
3466 .SH XI. Source code repository
3468 Since about February 2009, version 1.2.34, libpng has been under "git" source
3469 control. The git repository was built from old libpng-x.y.z.tar.gz files
3470 going back to version 0.70. You can access the git repository (read only)
3473 git://git.code.sf.net/p/libpng/code
3475 or you can browse it with a web browser by selecting the "code" button at
3477 https://sourceforge.net/projects/libpng/
3479 Patches can be sent to glennrp at users.sourceforge.net or to
3480 png-mng-implement at lists.sourceforge.net or you can upload them to
3481 the libpng bug tracker at
3483 http://libpng.sourceforge.net
3485 .SH XII. Coding style
3487 Our coding style is similar to the "Allman" style, with curly
3488 braces on separate lines:
3495 else if (another condition)
3500 The braces can be omitted from simple one-line actions:
3505 We use 3-space indentation, except for continued statements which
3506 are usually indented the same as the first line of the statement
3507 plus four more spaces.
3509 For macro definitions we use 2-space indentation, always leaving the "#"
3510 in the first column.
3512 #ifndef PNG_NO_FEATURE
3513 # ifndef PNG_FEATURE_SUPPORTED
3514 # define PNG_FEATURE_SUPPORTED
3518 Comments appear with the leading "/*" at the same indentation as
3519 the statement that follows the comment:
3521 /* Single-line comment */
3529 Very short comments can be placed at the end of the statement
3530 to which they pertain:
3532 statement; /* comment */
3534 We don't use C++ style ("//") comments. We have, however,
3535 used them in the past in some now-abandoned MMX assembler
3538 Functions and their curly braces are not indented, and
3539 exported functions are marked with PNGAPI:
3541 /* This is a public function that is visible to
3542 * application programers. It does thus-and-so.
3545 png_exported_function(png_ptr, png_info, foo)
3550 The prototypes for all exported functions appear in png.h,
3551 above the comment that says
3553 /* Maintainer: Put new public prototypes here ... */
3555 We mark all non-exported functions with "/* PRIVATE */"":
3558 png_non_exported_function(png_ptr, png_info, foo)
3563 The prototypes for non-exported functions (except for those in
3565 the PNG_INTERNAL section of png.h
3566 above the comment that says
3568 /* Maintainer: Put new private prototypes here ^ and in libpngpf.3 */
3570 The names of all exported functions and variables begin
3571 with "png_", and all publicly visible C preprocessor
3572 macros begin with "PNG".
3574 We put a space after each comma and after each semicolon
3575 in "for" statments, and we put spaces before and after each
3576 C binary operator and after "for" or "while". We don't
3577 put a space between a typecast and the expression being
3578 cast, nor do we put one between a function name and the
3579 left parenthesis that follows it:
3581 for (i = 2; i > 0; --i)
3582 y[i] = a(x) + (int)b;
3584 We prefer #ifdef and #ifndef to #if defined() and if !defined()
3585 when there is only one macro being tested.
3587 We do not use the TAB character for indentation in the C sources.
3589 Lines do not exceed 80 characters.
3591 Other rules can be inferred by inspecting the libpng source.
3593 .SH XIII. Y2K Compliance in libpng
3597 Since the PNG Development group is an ad-hoc body, we can't make
3598 an official declaration.
3600 This is your unofficial assurance that libpng from version 0.71 and
3601 upward through 1.2.51 are Y2K compliant. It is my belief that earlier
3602 versions were also Y2K compliant.
3604 Libpng only has three year fields. One is a 2-byte unsigned integer that
3605 will hold years up to 65535. The other two hold the date in text
3606 format, and will hold years up to 9999.
3609 "png_uint_16 year" in png_time_struct.
3612 "png_charp time_buffer" in png_struct and
3613 "near_time_buffer", which is a local character string in png.c.
3615 There are seven time-related functions:
3617 png_convert_to_rfc_1123() in png.c
3618 (formerly png_convert_to_rfc_1152() in error)
3619 png_convert_from_struct_tm() in pngwrite.c, called
3621 png_convert_from_time_t() in pngwrite.c
3622 png_get_tIME() in pngget.c
3623 png_handle_tIME() in pngrutil.c, called in pngread.c
3624 png_set_tIME() in pngset.c
3625 png_write_tIME() in pngwutil.c, called in pngwrite.c
3627 All appear to handle dates properly in a Y2K environment. The
3628 png_convert_from_time_t() function calls gmtime() to convert from system
3629 clock time, which returns (year - 1900), which we properly convert to
3630 the full 4-digit year. There is a possibility that applications using
3631 libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
3632 function, or that they are incorrectly passing only a 2-digit year
3633 instead of "year - 1900" into the png_convert_from_struct_tm() function,
3634 but this is not under our control. The libpng documentation has always
3635 stated that it works with 4-digit years, and the APIs have been
3638 The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
3639 integer to hold the year, and can hold years as large as 65535.
3641 zlib, upon which libpng depends, is also Y2K compliant. It contains
3642 no date-related code.
3645 Glenn Randers-Pehrson
3647 PNG Development Group
3651 Note about libpng version numbers:
3653 Due to various miscommunications, unforeseen code incompatibilities
3654 and occasional factors outside the authors' control, version numbering
3655 on the library has not always been consistent and straightforward.
3656 The following table summarizes matters since version 0.89c, which was
3657 the first widely used release:
3659 source png.h png.h shared-lib
3660 version string int version
3661 ------- ------ ----- ----------
3662 0.89c ("beta 3") 0.89 89 1.0.89
3663 0.90 ("beta 4") 0.90 90 0.90
3664 0.95 ("beta 5") 0.95 95 0.95
3665 0.96 ("beta 6") 0.96 96 0.96
3666 0.97b ("beta 7") 1.00.97 97 1.0.1
3667 0.97c 0.97 97 2.0.97
3670 0.99a-m 0.99 99 2.0.99
3672 1.0.0 1.0.0 100 2.1.0
3673 1.0.0 (from here on, the 100 2.1.0
3674 1.0.1 png.h string is 10001 2.1.0
3675 1.0.1a-e identical to the 10002 from here on, the
3676 1.0.2 source version) 10002 shared library is 2.V
3677 1.0.2a-b 10003 where V is the source
3678 1.0.1 10001 code version except as
3679 1.0.1a-e 10002 2.1.0.1a-e noted.
3681 1.0.2a-b 10003 2.1.0.2a-b
3683 1.0.3a-d 10004 2.1.0.3a-d
3685 1.0.4a-f 10005 2.1.0.4a-f
3686 1.0.5 (+ 2 patches) 10005 2.1.0.5
3687 1.0.5a-d 10006 2.1.0.5a-d
3688 1.0.5e-r 10100 2.1.0.5e-r
3689 1.0.5s-v 10006 2.1.0.5s-v
3690 1.0.6 (+ 3 patches) 10006 2.1.0.6
3691 1.0.6d-g 10007 2.1.0.6d-g
3694 1.0.6j 10007 2.1.0.6j
3695 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14
3696 1.0.7beta15-18 1 10007 2.1.0.7beta15-18
3697 1.0.7rc1-2 1 10007 2.1.0.7rc1-2
3698 1.0.7 1 10007 2.1.0.7
3699 1.0.8beta1-4 1 10008 2.1.0.8beta1-4
3700 1.0.8rc1 1 10008 2.1.0.8rc1
3701 1.0.8 1 10008 2.1.0.8
3702 1.0.9beta1-6 1 10009 2.1.0.9beta1-6
3703 1.0.9rc1 1 10009 2.1.0.9rc1
3704 1.0.9beta7-10 1 10009 2.1.0.9beta7-10
3705 1.0.9rc2 1 10009 2.1.0.9rc2
3706 1.0.9 1 10009 2.1.0.9
3707 1.0.10beta1 1 10010 2.1.0.10beta1
3708 1.0.10rc1 1 10010 2.1.0.10rc1
3709 1.0.10 1 10010 2.1.0.10
3710 1.0.11beta1-3 1 10011 2.1.0.11beta1-3
3711 1.0.11rc1 1 10011 2.1.0.11rc1
3712 1.0.11 1 10011 2.1.0.11
3713 1.0.12beta1-2 2 10012 2.1.0.12beta1-2
3714 1.0.12rc1 2 10012 2.1.0.12rc1
3715 1.0.12 2 10012 2.1.0.12
3716 1.1.0a-f - 10100 2.1.1.0a-f abandoned
3717 1.2.0beta1-2 2 10200 2.1.2.0beta1-2
3718 1.2.0beta3-5 3 10200 3.1.2.0beta3-5
3719 1.2.0rc1 3 10200 3.1.2.0rc1
3720 1.2.0 3 10200 3.1.2.0
3721 1.2.1beta-4 3 10201 3.1.2.1beta1-4
3722 1.2.1rc1-2 3 10201 3.1.2.1rc1-2
3723 1.2.1 3 10201 3.1.2.1
3724 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6
3725 1.0.13beta1 10 10013 10.so.0.1.0.13beta1
3726 1.0.13rc1 10 10013 10.so.0.1.0.13rc1
3727 1.2.2rc1 12 10202 12.so.0.1.2.2rc1
3728 1.0.13 10 10013 10.so.0.1.0.13
3729 1.2.2 12 10202 12.so.0.1.2.2
3730 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6
3731 1.2.3 12 10203 12.so.0.1.2.3
3732 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3
3733 1.2.4rc1 13 10204 12.so.0.1.2.4rc1
3734 1.0.14 10 10014 10.so.0.1.0.14
3735 1.2.4 13 10204 12.so.0.1.2.4
3736 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2
3737 1.0.15rc1 10 10015 10.so.0.1.0.15rc1
3738 1.0.15 10 10015 10.so.0.1.0.15
3739 1.2.5 13 10205 12.so.0.1.2.5
3740 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4
3741 1.2.6rc1-5 13 10206 12.so.0.1.2.6rc1-5
3742 1.0.16 10 10016 10.so.0.1.0.16
3743 1.2.6 13 10206 12.so.0.1.2.6
3744 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2
3745 1.0.17rc1 10 10017 10.so.0.1.0.17rc1
3746 1.2.7rc1 13 10207 12.so.0.1.2.7rc1
3747 1.0.17 10 10017 10.so.0.1.0.17
3748 1.2.7 13 10207 12.so.0.1.2.7
3749 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5
3750 1.0.18rc1-5 10 10018 10.so.0.1.0.18rc1-5
3751 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5
3752 1.0.18 10 10018 10.so.0.1.0.18
3753 1.2.8 13 10208 12.so.0.1.2.8
3754 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3
3755 1.2.9beta4-11 13 10209 12.so.0.9[.0]
3756 1.2.9rc1 13 10209 12.so.0.9[.0]
3757 1.2.9 13 10209 12.so.0.9[.0]
3758 1.2.10beta1-8 13 10210 12.so.0.10[.0]
3759 1.2.10rc1-3 13 10210 12.so.0.10[.0]
3760 1.2.10 13 10210 12.so.0.10[.0]
3761 1.2.11beta1-4 13 10211 12.so.0.11[.0]
3762 1.0.19rc1-5 10 10019 10.so.0.19[.0]
3763 1.2.11rc1-5 13 10211 12.so.0.11[.0]
3764 1.0.19 10 10019 10.so.0.19[.0]
3765 1.2.11 13 10211 12.so.0.11[.0]
3766 1.0.20 10 10020 10.so.0.20[.0]
3767 1.2.12 13 10212 12.so.0.12[.0]
3768 1.2.13beta1 13 10213 12.so.0.13[.0]
3769 1.0.21 10 10021 10.so.0.21[.0]
3770 1.2.13 13 10213 12.so.0.13[.0]
3771 1.2.14beta1-2 13 10214 12.so.0.14[.0]
3772 1.0.22rc1 10 10022 10.so.0.22[.0]
3773 1.2.14rc1 13 10214 12.so.0.14[.0]
3774 1.2.15beta1-6 13 10215 12.so.0.15[.0]
3775 1.0.23rc1-5 10 10023 10.so.0.23[.0]
3776 1.2.15rc1-5 13 10215 12.so.0.15[.0]
3777 1.0.23 10 10023 10.so.0.23[.0]
3778 1.2.15 13 10215 12.so.0.15[.0]
3779 1.2.16beta1-2 13 10216 12.so.0.16[.0]
3780 1.2.16rc1 13 10216 12.so.0.16[.0]
3781 1.0.24 10 10024 10.so.0.24[.0]
3782 1.2.16 13 10216 12.so.0.16[.0]
3783 1.2.17beta1-2 13 10217 12.so.0.17[.0]
3784 1.0.25rc1 10 10025 10.so.0.25[.0]
3785 1.2.17rc1-3 13 10217 12.so.0.17[.0]
3786 1.0.25 10 10025 10.so.0.25[.0]
3787 1.2.17 13 10217 12.so.0.17[.0]
3788 1.0.26 10 10026 10.so.0.26[.0]
3789 1.2.18 13 10218 12.so.0.18[.0]
3790 1.2.19beta1-31 13 10219 12.so.0.19[.0]
3791 1.0.27rc1-6 10 10027 10.so.0.27[.0]
3792 1.2.19rc1-6 13 10219 12.so.0.19[.0]
3793 1.0.27 10 10027 10.so.0.27[.0]
3794 1.2.19 13 10219 12.so.0.19[.0]
3795 1.2.20beta01-04 13 10220 12.so.0.20[.0]
3796 1.0.28rc1-6 10 10028 10.so.0.28[.0]
3797 1.2.20rc1-6 13 10220 12.so.0.20[.0]
3798 1.0.28 10 10028 10.so.0.28[.0]
3799 1.2.20 13 10220 12.so.0.20[.0]
3800 1.2.21beta1-2 13 10221 12.so.0.21[.0]
3801 1.2.21rc1-3 13 10221 12.so.0.21[.0]
3802 1.0.29 10 10029 10.so.0.29[.0]
3803 1.2.21 13 10221 12.so.0.21[.0]
3804 1.2.22beta1-4 13 10222 12.so.0.22[.0]
3805 1.0.30rc1 13 10030 10.so.0.30[.0]
3806 1.2.22rc1 13 10222 12.so.0.22[.0]
3807 1.0.30 10 10030 10.so.0.30[.0]
3808 1.2.22 13 10222 12.so.0.22[.0]
3809 1.2.23beta01-05 13 10223 12.so.0.23[.0]
3810 1.2.23rc01 13 10223 12.so.0.23[.0]
3811 1.2.23 13 10223 12.so.0.23[.0]
3812 1.2.24beta01-02 13 10224 12.so.0.24[.0]
3813 1.2.24rc01 13 10224 12.so.0.24[.0]
3814 1.2.24 13 10224 12.so.0.24[.0]
3815 1.2.25beta01-06 13 10225 12.so.0.25[.0]
3816 1.2.25rc01-02 13 10225 12.so.0.25[.0]
3817 1.0.31 10 10031 10.so.0.31[.0]
3818 1.2.25 13 10225 12.so.0.25[.0]
3819 1.2.26beta01-06 13 10226 12.so.0.26[.0]
3820 1.2.26rc01 13 10226 12.so.0.26[.0]
3821 1.2.26 13 10226 12.so.0.26[.0]
3822 1.0.32 10 10032 10.so.0.32[.0]
3823 1.2.27beta01-06 13 10227 12.so.0.27[.0]
3824 1.2.27rc01 13 10227 12.so.0.27[.0]
3825 1.0.33 10 10033 10.so.0.33[.0]
3826 1.2.27 13 10227 12.so.0.27[.0]
3827 1.0.34 10 10034 10.so.0.34[.0]
3828 1.2.28 13 10228 12.so.0.28[.0]
3829 1.2.29beta01-03 13 10229 12.so.0.29[.0]
3830 1.2.29rc01 13 10229 12.so.0.29[.0]
3831 1.0.35 10 10035 10.so.0.35[.0]
3832 1.2.29 13 10229 12.so.0.29[.0]
3833 1.0.37 10 10037 10.so.0.37[.0]
3834 1.2.30beta01-04 13 10230 12.so.0.30[.0]
3835 1.0.38rc01-08 10 10038 10.so.0.38[.0]
3836 1.2.30rc01-08 13 10230 12.so.0.30[.0]
3837 1.0.38 10 10038 10.so.0.38[.0]
3838 1.2.30 13 10230 12.so.0.30[.0]
3839 1.0.39rc01-03 10 10039 10.so.0.39[.0]
3840 1.2.31rc01-03 13 10231 12.so.0.31[.0]
3841 1.0.39 10 10039 10.so.0.39[.0]
3842 1.2.31 13 10231 12.so.0.31[.0]
3843 1.2.32beta01-02 13 10232 12.so.0.32[.0]
3844 1.0.40rc01 10 10040 10.so.0.40[.0]
3845 1.2.32rc01 13 10232 12.so.0.32[.0]
3846 1.0.40 10 10040 10.so.0.40[.0]
3847 1.2.32 13 10232 12.so.0.32[.0]
3848 1.2.33beta01-02 13 10233 12.so.0.33[.0]
3849 1.2.33rc01-02 13 10233 12.so.0.33[.0]
3850 1.0.41rc01 10 10041 10.so.0.41[.0]
3851 1.2.33 13 10233 12.so.0.33[.0]
3852 1.0.41 10 10041 10.so.0.41[.0]
3853 1.2.34beta01-07 13 10234 12.so.0.34[.0]
3854 1.0.42rc01 10 10042 10.so.0.42[.0]
3855 1.2.34rc01 13 10234 12.so.0.34[.0]
3856 1.0.42 10 10042 10.so.0.42[.0]
3857 1.2.34 13 10234 12.so.0.34[.0]
3858 1.2.35beta01-03 13 10235 12.so.0.35[.0]
3859 1.0.43rc01-02 10 10043 10.so.0.43[.0]
3860 1.2.35rc01-02 13 10235 12.so.0.35[.0]
3861 1.0.43 10 10043 10.so.0.43[.0]
3862 1.2.35 13 10235 12.so.0.35[.0]
3863 1.2.36beta01-05 13 10236 12.so.0.36[.0]
3864 1.2.36rc01 13 10236 12.so.0.36[.0]
3865 1.0.44 10 10044 10.so.0.44[.0]
3866 1.2.36 13 10236 12.so.0.36[.0]
3867 1.2.37beta01-03 13 10237 12.so.0.37[.0]
3868 1.2.37rc01 13 10237 12.so.0.37[.0]
3869 1.2.37 13 10237 12.so.0.37[.0]
3870 1.0.45 10 10045 12.so.0.45[.0]
3871 1.0.46 10 10046 10.so.0.46[.0]
3872 1.2.38beta01 13 10238 12.so.0.38[.0]
3873 1.2.38rc01-03 13 10238 12.so.0.38[.0]
3874 1.0.47 10 10047 10.so.0.47[.0]
3875 1.2.38 13 10238 12.so.0.38[.0]
3876 1.2.39beta01-05 13 10239 12.so.0.39[.0]
3877 1.2.39rc01 13 10239 12.so.0.39[.0]
3878 1.0.48 10 10048 10.so.0.48[.0]
3879 1.2.39 13 10239 12.so.0.39[.0]
3880 1.2.40beta01 13 10240 12.so.0.40[.0]
3881 1.2.40rc01 13 10240 12.so.0.40[.0]
3882 1.0.49 10 10049 10.so.0.49[.0]
3883 1.2.40 13 10240 12.so.0.40[.0]
3884 1.0.50 10 10050 10.so.0.50[.0]
3885 1.2.41beta01-18 13 10241 12.so.0.41[.0]
3886 1.0.51rc01 10 10051 10.so.0.51[.0]
3887 1.2.41rc01-03 13 10241 12.so.0.41[.0]
3888 1.0.51 10 10051 10.so.0.51[.0]
3889 1.2.41 13 10241 12.so.0.41[.0]
3890 1.2.42beta01-02 13 10242 12.so.0.42[.0]
3891 1.2.42rc01-05 13 10242 12.so.0.42[.0]
3892 1.0.52 10 10052 10.so.0.52[.0]
3893 1.2.42 13 10242 12.so.0.42[.0]
3894 1.2.43beta01-05 13 10243 12.so.0.43[.0]
3895 1.0.53rc01-02 10 10053 10.so.0.53[.0]
3896 1.2.43rc01-02 13 10243 12.so.0.43[.0]
3897 1.0.53 10 10053 10.so.0.53[.0]
3898 1.2.43 13 10243 12.so.0.43[.0]
3899 1.2.44beta01-03 13 10244 12.so.0.44[.0]
3900 1.2.44rc01-03 13 10244 12.so.0.44[.0]
3901 1.2.44 13 10244 12.so.0.44[.0]
3902 1.2.45beta01-03 13 10245 12.so.0.45[.0]
3903 1.0.55rc01 10 10055 10.so.0.55[.0]
3904 1.2.45rc01 13 10245 12.so.0.45[.0]
3905 1.0.55 10 10055 10.so.0.55[.0]
3906 1.2.45 13 10245 12.so.0.45[.0]
3907 1.2.46rc01-02 13 10246 12.so.0.46[.0]
3908 1.0.56 10 10056 10.so.0.56[.0]
3909 1.2.46 13 10246 12.so.0.46[.0]
3910 1.2.47beta01 13 10247 12.so.0.47[.0]
3911 1.2.47rc01 13 10247 12.so.0.47[.0]
3912 1.0.57rc01 10 10057 10.so.0.57[.0]
3913 1.2.47 13 10247 12.so.0.47[.0]
3914 1.0.57 10 10057 10.so.0.57[.0]
3915 1.2.48beta01 13 10248 12.so.0.48[.0]
3916 1.2.48rc01-02 13 10248 12.so.0.48[.0]
3917 1.0.58 10 10058 10.so.0.58[.0]
3918 1.2.48 13 10248 12.so.0.48[.0]
3919 1.2.49rc01 13 10249 12.so.0.49[.0]
3920 1.0.59 10 10059 10.so.0.59[.0]
3921 1.2.49 13 10249 12.so.0.49[.0]
3922 1.2.50 13 10250 12.so.0.50[.0]
3923 1.0.60 10 10060 10.so.0.60[.0]
3924 1.2.51beta01-05 13 10251 12.so.0.51[.0]
3925 1.2.51rc01-04 13 10251 12.so.0.51[.0]
3926 1.0.61 10 10061 10.so.0.61[.0]
3927 1.2.51 13 10251 12.so.0.51[.0]
3929 Henceforth the source version will match the shared-library minor
3930 and patch numbers; the shared-library major version number will be
3931 used for changes in backward compatibility, as it is intended. The
3932 PNG_PNGLIB_VER macro, which is not used within libpng but is available
3933 for applications, is an unsigned integer of the form xyyzz corresponding
3934 to the source version x.y.z (leading zeros in y and z). Beta versions
3935 were given the previous public release number plus a letter, until
3936 version 1.0.6j; from then on they were given the upcoming public
3937 release number plus "betaNN" or "rcNN".
3940 .IR libpngpf(3) ", " png(5)
3944 http://libpng.sourceforge.net (follow the [DOWNLOAD] link)
3945 http://www.libpng.org/pub/png
3950 (generally) at the same location as
3954 ftp://ftp.info-zip.org/pub/infozip/zlib
3957 .IR PNG specification: RFC 2083
3959 (generally) at the same location as
3963 ftp://ftp.rfc-editor.org:/in-notes/rfc2083.txt
3965 or (as a W3C Recommendation) at
3967 http://www.w3.org/TR/REC-png.html
3970 In the case of any inconsistency between the PNG specification
3971 and this library, the specification takes precedence.
3974 This man page: Glenn Randers-Pehrson
3975 <glennrp at users.sourceforge.net>
3977 The contributing authors would like to thank all those who helped
3978 with testing, bug fixes, and patience. This wouldn't have been
3979 possible without all of you.
3981 Thanks to Frank J. T. Wojcik for helping with the documentation.
3983 Libpng version 1.2.51 - February 6, 2014:
3984 Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
3985 Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
3987 Supported by the PNG development group
3989 png-mng-implement at lists.sf.net
3990 (subscription required; visit
3991 png-mng-implement at lists.sourceforge.net (subscription required; visit
3992 https://lists.sourceforge.net/lists/listinfo/png-mng-implement
3995 .SH COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
3997 (This copy of the libpng notices is provided for your convenience. In case of
3998 any discrepancy between this copy and the notices in the file png.h that is
3999 included in the libpng distribution, the latter shall prevail.)
4001 If you modify libpng you may insert additional notices immediately following
4004 This code is released under the libpng license.
4006 libpng versions 1.2.6, August 15, 2004, through 1.2.51, February 6, 2014, are
4007 Copyright (c) 2004,2006-2008 Glenn Randers-Pehrson, and are
4008 distributed according to the same disclaimer and license as libpng-1.2.5
4009 with the following individual added to the list of Contributing Authors
4013 libpng versions 1.0.7, July 1, 2000, through 1.2.5 - October 3, 2002, are
4014 Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
4015 distributed according to the same disclaimer and license as libpng-1.0.6
4016 with the following individuals added to the list of Contributing Authors
4018 Simon-Pierre Cadieux
4022 and with the following additions to the disclaimer:
4024 There is no warranty against interference with your
4025 enjoyment of the library or against infringement.
4026 There is no warranty that our efforts or the library
4027 will fulfill any of your particular purposes or needs.
4028 This library is provided with all faults, and the entire
4029 risk of satisfactory quality, performance, accuracy, and
4030 effort is with the user.
4032 libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
4033 Copyright (c) 1998, 1999 Glenn Randers-Pehrson
4034 Distributed according to the same disclaimer and license as libpng-0.96,
4035 with the following individuals added to the list of Contributing Authors:
4038 Glenn Randers-Pehrson
4041 libpng versions 0.89, June 1996, through 0.96, May 1997, are
4042 Copyright (c) 1996, 1997 Andreas Dilger
4043 Distributed according to the same disclaimer and license as libpng-0.88,
4044 with the following individuals added to the list of Contributing Authors:
4053 libpng versions 0.5, May 1995, through 0.88, January 1996, are
4054 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
4056 For the purposes of this copyright and license, "Contributing Authors"
4057 is defined as the following set of individuals:
4065 The PNG Reference Library is supplied "AS IS". The Contributing Authors
4066 and Group 42, Inc. disclaim all warranties, expressed or implied,
4067 including, without limitation, the warranties of merchantability and of
4068 fitness for any purpose. The Contributing Authors and Group 42, Inc.
4069 assume no liability for direct, indirect, incidental, special, exemplary,
4070 or consequential damages, which may result from the use of the PNG
4071 Reference Library, even if advised of the possibility of such damage.
4073 Permission is hereby granted to use, copy, modify, and distribute this
4074 source code, or portions hereof, for any purpose, without fee, subject
4075 to the following restrictions:
4077 1. The origin of this source code must not be misrepresented.
4079 2. Altered versions must be plainly marked as such and
4080 must not be misrepresented as being the original source.
4082 3. This Copyright notice may not be removed or altered from
4083 any source or altered source distribution.
4085 The Contributing Authors and Group 42, Inc. specifically permit, without
4086 fee, and encourage the use of this source code as a component to
4087 supporting the PNG file format in commercial products. If you use this
4088 source code in a product, acknowledgment is not required but would be
4092 A "png_get_copyright" function is available, for convenient use in "about"
4095 printf("%s",png_get_copyright(NULL));
4097 Also, the PNG logo (in PNG format, of course) is supplied in the
4098 files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
4100 Libpng is OSI Certified Open Source Software. OSI Certified Open Source is a
4101 certification mark of the Open Source Initiative.
4103 Glenn Randers-Pehrson
4104 glennrp at users.sourceforge.net