fix getsup (HH)
[luatex.git] / source / libs / libpng / libpng-src / libpng.3
blob27b673c6bd37e747c75b0f1b0bf1c8adc51c8095
1 .TH LIBPNG 3 "January 5, 2017"
2 .SH NAME
3 libpng \- Portable Network Graphics (PNG) Reference Library 1.6.28
4 .SH SYNOPSIS
5 \fB
6 #include <png.h>\fP
8 \fBpng_uint_32 png_access_version_number \fI(void\fP\fB);\fP
10 \fBvoid png_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
12 \fBvoid png_build_grayscale_palette (int \fP\fIbit_depth\fP\fB, png_colorp \fIpalette\fP\fB);\fP
14 \fBpng_voidp png_calloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
16 \fBvoid png_chunk_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
18 \fBvoid png_chunk_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
20 \fBvoid png_chunk_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
22 \fBvoid png_convert_from_struct_tm (png_timep \fP\fIptime\fP\fB, struct tm FAR * \fIttime\fP\fB);\fP
24 \fBvoid png_convert_from_time_t (png_timep \fP\fIptime\fP\fB, time_t \fIttime\fP\fB);\fP
26 \fBpng_charp png_convert_to_rfc1123 (png_structp \fP\fIpng_ptr\fP\fB, png_timep \fIptime\fP\fB);\fP
28 \fBpng_infop png_create_info_struct (png_structp \fIpng_ptr\fP\fB);\fP
30 \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
32 \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
34 \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
36 \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
38 \fBvoid png_data_freer (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIfreer\fP\fB, png_uint_32 \fImask)\fP\fB);\fP
40 \fBvoid png_destroy_info_struct (png_structp \fP\fIpng_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
42 \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
44 \fBvoid png_destroy_write_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
46 \fBvoid png_err (png_structp \fIpng_ptr\fP\fB);\fP
48 \fBvoid png_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
50 \fBvoid png_free (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
52 \fBvoid png_free_chunk_list (png_structp \fIpng_ptr\fP\fB);\fP
54 \fBvoid png_free_default (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
56 \fBvoid png_free_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fInum\fP\fB);\fP
58 \fBpng_byte png_get_bit_depth (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
60 \fBpng_uint_32 png_get_bKGD (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_16p \fI*background\fP\fB);\fP
62 \fBpng_byte png_get_channels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
64 \fBpng_uint_32 png_get_cHRM (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
66 \fBpng_uint_32 png_get_cHRM_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
68 \fBpng_uint_32 png_get_cHRM_XYZ (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, double \fP\fI*red_X\fP\fB, double \fP\fI*red_Y\fP\fB, double \fP\fI*red_Z\fP\fB, double \fP\fI*green_X\fP\fB, double \fP\fI*green_Y\fP\fB, double \fP\fI*green_Z\fP\fB, double \fP\fI*blue_X\fP\fB, double \fP\fI*blue_Y\fP\fB, double \fI*blue_Z\fP\fB);\fP
70 \fBpng_uint_32 png_get_cHRM_XYZ_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_fixed_point \fP\fI*int_red_X\fP\fB, png_fixed_point \fP\fI*int_red_Y\fP\fB, png_fixed_point \fP\fI*int_red_Z\fP\fB, png_fixed_point \fP\fI*int_green_X\fP\fB, png_fixed_point \fP\fI*int_green_Y\fP\fB, png_fixed_point \fP\fI*int_green_Z\fP\fB, png_fixed_point \fP\fI*int_blue_X\fP\fB, png_fixed_point \fP\fI*int_blue_Y\fP\fB, png_fixed_point \fI*int_blue_Z\fP\fB);\fP
72 \fBpng_uint_32 png_get_chunk_cache_max (png_const_structp \fIpng_ptr\fP\fB);\fP
74 \fBpng_alloc_size_t png_get_chunk_malloc_max (png_const_structp \fIpng_ptr\fP\fB);\fP
76 \fBpng_byte png_get_color_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
78 \fBpng_uint_32 png_get_compression_buffer_size (png_const_structp \fIpng_ptr\fP\fB);\fP
80 \fBpng_byte png_get_compression_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
82 \fBpng_byte png_get_copyright (png_const_structp \fIpng_ptr\fP\fB);\fP
84 \fBpng_uint_32 png_get_current_row_number \fI(png_const_structp\fP\fB);\fP
86 \fBpng_byte png_get_current_pass_number \fI(png_const_structp\fP\fB);\fP
88 \fBpng_voidp png_get_error_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
90 \fBpng_byte png_get_filter_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
92 \fBpng_uint_32 png_get_gAMA (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, double \fI*file_gamma\fP\fB);\fP
94 \fBpng_uint_32 png_get_gAMA_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fI*int_file_gamma\fP\fB);\fP
96 \fBpng_byte png_get_header_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
98 \fBpng_byte png_get_header_version (png_const_structp \fIpng_ptr\fP\fB);\fP
100 \fBpng_uint_32 png_get_hIST (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_16p \fI*hist\fP\fB);\fP
102 \fBpng_uint_32 png_get_iCCP (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_charpp \fP\fIname\fP\fB, int \fP\fI*compression_type\fP\fB, png_bytepp \fP\fIprofile\fP\fB, png_uint_32 \fI*proflen\fP\fB);\fP
104 \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
106 \fBpng_uint_32 png_get_image_height (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
108 \fBpng_uint_32 png_get_image_width (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
110 \fBpng_int_32 png_get_int_32 (png_bytep \fIbuf\fP\fB);\fP
112 \fBpng_byte png_get_interlace_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
114 \fBpng_uint_32 png_get_io_chunk_type (png_const_structp \fIpng_ptr\fP\fB);\fP
116 \fBpng_voidp png_get_io_ptr (png_structp \fIpng_ptr\fP\fB);\fP
118 \fBpng_uint_32 png_get_io_state (png_structp \fIpng_ptr\fP\fB);\fP
120 \fBpng_byte png_get_libpng_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
122 \fBint png_get_palette_max(png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
124 \fBpng_voidp png_get_mem_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
126 \fBpng_uint_32 png_get_oFFs (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
128 \fBpng_uint_32 png_get_pCAL (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
130 \fBpng_uint_32 png_get_pHYs (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
132 \fBfloat png_get_pixel_aspect_ratio (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
134 \fBpng_uint_32 png_get_pHYs_dpi (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_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
136 \fBpng_fixed_point png_get_pixel_aspect_ratio_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
138 \fBpng_uint_32 png_get_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
140 \fBpng_uint_32 png_get_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
142 \fBpng_voidp png_get_progressive_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
144 \fBpng_uint_32 png_get_PLTE (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_colorp \fP\fI*palette\fP\fB, int \fI*num_palette\fP\fB);\fP
146 \fBpng_byte png_get_rgb_to_gray_status (png_const_structp \fIpng_ptr\fP\fB);\fP
148 \fBpng_uint_32 png_get_rowbytes (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
150 \fBpng_bytepp png_get_rows (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
152 \fBpng_uint_32 png_get_sBIT (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_8p \fI*sig_bit\fP\fB);\fP
154 \fBvoid png_get_sCAL (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, double* \fP\fIwidth\fP\fB, double* \fIheight\fP\fB);\fP
156 \fBvoid png_get_sCAL_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, png_fixed_pointp \fP\fIwidth\fP\fB, png_fixed_pointp \fIheight\fP\fB);\fP
158 \fBvoid png_get_sCAL_s (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, png_charpp \fP\fIwidth\fP\fB, png_charpp \fIheight\fP\fB);\fP
160 \fBpng_bytep png_get_signature (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
162 \fBpng_uint_32 png_get_sPLT (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_spalette_p \fI*splt_ptr\fP\fB);\fP
164 \fBpng_uint_32 png_get_sRGB (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int \fI*file_srgb_intent\fP\fB);\fP
166 \fBpng_uint_32 png_get_text (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_textp \fP\fI*text_ptr\fP\fB, int \fI*num_text\fP\fB);\fP
168 \fBpng_uint_32 png_get_tIME (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_timep \fI*mod_time\fP\fB);\fP
170 \fBpng_uint_32 png_get_tRNS (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fI*trans_alpha\fP\fB, int \fP\fI*num_trans\fP\fB, png_color_16p \fI*trans_color\fP\fB);\fP
172 \fB/* This function is really an inline macro. \fI*/
174 \fBpng_uint_16 png_get_uint_16 (png_bytep \fIbuf\fP\fB);\fP
176 \fBpng_uint_32 png_get_uint_31 (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIbuf\fP\fB);\fP
178 \fB/* This function is really an inline macro. \fI*/
180 \fBpng_uint_32 png_get_uint_32 (png_bytep \fIbuf\fP\fB);\fP
182 \fBpng_uint_32 png_get_unknown_chunks (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_unknown_chunkpp \fIunknowns\fP\fB);\fP
184 \fBpng_voidp png_get_user_chunk_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
186 \fBpng_uint_32 png_get_user_height_max (png_const_structp \fIpng_ptr\fP\fB);\fP
188 \fBpng_voidp png_get_user_transform_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
190 \fBpng_uint_32 png_get_user_width_max (png_const_structp \fIpng_ptr\fP\fB);\fP
192 \fBpng_uint_32 png_get_valid (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fIflag\fP\fB);\fP
194 \fBfloat png_get_x_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
196 \fBpng_fixed_point png_get_x_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
198 \fBpng_int_32 png_get_x_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
200 \fBpng_int_32 png_get_x_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
202 \fBpng_uint_32 png_get_x_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
204 \fBpng_uint_32 png_get_x_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
206 \fBfloat png_get_y_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
208 \fBpng_fixed_point png_get_y_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
210 \fBpng_int_32 png_get_y_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
212 \fBpng_int_32 png_get_y_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
214 \fBpng_uint_32 png_get_y_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
216 \fBpng_uint_32 png_get_y_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
218 \fBint png_handle_as_unknown (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIchunk_name\fP\fB);\fP
220 \fBint png_image_begin_read_from_file (png_imagep \fP\fIimage\fP\fB, const char \fI*file_name\fP\fB);\fP
222 \fBint png_image_begin_read_from_stdio (png_imagep \fP\fIimage\fP\fB, FILE* \fIfile\fP\fB);\fP
224 \fBint, png_image_begin_read_from_memory (png_imagep \fP\fIimage\fP\fB, png_const_voidp \fP\fImemory\fP\fB, png_size_t \fIsize\fP\fB);\fP
226 \fBint png_image_finish_read (png_imagep \fP\fIimage\fP\fB, png_colorp \fP\fIbackground\fP\fB, void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
228 \fBvoid png_image_free (png_imagep \fIimage\fP\fB);\fP
230 \fBint png_image_write_to_file (png_imagep \fP\fIimage\fP\fB, const char \fP\fI*file\fP\fB, int \fP\fIconvert_to_8bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
232 \fBint png_image_write_to_memory (png_imagep \fP\fIimage\fP\fB, void \fP\fI*memory\fP\fB, png_alloc_size_t * PNG_RESTRICT \fP\fImemory_bytes\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, const void \fI*colormap)\fP\fB);\fP
234 \fBint png_image_write_to_stdio (png_imagep \fP\fIimage\fP\fB, FILE \fP\fI*file\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap)\fP\fB);\fP
236 \fBvoid png_info_init_3 (png_infopp \fP\fIinfo_ptr\fP\fB, png_size_t \fIpng_info_struct_size\fP\fB);\fP
238 \fBvoid png_init_io (png_structp \fP\fIpng_ptr\fP\fB, FILE \fI*fp\fP\fB);\fP
240 \fBvoid png_longjmp (png_structp \fP\fIpng_ptr\fP\fB, int \fIval\fP\fB);\fP
242 \fBpng_voidp png_malloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
244 \fBpng_voidp png_malloc_default (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
246 \fBpng_voidp png_malloc_warn (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
248 \fBpng_uint_32 png_permit_mng_features (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fImng_features_permitted\fP\fB);\fP
250 \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
252 \fBpng_size_t png_process_data_pause \fP\fI(png_structp\fP\fB, int \fIsave\fP\fB);\fP
254 \fBpng_uint_32 png_process_data_skip \fI(png_structp\fP\fB);\fP
256 \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
258 \fBvoid png_read_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
260 \fBvoid png_read_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
262 \fBvoid png_read_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
264 \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
266 \fBvoid png_read_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIrow\fP\fB, png_bytep \fIdisplay_row\fP\fB);\fP
268 \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
270 \fBvoid png_read_update_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
272 \fBint png_reset_zstream (png_structp \fIpng_ptr\fP\fB);\fP
274 \fBvoid png_save_int_32 (png_bytep \fP\fIbuf\fP\fB, png_int_32 \fIi\fP\fB);\fP
276 \fBvoid png_save_uint_16 (png_bytep \fP\fIbuf\fP\fB, unsigned int \fIi\fP\fB);\fP
278 \fBvoid png_save_uint_32 (png_bytep \fP\fIbuf\fP\fB, png_uint_32 \fIi\fP\fB);\fP
280 \fBvoid png_set_add_alpha (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
282 \fBvoid png_set_alpha_mode (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, double \fIoutput_gamma\fP\fB);\fP
284 \fBvoid png_set_alpha_mode_fixed (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, png_fixed_point \fIoutput_gamma\fP\fB);\fP
286 \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
288 \fBvoid png_set_background_fixed (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, png_uint_32 \fIbackground_gamma\fP\fB);\fP
290 \fBvoid png_set_benign_errors (png_structp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
292 \fBvoid png_set_bgr (png_structp \fIpng_ptr\fP\fB);\fP
294 \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
296 \fBvoid png_set_check_for_invalid_index(png_structrp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
298 \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
300 \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
302 \fBvoid png_set_cHRM_XYZ (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fP\fIred_X\fP\fB, double \fP\fIred_Y\fP\fB, double \fP\fIred_Z\fP\fB, double \fP\fIgreen_X\fP\fB, double \fP\fIgreen_Y\fP\fB, double \fP\fIgreen_Z\fP\fB, double \fP\fIblue_X\fP\fB, double \fP\fIblue_Y\fP\fB, double \fIblue_Z\fP\fB);\fP
304 \fBvoid png_set_cHRM_XYZ_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_fixed_point \fP\fIint_red_X\fP\fB, png_fixed_point \fP\fIint_red_Y\fP\fB, png_fixed_point \fP\fIint_red_Z\fP\fB, png_fixed_point \fP\fIint_green_X\fP\fB, png_fixed_point \fP\fIint_green_Y\fP\fB, png_fixed_point \fP\fIint_green_Z\fP\fB, png_fixed_point \fP\fIint_blue_X\fP\fB, png_fixed_point \fP\fIint_blue_Y\fP\fB, png_fixed_point \fIint_blue_Z\fP\fB);\fP
306 \fBvoid png_set_chunk_cache_max (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIuser_chunk_cache_max\fP\fB);\fP
308 \fBvoid png_set_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
310 \fBvoid png_set_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
312 \fBvoid png_set_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
314 \fBvoid png_set_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
316 \fBvoid png_set_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
318 \fBvoid png_set_crc_action (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIcrit_action\fP\fB, int \fIancil_action\fP\fB);\fP
320 \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
322 \fBvoid png_set_expand (png_structp \fIpng_ptr\fP\fB);\fP
324 \fBvoid png_set_expand_16 (png_structp \fIpng_ptr\fP\fB);\fP
326 \fBvoid png_set_expand_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
328 \fBvoid png_set_filler (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
330 \fBvoid png_set_filter (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImethod\fP\fB, int \fIfilters\fP\fB);\fP
332 \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
334 \fBvoid png_set_filter_heuristics_fixed (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIheuristic_method\fP\fB, int \fP\fInum_weights\fP\fB, png_fixed_point_p \fP\fIfilter_weights\fP\fB, png_fixed_point_p \fIfilter_costs\fP\fB);\fP
336 \fBvoid png_set_flush (png_structp \fP\fIpng_ptr\fP\fB, int \fInrows\fP\fB);\fP
338 \fBvoid png_set_gamma (png_structp \fP\fIpng_ptr\fP\fB, double \fP\fIscreen_gamma\fP\fB, double \fIdefault_file_gamma\fP\fB);\fP
340 \fBvoid png_set_gamma_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIscreen_gamma\fP\fB, png_uint_32 \fIdefault_file_gamma\fP\fB);\fP
342 \fBvoid png_set_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fIfile_gamma\fP\fB);\fP
344 \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
346 \fBvoid png_set_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
348 \fBvoid png_set_gray_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
350 \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
352 \fBvoid png_set_iCCP (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_const_charp \fP\fIname\fP\fB, int \fP\fIcompression_type\fP\fB, png_const_bytep \fP\fIprofile\fP\fB, png_uint_32 \fIproflen\fP\fB);\fP
354 \fBint png_set_interlace_handling (png_structp \fIpng_ptr\fP\fB);\fP
356 \fBvoid png_set_invalid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fImask\fP\fB);\fP
358 \fBvoid png_set_invert_alpha (png_structp \fIpng_ptr\fP\fB);\fP
360 \fBvoid png_set_invert_mono (png_structp \fIpng_ptr\fP\fB);\fP
362 \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
364 \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
366 \fBjmp_buf* png_set_longjmp_fn (png_structp \fP\fIpng_ptr\fP\fB, png_longjmp_ptr \fP\fIlongjmp_fn\fP\fB, size_t \fIjmp_buf_size\fP\fB);\fP
368 \fBvoid png_set_chunk_malloc_max (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIuser_chunk_cache_max\fP\fB);\fP
370 \fBvoid png_set_compression_buffer_size (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
372 \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
374 \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
376 \fBint png_set_option(png_structrp \fP\fIpng_ptr\fP\fB, int \fP\fIoption\fP\fB, int \fIonoff\fP\fB);\fP
378 \fBvoid png_set_packing (png_structp \fIpng_ptr\fP\fB);\fP
380 \fBvoid png_set_packswap (png_structp \fIpng_ptr\fP\fB);\fP
382 \fBvoid png_set_palette_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
384 \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
386 \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
388 \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
390 \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
392 \fBvoid png_set_quantize (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_quantize\fP\fB);\fP
394 \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
396 \fBvoid png_set_read_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_read_status_ptr \fIread_row_fn\fP\fB);\fP
398 \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
400 \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
402 \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
404 \fBvoid png_set_rgb_to_gray_fixed (png_structp \fP\fIpng_ptr\fP\fB, int error_action png_uint_32 \fP\fIred\fP\fB, png_uint_32 \fIgreen\fP\fB);\fP
406 \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
408 \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
410 \fBvoid png_set_sCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, double \fP\fIwidth\fP\fB, double \fIheight\fP\fB);\fP
412 \fBvoid png_set_sCAL_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, png_fixed_point \fP\fIwidth\fP\fB, png_fixed_point \fIheight\fP\fB);\fP
414 \fBvoid png_set_sCAL_s (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, png_charp \fP\fIwidth\fP\fB, png_charp \fIheight\fP\fB);\fP
416 \fBvoid png_set_scale_16 (png_structp \fIpng_ptr\fP\fB);\fP
418 \fBvoid png_set_shift (png_structp \fP\fIpng_ptr\fP\fB, png_color_8p \fItrue_bits\fP\fB);\fP
420 \fBvoid png_set_sig_bytes (png_structp \fP\fIpng_ptr\fP\fB, int \fInum_bytes\fP\fB);\fP
422 \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
424 \fBvoid png_set_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
426 \fBvoid png_set_sRGB_gAMA_and_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
428 \fBvoid png_set_strip_16 (png_structp \fIpng_ptr\fP\fB);\fP
430 \fBvoid png_set_strip_alpha (png_structp \fIpng_ptr\fP\fB);\fP
432 \fBvoid png_set_strip_error_numbers (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIstrip_mode\fP\fB);\fP
434 \fBvoid png_set_swap (png_structp \fIpng_ptr\fP\fB);\fP
436 \fBvoid png_set_swap_alpha (png_structp \fIpng_ptr\fP\fB);\fP
438 \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
440 \fBvoid png_set_text_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
442 \fBvoid png_set_text_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
444 \fBvoid png_set_text_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
446 \fBvoid png_set_text_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
448 \fBvoid \fP\fIpng_set_text_compression_method\fP\fB, (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod)\fP\fB);\fP
450 \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
452 \fBvoid png_set_tRNS (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fItrans_alpha\fP\fB, int \fP\fInum_trans\fP\fB, png_color_16p \fItrans_color\fP\fB);\fP
454 \fBvoid png_set_tRNS_to_alpha (png_structp \fIpng_ptr\fP\fB);\fP
456 \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
458 \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
460 \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
462 \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
464 \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
466 \fBvoid png_set_write_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_write_status_ptr \fIwrite_row_fn\fP\fB);\fP
468 \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
470 \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
472 \fBvoid png_start_read_image (png_structp \fIpng_ptr\fP\fB);\fP
474 \fBvoid png_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
476 \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
478 \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
480 \fBvoid png_write_chunk_end (png_structp \fIpng_ptr\fP\fB);\fP
482 \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
484 \fBvoid png_write_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
486 \fBvoid png_write_flush (png_structp \fIpng_ptr\fP\fB);\fP
488 \fBvoid png_write_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
490 \fBvoid png_write_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
492 \fBvoid png_write_info_before_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
494 \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
496 \fBvoid png_write_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIrow\fP\fB);\fP
498 \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
500 \fBvoid png_write_sig (png_structp \fIpng_ptr\fP\fB);\fP
502 .SH DESCRIPTION
504 .I libpng
505 library supports encoding, decoding, and various manipulations of
506 the Portable Network Graphics (PNG) format image files.  It uses the
507 .IR zlib(3)
508 compression library.
509 Following is a copy of the libpng-manual.txt file that accompanies libpng.
510 .SH LIBPNG.TXT
511 libpng-manual.txt - A description on how to use and modify libpng
513  libpng version 1.6.28 - January 5, 2017
514  Updated and distributed by Glenn Randers-Pehrson
515  <glennrp at users.sourceforge.net>
516  Copyright (c) 1998-2016 Glenn Randers-Pehrson
518  This document is released under the libpng license.
519  For conditions of distribution and use, see the disclaimer
520  and license in png.h
522  Based on:
524  libpng versions 0.97, January 1998, through 1.6.28 - January 5, 2017
525  Updated and distributed by Glenn Randers-Pehrson
526  Copyright (c) 1998-2016 Glenn Randers-Pehrson
528  libpng 1.0 beta 6 - version 0.96 - May 28, 1997
529  Updated and distributed by Andreas Dilger
530  Copyright (c) 1996, 1997 Andreas Dilger
532  libpng 1.0 beta 2 - version 0.88 - January 26, 1996
533  For conditions of distribution and use, see copyright
534  notice in png.h. Copyright (c) 1995, 1996 Guy Eric
535  Schalnat, Group 42, Inc.
537  Updated/rewritten per request in the libpng FAQ
538  Copyright (c) 1995, 1996 Frank J. T. Wojcik
539  December 18, 1995 & January 20, 1996
541  TABLE OF CONTENTS
543     I. Introduction
544    II. Structures
545   III. Reading
546    IV. Writing
547     V. Simplified API
548    VI. Modifying/Customizing libpng
549   VII. MNG support
550  VIII. Changes to Libpng from version 0.88
551    IX. Changes to Libpng from version 1.0.x to 1.2.x
552     X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
553    XI. Changes to Libpng from version 1.4.x to 1.5.x
554   XII. Changes to Libpng from version 1.5.x to 1.6.x
555  XIII. Detecting libpng
556   XIV. Source code repository
557    XV. Coding style
558   XVI. Y2K Compliance in libpng
560 .SH I. Introduction
562 This file describes how to use and modify the PNG reference library
563 (known as libpng) for your own use.  In addition to this
564 file, example.c is a good starting point for using the library, as
565 it is heavily commented and should include everything most people
566 will need.  We assume that libpng is already installed; see the
567 INSTALL file for instructions on how to configure and install libpng.
569 For examples of libpng usage, see the files "example.c", "pngtest.c",
570 and the files in the "contrib" directory, all of which are included in
571 the libpng distribution.
573 Libpng was written as a companion to the PNG specification, as a way
574 of reducing the amount of time and effort it takes to support the PNG
575 file format in application programs.
577 The PNG specification (second edition), November 2003, is available as
578 a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2004 (E)) at
579 <http://www.w3.org/TR/2003/REC-PNG-20031110/
580 The W3C and ISO documents have identical technical content.
582 The PNG-1.2 specification is available at
583 <http://png-mng.sourceforge.net/pub/png/spec/1.2/>.
584 It is technically equivalent
585 to the PNG specification (second edition) but has some additional material.
587 The PNG-1.0 specification is available as RFC 2083 
588 <http://png-mng.sourceforge.net/pub/png/spec/1.0/> and as a
589 W3C Recommendation <http://www.w3.org/TR/REC-png-961001>.
591 Some additional chunks are described in the special-purpose public chunks
592 documents at <http://www.libpng.org/pub/png/spec/register/>
594 Other information
595 about PNG, and the latest version of libpng, can be found at the PNG home
596 page, <http://www.libpng.org/pub/png/>.
598 Most users will not have to modify the library significantly; advanced
599 users may want to modify it more.  All attempts were made to make it as
600 complete as possible, while keeping the code easy to understand.
601 Currently, this library only supports C.  Support for other languages
602 is being considered.
604 Libpng has been designed to handle multiple sessions at one time,
605 to be easily modifiable, to be portable to the vast majority of
606 machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
607 to use.  The ultimate goal of libpng is to promote the acceptance of
608 the PNG file format in whatever way possible.  While there is still
609 work to be done (see the TODO file), libpng should cover the
610 majority of the needs of its users.
612 Libpng uses zlib for its compression and decompression of PNG files.
613 Further information about zlib, and the latest version of zlib, can
614 be found at the zlib home page, <http://zlib.net/>.
615 The zlib compression utility is a general purpose utility that is
616 useful for more than PNG files, and can be used without libpng.
617 See the documentation delivered with zlib for more details.
618 You can usually find the source files for the zlib utility wherever you
619 find the libpng source files.
621 Libpng is thread safe, provided the threads are using different
622 instances of the structures.  Each thread should have its own
623 png_struct and png_info instances, and thus its own image.
624 Libpng does not protect itself against two threads using the
625 same instance of a structure.
627 .SH II. Structures
629 There are two main structures that are important to libpng, png_struct
630 and png_info.  Both are internal structures that are no longer exposed
631 in the libpng interface (as of libpng 1.5.0).
633 The png_info structure is designed to provide information about the
634 PNG file.  At one time, the fields of png_info were intended to be
635 directly accessible to the user.  However, this tended to cause problems
636 with applications using dynamically loaded libraries, and as a result
637 a set of interface functions for png_info (the png_get_*() and png_set_*()
638 functions) was developed, and direct access to the png_info fields was
639 deprecated..
641 The png_struct structure is the object used by the library to decode a
642 single image.  As of 1.5.0 this structure is also not exposed.
644 Almost all libpng APIs require a pointer to a png_struct as the first argument.
645 Many (in particular the png_set and png_get APIs) also require a pointer
646 to png_info as the second argument.  Some application visible macros
647 defined in png.h designed for basic data access (reading and writing
648 integers in the PNG format) don't take a png_info pointer, but it's almost
649 always safe to assume that a (png_struct*) has to be passed to call an API
650 function.
652 You can have more than one png_info structure associated with an image,
653 as illustrated in pngtest.c, one for information valid prior to the
654 IDAT chunks and another (called "end_info" below) for things after them.
656 The png.h header file is an invaluable reference for programming with libpng.
657 And while I'm on the topic, make sure you include the libpng header file:
659 #include <png.h>
661 and also (as of libpng-1.5.0) the zlib header file, if you need it:
663 #include <zlib.h>
665 .SS Types
667 The png.h header file defines a number of integral types used by the
668 APIs.  Most of these are fairly obvious; for example types corresponding
669 to integers of particular sizes and types for passing color values.
671 One exception is how non-integral numbers are handled.  For application
672 convenience most APIs that take such numbers have C (double) arguments;
673 however, internally PNG, and libpng, use 32 bit signed integers and encode
674 the value by multiplying by 100,000.  As of libpng 1.5.0 a convenience
675 macro PNG_FP_1 is defined in png.h along with a type (png_fixed_point)
676 which is simply (png_int_32).
678 All APIs that take (double) arguments also have a matching API that
679 takes the corresponding fixed point integer arguments.  The fixed point
680 API has the same name as the floating point one with "_fixed" appended.
681 The actual range of values permitted in the APIs is frequently less than
682 the full range of (png_fixed_point) (\-21474 to +21474).  When APIs require
683 a non-negative argument the type is recorded as png_uint_32 above.  Consult
684 the header file and the text below for more information.
686 Special care must be take with sCAL chunk handling because the chunk itself
687 uses non-integral values encoded as strings containing decimal floating point
688 numbers.  See the comments in the header file.
690 .SS Configuration
692 The main header file function declarations are frequently protected by C
693 preprocessing directives of the form:
695     #ifdef PNG_feature_SUPPORTED
696     declare-function
697     #endif
698     ...
699     #ifdef PNG_feature_SUPPORTED
700     use-function
701     #endif
703 The library can be built without support for these APIs, although a
704 standard build will have all implemented APIs.  Application programs
705 should check the feature macros before using an API for maximum
706 portability.  From libpng 1.5.0 the feature macros set during the build
707 of libpng are recorded in the header file "pnglibconf.h" and this file
708 is always included by png.h.
710 If you don't need to change the library configuration from the default, skip to
711 the next section ("Reading").
713 Notice that some of the makefiles in the 'scripts' directory and (in 1.5.0) all
714 of the build project files in the 'projects' directory simply copy
715 scripts/pnglibconf.h.prebuilt to pnglibconf.h.  This means that these build
716 systems do not permit easy auto-configuration of the library - they only
717 support the default configuration.
719 The easiest way to make minor changes to the libpng configuration when
720 auto-configuration is supported is to add definitions to the command line
721 using (typically) CPPFLAGS.  For example:
723 CPPFLAGS=\-DPNG_NO_FLOATING_ARITHMETIC
725 will change the internal libpng math implementation for gamma correction and
726 other arithmetic calculations to fixed point, avoiding the need for fast
727 floating point support.  The result can be seen in the generated pnglibconf.h -
728 make sure it contains the changed feature macro setting.
730 If you need to make more extensive configuration changes - more than one or two
731 feature macro settings - you can either add \-DPNG_USER_CONFIG to the build
732 command line and put a list of feature macro settings in pngusr.h or you can set
733 DFA_XTRA (a makefile variable) to a file containing the same information in the
734 form of 'option' settings.
736 A. Changing pnglibconf.h
738 A variety of methods exist to build libpng.  Not all of these support
739 reconfiguration of pnglibconf.h.  To reconfigure pnglibconf.h it must either be
740 rebuilt from scripts/pnglibconf.dfa using awk or it must be edited by hand.
742 Hand editing is achieved by copying scripts/pnglibconf.h.prebuilt to
743 pnglibconf.h and changing the lines defining the supported features, paying
744 very close attention to the 'option' information in scripts/pnglibconf.dfa
745 that describes those features and their requirements.  This is easy to get
746 wrong.
748 B. Configuration using DFA_XTRA
750 Rebuilding from pnglibconf.dfa is easy if a functioning 'awk', or a later
751 variant such as 'nawk' or 'gawk', is available.  The configure build will
752 automatically find an appropriate awk and build pnglibconf.h.
753 The scripts/pnglibconf.mak file contains a set of make rules for doing the
754 same thing if configure is not used, and many of the makefiles in the scripts
755 directory use this approach.
757 When rebuilding simply write a new file containing changed options and set
758 DFA_XTRA to the name of this file.  This causes the build to append the new file
759 to the end of scripts/pnglibconf.dfa.  The pngusr.dfa file should contain lines
760 of the following forms:
762 everything = off
764 This turns all optional features off.  Include it at the start of pngusr.dfa to
765 make it easier to build a minimal configuration.  You will need to turn at least
766 some features on afterward to enable either reading or writing code, or both.
768 option feature on
769 option feature off
771 Enable or disable a single feature.  This will automatically enable other
772 features required by a feature that is turned on or disable other features that
773 require a feature which is turned off.  Conflicting settings will cause an error
774 message to be emitted by awk.
776 setting feature default value
778 Changes the default value of setting 'feature' to 'value'.  There are a small
779 number of settings listed at the top of pnglibconf.h, they are documented in the
780 source code.  Most of these values have performance implications for the library
781 but most of them have no visible effect on the API.  Some can also be overridden
782 from the API.
784 This method of building a customized pnglibconf.h is illustrated in
785 contrib/pngminim/*.  See the "$(PNGCONF):" target in the makefile and
786 pngusr.dfa in these directories.
788 C. Configuration using PNG_USER_CONFIG
790 If \-DPNG_USER_CONFIG is added to the CPPFLAGS when pnglibconf.h is built,
791 the file pngusr.h will automatically be included before the options in
792 scripts/pnglibconf.dfa are processed.  Your pngusr.h file should contain only
793 macro definitions turning features on or off or setting settings.
795 Apart from the global setting "everything = off" all the options listed above
796 can be set using macros in pngusr.h:
798 #define PNG_feature_SUPPORTED
800 is equivalent to:
802 option feature on
804 #define PNG_NO_feature
806 is equivalent to:
808 option feature off
810 #define PNG_feature value
812 is equivalent to:
814 setting feature default value
816 Notice that in both cases, pngusr.dfa and pngusr.h, the contents of the
817 pngusr file you supply override the contents of scripts/pnglibconf.dfa
819 If confusing or incomprehensible behavior results it is possible to
820 examine the intermediate file pnglibconf.dfn to find the full set of
821 dependency information for each setting and option.  Simply locate the
822 feature in the file and read the C comments that precede it.
824 This method is also illustrated in the contrib/pngminim/* makefiles and
825 pngusr.h.
827 .SH III. Reading
829 We'll now walk you through the possible functions to call when reading
830 in a PNG file sequentially, briefly explaining the syntax and purpose
831 of each one.  See example.c and png.h for more detail.  While
832 progressive reading is covered in the next section, you will still
833 need some of the functions discussed in this section to read a PNG
834 file.
836 .SS Setup
838 You will want to do the I/O initialization(*) before you get into libpng,
839 so if it doesn't work, you don't have much to undo.  Of course, you
840 will also want to insure that you are, in fact, dealing with a PNG
841 file.  Libpng provides a simple check to see if a file is a PNG file.
842 To use it, pass in the first 1 to 8 bytes of the file to the function
843 png_sig_cmp(), and it will return 0 (false) if the bytes match the
844 corresponding bytes of the PNG signature, or nonzero (true) otherwise.
845 Of course, the more bytes you pass in, the greater the accuracy of the
846 prediction.
848 If you are intending to keep the file pointer open for use in libpng,
849 you must ensure you don't read more than 8 bytes from the beginning
850 of the file, and you also have to make a call to png_set_sig_bytes()
851 with the number of bytes you read from the beginning.  Libpng will
852 then only check the bytes (if any) that your program didn't read.
854 (*): If you are not using the standard I/O functions, you will need
855 to replace them with custom functions.  See the discussion under
856 Customizing libpng.
858     FILE *fp = fopen(file_name, "rb");
859     if (!fp)
860     {
861        return (ERROR);
862     }
864     if (fread(header, 1, number, fp) != number)
865     {
866        return (ERROR);
867     }
869     is_png = !png_sig_cmp(header, 0, number);
870     if (!is_png)
871     {
872        return (NOT_PNG);
873     }
875 Next, png_struct and png_info need to be allocated and initialized.  In
876 order to ensure that the size of these structures is correct even with a
877 dynamically linked libpng, there are functions to initialize and
878 allocate the structures.  We also pass the library version, optional
879 pointers to error handling functions, and a pointer to a data struct for
880 use by the error functions, if necessary (the pointer and functions can
881 be NULL if the default error handlers are to be used).  See the section
882 on Changes to Libpng below regarding the old initialization functions.
883 The structure allocation functions quietly return NULL if they fail to
884 create the structure, so your application should check for that.
886     png_structp png_ptr = png_create_read_struct
887         (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
888         user_error_fn, user_warning_fn);
890     if (!png_ptr)
891        return (ERROR);
893     png_infop info_ptr = png_create_info_struct(png_ptr);
895     if (!info_ptr)
896     {
897        png_destroy_read_struct(&png_ptr,
898            (png_infopp)NULL, (png_infopp)NULL);
899        return (ERROR);
900     }
902 If you want to use your own memory allocation routines,
903 use a libpng that was built with PNG_USER_MEM_SUPPORTED defined, and use
904 png_create_read_struct_2() instead of png_create_read_struct():
906     png_structp png_ptr = png_create_read_struct_2
907         (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
908         user_error_fn, user_warning_fn, (png_voidp)
909         user_mem_ptr, user_malloc_fn, user_free_fn);
911 The error handling routines passed to png_create_read_struct()
912 and the memory alloc/free routines passed to png_create_struct_2()
913 are only necessary if you are not using the libpng supplied error
914 handling and memory alloc/free functions.
916 When libpng encounters an error, it expects to longjmp back
917 to your routine.  Therefore, you will need to call setjmp and pass
918 your png_jmpbuf(png_ptr).  If you read the file from different
919 routines, you will need to update the longjmp buffer every time you enter
920 a new routine that will call a png_*() function.
922 See your documentation of setjmp/longjmp for your compiler for more
923 information on setjmp/longjmp.  See the discussion on libpng error
924 handling in the Customizing Libpng section below for more information
925 on the libpng error handling.  If an error occurs, and libpng longjmp's
926 back to your setjmp, you will want to call png_destroy_read_struct() to
927 free any memory.
929     if (setjmp(png_jmpbuf(png_ptr)))
930     {
931        png_destroy_read_struct(&png_ptr, &info_ptr,
932            &end_info);
933        fclose(fp);
934        return (ERROR);
935     }
937 Pass (png_infopp)NULL instead of &end_info if you didn't create
938 an end_info structure.
940 If you would rather avoid the complexity of setjmp/longjmp issues,
941 you can compile libpng with PNG_NO_SETJMP, in which case
942 errors will result in a call to PNG_ABORT() which defaults to abort().
944 You can #define PNG_ABORT() to a function that does something
945 more useful than abort(), as long as your function does not
946 return.
948 Now you need to set up the input code.  The default for libpng is to
949 use the C function fread().  If you use this, you will need to pass a
950 valid FILE * in the function png_init_io().  Be sure that the file is
951 opened in binary mode.  If you wish to handle reading data in another
952 way, you need not call the png_init_io() function, but you must then
953 implement the libpng I/O methods discussed in the Customizing Libpng
954 section below.
956     png_init_io(png_ptr, fp);
958 If you had previously opened the file and read any of the signature from
959 the beginning in order to see if this was a PNG file, you need to let
960 libpng know that there are some bytes missing from the start of the file.
962     png_set_sig_bytes(png_ptr, number);
964 You can change the zlib compression buffer size to be used while
965 reading compressed data with
967     png_set_compression_buffer_size(png_ptr, buffer_size);
969 where the default size is 8192 bytes.  Note that the buffer size
970 is changed immediately and the buffer is reallocated immediately,
971 instead of setting a flag to be acted upon later.
973 If you want CRC errors to be handled in a different manner than
974 the default, use
976     png_set_crc_action(png_ptr, crit_action, ancil_action);
978 The values for png_set_crc_action() say how libpng is to handle CRC errors in
979 ancillary and critical chunks, and whether to use the data contained
980 therein. Starting with libpng-1.6.26, this also governs how an ADLER32 error
981 is handled while reading the IDAT chunk. Note that it is impossible to
982 "discard" data in a critical chunk.
984 Choices for (int) crit_action are
985    PNG_CRC_DEFAULT      0  error/quit
986    PNG_CRC_ERROR_QUIT   1  error/quit
987    PNG_CRC_WARN_USE     3  warn/use data
988    PNG_CRC_QUIET_USE    4  quiet/use data
989    PNG_CRC_NO_CHANGE    5  use the current value
991 Choices for (int) ancil_action are
992    PNG_CRC_DEFAULT      0  error/quit
993    PNG_CRC_ERROR_QUIT   1  error/quit
994    PNG_CRC_WARN_DISCARD 2  warn/discard data
995    PNG_CRC_WARN_USE     3  warn/use data
996    PNG_CRC_QUIET_USE    4  quiet/use data
997    PNG_CRC_NO_CHANGE    5  use the current value
999 When the setting for crit_action is PNG_CRC_QUIET_USE, the CRC and ADLER32
1000 checksums are not only ignored, but they are not evaluated.
1002 .SS Setting up callback code
1004 You can set up a callback function to handle any unknown chunks in the
1005 input stream. You must supply the function
1007     read_chunk_callback(png_structp png_ptr,
1008          png_unknown_chunkp chunk);
1009     {
1010        /* The unknown chunk structure contains your
1011           chunk data, along with similar data for any other
1012           unknown chunks: */
1014            png_byte name[5];
1015            png_byte *data;
1016            png_size_t size;
1018        /* Note that libpng has already taken care of
1019           the CRC handling */
1021        /* put your code here.  Search for your chunk in the
1022           unknown chunk structure, process it, and return one
1023           of the following: */
1025        return (\-n); /* chunk had an error */
1026        return (0); /* did not recognize */
1027        return (n); /* success */
1028     }
1030 (You can give your function another name that you like instead of
1031 "read_chunk_callback")
1033 To inform libpng about your function, use
1035     png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
1036         read_chunk_callback);
1038 This names not only the callback function, but also a user pointer that
1039 you can retrieve with
1041     png_get_user_chunk_ptr(png_ptr);
1043 If you call the png_set_read_user_chunk_fn() function, then all unknown
1044 chunks which the callback does not handle will be saved when read.  You can
1045 cause them to be discarded by returning '1' ("handled") instead of '0'.  This
1046 behavior will change in libpng 1.7 and the default handling set by the
1047 png_set_keep_unknown_chunks() function, described below, will be used when the
1048 callback returns 0.  If you want the existing behavior you should set the global
1049 default to PNG_HANDLE_CHUNK_IF_SAFE now; this is compatible with all current
1050 versions of libpng and with 1.7.  Libpng 1.6 issues a warning if you keep the
1051 default, or PNG_HANDLE_CHUNK_NEVER, and the callback returns 0.
1053 At this point, you can set up a callback function that will be
1054 called after each row has been read, which you can use to control
1055 a progress meter or the like.  It's demonstrated in pngtest.c.
1056 You must supply a function
1058     void read_row_callback(png_structp png_ptr,
1059        png_uint_32 row, int pass);
1060     {
1061       /* put your code here */
1062     }
1064 (You can give it another name that you like instead of "read_row_callback")
1066 To inform libpng about your function, use
1068     png_set_read_status_fn(png_ptr, read_row_callback);
1070 When this function is called the row has already been completely processed and
1071 the 'row' and 'pass' refer to the next row to be handled.  For the
1072 non-interlaced case the row that was just handled is simply one less than the
1073 passed in row number, and pass will always be 0.  For the interlaced case the
1074 same applies unless the row value is 0, in which case the row just handled was
1075 the last one from one of the preceding passes.  Because interlacing may skip a
1076 pass you cannot be sure that the preceding pass is just 'pass\-1'; if you really
1077 need to know what the last pass is record (row,pass) from the callback and use
1078 the last recorded value each time.
1080 As with the user transform you can find the output row using the
1081 PNG_ROW_FROM_PASS_ROW macro.
1083 .SS Unknown-chunk handling
1085 Now you get to set the way the library processes unknown chunks in the
1086 input PNG stream. Both known and unknown chunks will be read.  Normal
1087 behavior is that known chunks will be parsed into information in
1088 various info_ptr members while unknown chunks will be discarded. This
1089 behavior can be wasteful if your application will never use some known
1090 chunk types. To change this, you can call:
1092     png_set_keep_unknown_chunks(png_ptr, keep,
1093         chunk_list, num_chunks);
1095     keep       - 0: default unknown chunk handling
1096                  1: ignore; do not keep
1097                  2: keep only if safe-to-copy
1098                  3: keep even if unsafe-to-copy
1100                You can use these definitions:
1101                  PNG_HANDLE_CHUNK_AS_DEFAULT   0
1102                  PNG_HANDLE_CHUNK_NEVER        1
1103                  PNG_HANDLE_CHUNK_IF_SAFE      2
1104                  PNG_HANDLE_CHUNK_ALWAYS       3
1106     chunk_list - list of chunks affected (a byte string,
1107                  five bytes per chunk, NULL or '\0' if
1108                  num_chunks is positive; ignored if
1109                  numchunks <= 0).
1111     num_chunks - number of chunks affected; if 0, all
1112                  unknown chunks are affected.  If positive,
1113                  only the chunks in the list are affected,
1114                  and if negative all unknown chunks and
1115                  all known chunks except for the IHDR,
1116                  PLTE, tRNS, IDAT, and IEND chunks are
1117                  affected.
1119 Unknown chunks declared in this way will be saved as raw data onto a
1120 list of png_unknown_chunk structures.  If a chunk that is normally
1121 known to libpng is named in the list, it will be handled as unknown,
1122 according to the "keep" directive.  If a chunk is named in successive
1123 instances of png_set_keep_unknown_chunks(), the final instance will
1124 take precedence.  The IHDR and IEND chunks should not be named in
1125 chunk_list; if they are, libpng will process them normally anyway.
1126 If you know that your application will never make use of some particular
1127 chunks, use PNG_HANDLE_CHUNK_NEVER (or 1) as demonstrated below.
1129 Here is an example of the usage of png_set_keep_unknown_chunks(),
1130 where the private "vpAg" chunk will later be processed by a user chunk
1131 callback function:
1133     png_byte vpAg[5]={118, 112,  65, 103, (png_byte) '\0'};
1135     #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
1136       png_byte unused_chunks[]=
1137       {
1138         104,  73,  83,  84, (png_byte) '\0',   /* hIST */
1139         105,  84,  88, 116, (png_byte) '\0',   /* iTXt */
1140         112,  67,  65,  76, (png_byte) '\0',   /* pCAL */
1141         115,  67,  65,  76, (png_byte) '\0',   /* sCAL */
1142         115,  80,  76,  84, (png_byte) '\0',   /* sPLT */
1143         116,  73,  77,  69, (png_byte) '\0',   /* tIME */
1144       };
1145     #endif
1147     ...
1149     #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
1150       /* ignore all unknown chunks
1151        * (use global setting "2" for libpng16 and earlier):
1152        */
1153       png_set_keep_unknown_chunks(read_ptr, 2, NULL, 0);
1155       /* except for vpAg: */
1156       png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
1158       /* also ignore unused known chunks: */
1159       png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
1160          (int)(sizeof unused_chunks)/5);
1161     #endif
1163 .SS User limits
1165 The PNG specification allows the width and height of an image to be as
1166 large as 2^(31\-1 (0x7fffffff), or about 2.147 billion rows and columns.
1167 For safety, libpng imposes a default limit of 1 million rows and columns.
1168 Larger images will be rejected immediately with a png_error() call. If
1169 you wish to change these limits, you can use
1171    png_set_user_limits(png_ptr, width_max, height_max);
1173 to set your own limits (libpng may reject some very wide images
1174 anyway because of potential buffer overflow conditions).
1176 You should put this statement after you create the PNG structure and
1177 before calling png_read_info(), png_read_png(), or png_process_data().
1179 When writing a PNG datastream, put this statement before calling
1180 png_write_info() or png_write_png().
1182 If you need to retrieve the limits that are being applied, use
1184    width_max = png_get_user_width_max(png_ptr);
1185    height_max = png_get_user_height_max(png_ptr);
1187 The PNG specification sets no limit on the number of ancillary chunks
1188 allowed in a PNG datastream.  By default, libpng imposes a limit of
1189 a total of 1000 sPLT, tEXt, iTXt, zTXt, and unknown chunks to be stored.
1190 If you have set up both info_ptr and end_info_ptr, the limit applies
1191 separately to each.  You can change the limit on the total number of such
1192 chunks that will be stored, with
1194    png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);
1196 where 0x7fffffffL means unlimited.  You can retrieve this limit with
1198    chunk_cache_max = png_get_chunk_cache_max(png_ptr);
1200 Libpng imposes a limit of 8 Megabytes (8,000,000 bytes) on the amount of
1201 memory that a compressed chunk other than IDAT can occupy, when decompressed.
1202 You can change this limit with
1204    png_set_chunk_malloc_max(png_ptr, user_chunk_malloc_max);
1206 and you can retrieve the limit with
1208    chunk_malloc_max = png_get_chunk_malloc_max(png_ptr);
1210 Any chunks that would cause either of these limits to be exceeded will
1211 be ignored.
1213 .SS Information about your system
1215 If you intend to display the PNG or to incorporate it in other image data you
1216 need to tell libpng information about your display or drawing surface so that
1217 libpng can convert the values in the image to match the display.
1219 From libpng-1.5.4 this information can be set before reading the PNG file
1220 header.  In earlier versions png_set_gamma() existed but behaved incorrectly if
1221 called before the PNG file header had been read and png_set_alpha_mode() did not
1222 exist.
1224 If you need to support versions prior to libpng-1.5.4 test the version number
1225 as illustrated below using "PNG_LIBPNG_VER >= 10504" and follow the procedures
1226 described in the appropriate manual page.
1228 You give libpng the encoding expected by your system expressed as a 'gamma'
1229 value.  You can also specify a default encoding for the PNG file in
1230 case the required information is missing from the file.  By default libpng
1231 assumes that the PNG data matches your system, to keep this default call:
1233    png_set_gamma(png_ptr, screen_gamma, output_gamma);
1235 or you can use the fixed point equivalent:
1237    png_set_gamma_fixed(png_ptr, PNG_FP_1*screen_gamma,
1238       PNG_FP_1*output_gamma);
1240 If you don't know the gamma for your system it is probably 2.2 - a good
1241 approximation to the IEC standard for display systems (sRGB).  If images are
1242 too contrasty or washed out you got the value wrong - check your system
1243 documentation!
1245 Many systems permit the system gamma to be changed via a lookup table in the
1246 display driver, a few systems, including older Macs, change the response by
1247 default.  As of 1.5.4 three special values are available to handle common
1248 situations:
1250    PNG_DEFAULT_sRGB: Indicates that the system conforms to the
1251                      IEC 61966-2-1 standard.  This matches almost
1252                      all systems.
1253    PNG_GAMMA_MAC_18: Indicates that the system is an older
1254                      (pre Mac OS 10.6) Apple Macintosh system with
1255                      the default settings.
1256    PNG_GAMMA_LINEAR: Just the fixed point value for 1.0 - indicates
1257                      that the system expects data with no gamma
1258                      encoding.
1260 You would use the linear (unencoded) value if you need to process the pixel
1261 values further because this avoids the need to decode and re-encode each
1262 component value whenever arithmetic is performed.  A lot of graphics software
1263 uses linear values for this reason, often with higher precision component values
1264 to preserve overall accuracy.
1267 The output_gamma value expresses how to decode the output values, not how
1268 they are encoded.  The values used correspond to the normal numbers used to
1269 describe the overall gamma of a computer display system; for example 2.2 for
1270 an sRGB conformant system.  The values are scaled by 100000 in the _fixed
1271 version of the API (so 220000 for sRGB.)
1273 The inverse of the value is always used to provide a default for the PNG file
1274 encoding if it has no gAMA chunk and if png_set_gamma() has not been called
1275 to override the PNG gamma information.
1277 When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
1278 opaque pixels however pixels with lower alpha values are not encoded,
1279 regardless of the output gamma setting.
1281 When the standard Porter Duff handling is requested with mode 1 the output
1282 encoding is set to be linear and the output_gamma value is only relevant
1283 as a default for input data that has no gamma information.  The linear output
1284 encoding will be overridden if png_set_gamma() is called - the results may be
1285 highly unexpected!
1287 The following numbers are derived from the sRGB standard and the research
1288 behind it.  sRGB is defined to be approximated by a PNG gAMA chunk value of
1289 0.45455 (1/2.2) for PNG.  The value implicitly includes any viewing
1290 correction required to take account of any differences in the color
1291 environment of the original scene and the intended display environment; the
1292 value expresses how to *decode* the image for display, not how the original
1293 data was *encoded*.
1295 sRGB provides a peg for the PNG standard by defining a viewing environment.
1296 sRGB itself, and earlier TV standards, actually use a more complex transform
1297 (a linear portion then a gamma 2.4 power law) than PNG can express.  (PNG is
1298 limited to simple power laws.)  By saying that an image for direct display on
1299 an sRGB conformant system should be stored with a gAMA chunk value of 45455
1300 (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
1301 makes it possible to derive values for other display systems and
1302 environments.
1304 The Mac value is deduced from the sRGB based on an assumption that the actual
1305 extra viewing correction used in early Mac display systems was implemented as
1306 a power 1.45 lookup table.
1308 Any system where a programmable lookup table is used or where the behavior of
1309 the final display device characteristics can be changed requires system
1310 specific code to obtain the current characteristic.  However this can be
1311 difficult and most PNG gamma correction only requires an approximate value.
1313 By default, if png_set_alpha_mode() is not called, libpng assumes that all
1314 values are unencoded, linear, values and that the output device also has a
1315 linear characteristic.  This is only very rarely correct - it is invariably
1316 better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
1317 default if you don't know what the right answer is!
1319 The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
1320 10.6) which used a correction table to implement a somewhat lower gamma on an
1321 otherwise sRGB system.
1323 Both these values are reserved (not simple gamma values) in order to allow
1324 more precise correction internally in the future.
1326 NOTE: the values can be passed to either the fixed or floating
1327 point APIs, but the floating point API will also accept floating point
1328 values.
1330 The second thing you may need to tell libpng about is how your system handles
1331 alpha channel information.  Some, but not all, PNG files contain an alpha
1332 channel.  To display these files correctly you need to compose the data onto a
1333 suitable background, as described in the PNG specification.
1335 Libpng only supports composing onto a single color (using png_set_background;
1336 see below).  Otherwise you must do the composition yourself and, in this case,
1337 you may need to call png_set_alpha_mode:
1339    #if PNG_LIBPNG_VER >= 10504
1340       png_set_alpha_mode(png_ptr, mode, screen_gamma);
1341    #else
1342       png_set_gamma(png_ptr, screen_gamma, 1.0/screen_gamma);
1343    #endif
1345 The screen_gamma value is the same as the argument to png_set_gamma; however,
1346 how it affects the output depends on the mode.  png_set_alpha_mode() sets the
1347 file gamma default to 1/screen_gamma, so normally you don't need to call
1348 png_set_gamma.  If you need different defaults call png_set_gamma() before
1349 png_set_alpha_mode() - if you call it after it will override the settings made
1350 by png_set_alpha_mode().
1352 The mode is as follows:
1354     PNG_ALPHA_PNG: The data is encoded according to the PNG
1355 specification.  Red, green and blue, or gray, components are
1356 gamma encoded color values and are not premultiplied by the
1357 alpha value.  The alpha value is a linear measure of the
1358 contribution of the pixel to the corresponding final output pixel.
1360 You should normally use this format if you intend to perform
1361 color correction on the color values; most, maybe all, color
1362 correction software has no handling for the alpha channel and,
1363 anyway, the math to handle pre-multiplied component values is
1364 unnecessarily complex.
1366 Before you do any arithmetic on the component values you need
1367 to remove the gamma encoding and multiply out the alpha
1368 channel.  See the PNG specification for more detail.  It is
1369 important to note that when an image with an alpha channel is
1370 scaled, linear encoded, pre-multiplied component values must
1371 be used!
1373 The remaining modes assume you don't need to do any further color correction or
1374 that if you do, your color correction software knows all about alpha (it
1375 probably doesn't!).  They 'associate' the alpha with the color information by
1376 storing color channel values that have been scaled by the alpha.  The
1377 advantage is that the color channels can be resampled (the image can be
1378 scaled) in this form.  The disadvantage is that normal practice is to store
1379 linear, not (gamma) encoded, values and this requires 16-bit channels for
1380 still images rather than the 8-bit channels that are just about sufficient if
1381 gamma encoding is used.  In addition all non-transparent pixel values,
1382 including completely opaque ones, must be gamma encoded to produce the final
1383 image.  These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
1384 described below (the latter being the two common names for associated alpha
1385 color channels). Note that PNG files always contain non-associated color
1386 channels; png_set_alpha_mode() with one of the modes causes the decoder to
1387 convert the pixels to an associated form before returning them to your
1388 application. 
1390 Since it is not necessary to perform arithmetic on opaque color values so
1391 long as they are not to be resampled and are in the final color space it is
1392 possible to optimize the handling of alpha by storing the opaque pixels in
1393 the PNG format (adjusted for the output color space) while storing partially
1394 opaque pixels in the standard, linear, format.  The accuracy required for
1395 standard alpha composition is relatively low, because the pixels are
1396 isolated, therefore typically the accuracy loss in storing 8-bit linear
1397 values is acceptable.  (This is not true if the alpha channel is used to
1398 simulate transparency over large areas - use 16 bits or the PNG mode in
1399 this case!)  This is the 'OPTIMIZED' mode.  For this mode a pixel is
1400 treated as opaque only if the alpha value is equal to the maximum value.
1402     PNG_ALPHA_STANDARD:  The data libpng produces is encoded in the
1403 standard way assumed by most correctly written graphics software.
1404 The gamma encoding will be removed by libpng and the
1405 linear component values will be pre-multiplied by the
1406 alpha channel.
1408 With this format the final image must be re-encoded to
1409 match the display gamma before the image is displayed.
1410 If your system doesn't do that, yet still seems to
1411 perform arithmetic on the pixels without decoding them,
1412 it is broken - check out the modes below.
1414 With PNG_ALPHA_STANDARD libpng always produces linear
1415 component values, whatever screen_gamma you supply.  The
1416 screen_gamma value is, however, used as a default for
1417 the file gamma if the PNG file has no gamma information.
1419 If you call png_set_gamma() after png_set_alpha_mode() you
1420 will override the linear encoding.  Instead the
1421 pre-multiplied pixel values will be gamma encoded but
1422 the alpha channel will still be linear.  This may
1423 actually match the requirements of some broken software,
1424 but it is unlikely.
1426 While linear 8-bit data is often used it has
1427 insufficient precision for any image with a reasonable
1428 dynamic range.  To avoid problems, and if your software
1429 supports it, use png_set_expand_16() to force all
1430 components to 16 bits.
1432     PNG_ALPHA_OPTIMIZED: This mode is the same as PNG_ALPHA_STANDARD
1433 except that completely opaque pixels are gamma encoded according to
1434 the screen_gamma value.  Pixels with alpha less than 1.0
1435 will still have linear components.
1437 Use this format if you have control over your
1438 compositing software and so don't do other arithmetic
1439 (such as scaling) on the data you get from libpng.  Your
1440 compositing software can simply copy opaque pixels to
1441 the output but still has linear values for the
1442 non-opaque pixels.
1444 In normal compositing, where the alpha channel encodes
1445 partial pixel coverage (as opposed to broad area
1446 translucency), the inaccuracies of the 8-bit
1447 representation of non-opaque pixels are irrelevant.
1449 You can also try this format if your software is broken;
1450 it might look better.
1452     PNG_ALPHA_BROKEN: This is PNG_ALPHA_STANDARD; however, all component
1453 values, including the alpha channel are gamma encoded.  This is
1454 broken because, in practice, no implementation that uses this choice
1455 correctly undoes the encoding before handling alpha composition.  Use this
1456 choice only if other serious errors in the software or hardware you use
1457 mandate it.  In most cases of broken software or hardware the bug in the
1458 final display manifests as a subtle halo around composited parts of the
1459 image.  You may not even perceive this as a halo; the composited part of
1460 the image may simply appear separate from the background, as though it had
1461 been cut out of paper and pasted on afterward.
1463 If you don't have to deal with bugs in software or hardware, or if you can fix
1464 them, there are three recommended ways of using png_set_alpha_mode():
1466    png_set_alpha_mode(png_ptr, PNG_ALPHA_PNG,
1467        screen_gamma);
1469 You can do color correction on the result (libpng does not currently
1470 support color correction internally).  When you handle the alpha channel
1471 you need to undo the gamma encoding and multiply out the alpha.
1473    png_set_alpha_mode(png_ptr, PNG_ALPHA_STANDARD,
1474        screen_gamma);
1475    png_set_expand_16(png_ptr);
1477 If you are using the high level interface, don't call png_set_expand_16();
1478 instead pass PNG_TRANSFORM_EXPAND_16 to the interface.
1480 With this mode you can't do color correction, but you can do arithmetic,
1481 including composition and scaling, on the data without further processing.
1483    png_set_alpha_mode(png_ptr, PNG_ALPHA_OPTIMIZED,
1484        screen_gamma);
1486 You can avoid the expansion to 16-bit components with this mode, but you
1487 lose the ability to scale the image or perform other linear arithmetic.
1488 All you can do is compose the result onto a matching output.  Since this
1489 mode is libpng-specific you also need to write your own composition
1490 software.
1492 The following are examples of calls to png_set_alpha_mode to achieve the
1493 required overall gamma correction and, where necessary, alpha
1494 premultiplication.
1496     png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1498 This is the default libpng handling of the alpha channel - it is not
1499 pre-multiplied into the color components.  In addition the call states
1500 that the output is for a sRGB system and causes all PNG files without gAMA
1501 chunks to be assumed to be encoded using sRGB.
1503     png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1505 In this case the output is assumed to be something like an sRGB conformant
1506 display preceeded by a power-law lookup table of power 1.45.  This is how
1507 early Mac systems behaved.
1509     png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1511 This is the classic Jim Blinn approach and will work in academic
1512 environments where everything is done by the book.  It has the shortcoming
1513 of assuming that input PNG data with no gamma information is linear - this
1514 is unlikely to be correct unless the PNG files where generated locally.
1515 Most of the time the output precision will be so low as to show
1516 significant banding in dark areas of the image.
1518     png_set_expand_16(pp);
1519     png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1521 This is a somewhat more realistic Jim Blinn inspired approach.  PNG files
1522 are assumed to have the sRGB encoding if not marked with a gamma value and
1523 the output is always 16 bits per component.  This permits accurate scaling
1524 and processing of the data.  If you know that your input PNG files were
1525 generated locally you might need to replace PNG_DEFAULT_sRGB with the
1526 correct value for your system.
1528     png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1530 If you just need to composite the PNG image onto an existing background
1531 and if you control the code that does this you can use the optimization
1532 setting.  In this case you just copy completely opaque pixels to the
1533 output.  For pixels that are not completely transparent (you just skip
1534 those) you do the composition math using png_composite or png_composite_16
1535 below then encode the resultant 8-bit or 16-bit values to match the output
1536 encoding.
1538     Other cases
1540 If neither the PNG nor the standard linear encoding work for you because
1541 of the software or hardware you use then you have a big problem.  The PNG
1542 case will probably result in halos around the image.  The linear encoding
1543 will probably result in a washed out, too bright, image (it's actually too
1544 contrasty.)  Try the ALPHA_OPTIMIZED mode above - this will probably
1545 substantially reduce the halos.  Alternatively try:
1547     png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1549 This option will also reduce the halos, but there will be slight dark
1550 halos round the opaque parts of the image where the background is light.
1551 In the OPTIMIZED mode the halos will be light halos where the background
1552 is dark.  Take your pick - the halos are unavoidable unless you can get
1553 your hardware/software fixed!  (The OPTIMIZED approach is slightly
1554 faster.)
1556 When the default gamma of PNG files doesn't match the output gamma.
1557 If you have PNG files with no gamma information png_set_alpha_mode allows
1558 you to provide a default gamma, but it also sets the ouput gamma to the
1559 matching value.  If you know your PNG files have a gamma that doesn't
1560 match the output you can take advantage of the fact that
1561 png_set_alpha_mode always sets the output gamma but only sets the PNG
1562 default if it is not already set:
1564     png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1565     png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1567 The first call sets both the default and the output gamma values, the
1568 second call overrides the output gamma without changing the default.  This
1569 is easier than achieving the same effect with png_set_gamma.  You must use
1570 PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1571 fire if more than one call to png_set_alpha_mode and png_set_background is
1572 made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1573 are ignored.
1575 If you don't need, or can't handle, the alpha channel you can call
1576 png_set_background() to remove it by compositing against a fixed color.  Don't
1577 call png_set_strip_alpha() to do this - it will leave spurious pixel values in
1578 transparent parts of this image.
1580    png_set_background(png_ptr, &background_color,
1581        PNG_BACKGROUND_GAMMA_SCREEN, 0, 1);
1583 The background_color is an RGB or grayscale value according to the data format
1584 libpng will produce for you.  Because you don't yet know the format of the PNG
1585 file, if you call png_set_background at this point you must arrange for the
1586 format produced by libpng to always have 8-bit or 16-bit components and then
1587 store the color as an 8-bit or 16-bit color as appropriate.  The color contains
1588 separate gray and RGB component values, so you can let libpng produce gray or
1589 RGB output according to the input format, but low bit depth grayscale images
1590 must always be converted to at least 8-bit format.  (Even though low bit depth
1591 grayscale images can't have an alpha channel they can have a transparent
1592 color!)
1594 You set the transforms you need later, either as flags to the high level
1595 interface or libpng API calls for the low level interface.  For reference the
1596 settings and API calls required are:
1598 8-bit values:
1599    PNG_TRANSFORM_SCALE_16 | PNG_EXPAND
1600    png_set_expand(png_ptr); png_set_scale_16(png_ptr);
1602    If you must get exactly the same inaccurate results
1603    produced by default in versions prior to libpng-1.5.4,
1604    use PNG_TRANSFORM_STRIP_16 and png_set_strip_16(png_ptr)
1605    instead.
1607 16-bit values:
1608    PNG_TRANSFORM_EXPAND_16
1609    png_set_expand_16(png_ptr);
1611 In either case palette image data will be expanded to RGB.  If you just want
1612 color data you can add PNG_TRANSFORM_GRAY_TO_RGB or png_set_gray_to_rgb(png_ptr)
1613 to the list.
1615 Calling png_set_background before the PNG file header is read will not work
1616 prior to libpng-1.5.4.  Because the failure may result in unexpected warnings or
1617 errors it is therefore much safer to call png_set_background after the head has
1618 been read.  Unfortunately this means that prior to libpng-1.5.4 it cannot be
1619 used with the high level interface.
1621 .SS The high-level read interface
1623 At this point there are two ways to proceed; through the high-level
1624 read interface, or through a sequence of low-level read operations.
1625 You can use the high-level interface if (a) you are willing to read
1626 the entire image into memory, and (b) the input transformations
1627 you want to do are limited to the following set:
1629     PNG_TRANSFORM_IDENTITY      No transformation
1630     PNG_TRANSFORM_SCALE_16      Strip 16-bit samples to
1631                                 8-bit accurately
1632     PNG_TRANSFORM_STRIP_16      Chop 16-bit samples to
1633                                 8-bit less accurately
1634     PNG_TRANSFORM_STRIP_ALPHA   Discard the alpha channel
1635     PNG_TRANSFORM_PACKING       Expand 1, 2 and 4-bit
1636                                 samples to bytes
1637     PNG_TRANSFORM_PACKSWAP      Change order of packed
1638                                 pixels to LSB first
1639     PNG_TRANSFORM_EXPAND        Perform set_expand()
1640     PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
1641     PNG_TRANSFORM_SHIFT         Normalize pixels to the
1642                                 sBIT depth
1643     PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
1644                                 to BGRA
1645     PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
1646                                 to AG
1647     PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
1648                                 to transparency
1649     PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
1650     PNG_TRANSFORM_GRAY_TO_RGB   Expand grayscale samples
1651                                 to RGB (or GA to RGBA)
1652     PNG_TRANSFORM_EXPAND_16     Expand samples to 16 bits
1654 (This excludes setting a background color, doing gamma transformation,
1655 quantizing, and setting filler.)  If this is the case, simply do this:
1657     png_read_png(png_ptr, info_ptr, png_transforms, NULL)
1659 where png_transforms is an integer containing the bitwise OR of some
1660 set of transformation flags.  This call is equivalent to png_read_info(),
1661 followed the set of transformations indicated by the transform mask,
1662 then png_read_image(), and finally png_read_end().
1664 (The final parameter of this call is not yet used.  Someday it might point
1665 to transformation parameters required by some future input transform.)
1667 You must use png_transforms and not call any png_set_transform() functions
1668 when you use png_read_png().
1670 After you have called png_read_png(), you can retrieve the image data
1671 with
1673    row_pointers = png_get_rows(png_ptr, info_ptr);
1675 where row_pointers is an array of pointers to the pixel data for each row:
1677    png_bytep row_pointers[height];
1679 If you know your image size and pixel size ahead of time, you can allocate
1680 row_pointers prior to calling png_read_png() with
1682    if (height > PNG_UINT_32_MAX/(sizeof (png_byte)))
1683       png_error (png_ptr,
1684           "Image is too tall to process in memory");
1686    if (width > PNG_UINT_32_MAX/pixel_size)
1687       png_error (png_ptr,
1688           "Image is too wide to process in memory");
1690    row_pointers = png_malloc(png_ptr,
1691        height*(sizeof (png_bytep)));
1693    for (int i=0; i<height, i++)
1694       row_pointers[i]=NULL;  /* security precaution */
1696    for (int i=0; i<height, i++)
1697       row_pointers[i]=png_malloc(png_ptr,
1698           width*pixel_size);
1700    png_set_rows(png_ptr, info_ptr, &row_pointers);
1702 Alternatively you could allocate your image in one big block and define
1703 row_pointers[i] to point into the proper places in your block.
1705 If you use png_set_rows(), the application is responsible for freeing
1706 row_pointers (and row_pointers[i], if they were separately allocated).
1708 If you don't allocate row_pointers ahead of time, png_read_png() will
1709 do it, and it'll be free'ed by libpng when you call png_destroy_*().
1711 .SS The low-level read interface
1713 If you are going the low-level route, you are now ready to read all
1714 the file information up to the actual image data.  You do this with a
1715 call to png_read_info().
1717     png_read_info(png_ptr, info_ptr);
1719 This will process all chunks up to but not including the image data.
1721 This also copies some of the data from the PNG file into the decode structure
1722 for use in later transformations.  Important information copied in is:
1724 1) The PNG file gamma from the gAMA chunk.  This overwrites the default value
1725 provided by an earlier call to png_set_gamma or png_set_alpha_mode.
1727 2) Prior to libpng-1.5.4 the background color from a bKGd chunk.  This
1728 damages the information provided by an earlier call to png_set_background
1729 resulting in unexpected behavior.  Libpng-1.5.4 no longer does this.
1731 3) The number of significant bits in each component value.  Libpng uses this to
1732 optimize gamma handling by reducing the internal lookup table sizes.
1734 4) The transparent color information from a tRNS chunk.  This can be modified by
1735 a later call to png_set_tRNS.
1737 .SS Querying the info structure
1739 Functions are used to get the information from the info_ptr once it
1740 has been read.  Note that these fields may not be completely filled
1741 in until png_read_end() has read the chunk data following the image.
1743     png_get_IHDR(png_ptr, info_ptr, &width, &height,
1744        &bit_depth, &color_type, &interlace_type,
1745        &compression_type, &filter_method);
1747     width          - holds the width of the image
1748                      in pixels (up to 2^31).
1750     height         - holds the height of the image
1751                      in pixels (up to 2^31).
1753     bit_depth      - holds the bit depth of one of the
1754                      image channels.  (valid values are
1755                      1, 2, 4, 8, 16 and depend also on
1756                      the color_type.  See also
1757                      significant bits (sBIT) below).
1759     color_type     - describes which color/alpha channels
1760                          are present.
1761                      PNG_COLOR_TYPE_GRAY
1762                         (bit depths 1, 2, 4, 8, 16)
1763                      PNG_COLOR_TYPE_GRAY_ALPHA
1764                         (bit depths 8, 16)
1765                      PNG_COLOR_TYPE_PALETTE
1766                         (bit depths 1, 2, 4, 8)
1767                      PNG_COLOR_TYPE_RGB
1768                         (bit_depths 8, 16)
1769                      PNG_COLOR_TYPE_RGB_ALPHA
1770                         (bit_depths 8, 16)
1772                      PNG_COLOR_MASK_PALETTE
1773                      PNG_COLOR_MASK_COLOR
1774                      PNG_COLOR_MASK_ALPHA
1776     interlace_type - (PNG_INTERLACE_NONE or
1777                      PNG_INTERLACE_ADAM7)
1779     compression_type - (must be PNG_COMPRESSION_TYPE_BASE
1780                      for PNG 1.0)
1782     filter_method  - (must be PNG_FILTER_TYPE_BASE
1783                      for PNG 1.0, and can also be
1784                      PNG_INTRAPIXEL_DIFFERENCING if
1785                      the PNG datastream is embedded in
1786                      a MNG-1.0 datastream)
1788     Any of width, height, color_type, bit_depth,
1789     interlace_type, compression_type, or filter_method can
1790     be NULL if you are not interested in their values.
1792     Note that png_get_IHDR() returns 32-bit data into
1793     the application's width and height variables.
1794     This is an unsafe situation if these are not png_uint_32
1795     variables.  In such situations, the
1796     png_get_image_width() and png_get_image_height()
1797     functions described below are safer.
1799     width            = png_get_image_width(png_ptr,
1800                          info_ptr);
1802     height           = png_get_image_height(png_ptr,
1803                          info_ptr);
1805     bit_depth        = png_get_bit_depth(png_ptr,
1806                          info_ptr);
1808     color_type       = png_get_color_type(png_ptr,
1809                          info_ptr);
1811     interlace_type   = png_get_interlace_type(png_ptr,
1812                          info_ptr);
1814     compression_type = png_get_compression_type(png_ptr,
1815                          info_ptr);
1817     filter_method    = png_get_filter_type(png_ptr,
1818                          info_ptr);
1820     channels = png_get_channels(png_ptr, info_ptr);
1822     channels       - number of channels of info for the
1823                      color type (valid values are 1 (GRAY,
1824                      PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
1825                      4 (RGB_ALPHA or RGB + filler byte))
1827     rowbytes = png_get_rowbytes(png_ptr, info_ptr);
1829     rowbytes       - number of bytes needed to hold a row
1831     signature = png_get_signature(png_ptr, info_ptr);
1833     signature      - holds the signature read from the
1834                      file (if any).  The data is kept in
1835                      the same offset it would be if the
1836                      whole signature were read (i.e. if an
1837                      application had already read in 4
1838                      bytes of signature before starting
1839                      libpng, the remaining 4 bytes would
1840                      be in signature[4] through signature[7]
1841                      (see png_set_sig_bytes())).
1843 These are also important, but their validity depends on whether the chunk
1844 has been read.  The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
1845 png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
1846 data has been read, or zero if it is missing.  The parameters to the
1847 png_get_<chunk> are set directly if they are simple data types, or a
1848 pointer into the info_ptr is returned for any complex types.
1850 The colorspace data from gAMA, cHRM, sRGB, iCCP, and sBIT chunks
1851 is simply returned to give the application information about how the
1852 image was encoded.  Libpng itself only does transformations using the file
1853 gamma when combining semitransparent pixels with the background color, and,
1854 since libpng-1.6.0, when converting between 8-bit sRGB and 16-bit linear pixels
1855 within the simplified API.  Libpng also uses the file gamma when converting
1856 RGB to gray, beginning with libpng-1.0.5, if the application calls
1857 png_set_rgb_to_gray()).
1859     png_get_PLTE(png_ptr, info_ptr, &palette,
1860                      &num_palette);
1862     palette        - the palette for the file
1863                      (array of png_color)
1865     num_palette    - number of entries in the palette
1867     png_get_gAMA(png_ptr, info_ptr, &file_gamma);
1868     png_get_gAMA_fixed(png_ptr, info_ptr, &int_file_gamma);
1870     file_gamma     - the gamma at which the file is
1871                      written (PNG_INFO_gAMA)
1873     int_file_gamma - 100,000 times the gamma at which the
1874                      file is written
1876     png_get_cHRM(png_ptr, info_ptr,  &white_x, &white_y, &red_x,
1877                      &red_y, &green_x, &green_y, &blue_x, &blue_y)
1878     png_get_cHRM_XYZ(png_ptr, info_ptr, &red_X, &red_Y, &red_Z,
1879                      &green_X, &green_Y, &green_Z, &blue_X, &blue_Y,
1880                      &blue_Z)
1881     png_get_cHRM_fixed(png_ptr, info_ptr, &int_white_x,
1882                      &int_white_y, &int_red_x, &int_red_y,
1883                      &int_green_x, &int_green_y, &int_blue_x,
1884                      &int_blue_y)
1885     png_get_cHRM_XYZ_fixed(png_ptr, info_ptr, &int_red_X, &int_red_Y,
1886                      &int_red_Z, &int_green_X, &int_green_Y,
1887                      &int_green_Z, &int_blue_X, &int_blue_Y,
1888                      &int_blue_Z)
1890     {white,red,green,blue}_{x,y}
1891                      A color space encoding specified using the
1892                      chromaticities of the end points and the
1893                      white point. (PNG_INFO_cHRM)
1895     {red,green,blue}_{X,Y,Z}
1896                      A color space encoding specified using the
1897                      encoding end points - the CIE tristimulus
1898                      specification of the intended color of the red,
1899                      green and blue channels in the PNG RGB data.
1900                      The white point is simply the sum of the three
1901                      end points. (PNG_INFO_cHRM)
1903     png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
1905     srgb_intent -    the rendering intent (PNG_INFO_sRGB)
1906                      The presence of the sRGB chunk
1907                      means that the pixel data is in the
1908                      sRGB color space.  This chunk also
1909                      implies specific values of gAMA and
1910                      cHRM.
1912     png_get_iCCP(png_ptr, info_ptr, &name,
1913        &compression_type, &profile, &proflen);
1915     name             - The profile name.
1917     compression_type - The compression type; always
1918                        PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
1919                        You may give NULL to this argument to
1920                        ignore it.
1922     profile          - International Color Consortium color
1923                        profile data. May contain NULs.
1925     proflen          - length of profile data in bytes.
1927     png_get_sBIT(png_ptr, info_ptr, &sig_bit);
1929     sig_bit        - the number of significant bits for
1930                      (PNG_INFO_sBIT) each of the gray,
1931                      red, green, and blue channels,
1932                      whichever are appropriate for the
1933                      given color type (png_color_16)
1935     png_get_tRNS(png_ptr, info_ptr, &trans_alpha,
1936                      &num_trans, &trans_color);
1938     trans_alpha    - array of alpha (transparency)
1939                      entries for palette (PNG_INFO_tRNS)
1941     num_trans      - number of transparent entries
1942                      (PNG_INFO_tRNS)
1944     trans_color    - graylevel or color sample values of
1945                      the single transparent color for
1946                      non-paletted images (PNG_INFO_tRNS)
1948     png_get_hIST(png_ptr, info_ptr, &hist);
1949                      (PNG_INFO_hIST)
1951     hist           - histogram of palette (array of
1952                      png_uint_16)
1954     png_get_tIME(png_ptr, info_ptr, &mod_time);
1956     mod_time       - time image was last modified
1957                     (PNG_VALID_tIME)
1959     png_get_bKGD(png_ptr, info_ptr, &background);
1961     background     - background color (of type
1962                      png_color_16p) (PNG_VALID_bKGD)
1963                      valid 16-bit red, green and blue
1964                      values, regardless of color_type
1966     num_comments   = png_get_text(png_ptr, info_ptr,
1967                      &text_ptr, &num_text);
1969     num_comments   - number of comments
1971     text_ptr       - array of png_text holding image
1972                      comments
1974     text_ptr[i].compression - type of compression used
1975                  on "text" PNG_TEXT_COMPRESSION_NONE
1976                            PNG_TEXT_COMPRESSION_zTXt
1977                            PNG_ITXT_COMPRESSION_NONE
1978                            PNG_ITXT_COMPRESSION_zTXt
1980     text_ptr[i].key   - keyword for comment.  Must contain
1981                          1-79 characters.
1983     text_ptr[i].text  - text comments for current
1984                          keyword.  Can be empty.
1986     text_ptr[i].text_length - length of text string,
1987                  after decompression, 0 for iTXt
1989     text_ptr[i].itxt_length - length of itxt string,
1990                  after decompression, 0 for tEXt/zTXt
1992     text_ptr[i].lang  - language of comment (empty
1993                          string for unknown).
1995     text_ptr[i].lang_key  - keyword in UTF-8
1996                          (empty string for unknown).
1998     Note that the itxt_length, lang, and lang_key
1999     members of the text_ptr structure only exist when the
2000     library is built with iTXt chunk support.  Prior to
2001     libpng-1.4.0 the library was built by default without
2002     iTXt support. Also note that when iTXt is supported,
2003     they contain NULL pointers when the "compression"
2004     field contains PNG_TEXT_COMPRESSION_NONE or
2005     PNG_TEXT_COMPRESSION_zTXt.
2007     num_text       - number of comments (same as
2008                      num_comments; you can put NULL here
2009                      to avoid the duplication)
2011     Note while png_set_text() will accept text, language,
2012     and translated keywords that can be NULL pointers, the
2013     structure returned by png_get_text will always contain
2014     regular zero-terminated C strings.  They might be
2015     empty strings but they will never be NULL pointers.
2017     num_spalettes = png_get_sPLT(png_ptr, info_ptr,
2018        &palette_ptr);
2020     num_spalettes  - number of sPLT chunks read.
2022     palette_ptr    - array of palette structures holding
2023                      contents of one or more sPLT chunks
2024                      read.
2026     png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
2027        &unit_type);
2029     offset_x       - positive offset from the left edge
2030                      of the screen (can be negative)
2032     offset_y       - positive offset from the top edge
2033                      of the screen (can be negative)
2035     unit_type      - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
2037     png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
2038        &unit_type);
2040     res_x          - pixels/unit physical resolution in
2041                      x direction
2043     res_y          - pixels/unit physical resolution in
2044                      x direction
2046     unit_type      - PNG_RESOLUTION_UNKNOWN,
2047                      PNG_RESOLUTION_METER
2049     png_get_sCAL(png_ptr, info_ptr, &unit, &width,
2050        &height)
2052     unit        - physical scale units (an integer)
2054     width       - width of a pixel in physical scale units
2056     height      - height of a pixel in physical scale units
2057                  (width and height are doubles)
2059     png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
2060        &height)
2062     unit        - physical scale units (an integer)
2064     width       - width of a pixel in physical scale units
2065                   (expressed as a string)
2067     height      - height of a pixel in physical scale units
2068                  (width and height are strings like "2.54")
2070     num_unknown_chunks = png_get_unknown_chunks(png_ptr,
2071        info_ptr, &unknowns)
2073     unknowns          - array of png_unknown_chunk
2074                         structures holding unknown chunks
2076     unknowns[i].name  - name of unknown chunk
2078     unknowns[i].data  - data of unknown chunk
2080     unknowns[i].size  - size of unknown chunk's data
2082     unknowns[i].location - position of chunk in file
2084     The value of "i" corresponds to the order in which the
2085     chunks were read from the PNG file or inserted with the
2086     png_set_unknown_chunks() function.
2088     The value of "location" is a bitwise "or" of
2090          PNG_HAVE_IHDR  (0x01)
2091          PNG_HAVE_PLTE  (0x02)
2092          PNG_AFTER_IDAT (0x08)
2094 The data from the pHYs chunk can be retrieved in several convenient
2095 forms:
2097     res_x = png_get_x_pixels_per_meter(png_ptr,
2098        info_ptr)
2100     res_y = png_get_y_pixels_per_meter(png_ptr,
2101        info_ptr)
2103     res_x_and_y = png_get_pixels_per_meter(png_ptr,
2104        info_ptr)
2106     res_x = png_get_x_pixels_per_inch(png_ptr,
2107        info_ptr)
2109     res_y = png_get_y_pixels_per_inch(png_ptr,
2110        info_ptr)
2112     res_x_and_y = png_get_pixels_per_inch(png_ptr,
2113        info_ptr)
2115     aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
2116        info_ptr)
2118     Each of these returns 0 [signifying "unknown"] if
2119        the data is not present or if res_x is 0;
2120        res_x_and_y is 0 if res_x != res_y
2122     Note that because of the way the resolutions are
2123        stored internally, the inch conversions won't
2124        come out to exactly even number.  For example,
2125        72 dpi is stored as 0.28346 pixels/meter, and
2126        when this is retrieved it is 71.9988 dpi, so
2127        be sure to round the returned value appropriately
2128        if you want to display a reasonable-looking result.
2130 The data from the oFFs chunk can be retrieved in several convenient
2131 forms:
2133     x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
2135     y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
2137     x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
2139     y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
2141     Each of these returns 0 [signifying "unknown" if both
2142        x and y are 0] if the data is not present or if the
2143        chunk is present but the unit is the pixel.  The
2144        remark about inexact inch conversions applies here
2145        as well, because a value in inches can't always be
2146        converted to microns and back without some loss
2147        of precision.
2149 For more information, see the
2150 PNG specification for chunk contents.  Be careful with trusting
2151 rowbytes, as some of the transformations could increase the space
2152 needed to hold a row (expand, filler, gray_to_rgb, etc.).
2153 See png_read_update_info(), below.
2155 A quick word about text_ptr and num_text.  PNG stores comments in
2156 keyword/text pairs, one pair per chunk, with no limit on the number
2157 of text chunks, and a 2^31 byte limit on their size.  While there are
2158 suggested keywords, there is no requirement to restrict the use to these
2159 strings.  It is strongly suggested that keywords and text be sensible
2160 to humans (that's the point), so don't use abbreviations.  Non-printing
2161 symbols are not allowed.  See the PNG specification for more details.
2162 There is also no requirement to have text after the keyword.
2164 Keywords should be limited to 79 Latin-1 characters without leading or
2165 trailing spaces, but non-consecutive spaces are allowed within the
2166 keyword.  It is possible to have the same keyword any number of times.
2167 The text_ptr is an array of png_text structures, each holding a
2168 pointer to a language string, a pointer to a keyword and a pointer to
2169 a text string.  The text string, language code, and translated
2170 keyword may be empty or NULL pointers.  The keyword/text
2171 pairs are put into the array in the order that they are received.
2172 However, some or all of the text chunks may be after the image, so, to
2173 make sure you have read all the text chunks, don't mess with these
2174 until after you read the stuff after the image.  This will be
2175 mentioned again below in the discussion that goes with png_read_end().
2177 .SS Input transformations
2179 After you've read the header information, you can set up the library
2180 to handle any special transformations of the image data.  The various
2181 ways to transform the data will be described in the order that they
2182 should occur.  This is important, as some of these change the color
2183 type and/or bit depth of the data, and some others only work on
2184 certain color types and bit depths.
2186 Transformations you request are ignored if they don't have any meaning for a
2187 particular input data format.  However some transformations can have an effect
2188 as a result of a previous transformation.  If you specify a contradictory set of
2189 transformations, for example both adding and removing the alpha channel, you
2190 cannot predict the final result.
2192 The color used for the transparency values should be supplied in the same
2193 format/depth as the current image data.  It is stored in the same format/depth
2194 as the image data in a tRNS chunk, so this is what libpng expects for this data.
2196 The color used for the background value depends on the need_expand argument as
2197 described below.
2199 Data will be decoded into the supplied row buffers packed into bytes
2200 unless the library has been told to transform it into another format.
2201 For example, 4 bit/pixel paletted or grayscale data will be returned
2202 2 pixels/byte with the leftmost pixel in the high-order bits of the byte,
2203 unless png_set_packing() is called.  8-bit RGB data will be stored
2204 in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
2205 is called to insert filler bytes, either before or after each RGB triplet.
2207 16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
2208 byte of the color value first, unless png_set_scale_16() is called to
2209 transform it to regular RGB RGB triplets, or png_set_filler() or
2210 png_set_add alpha() is called to insert two filler bytes, either before
2211 or after each RRGGBB triplet.  Similarly, 8-bit or 16-bit grayscale data can
2212 be modified with png_set_filler(), png_set_add_alpha(), png_set_strip_16(),
2213 or png_set_scale_16().
2215 The following code transforms grayscale images of less than 8 to 8 bits,
2216 changes paletted images to RGB, and adds a full alpha channel if there is
2217 transparency information in a tRNS chunk.  This is most useful on
2218 grayscale images with bit depths of 2 or 4 or if there is a multiple-image
2219 viewing application that wishes to treat all images in the same way.
2221     if (color_type == PNG_COLOR_TYPE_PALETTE)
2222         png_set_palette_to_rgb(png_ptr);
2224     if (png_get_valid(png_ptr, info_ptr,
2225         PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
2227     if (color_type == PNG_COLOR_TYPE_GRAY &&
2228         bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
2230 The first two functions are actually aliases for png_set_expand(), added
2231 in libpng version 1.0.4, with the function names expanded to improve code
2232 readability.  In some future version they may actually do different
2233 things.
2235 As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
2236 added.  It expands the sample depth without changing tRNS to alpha.
2238 As of libpng version 1.5.2, png_set_expand_16() was added.  It behaves as
2239 png_set_expand(); however, the resultant channels have 16 bits rather than 8.
2240 Use this when the output color or gray channels are made linear to avoid fairly
2241 severe accuracy loss.
2243    if (bit_depth < 16)
2244       png_set_expand_16(png_ptr);
2246 PNG can have files with 16 bits per channel.  If you only can handle
2247 8 bits per channel, this will strip the pixels down to 8-bit.
2249     if (bit_depth == 16)
2250 #if PNG_LIBPNG_VER >= 10504
2251        png_set_scale_16(png_ptr);
2252 #else
2253        png_set_strip_16(png_ptr);
2254 #endif
2256 (The more accurate "png_set_scale_16()" API became available in libpng version
2257 1.5.4).
2259 If you need to process the alpha channel on the image separately from the image
2260 data (for example if you convert it to a bitmap mask) it is possible to have
2261 libpng strip the channel leaving just RGB or gray data:
2263     if (color_type & PNG_COLOR_MASK_ALPHA)
2264        png_set_strip_alpha(png_ptr);
2266 If you strip the alpha channel you need to find some other way of dealing with
2267 the information.  If, instead, you want to convert the image to an opaque
2268 version with no alpha channel use png_set_background; see below.
2270 As of libpng version 1.5.2, almost all useful expansions are supported, the
2271 major ommissions are conversion of grayscale to indexed images (which can be
2272 done trivially in the application) and conversion of indexed to grayscale (which
2273 can be done by a trivial manipulation of the palette.)
2275 In the following table, the 01 means grayscale with depth<8, 31 means
2276 indexed with depth<8, other numerals represent the color type, "T" means
2277 the tRNS chunk is present, A means an alpha channel is present, and O
2278 means tRNS or alpha is present but all pixels in the image are opaque.
2280   FROM  01  31   0  0T  0O   2  2T  2O   3  3T  3O  4A  4O  6A  6O
2281    TO
2282    01    -  [G]  -   -   -   -   -   -   -   -   -   -   -   -   -
2283    31   [Q]  Q  [Q] [Q] [Q]  Q   Q   Q   Q   Q   Q  [Q] [Q]  Q   Q
2284     0    1   G   +   .   .   G   G   G   G   G   G   B   B  GB  GB
2285    0T    lt  Gt  t   +   .   Gt  G   G   Gt  G   G   Bt  Bt GBt GBt
2286    0O    lt  Gt  t   .   +   Gt  Gt  G   Gt  Gt  G   Bt  Bt GBt GBt
2287     2    C   P   C   C   C   +   .   .   C   -   -  CB  CB   B   B
2288    2T    Ct  -   Ct  C   C   t   +   t   -   -   -  CBt CBt  Bt  Bt
2289    2O    Ct  -   Ct  C   C   t   t   +   -   -   -  CBt CBt  Bt  Bt
2290     3   [Q]  p  [Q] [Q] [Q]  Q   Q   Q   +   .   .  [Q] [Q]  Q   Q
2291    3T   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   +   t  [Qt][Qt] Qt  Qt
2292    3O   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   t   +  [Qt][Qt] Qt  Qt
2293    4A    lA  G   A   T   T   GA  GT  GT  GA  GT  GT  +   BA  G  GBA
2294    4O    lA GBA  A   T   T   GA  GT  GT  GA  GT  GT  BA  +  GBA  G
2295    6A    CA  PA  CA  C   C   A   T  tT   PA  P   P   C  CBA  +   BA
2296    6O    CA PBA  CA  C   C   A  tT   T   PA  P   P  CBA  C   BA  +
2298 Within the matrix,
2299      "+" identifies entries where 'from' and 'to' are the same.
2300      "-" means the transformation is not supported.
2301      "." means nothing is necessary (a tRNS chunk can just be ignored).
2302      "t" means the transformation is obtained by png_set_tRNS.
2303      "A" means the transformation is obtained by png_set_add_alpha().
2304      "X" means the transformation is obtained by png_set_expand().
2305      "1" means the transformation is obtained by
2306          png_set_expand_gray_1_2_4_to_8() (and by png_set_expand()
2307          if there is no transparency in the original or the final
2308          format).
2309      "C" means the transformation is obtained by png_set_gray_to_rgb().
2310      "G" means the transformation is obtained by png_set_rgb_to_gray().
2311      "P" means the transformation is obtained by
2312          png_set_expand_palette_to_rgb().
2313      "p" means the transformation is obtained by png_set_packing().
2314      "Q" means the transformation is obtained by png_set_quantize().
2315      "T" means the transformation is obtained by
2316          png_set_tRNS_to_alpha().
2317      "B" means the transformation is obtained by
2318          png_set_background(), or png_strip_alpha().
2320 When an entry has multiple transforms listed all are required to cause the
2321 right overall transformation.  When two transforms are separated by a comma
2322 either will do the job.  When transforms are enclosed in [] the transform should
2323 do the job but this is currently unimplemented - a different format will result
2324 if the suggested transformations are used.
2326 In PNG files, the alpha channel in an image
2327 is the level of opacity.  If you need the alpha channel in an image to
2328 be the level of transparency instead of opacity, you can invert the
2329 alpha channel (or the tRNS chunk data) after it's read, so that 0 is
2330 fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
2331 images) is fully transparent, with
2333     png_set_invert_alpha(png_ptr);
2335 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
2336 they can, resulting in, for example, 8 pixels per byte for 1 bit
2337 files.  This code expands to 1 pixel per byte without changing the
2338 values of the pixels:
2340     if (bit_depth < 8)
2341        png_set_packing(png_ptr);
2343 PNG files have possible bit depths of 1, 2, 4, 8, and 16.  All pixels
2344 stored in a PNG image have been "scaled" or "shifted" up to the next
2345 higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
2346 to 8 bits/sample in the range [0, 255]).  However, it is also possible
2347 to convert the PNG pixel data back to the original bit depth of the
2348 image.  This call reduces the pixels back down to the original bit depth:
2350     png_color_8p sig_bit;
2352     if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
2353        png_set_shift(png_ptr, sig_bit);
2355 PNG files store 3-color pixels in red, green, blue order.  This code
2356 changes the storage of the pixels to blue, green, red:
2358     if (color_type == PNG_COLOR_TYPE_RGB ||
2359         color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2360        png_set_bgr(png_ptr);
2362 PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
2363 into 4 or 8 bytes for windowing systems that need them in this format:
2365     if (color_type == PNG_COLOR_TYPE_RGB)
2366        png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
2368 where "filler" is the 8-bit or 16-bit number to fill with, and the location
2369 is either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
2370 you want the filler before the RGB or after. When filling an 8-bit pixel,
2371 the least significant 8 bits of the number are used, if a 16-bit number is
2372 supplied.  This transformation does not affect images that already have full
2373 alpha channels.  To add an opaque alpha channel, use filler=0xffff and
2374 PNG_FILLER_AFTER which will generate RGBA pixels.
2376 Note that png_set_filler() does not change the color type.  If you want
2377 to do that, you can add a true alpha channel with
2379     if (color_type == PNG_COLOR_TYPE_RGB ||
2380        color_type == PNG_COLOR_TYPE_GRAY)
2381        png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
2383 where "filler" contains the alpha value to assign to each pixel.
2384 The png_set_add_alpha() function was added in libpng-1.2.7.
2386 If you are reading an image with an alpha channel, and you need the
2387 data as ARGB instead of the normal PNG format RGBA:
2389     if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2390        png_set_swap_alpha(png_ptr);
2392 For some uses, you may want a grayscale image to be represented as
2393 RGB.  This code will do that conversion:
2395     if (color_type == PNG_COLOR_TYPE_GRAY ||
2396         color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
2397        png_set_gray_to_rgb(png_ptr);
2399 Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
2400 with alpha.
2402     if (color_type == PNG_COLOR_TYPE_RGB ||
2403         color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2404        png_set_rgb_to_gray(png_ptr, error_action,
2405           double red_weight, double green_weight);
2407     error_action = 1: silently do the conversion
2409     error_action = 2: issue a warning if the original
2410                       image has any pixel where
2411                       red != green or red != blue
2413     error_action = 3: issue an error and abort the
2414                       conversion if the original
2415                       image has any pixel where
2416                       red != green or red != blue
2418     red_weight:       weight of red component
2420     green_weight:     weight of green component
2421                       If either weight is negative, default
2422                       weights are used.
2424 In the corresponding fixed point API the red_weight and green_weight values are
2425 simply scaled by 100,000:
2427     png_set_rgb_to_gray(png_ptr, error_action,
2428        png_fixed_point red_weight,
2429        png_fixed_point green_weight);
2431 If you have set error_action = 1 or 2, you can
2432 later check whether the image really was gray, after processing
2433 the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
2434 It will return a png_byte that is zero if the image was gray or
2435 1 if there were any non-gray pixels.  Background and sBIT data
2436 will be silently converted to grayscale, using the green channel
2437 data for sBIT, regardless of the error_action setting.
2439 The default values come from the PNG file cHRM chunk if present; otherwise, the
2440 defaults correspond to the ITU-R recommendation 709, and also the sRGB color
2441 space, as recommended in the Charles Poynton's Colour FAQ,
2442 Copyright (c) 2006-11-28 Charles Poynton, in section 9:
2444 <http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC9>
2446     Y = 0.2126 * R + 0.7152 * G + 0.0722 * B
2448 Previous versions of this document, 1998 through 2002, recommended a slightly
2449 different formula:
2451     Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
2453 Libpng uses an integer approximation:
2455     Y = (6968 * R + 23434 * G + 2366 * B)/32768
2457 The calculation is done in a linear colorspace, if the image gamma
2458 can be determined.
2460 The png_set_background() function has been described already; it tells libpng to
2461 composite images with alpha or simple transparency against the supplied
2462 background color.  For compatibility with versions of libpng earlier than
2463 libpng-1.5.4 it is recommended that you call the function after reading the file
2464 header, even if you don't want to use the color in a bKGD chunk, if one exists.
2466 If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
2467 you may use this color, or supply another color more suitable for
2468 the current display (e.g., the background color from a web page).  You
2469 need to tell libpng how the color is represented, both the format of the
2470 component values in the color (the number of bits) and the gamma encoding of the
2471 color.  The function takes two arguments, background_gamma_mode and need_expand
2472 to convey this information; however, only two combinations are likely to be
2473 useful:
2475     png_color_16 my_background;
2476     png_color_16p image_background;
2478     if (png_get_bKGD(png_ptr, info_ptr, &image_background))
2479        png_set_background(png_ptr, image_background,
2480            PNG_BACKGROUND_GAMMA_FILE, 1/*needs to be expanded*/, 1);
2481     else
2482        png_set_background(png_ptr, &my_background,
2483            PNG_BACKGROUND_GAMMA_SCREEN, 0/*do not expand*/, 1);
2485 The second call was described above - my_background is in the format of the
2486 final, display, output produced by libpng.  Because you now know the format of
2487 the PNG it is possible to avoid the need to choose either 8-bit or 16-bit
2488 output and to retain palette images (the palette colors will be modified
2489 appropriately and the tRNS chunk removed.)  However, if you are doing this,
2490 take great care not to ask for transformations without checking first that
2491 they apply!
2493 In the first call the background color has the original bit depth and color type
2494 of the PNG file.  So, for palette images the color is supplied as a palette
2495 index and for low bit greyscale images the color is a reduced bit value in
2496 image_background->gray.
2498 If you didn't call png_set_gamma() before reading the file header, for example
2499 if you need your code to remain compatible with older versions of libpng prior
2500 to libpng-1.5.4, this is the place to call it.
2502 Do not call it if you called png_set_alpha_mode(); doing so will damage the
2503 settings put in place by png_set_alpha_mode().  (If png_set_alpha_mode() is
2504 supported then you can certainly do png_set_gamma() before reading the PNG
2505 header.)
2507 This API unconditionally sets the screen and file gamma values, so it will
2508 override the value in the PNG file unless it is called before the PNG file
2509 reading starts.  For this reason you must always call it with the PNG file
2510 value when you call it in this position:
2512    if (png_get_gAMA(png_ptr, info_ptr, &file_gamma))
2513       png_set_gamma(png_ptr, screen_gamma, file_gamma);
2515    else
2516       png_set_gamma(png_ptr, screen_gamma, 0.45455);
2518 If you need to reduce an RGB file to a paletted file, or if a paletted
2519 file has more entries than will fit on your screen, png_set_quantize()
2520 will do that.  Note that this is a simple match quantization that merely
2521 finds the closest color available.  This should work fairly well with
2522 optimized palettes, but fairly badly with linear color cubes.  If you
2523 pass a palette that is larger than maximum_colors, the file will
2524 reduce the number of colors in the palette so it will fit into
2525 maximum_colors.  If there is a histogram, libpng will use it to make
2526 more intelligent choices when reducing the palette.  If there is no
2527 histogram, it may not do as good a job.
2529    if (color_type & PNG_COLOR_MASK_COLOR)
2530    {
2531       if (png_get_valid(png_ptr, info_ptr,
2532           PNG_INFO_PLTE))
2533       {
2534          png_uint_16p histogram = NULL;
2536          png_get_hIST(png_ptr, info_ptr,
2537              &histogram);
2538          png_set_quantize(png_ptr, palette, num_palette,
2539             max_screen_colors, histogram, 1);
2540       }
2542       else
2543       {
2544          png_color std_color_cube[MAX_SCREEN_COLORS] =
2545             { ... colors ... };
2547          png_set_quantize(png_ptr, std_color_cube,
2548             MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
2549             NULL,0);
2550       }
2551    }
2553 PNG files describe monochrome as black being zero and white being one.
2554 The following code will reverse this (make black be one and white be
2555 zero):
2557    if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
2558       png_set_invert_mono(png_ptr);
2560 This function can also be used to invert grayscale and gray-alpha images:
2562    if (color_type == PNG_COLOR_TYPE_GRAY ||
2563        color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
2564       png_set_invert_mono(png_ptr);
2566 PNG files store 16-bit pixels in network byte order (big-endian,
2567 ie. most significant bits first).  This code changes the storage to the
2568 other way (little-endian, i.e. least significant bits first, the
2569 way PCs store them):
2571     if (bit_depth == 16)
2572        png_set_swap(png_ptr);
2574 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
2575 need to change the order the pixels are packed into bytes, you can use:
2577     if (bit_depth < 8)
2578        png_set_packswap(png_ptr);
2580 Finally, you can write your own transformation function if none of
2581 the existing ones meets your needs.  This is done by setting a callback
2582 with
2584     png_set_read_user_transform_fn(png_ptr,
2585         read_transform_fn);
2587 You must supply the function
2589     void read_transform_fn(png_structp png_ptr, png_row_infop
2590         row_info, png_bytep data)
2592 See pngtest.c for a working example.  Your function will be called
2593 after all of the other transformations have been processed.  Take care with
2594 interlaced images if you do the interlace yourself - the width of the row is the
2595 width in 'row_info', not the overall image width.
2597 If supported, libpng provides two information routines that you can use to find
2598 where you are in processing the image:
2600    png_get_current_pass_number(png_structp png_ptr);
2601    png_get_current_row_number(png_structp png_ptr);
2603 Don't try using these outside a transform callback - firstly they are only
2604 supported if user transforms are supported, secondly they may well return
2605 unexpected results unless the row is actually being processed at the moment they
2606 are called.
2608 With interlaced
2609 images the value returned is the row in the input sub-image image.  Use
2610 PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
2611 find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
2613 The discussion of interlace handling above contains more information on how to
2614 use these values.
2616 You can also set up a pointer to a user structure for use by your
2617 callback function, and you can inform libpng that your transform
2618 function will change the number of channels or bit depth with the
2619 function
2621     png_set_user_transform_info(png_ptr, user_ptr,
2622         user_depth, user_channels);
2624 The user's application, not libpng, is responsible for allocating and
2625 freeing any memory required for the user structure.
2627 You can retrieve the pointer via the function
2628 png_get_user_transform_ptr().  For example:
2630     voidp read_user_transform_ptr =
2631         png_get_user_transform_ptr(png_ptr);
2633 The last thing to handle is interlacing; this is covered in detail below,
2634 but you must call the function here if you want libpng to handle expansion
2635 of the interlaced image.
2637     number_of_passes = png_set_interlace_handling(png_ptr);
2639 After setting the transformations, libpng can update your png_info
2640 structure to reflect any transformations you've requested with this
2641 call.
2643     png_read_update_info(png_ptr, info_ptr);
2645 This is most useful to update the info structure's rowbytes
2646 field so you can use it to allocate your image memory.  This function
2647 will also update your palette with the correct screen_gamma and
2648 background if these have been given with the calls above.  You may
2649 only call png_read_update_info() once with a particular info_ptr.
2651 After you call png_read_update_info(), you can allocate any
2652 memory you need to hold the image.  The row data is simply
2653 raw byte data for all forms of images.  As the actual allocation
2654 varies among applications, no example will be given.  If you
2655 are allocating one large chunk, you will need to build an
2656 array of pointers to each row, as it will be needed for some
2657 of the functions below.
2659 Remember: Before you call png_read_update_info(), the png_get_*()
2660 functions return the values corresponding to the original PNG image.
2661 After you call png_read_update_info the values refer to the image
2662 that libpng will output.  Consequently you must call all the png_set_
2663 functions before you call png_read_update_info().  This is particularly
2664 important for png_set_interlace_handling() - if you are going to call
2665 png_read_update_info() you must call png_set_interlace_handling() before
2666 it unless you want to receive interlaced output.
2668 .SS Reading image data
2670 After you've allocated memory, you can read the image data.
2671 The simplest way to do this is in one function call.  If you are
2672 allocating enough memory to hold the whole image, you can just
2673 call png_read_image() and libpng will read in all the image data
2674 and put it in the memory area supplied.  You will need to pass in
2675 an array of pointers to each row.
2677 This function automatically handles interlacing, so you don't
2678 need to call png_set_interlace_handling() (unless you call
2679 png_read_update_info()) or call this function multiple times, or any
2680 of that other stuff necessary with png_read_rows().
2682    png_read_image(png_ptr, row_pointers);
2684 where row_pointers is:
2686    png_bytep row_pointers[height];
2688 You can point to void or char or whatever you use for pixels.
2690 If you don't want to read in the whole image at once, you can
2691 use png_read_rows() instead.  If there is no interlacing (check
2692 interlace_type == PNG_INTERLACE_NONE), this is simple:
2694     png_read_rows(png_ptr, row_pointers, NULL,
2695         number_of_rows);
2697 where row_pointers is the same as in the png_read_image() call.
2699 If you are doing this just one row at a time, you can do this with
2700 a single row_pointer instead of an array of row_pointers:
2702     png_bytep row_pointer = row;
2703     png_read_row(png_ptr, row_pointer, NULL);
2705 If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
2706 get somewhat harder.  The only current (PNG Specification version 1.2)
2707 interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7);
2708 a somewhat complicated 2D interlace scheme, known as Adam7, that
2709 breaks down an image into seven smaller images of varying size, based
2710 on an 8x8 grid.  This number is defined (from libpng 1.5) as
2711 PNG_INTERLACE_ADAM7_PASSES in png.h
2713 libpng can fill out those images or it can give them to you "as is".
2714 It is almost always better to have libpng handle the interlacing for you.
2715 If you want the images filled out, there are two ways to do that.  The one
2716 mentioned in the PNG specification is to expand each pixel to cover
2717 those pixels that have not been read yet (the "rectangle" method).
2718 This results in a blocky image for the first pass, which gradually
2719 smooths out as more pixels are read.  The other method is the "sparkle"
2720 method, where pixels are drawn only in their final locations, with the
2721 rest of the image remaining whatever colors they were initialized to
2722 before the start of the read.  The first method usually looks better,
2723 but tends to be slower, as there are more pixels to put in the rows.
2725 If, as is likely, you want libpng to expand the images, call this before
2726 calling png_start_read_image() or png_read_update_info():
2728     if (interlace_type == PNG_INTERLACE_ADAM7)
2729        number_of_passes
2730            = png_set_interlace_handling(png_ptr);
2732 This will return the number of passes needed.  Currently, this is seven,
2733 but may change if another interlace type is added.  This function can be
2734 called even if the file is not interlaced, where it will return one pass.
2735 You then need to read the whole image 'number_of_passes' times.  Each time
2736 will distribute the pixels from the current pass to the correct place in
2737 the output image, so you need to supply the same rows to png_read_rows in
2738 each pass.
2740 If you are not going to display the image after each pass, but are
2741 going to wait until the entire image is read in, use the sparkle
2742 effect.  This effect is faster and the end result of either method
2743 is exactly the same.  If you are planning on displaying the image
2744 after each pass, the "rectangle" effect is generally considered the
2745 better looking one.
2747 If you only want the "sparkle" effect, just call png_read_row() or
2748 png_read_rows() as
2749 normal, with the third parameter NULL.  Make sure you make pass over
2750 the image number_of_passes times, and you don't change the data in the
2751 rows between calls.  You can change the locations of the data, just
2752 not the data.  Each pass only writes the pixels appropriate for that
2753 pass, and assumes the data from previous passes is still valid.
2755     png_read_rows(png_ptr, row_pointers, NULL,
2756         number_of_rows);
2757     or
2758     png_read_row(png_ptr, row_pointers, NULL);
2760 If you only want the first effect (the rectangles), do the same as
2761 before except pass the row buffer in the third parameter, and leave
2762 the second parameter NULL.
2764     png_read_rows(png_ptr, NULL, row_pointers,
2765         number_of_rows);
2766     or
2767     png_read_row(png_ptr, NULL, row_pointers);
2769 If you don't want libpng to handle the interlacing details, just call
2770 png_read_rows() PNG_INTERLACE_ADAM7_PASSES times to read in all the images.
2771 Each of the images is a valid image by itself; however, you will almost
2772 certainly need to distribute the pixels from each sub-image to the
2773 correct place.  This is where everything gets very tricky.
2775 If you want to retrieve the separate images you must pass the correct
2776 number of rows to each successive call of png_read_rows().  The calculation
2777 gets pretty complicated for small images, where some sub-images may
2778 not even exist because either their width or height ends up zero.
2779 libpng provides two macros to help you in 1.5 and later versions:
2781    png_uint_32 width = PNG_PASS_COLS(image_width, pass_number);
2782    png_uint_32 height = PNG_PASS_ROWS(image_height, pass_number);
2784 Respectively these tell you the width and height of the sub-image
2785 corresponding to the numbered pass.  'pass' is in in the range 0 to 6 -
2786 this can be confusing because the specification refers to the same passes
2787 as 1 to 7!  Be careful, you must check both the width and height before
2788 calling png_read_rows() and not call it for that pass if either is zero.
2790 You can, of course, read each sub-image row by row.  If you want to
2791 produce optimal code to make a pixel-by-pixel transformation of an
2792 interlaced image this is the best approach; read each row of each pass,
2793 transform it, and write it out to a new interlaced image.
2795 If you want to de-interlace the image yourself libpng provides further
2796 macros to help that tell you where to place the pixels in the output image.
2797 Because the interlacing scheme is rectangular - sub-image pixels are always
2798 arranged on a rectangular grid - all you need to know for each pass is the
2799 starting column and row in the output image of the first pixel plus the
2800 spacing between each pixel.  As of libpng 1.5 there are four macros to
2801 retrieve this information:
2803    png_uint_32 x = PNG_PASS_START_COL(pass);
2804    png_uint_32 y = PNG_PASS_START_ROW(pass);
2805    png_uint_32 xStep = 1U << PNG_PASS_COL_SHIFT(pass);
2806    png_uint_32 yStep = 1U << PNG_PASS_ROW_SHIFT(pass);
2808 These allow you to write the obvious loop:
2810    png_uint_32 input_y = 0;
2811    png_uint_32 output_y = PNG_PASS_START_ROW(pass);
2813    while (output_y < output_image_height)
2814    {
2815       png_uint_32 input_x = 0;
2816       png_uint_32 output_x = PNG_PASS_START_COL(pass);
2818       while (output_x < output_image_width)
2819       {
2820          image[output_y][output_x] =
2821              subimage[pass][input_y][input_x++];
2823          output_x += xStep;
2824       }
2826       ++input_y;
2827       output_y += yStep;
2828    }
2830 Notice that the steps between successive output rows and columns are
2831 returned as shifts.  This is possible because the pixels in the subimages
2832 are always a power of 2 apart - 1, 2, 4 or 8 pixels - in the original
2833 image.  In practice you may need to directly calculate the output coordinate
2834 given an input coordinate.  libpng provides two further macros for this
2835 purpose:
2837    png_uint_32 output_x = PNG_COL_FROM_PASS_COL(input_x, pass);
2838    png_uint_32 output_y = PNG_ROW_FROM_PASS_ROW(input_y, pass);
2840 Finally a pair of macros are provided to tell you if a particular image
2841 row or column appears in a given pass:
2843    int col_in_pass = PNG_COL_IN_INTERLACE_PASS(output_x, pass);
2844    int row_in_pass = PNG_ROW_IN_INTERLACE_PASS(output_y, pass);
2846 Bear in mind that you will probably also need to check the width and height
2847 of the pass in addition to the above to be sure the pass even exists!
2849 With any luck you are convinced by now that you don't want to do your own
2850 interlace handling.  In reality normally the only good reason for doing this
2851 is if you are processing PNG files on a pixel-by-pixel basis and don't want
2852 to load the whole file into memory when it is interlaced.
2854 libpng includes a test program, pngvalid, that illustrates reading and
2855 writing of interlaced images.  If you can't get interlacing to work in your
2856 code and don't want to leave it to libpng (the recommended approach), see
2857 how pngvalid.c does it.
2859 .SS Finishing a sequential read
2861 After you are finished reading the image through the
2862 low-level interface, you can finish reading the file.
2864 If you want to use a different crc action for handling CRC errors in
2865 chunks after the image data, you can call png_set_crc_action()
2866 again at this point.
2868 If you are interested in comments or time, which may be stored either
2869 before or after the image data, you should pass the separate png_info
2870 struct if you want to keep the comments from before and after the image
2871 separate.
2873     png_infop end_info = png_create_info_struct(png_ptr);
2875     if (!end_info)
2876     {
2877        png_destroy_read_struct(&png_ptr, &info_ptr,
2878            (png_infopp)NULL);
2879        return (ERROR);
2880     }
2882    png_read_end(png_ptr, end_info);
2884 If you are not interested, you should still call png_read_end()
2885 but you can pass NULL, avoiding the need to create an end_info structure.
2886 If you do this, libpng will not process any chunks after IDAT other than
2887 skipping over them and perhaps (depending on whether you have called
2888 png_set_crc_action) checking their CRCs while looking for the IEND chunk.
2890    png_read_end(png_ptr, (png_infop)NULL);
2892 If you don't call png_read_end(), then your file pointer will be
2893 left pointing to the first chunk after the last IDAT, which is probably
2894 not what you want if you expect to read something beyond the end of
2895 the PNG datastream.
2897 When you are done, you can free all memory allocated by libpng like this:
2899    png_destroy_read_struct(&png_ptr, &info_ptr,
2900        &end_info);
2902 or, if you didn't create an end_info structure,
2904    png_destroy_read_struct(&png_ptr, &info_ptr,
2905        (png_infopp)NULL);
2907 It is also possible to individually free the info_ptr members that
2908 point to libpng-allocated storage with the following function:
2910     png_free_data(png_ptr, info_ptr, mask, seq)
2912     mask - identifies data to be freed, a mask
2913            containing the bitwise OR of one or
2914            more of
2915              PNG_FREE_PLTE, PNG_FREE_TRNS,
2916              PNG_FREE_HIST, PNG_FREE_ICCP,
2917              PNG_FREE_PCAL, PNG_FREE_ROWS,
2918              PNG_FREE_SCAL, PNG_FREE_SPLT,
2919              PNG_FREE_TEXT, PNG_FREE_UNKN,
2920            or simply PNG_FREE_ALL
2922     seq  - sequence number of item to be freed
2923            (\-1 for all items)
2925 This function may be safely called when the relevant storage has
2926 already been freed, or has not yet been allocated, or was allocated
2927 by the user and not by libpng,  and will in those cases do nothing.
2928 The "seq" parameter is ignored if only one item of the selected data
2929 type, such as PLTE, is allowed.  If "seq" is not \-1, and multiple items
2930 are allowed for the data type identified in the mask, such as text or
2931 sPLT, only the n'th item in the structure is freed, where n is "seq".
2933 The default behavior is only to free data that was allocated internally
2934 by libpng.  This can be changed, so that libpng will not free the data,
2935 or so that it will free data that was allocated by the user with png_malloc()
2936 or png_calloc() and passed in via a png_set_*() function, with
2938     png_data_freer(png_ptr, info_ptr, freer, mask)
2940     freer  - one of
2941                PNG_DESTROY_WILL_FREE_DATA
2942                PNG_SET_WILL_FREE_DATA
2943                PNG_USER_WILL_FREE_DATA
2945     mask   - which data elements are affected
2946              same choices as in png_free_data()
2948 This function only affects data that has already been allocated.
2949 You can call this function after reading the PNG data but before calling
2950 any png_set_*() functions, to control whether the user or the png_set_*()
2951 function is responsible for freeing any existing data that might be present,
2952 and again after the png_set_*() functions to control whether the user
2953 or png_destroy_*() is supposed to free the data.  When the user assumes
2954 responsibility for libpng-allocated data, the application must use
2955 png_free() to free it, and when the user transfers responsibility to libpng
2956 for data that the user has allocated, the user must have used png_malloc()
2957 or png_calloc() to allocate it.
2959 If you allocated your row_pointers in a single block, as suggested above in
2960 the description of the high level read interface, you must not transfer
2961 responsibility for freeing it to the png_set_rows or png_read_destroy function,
2962 because they would also try to free the individual row_pointers[i].
2964 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
2965 separately, do not transfer responsibility for freeing text_ptr to libpng,
2966 because when libpng fills a png_text structure it combines these members with
2967 the key member, and png_free_data() will free only text_ptr.key.  Similarly,
2968 if you transfer responsibility for free'ing text_ptr from libpng to your
2969 application, your application must not separately free those members.
2971 The png_free_data() function will turn off the "valid" flag for anything
2972 it frees.  If you need to turn the flag off for a chunk that was freed by
2973 your application instead of by libpng, you can use
2975     png_set_invalid(png_ptr, info_ptr, mask);
2977     mask - identifies the chunks to be made invalid,
2978            containing the bitwise OR of one or
2979            more of
2980              PNG_INFO_gAMA, PNG_INFO_sBIT,
2981              PNG_INFO_cHRM, PNG_INFO_PLTE,
2982              PNG_INFO_tRNS, PNG_INFO_bKGD,
2983              PNG_INFO_hIST, PNG_INFO_pHYs,
2984              PNG_INFO_oFFs, PNG_INFO_tIME,
2985              PNG_INFO_pCAL, PNG_INFO_sRGB,
2986              PNG_INFO_iCCP, PNG_INFO_sPLT,
2987              PNG_INFO_sCAL, PNG_INFO_IDAT
2989 For a more compact example of reading a PNG image, see the file example.c.
2991 .SS Reading PNG files progressively
2993 The progressive reader is slightly different from the non-progressive
2994 reader.  Instead of calling png_read_info(), png_read_rows(), and
2995 png_read_end(), you make one call to png_process_data(), which calls
2996 callbacks when it has the info, a row, or the end of the image.  You
2997 set up these callbacks with png_set_progressive_read_fn().  You don't
2998 have to worry about the input/output functions of libpng, as you are
2999 giving the library the data directly in png_process_data().  I will
3000 assume that you have read the section on reading PNG files above,
3001 so I will only highlight the differences (although I will show
3002 all of the code).
3004 png_structp png_ptr;
3005 png_infop info_ptr;
3007  /*  An example code fragment of how you would
3008      initialize the progressive reader in your
3009      application. */
3010  int
3011  initialize_png_reader()
3013     png_ptr = png_create_read_struct
3014         (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
3015          user_error_fn, user_warning_fn);
3017     if (!png_ptr)
3018         return (ERROR);
3020     info_ptr = png_create_info_struct(png_ptr);
3022     if (!info_ptr)
3023     {
3024        png_destroy_read_struct(&png_ptr,
3025           (png_infopp)NULL, (png_infopp)NULL);
3026        return (ERROR);
3027     }
3029     if (setjmp(png_jmpbuf(png_ptr)))
3030     {
3031        png_destroy_read_struct(&png_ptr, &info_ptr,
3032           (png_infopp)NULL);
3033        return (ERROR);
3034     }
3036     /* This one's new.  You can provide functions
3037        to be called when the header info is valid,
3038        when each row is completed, and when the image
3039        is finished.  If you aren't using all functions,
3040        you can specify NULL parameters.  Even when all
3041        three functions are NULL, you need to call
3042        png_set_progressive_read_fn().  You can use
3043        any struct as the user_ptr (cast to a void pointer
3044        for the function call), and retrieve the pointer
3045        from inside the callbacks using the function
3047           png_get_progressive_ptr(png_ptr);
3049        which will return a void pointer, which you have
3050        to cast appropriately.
3051      */
3052     png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
3053         info_callback, row_callback, end_callback);
3055     return 0;
3058  /* A code fragment that you call as you receive blocks
3059    of data */
3060  int
3061  process_data(png_bytep buffer, png_uint_32 length)
3063     if (setjmp(png_jmpbuf(png_ptr)))
3064     {
3065        png_destroy_read_struct(&png_ptr, &info_ptr,
3066            (png_infopp)NULL);
3067        return (ERROR);
3068     }
3070     /* This one's new also.  Simply give it a chunk
3071        of data from the file stream (in order, of
3072        course).  On machines with segmented memory
3073        models machines, don't give it any more than
3074        64K.  The library seems to run fine with sizes
3075        of 4K. Although you can give it much less if
3076        necessary (I assume you can give it chunks of
3077        1 byte, I haven't tried less than 256 bytes
3078        yet).  When this function returns, you may
3079        want to display any rows that were generated
3080        in the row callback if you don't already do
3081        so there.
3082      */
3083     png_process_data(png_ptr, info_ptr, buffer, length);
3085     /* At this point you can call png_process_data_skip if
3086        you want to handle data the library will skip yourself;
3087        it simply returns the number of bytes to skip (and stops
3088        libpng skipping that number of bytes on the next
3089        png_process_data call).
3090     return 0;
3093  /* This function is called (as set by
3094     png_set_progressive_read_fn() above) when enough data
3095     has been supplied so all of the header has been
3096     read.
3097  */
3098  void
3099  info_callback(png_structp png_ptr, png_infop info)
3101     /* Do any setup here, including setting any of
3102        the transformations mentioned in the Reading
3103        PNG files section.  For now, you _must_ call
3104        either png_start_read_image() or
3105        png_read_update_info() after all the
3106        transformations are set (even if you don't set
3107        any).  You may start getting rows before
3108        png_process_data() returns, so this is your
3109        last chance to prepare for that.
3111        This is where you turn on interlace handling,
3112        assuming you don't want to do it yourself.
3114        If you need to you can stop the processing of
3115        your original input data at this point by calling
3116        png_process_data_pause.  This returns the number
3117        of unprocessed bytes from the last png_process_data
3118        call - it is up to you to ensure that the next call
3119        sees these bytes again.  If you don't want to bother
3120        with this you can get libpng to cache the unread
3121        bytes by setting the 'save' parameter (see png.h) but
3122        then libpng will have to copy the data internally.
3123      */
3126  /* This function is called when each row of image
3127     data is complete */
3128  void
3129  row_callback(png_structp png_ptr, png_bytep new_row,
3130     png_uint_32 row_num, int pass)
3132     /* If the image is interlaced, and you turned
3133        on the interlace handler, this function will
3134        be called for every row in every pass.  Some
3135        of these rows will not be changed from the
3136        previous pass.  When the row is not changed,
3137        the new_row variable will be NULL.  The rows
3138        and passes are called in order, so you don't
3139        really need the row_num and pass, but I'm
3140        supplying them because it may make your life
3141        easier.
3143        If you did not turn on interlace handling then
3144        the callback is called for each row of each
3145        sub-image when the image is interlaced.  In this
3146        case 'row_num' is the row in the sub-image, not
3147        the row in the output image as it is in all other
3148        cases.
3150        For the non-NULL rows of interlaced images when
3151        you have switched on libpng interlace handling,
3152        you must call png_progressive_combine_row()
3153        passing in the row and the old row.  You can
3154        call this function for NULL rows (it will just
3155        return) and for non-interlaced images (it just
3156        does the memcpy for you) if it will make the
3157        code easier.  Thus, you can just do this for
3158        all cases if you switch on interlace handling;
3159      */
3161         png_progressive_combine_row(png_ptr, old_row,
3162           new_row);
3164     /* where old_row is what was displayed
3165        previously for the row.  Note that the first
3166        pass (pass == 0, really) will completely cover
3167        the old row, so the rows do not have to be
3168        initialized.  After the first pass (and only
3169        for interlaced images), you will have to pass
3170        the current row, and the function will combine
3171        the old row and the new row.
3173        You can also call png_process_data_pause in this
3174        callback - see above.
3175     */
3178  void
3179  end_callback(png_structp png_ptr, png_infop info)
3181     /* This function is called after the whole image
3182        has been read, including any chunks after the
3183        image (up to and including the IEND).  You
3184        will usually have the same info chunk as you
3185        had in the header, although some data may have
3186        been added to the comments and time fields.
3188        Most people won't do much here, perhaps setting
3189        a flag that marks the image as finished.
3190      */
3195 .SH IV. Writing
3197 Much of this is very similar to reading.  However, everything of
3198 importance is repeated here, so you won't have to constantly look
3199 back up in the reading section to understand writing.
3201 .SS Setup
3203 You will want to do the I/O initialization before you get into libpng,
3204 so if it doesn't work, you don't have anything to undo. If you are not
3205 using the standard I/O functions, you will need to replace them with
3206 custom writing functions.  See the discussion under Customizing libpng.
3208     FILE *fp = fopen(file_name, "wb");
3210     if (!fp)
3211        return (ERROR);
3213 Next, png_struct and png_info need to be allocated and initialized.
3214 As these can be both relatively large, you may not want to store these
3215 on the stack, unless you have stack space to spare.  Of course, you
3216 will want to check if they return NULL.  If you are also reading,
3217 you won't want to name your read structure and your write structure
3218 both "png_ptr"; you can call them anything you like, such as
3219 "read_ptr" and "write_ptr".  Look at pngtest.c, for example.
3221     png_structp png_ptr = png_create_write_struct
3222        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
3223         user_error_fn, user_warning_fn);
3225     if (!png_ptr)
3226        return (ERROR);
3228     png_infop info_ptr = png_create_info_struct(png_ptr);
3229     if (!info_ptr)
3230     {
3231        png_destroy_write_struct(&png_ptr,
3232            (png_infopp)NULL);
3233        return (ERROR);
3234     }
3236 If you want to use your own memory allocation routines,
3237 define PNG_USER_MEM_SUPPORTED and use
3238 png_create_write_struct_2() instead of png_create_write_struct():
3240     png_structp png_ptr = png_create_write_struct_2
3241        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
3242         user_error_fn, user_warning_fn, (png_voidp)
3243         user_mem_ptr, user_malloc_fn, user_free_fn);
3245 After you have these structures, you will need to set up the
3246 error handling.  When libpng encounters an error, it expects to
3247 longjmp() back to your routine.  Therefore, you will need to call
3248 setjmp() and pass the png_jmpbuf(png_ptr).  If you
3249 write the file from different routines, you will need to update
3250 the png_jmpbuf(png_ptr) every time you enter a new routine that will
3251 call a png_*() function.  See your documentation of setjmp/longjmp
3252 for your compiler for more information on setjmp/longjmp.  See
3253 the discussion on libpng error handling in the Customizing Libpng
3254 section below for more information on the libpng error handling.
3256     if (setjmp(png_jmpbuf(png_ptr)))
3257     {
3258     png_destroy_write_struct(&png_ptr, &info_ptr);
3259        fclose(fp);
3260        return (ERROR);
3261     }
3262     ...
3263     return;
3265 If you would rather avoid the complexity of setjmp/longjmp issues,
3266 you can compile libpng with PNG_NO_SETJMP, in which case
3267 errors will result in a call to PNG_ABORT() which defaults to abort().
3269 You can #define PNG_ABORT() to a function that does something
3270 more useful than abort(), as long as your function does not
3271 return.
3273 Checking for invalid palette index on write was added at libpng
3274 1.5.10.  If a pixel contains an invalid (out-of-range) index libpng issues
3275 a benign error.  This is enabled by default because this condition is an
3276 error according to the PNG specification, Clause 11.3.2, but the error can
3277 be ignored in each png_ptr with
3279    png_set_check_for_invalid_index(png_ptr, 0);
3281 If the error is ignored, or if png_benign_error() treats it as a warning,
3282 any invalid pixels are written as-is by the encoder, resulting in an
3283 invalid PNG datastream as output.  In this case the application is
3284 responsible for ensuring that the pixel indexes are in range when it writes
3285 a PLTE chunk with fewer entries than the bit depth would allow.
3287 Now you need to set up the output code.  The default for libpng is to
3288 use the C function fwrite().  If you use this, you will need to pass a
3289 valid FILE * in the function png_init_io().  Be sure that the file is
3290 opened in binary mode.  Again, if you wish to handle writing data in
3291 another way, see the discussion on libpng I/O handling in the Customizing
3292 Libpng section below.
3294     png_init_io(png_ptr, fp);
3296 If you are embedding your PNG into a datastream such as MNG, and don't
3297 want libpng to write the 8-byte signature, or if you have already
3298 written the signature in your application, use
3300     png_set_sig_bytes(png_ptr, 8);
3302 to inform libpng that it should not write a signature.
3304 .SS Write callbacks
3306 At this point, you can set up a callback function that will be
3307 called after each row has been written, which you can use to control
3308 a progress meter or the like.  It's demonstrated in pngtest.c.
3309 You must supply a function
3311     void write_row_callback(png_structp png_ptr, png_uint_32 row,
3312        int pass);
3313     {
3314       /* put your code here */
3315     }
3317 (You can give it another name that you like instead of "write_row_callback")
3319 To inform libpng about your function, use
3321     png_set_write_status_fn(png_ptr, write_row_callback);
3323 When this function is called the row has already been completely processed and
3324 it has also been written out.  The 'row' and 'pass' refer to the next row to be
3325 handled.  For the
3326 non-interlaced case the row that was just handled is simply one less than the
3327 passed in row number, and pass will always be 0.  For the interlaced case the
3328 same applies unless the row value is 0, in which case the row just handled was
3329 the last one from one of the preceding passes.  Because interlacing may skip a
3330 pass you cannot be sure that the preceding pass is just 'pass\-1', if you really
3331 need to know what the last pass is record (row,pass) from the callback and use
3332 the last recorded value each time.
3334 As with the user transform you can find the output row using the
3335 PNG_ROW_FROM_PASS_ROW macro.
3337 You now have the option of modifying how the compression library will
3338 run.  The following functions are mainly for testing, but may be useful
3339 in some cases, like if you need to write PNG files extremely fast and
3340 are willing to give up some compression, or if you want to get the
3341 maximum possible compression at the expense of slower writing.  If you
3342 have no special needs in this area, let the library do what it wants by
3343 not calling this function at all, as it has been tuned to deliver a good
3344 speed/compression ratio. The second parameter to png_set_filter() is
3345 the filter method, for which the only valid values are 0 (as of the
3346 July 1999 PNG specification, version 1.2) or 64 (if you are writing
3347 a PNG datastream that is to be embedded in a MNG datastream).  The third
3348 parameter is a flag that indicates which filter type(s) are to be tested
3349 for each scanline.  See the PNG specification for details on the specific
3350 filter types.
3353     /* turn on or off filtering, and/or choose
3354        specific filters.  You can use either a single
3355        PNG_FILTER_VALUE_NAME or the bitwise OR of one
3356        or more PNG_FILTER_NAME masks.
3357      */
3358     png_set_filter(png_ptr, 0,
3359        PNG_FILTER_NONE  | PNG_FILTER_VALUE_NONE |
3360        PNG_FILTER_SUB   | PNG_FILTER_VALUE_SUB  |
3361        PNG_FILTER_UP    | PNG_FILTER_VALUE_UP   |
3362        PNG_FILTER_AVG   | PNG_FILTER_VALUE_AVG  |
3363        PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
3364        PNG_ALL_FILTERS  | PNG_FAST_FILTERS);
3366 If an application wants to start and stop using particular filters during
3367 compression, it should start out with all of the filters (to ensure that
3368 the previous row of pixels will be stored in case it's needed later),
3369 and then add and remove them after the start of compression.
3371 If you are writing a PNG datastream that is to be embedded in a MNG
3372 datastream, the second parameter can be either 0 or 64.
3374 The png_set_compression_*() functions interface to the zlib compression
3375 library, and should mostly be ignored unless you really know what you are
3376 doing.  The only generally useful call is png_set_compression_level()
3377 which changes how much time zlib spends on trying to compress the image
3378 data.  See the Compression Library (zlib.h and algorithm.txt, distributed
3379 with zlib) for details on the compression levels.
3381     #include zlib.h
3383     /* Set the zlib compression level */
3384     png_set_compression_level(png_ptr,
3385         Z_BEST_COMPRESSION);
3387     /* Set other zlib parameters for compressing IDAT */
3388     png_set_compression_mem_level(png_ptr, 8);
3389     png_set_compression_strategy(png_ptr,
3390         Z_DEFAULT_STRATEGY);
3391     png_set_compression_window_bits(png_ptr, 15);
3392     png_set_compression_method(png_ptr, 8);
3393     png_set_compression_buffer_size(png_ptr, 8192)
3395     /* Set zlib parameters for text compression
3396      * If you don't call these, the parameters
3397      * fall back on those defined for IDAT chunks
3398      */
3399     png_set_text_compression_mem_level(png_ptr, 8);
3400     png_set_text_compression_strategy(png_ptr,
3401         Z_DEFAULT_STRATEGY);
3402     png_set_text_compression_window_bits(png_ptr, 15);
3403     png_set_text_compression_method(png_ptr, 8);
3405 .SS Setting the contents of info for output
3407 You now need to fill in the png_info structure with all the data you
3408 wish to write before the actual image.  Note that the only thing you
3409 are allowed to write after the image is the text chunks and the time
3410 chunk (as of PNG Specification 1.2, anyway).  See png_write_end() and
3411 the latest PNG specification for more information on that.  If you
3412 wish to write them before the image, fill them in now, and flag that
3413 data as being valid.  If you want to wait until after the data, don't
3414 fill them until png_write_end().  For all the fields in png_info and
3415 their data types, see png.h.  For explanations of what the fields
3416 contain, see the PNG specification.
3418 Some of the more important parts of the png_info are:
3420     png_set_IHDR(png_ptr, info_ptr, width, height,
3421        bit_depth, color_type, interlace_type,
3422        compression_type, filter_method)
3424     width          - holds the width of the image
3425                      in pixels (up to 2^31).
3427     height         - holds the height of the image
3428                      in pixels (up to 2^31).
3430     bit_depth      - holds the bit depth of one of the
3431                      image channels.
3432                      (valid values are 1, 2, 4, 8, 16
3433                      and depend also on the
3434                      color_type.  See also significant
3435                      bits (sBIT) below).
3437     color_type     - describes which color/alpha
3438                      channels are present.
3439                      PNG_COLOR_TYPE_GRAY
3440                         (bit depths 1, 2, 4, 8, 16)
3441                      PNG_COLOR_TYPE_GRAY_ALPHA
3442                         (bit depths 8, 16)
3443                      PNG_COLOR_TYPE_PALETTE
3444                         (bit depths 1, 2, 4, 8)
3445                      PNG_COLOR_TYPE_RGB
3446                         (bit_depths 8, 16)
3447                      PNG_COLOR_TYPE_RGB_ALPHA
3448                         (bit_depths 8, 16)
3450                      PNG_COLOR_MASK_PALETTE
3451                      PNG_COLOR_MASK_COLOR
3452                      PNG_COLOR_MASK_ALPHA
3454     interlace_type - PNG_INTERLACE_NONE or
3455                      PNG_INTERLACE_ADAM7
3457     compression_type - (must be
3458                      PNG_COMPRESSION_TYPE_DEFAULT)
3460     filter_method  - (must be PNG_FILTER_TYPE_DEFAULT
3461                      or, if you are writing a PNG to
3462                      be embedded in a MNG datastream,
3463                      can also be
3464                      PNG_INTRAPIXEL_DIFFERENCING)
3466 If you call png_set_IHDR(), the call must appear before any of the
3467 other png_set_*() functions, because they might require access to some of
3468 the IHDR settings.  The remaining png_set_*() functions can be called
3469 in any order.
3471 If you wish, you can reset the compression_type, interlace_type, or
3472 filter_method later by calling png_set_IHDR() again; if you do this, the
3473 width, height, bit_depth, and color_type must be the same in each call.
3475     png_set_PLTE(png_ptr, info_ptr, palette,
3476        num_palette);
3478     palette        - the palette for the file
3479                      (array of png_color)
3480     num_palette    - number of entries in the palette
3483     png_set_gAMA(png_ptr, info_ptr, file_gamma);
3484     png_set_gAMA_fixed(png_ptr, info_ptr, int_file_gamma);
3486     file_gamma     - the gamma at which the image was
3487                      created (PNG_INFO_gAMA)
3489     int_file_gamma - 100,000 times the gamma at which
3490                      the image was created
3492     png_set_cHRM(png_ptr, info_ptr,  white_x, white_y, red_x, red_y,
3493                      green_x, green_y, blue_x, blue_y)
3494     png_set_cHRM_XYZ(png_ptr, info_ptr, red_X, red_Y, red_Z, green_X,
3495                      green_Y, green_Z, blue_X, blue_Y, blue_Z)
3496     png_set_cHRM_fixed(png_ptr, info_ptr, int_white_x, int_white_y,
3497                      int_red_x, int_red_y, int_green_x, int_green_y,
3498                      int_blue_x, int_blue_y)
3499     png_set_cHRM_XYZ_fixed(png_ptr, info_ptr, int_red_X, int_red_Y,
3500                      int_red_Z, int_green_X, int_green_Y, int_green_Z,
3501                      int_blue_X, int_blue_Y, int_blue_Z)
3503     {white,red,green,blue}_{x,y}
3504                      A color space encoding specified using the chromaticities
3505                      of the end points and the white point.
3507     {red,green,blue}_{X,Y,Z}
3508                      A color space encoding specified using the encoding end
3509                      points - the CIE tristimulus specification of the intended
3510                      color of the red, green and blue channels in the PNG RGB
3511                      data.  The white point is simply the sum of the three end
3512                      points.
3514     png_set_sRGB(png_ptr, info_ptr, srgb_intent);
3516     srgb_intent    - the rendering intent
3517                      (PNG_INFO_sRGB) The presence of
3518                      the sRGB chunk means that the pixel
3519                      data is in the sRGB color space.
3520                      This chunk also implies specific
3521                      values of gAMA and cHRM.  Rendering
3522                      intent is the CSS-1 property that
3523                      has been defined by the International
3524                      Color Consortium
3525                      (http://www.color.org).
3526                      It can be one of
3527                      PNG_sRGB_INTENT_SATURATION,
3528                      PNG_sRGB_INTENT_PERCEPTUAL,
3529                      PNG_sRGB_INTENT_ABSOLUTE, or
3530                      PNG_sRGB_INTENT_RELATIVE.
3533     png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
3534        srgb_intent);
3536     srgb_intent    - the rendering intent
3537                      (PNG_INFO_sRGB) The presence of the
3538                      sRGB chunk means that the pixel
3539                      data is in the sRGB color space.
3540                      This function also causes gAMA and
3541                      cHRM chunks with the specific values
3542                      that are consistent with sRGB to be
3543                      written.
3545     png_set_iCCP(png_ptr, info_ptr, name, compression_type,
3546                        profile, proflen);
3548     name             - The profile name.
3550     compression_type - The compression type; always
3551                        PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
3552                        You may give NULL to this argument to
3553                        ignore it.
3555     profile          - International Color Consortium color
3556                        profile data. May contain NULs.
3558     proflen          - length of profile data in bytes.
3560     png_set_sBIT(png_ptr, info_ptr, sig_bit);
3562     sig_bit        - the number of significant bits for
3563                      (PNG_INFO_sBIT) each of the gray, red,
3564                      green, and blue channels, whichever are
3565                      appropriate for the given color type
3566                      (png_color_16)
3568     png_set_tRNS(png_ptr, info_ptr, trans_alpha,
3569        num_trans, trans_color);
3571     trans_alpha    - array of alpha (transparency)
3572                      entries for palette (PNG_INFO_tRNS)
3574     num_trans      - number of transparent entries
3575                      (PNG_INFO_tRNS)
3577     trans_color    - graylevel or color sample values
3578                      (in order red, green, blue) of the
3579                      single transparent color for
3580                      non-paletted images (PNG_INFO_tRNS)
3582     png_set_hIST(png_ptr, info_ptr, hist);
3584     hist           - histogram of palette (array of
3585                      png_uint_16) (PNG_INFO_hIST)
3587     png_set_tIME(png_ptr, info_ptr, mod_time);
3589     mod_time       - time image was last modified
3590                      (PNG_VALID_tIME)
3592     png_set_bKGD(png_ptr, info_ptr, background);
3594     background     - background color (of type
3595                      png_color_16p) (PNG_VALID_bKGD)
3597     png_set_text(png_ptr, info_ptr, text_ptr, num_text);
3599     text_ptr       - array of png_text holding image
3600                      comments
3602     text_ptr[i].compression - type of compression used
3603                  on "text" PNG_TEXT_COMPRESSION_NONE
3604                            PNG_TEXT_COMPRESSION_zTXt
3605                            PNG_ITXT_COMPRESSION_NONE
3606                            PNG_ITXT_COMPRESSION_zTXt
3607     text_ptr[i].key   - keyword for comment.  Must contain
3608                  1-79 characters.
3609     text_ptr[i].text  - text comments for current
3610                          keyword.  Can be NULL or empty.
3611     text_ptr[i].text_length - length of text string,
3612                  after decompression, 0 for iTXt
3613     text_ptr[i].itxt_length - length of itxt string,
3614                  after decompression, 0 for tEXt/zTXt
3615     text_ptr[i].lang  - language of comment (NULL or
3616                          empty for unknown).
3617     text_ptr[i].translated_keyword  - keyword in UTF-8 (NULL
3618                          or empty for unknown).
3620     Note that the itxt_length, lang, and lang_key
3621     members of the text_ptr structure only exist when the
3622     library is built with iTXt chunk support.  Prior to
3623     libpng-1.4.0 the library was built by default without
3624     iTXt support. Also note that when iTXt is supported,
3625     they contain NULL pointers when the "compression"
3626     field contains PNG_TEXT_COMPRESSION_NONE or
3627     PNG_TEXT_COMPRESSION_zTXt.
3629     num_text       - number of comments
3631     png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
3632        num_spalettes);
3634     palette_ptr    - array of png_sPLT_struct structures
3635                      to be added to the list of palettes
3636                      in the info structure.
3637     num_spalettes  - number of palette structures to be
3638                      added.
3640     png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
3641         unit_type);
3643     offset_x  - positive offset from the left
3644                      edge of the screen
3646     offset_y  - positive offset from the top
3647                      edge of the screen
3649     unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
3651     png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
3652         unit_type);
3654     res_x       - pixels/unit physical resolution
3655                   in x direction
3657     res_y       - pixels/unit physical resolution
3658                   in y direction
3660     unit_type   - PNG_RESOLUTION_UNKNOWN,
3661                   PNG_RESOLUTION_METER
3663     png_set_sCAL(png_ptr, info_ptr, unit, width, height)
3665     unit        - physical scale units (an integer)
3667     width       - width of a pixel in physical scale units
3669     height      - height of a pixel in physical scale units
3670                   (width and height are doubles)
3672     png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
3674     unit        - physical scale units (an integer)
3676     width       - width of a pixel in physical scale units
3677                   expressed as a string
3679     height      - height of a pixel in physical scale units
3680                  (width and height are strings like "2.54")
3682     png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
3683        num_unknowns)
3685     unknowns          - array of png_unknown_chunk
3686                         structures holding unknown chunks
3687     unknowns[i].name  - name of unknown chunk
3688     unknowns[i].data  - data of unknown chunk
3689     unknowns[i].size  - size of unknown chunk's data
3690     unknowns[i].location - position to write chunk in file
3691                            0: do not write chunk
3692                            PNG_HAVE_IHDR: before PLTE
3693                            PNG_HAVE_PLTE: before IDAT
3694                            PNG_AFTER_IDAT: after IDAT
3696 The "location" member is set automatically according to
3697 what part of the output file has already been written.
3698 You can change its value after calling png_set_unknown_chunks()
3699 as demonstrated in pngtest.c.  Within each of the "locations",
3700 the chunks are sequenced according to their position in the
3701 structure (that is, the value of "i", which is the order in which
3702 the chunk was either read from the input file or defined with
3703 png_set_unknown_chunks).
3705 A quick word about text and num_text.  text is an array of png_text
3706 structures.  num_text is the number of valid structures in the array.
3707 Each png_text structure holds a language code, a keyword, a text value,
3708 and a compression type.
3710 The compression types have the same valid numbers as the compression
3711 types of the image data.  Currently, the only valid number is zero.
3712 However, you can store text either compressed or uncompressed, unlike
3713 images, which always have to be compressed.  So if you don't want the
3714 text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
3715 Because tEXt and zTXt chunks don't have a language field, if you
3716 specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
3717 any language code or translated keyword will not be written out.
3719 Until text gets around a few hundred bytes, it is not worth compressing it.
3720 After the text has been written out to the file, the compression type
3721 is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
3722 so that it isn't written out again at the end (in case you are calling
3723 png_write_end() with the same struct).
3725 The keywords that are given in the PNG Specification are:
3727     Title            Short (one line) title or
3728                      caption for image
3730     Author           Name of image's creator
3732     Description      Description of image (possibly long)
3734     Copyright        Copyright notice
3736     Creation Time    Time of original image creation
3737                      (usually RFC 1123 format, see below)
3739     Software         Software used to create the image
3741     Disclaimer       Legal disclaimer
3743     Warning          Warning of nature of content
3745     Source           Device used to create the image
3747     Comment          Miscellaneous comment; conversion
3748                      from other image format
3750 The keyword-text pairs work like this.  Keywords should be short
3751 simple descriptions of what the comment is about.  Some typical
3752 keywords are found in the PNG specification, as is some recommendations
3753 on keywords.  You can repeat keywords in a file.  You can even write
3754 some text before the image and some after.  For example, you may want
3755 to put a description of the image before the image, but leave the
3756 disclaimer until after, so viewers working over modem connections
3757 don't have to wait for the disclaimer to go over the modem before
3758 they start seeing the image.  Finally, keywords should be full
3759 words, not abbreviations.  Keywords and text are in the ISO 8859-1
3760 (Latin-1) character set (a superset of regular ASCII) and can not
3761 contain NUL characters, and should not contain control or other
3762 unprintable characters.  To make the comments widely readable, stick
3763 with basic ASCII, and avoid machine specific character set extensions
3764 like the IBM-PC character set.  The keyword must be present, but
3765 you can leave off the text string on non-compressed pairs.
3766 Compressed pairs must have a text string, as only the text string
3767 is compressed anyway, so the compression would be meaningless.
3769 PNG supports modification time via the png_time structure.  Two
3770 conversion routines are provided, png_convert_from_time_t() for
3771 time_t and png_convert_from_struct_tm() for struct tm.  The
3772 time_t routine uses gmtime().  You don't have to use either of
3773 these, but if you wish to fill in the png_time structure directly,
3774 you should provide the time in universal time (GMT) if possible
3775 instead of your local time.  Note that the year number is the full
3776 year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
3777 that months start with 1.
3779 If you want to store the time of the original image creation, you should
3780 use a plain tEXt chunk with the "Creation Time" keyword.  This is
3781 necessary because the "creation time" of a PNG image is somewhat vague,
3782 depending on whether you mean the PNG file, the time the image was
3783 created in a non-PNG format, a still photo from which the image was
3784 scanned, or possibly the subject matter itself.  In order to facilitate
3785 machine-readable dates, it is recommended that the "Creation Time"
3786 tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
3787 although this isn't a requirement.  Unlike the tIME chunk, the
3788 "Creation Time" tEXt chunk is not expected to be automatically changed
3789 by the software.  To facilitate the use of RFC 1123 dates, a function
3790 png_convert_to_rfc1123_buffer(buffer, png_timep) is provided to
3791 convert from PNG time to an RFC 1123 format string.  The caller must provide
3792 a writeable buffer of at least 29 bytes.
3794 .SS Writing unknown chunks
3796 You can use the png_set_unknown_chunks function to queue up private chunks
3797 for writing.  You give it a chunk name, location, raw data, and a size.  You
3798 also must use png_set_keep_unknown_chunks() to ensure that libpng will
3799 handle them.  That's all there is to it.  The chunks will be written by the
3800 next following png_write_info_before_PLTE, png_write_info, or png_write_end
3801 function, depending upon the specified location.  Any chunks previously
3802 read into the info structure's unknown-chunk list will also be written out
3803 in a sequence that satisfies the PNG specification's ordering rules.
3805 Here is an example of writing two private chunks, prVt and miNE:
3807     #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
3808     /* Set unknown chunk data */
3809     png_unknown_chunk unk_chunk[2];
3810     strcpy((char *) unk_chunk[0].name, "prVt";
3811     unk_chunk[0].data = (unsigned char *) "PRIVATE DATA";
3812     unk_chunk[0].size = strlen(unk_chunk[0].data)+1;
3813     unk_chunk[0].location = PNG_HAVE_IHDR;
3814     strcpy((char *) unk_chunk[1].name, "miNE";
3815     unk_chunk[1].data = (unsigned char *) "MY CHUNK DATA";
3816     unk_chunk[1].size = strlen(unk_chunk[0].data)+1;
3817     unk_chunk[1].location = PNG_AFTER_IDAT;
3818     png_set_unknown_chunks(write_ptr, write_info_ptr,
3819         unk_chunk, 2);
3820     /* Needed because miNE is not safe-to-copy */
3821     png_set_keep_unknown_chunks(png, PNG_HANDLE_CHUNK_ALWAYS,
3822        (png_bytep) "miNE", 1);
3823     # if PNG_LIBPNG_VER < 10600
3824       /* Deal with unknown chunk location bug in 1.5.x and earlier */
3825       png_set_unknown_chunk_location(png, info, 0, PNG_HAVE_IHDR);
3826       png_set_unknown_chunk_location(png, info, 1, PNG_AFTER_IDAT);
3827     # endif
3828     # if PNG_LIBPNG_VER < 10500
3829       /* PNG_AFTER_IDAT writes two copies of the chunk prior to libpng-1.5.0,
3830        * one before IDAT and another after IDAT, so don't use it; only use
3831        * PNG_HAVE_IHDR location.  This call resets the location previously
3832        * set by assignment and png_set_unknown_chunk_location() for chunk 1.
3833        */
3834       png_set_unknown_chunk_location(png, info, 1, PNG_HAVE_IHDR);
3835     # endif
3836     #endif
3838 .SS The high-level write interface
3840 At this point there are two ways to proceed; through the high-level
3841 write interface, or through a sequence of low-level write operations.
3842 You can use the high-level interface if your image data is present
3843 in the info structure.  All defined output
3844 transformations are permitted, enabled by the following masks.
3846     PNG_TRANSFORM_IDENTITY      No transformation
3847     PNG_TRANSFORM_PACKING       Pack 1, 2 and 4-bit samples
3848     PNG_TRANSFORM_PACKSWAP      Change order of packed
3849                                 pixels to LSB first
3850     PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
3851     PNG_TRANSFORM_SHIFT         Normalize pixels to the
3852                                 sBIT depth
3853     PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
3854                                 to BGRA
3855     PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
3856                                 to AG
3857     PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
3858                                 to transparency
3859     PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
3860     PNG_TRANSFORM_STRIP_FILLER        Strip out filler
3861                                       bytes (deprecated).
3862     PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
3863                                       filler bytes
3864     PNG_TRANSFORM_STRIP_FILLER_AFTER  Strip out trailing
3865                                       filler bytes
3867 If you have valid image data in the info structure (you can use
3868 png_set_rows() to put image data in the info structure), simply do this:
3870     png_write_png(png_ptr, info_ptr, png_transforms, NULL)
3872 where png_transforms is an integer containing the bitwise OR of some set of
3873 transformation flags.  This call is equivalent to png_write_info(),
3874 followed the set of transformations indicated by the transform mask,
3875 then png_write_image(), and finally png_write_end().
3877 (The final parameter of this call is not yet used.  Someday it might point
3878 to transformation parameters required by some future output transform.)
3880 You must use png_transforms and not call any png_set_transform() functions
3881 when you use png_write_png().
3883 .SS The low-level write interface
3885 If you are going the low-level route instead, you are now ready to
3886 write all the file information up to the actual image data.  You do
3887 this with a call to png_write_info().
3889     png_write_info(png_ptr, info_ptr);
3891 Note that there is one transformation you may need to do before
3892 png_write_info().  In PNG files, the alpha channel in an image is the
3893 level of opacity.  If your data is supplied as a level of transparency,
3894 you can invert the alpha channel before you write it, so that 0 is
3895 fully transparent and 255 (in 8-bit or paletted images) or 65535
3896 (in 16-bit images) is fully opaque, with
3898     png_set_invert_alpha(png_ptr);
3900 This must appear before png_write_info() instead of later with the
3901 other transformations because in the case of paletted images the tRNS
3902 chunk data has to be inverted before the tRNS chunk is written.  If
3903 your image is not a paletted image, the tRNS data (which in such cases
3904 represents a single color to be rendered as transparent) won't need to
3905 be changed, and you can safely do this transformation after your
3906 png_write_info() call.
3908 If you need to write a private chunk that you want to appear before
3909 the PLTE chunk when PLTE is present, you can write the PNG info in
3910 two steps, and insert code to write your own chunk between them:
3912     png_write_info_before_PLTE(png_ptr, info_ptr);
3913     png_set_unknown_chunks(png_ptr, info_ptr, ...);
3914     png_write_info(png_ptr, info_ptr);
3916 After you've written the file information, you can set up the library
3917 to handle any special transformations of the image data.  The various
3918 ways to transform the data will be described in the order that they
3919 should occur.  This is important, as some of these change the color
3920 type and/or bit depth of the data, and some others only work on
3921 certain color types and bit depths.  Even though each transformation
3922 checks to see if it has data that it can do something with, you should
3923 make sure to only enable a transformation if it will be valid for the
3924 data.  For example, don't swap red and blue on grayscale data.
3926 PNG files store RGB pixels packed into 3 or 6 bytes.  This code tells
3927 the library to strip input data that has 4 or 8 bytes per pixel down
3928 to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
3929 bytes per pixel).
3931     png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
3933 where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
3934 PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
3935 is stored XRGB or RGBX.
3937 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
3938 they can, resulting in, for example, 8 pixels per byte for 1 bit files.
3939 If the data is supplied at 1 pixel per byte, use this code, which will
3940 correctly pack the pixels into a single byte:
3942     png_set_packing(png_ptr);
3944 PNG files reduce possible bit depths to 1, 2, 4, 8, and 16.  If your
3945 data is of another bit depth, you can write an sBIT chunk into the
3946 file so that decoders can recover the original data if desired.
3948     /* Set the true bit depth of the image data */
3949     if (color_type & PNG_COLOR_MASK_COLOR)
3950     {
3951        sig_bit.red = true_bit_depth;
3952        sig_bit.green = true_bit_depth;
3953        sig_bit.blue = true_bit_depth;
3954     }
3956     else
3957     {
3958        sig_bit.gray = true_bit_depth;
3959     }
3961     if (color_type & PNG_COLOR_MASK_ALPHA)
3962     {
3963        sig_bit.alpha = true_bit_depth;
3964     }
3966     png_set_sBIT(png_ptr, info_ptr, &sig_bit);
3968 If the data is stored in the row buffer in a bit depth other than
3969 one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
3970 this will scale the values to appear to be the correct bit depth as
3971 is required by PNG.
3973     png_set_shift(png_ptr, &sig_bit);
3975 PNG files store 16-bit pixels in network byte order (big-endian,
3976 ie. most significant bits first).  This code would be used if they are
3977 supplied the other way (little-endian, i.e. least significant bits
3978 first, the way PCs store them):
3980     if (bit_depth > 8)
3981        png_set_swap(png_ptr);
3983 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
3984 need to change the order the pixels are packed into bytes, you can use:
3986     if (bit_depth < 8)
3987        png_set_packswap(png_ptr);
3989 PNG files store 3 color pixels in red, green, blue order.  This code
3990 would be used if they are supplied as blue, green, red:
3992     png_set_bgr(png_ptr);
3994 PNG files describe monochrome as black being zero and white being
3995 one. This code would be used if the pixels are supplied with this reversed
3996 (black being one and white being zero):
3998     png_set_invert_mono(png_ptr);
4000 Finally, you can write your own transformation function if none of
4001 the existing ones meets your needs.  This is done by setting a callback
4002 with
4004     png_set_write_user_transform_fn(png_ptr,
4005        write_transform_fn);
4007 You must supply the function
4009     void write_transform_fn(png_structp png_ptr, png_row_infop
4010        row_info, png_bytep data)
4012 See pngtest.c for a working example.  Your function will be called
4013 before any of the other transformations are processed.  If supported
4014 libpng also supplies an information routine that may be called from
4015 your callback:
4017    png_get_current_row_number(png_ptr);
4018    png_get_current_pass_number(png_ptr);
4020 This returns the current row passed to the transform.  With interlaced
4021 images the value returned is the row in the input sub-image image.  Use
4022 PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
4023 find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
4025 The discussion of interlace handling above contains more information on how to
4026 use these values.
4028 You can also set up a pointer to a user structure for use by your
4029 callback function.
4031     png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
4033 The user_channels and user_depth parameters of this function are ignored
4034 when writing; you can set them to zero as shown.
4036 You can retrieve the pointer via the function png_get_user_transform_ptr().
4037 For example:
4039     voidp write_user_transform_ptr =
4040        png_get_user_transform_ptr(png_ptr);
4042 It is possible to have libpng flush any pending output, either manually,
4043 or automatically after a certain number of lines have been written.  To
4044 flush the output stream a single time call:
4046     png_write_flush(png_ptr);
4048 and to have libpng flush the output stream periodically after a certain
4049 number of scanlines have been written, call:
4051     png_set_flush(png_ptr, nrows);
4053 Note that the distance between rows is from the last time png_write_flush()
4054 was called, or the first row of the image if it has never been called.
4055 So if you write 50 lines, and then png_set_flush 25, it will flush the
4056 output on the next scanline, and every 25 lines thereafter, unless
4057 png_write_flush() is called before 25 more lines have been written.
4058 If nrows is too small (less than about 10 lines for a 640 pixel wide
4059 RGB image) the image compression may decrease noticeably (although this
4060 may be acceptable for real-time applications).  Infrequent flushing will
4061 only degrade the compression performance by a few percent over images
4062 that do not use flushing.
4064 .SS Writing the image data
4066 That's it for the transformations.  Now you can write the image data.
4067 The simplest way to do this is in one function call.  If you have the
4068 whole image in memory, you can just call png_write_image() and libpng
4069 will write the image.  You will need to pass in an array of pointers to
4070 each row.  This function automatically handles interlacing, so you don't
4071 need to call png_set_interlace_handling() or call this function multiple
4072 times, or any of that other stuff necessary with png_write_rows().
4074     png_write_image(png_ptr, row_pointers);
4076 where row_pointers is:
4078     png_byte *row_pointers[height];
4080 You can point to void or char or whatever you use for pixels.
4082 If you don't want to write the whole image at once, you can
4083 use png_write_rows() instead.  If the file is not interlaced,
4084 this is simple:
4086     png_write_rows(png_ptr, row_pointers,
4087        number_of_rows);
4089 row_pointers is the same as in the png_write_image() call.
4091 If you are just writing one row at a time, you can do this with
4092 a single row_pointer instead of an array of row_pointers:
4094     png_bytep row_pointer = row;
4096     png_write_row(png_ptr, row_pointer);
4098 When the file is interlaced, things can get a good deal more complicated.
4099 The only currently (as of the PNG Specification version 1.2, dated July
4100 1999) defined interlacing scheme for PNG files is the "Adam7" interlace
4101 scheme, that breaks down an image into seven smaller images of varying
4102 size.  libpng will build these images for you, or you can do them
4103 yourself.  If you want to build them yourself, see the PNG specification
4104 for details of which pixels to write when.
4106 If you don't want libpng to handle the interlacing details, just
4107 use png_set_interlace_handling() and call png_write_rows() the
4108 correct number of times to write all the sub-images
4109 (png_set_interlace_handling() returns the number of sub-images.)
4111 If you want libpng to build the sub-images, call this before you start
4112 writing any rows:
4114     number_of_passes = png_set_interlace_handling(png_ptr);
4116 This will return the number of passes needed.  Currently, this is seven,
4117 but may change if another interlace type is added.
4119 Then write the complete image number_of_passes times.
4121     png_write_rows(png_ptr, row_pointers, number_of_rows);
4123 Think carefully before you write an interlaced image.  Typically code that
4124 reads such images reads all the image data into memory, uncompressed, before
4125 doing any processing.  Only code that can display an image on the fly can
4126 take advantage of the interlacing and even then the image has to be exactly
4127 the correct size for the output device, because scaling an image requires
4128 adjacent pixels and these are not available until all the passes have been
4129 read.
4131 If you do write an interlaced image you will hardly ever need to handle
4132 the interlacing yourself.  Call png_set_interlace_handling() and use the
4133 approach described above.
4135 The only time it is conceivable that you will really need to write an
4136 interlaced image pass-by-pass is when you have read one pass by pass and
4137 made some pixel-by-pixel transformation to it, as described in the read
4138 code above.  In this case use the PNG_PASS_ROWS and PNG_PASS_COLS macros
4139 to determine the size of each sub-image in turn and simply write the rows
4140 you obtained from the read code.
4142 .SS Finishing a sequential write
4144 After you are finished writing the image, you should finish writing
4145 the file.  If you are interested in writing comments or time, you should
4146 pass an appropriately filled png_info pointer.  If you are not interested,
4147 you can pass NULL.
4149     png_write_end(png_ptr, info_ptr);
4151 When you are done, you can free all memory used by libpng like this:
4153     png_destroy_write_struct(&png_ptr, &info_ptr);
4155 It is also possible to individually free the info_ptr members that
4156 point to libpng-allocated storage with the following function:
4158     png_free_data(png_ptr, info_ptr, mask, seq)
4160     mask  - identifies data to be freed, a mask
4161             containing the bitwise OR of one or
4162             more of
4163               PNG_FREE_PLTE, PNG_FREE_TRNS,
4164               PNG_FREE_HIST, PNG_FREE_ICCP,
4165               PNG_FREE_PCAL, PNG_FREE_ROWS,
4166               PNG_FREE_SCAL, PNG_FREE_SPLT,
4167               PNG_FREE_TEXT, PNG_FREE_UNKN,
4168             or simply PNG_FREE_ALL
4170     seq   - sequence number of item to be freed
4171             (\-1 for all items)
4173 This function may be safely called when the relevant storage has
4174 already been freed, or has not yet been allocated, or was allocated
4175 by the user  and not by libpng,  and will in those cases do nothing.
4176 The "seq" parameter is ignored if only one item of the selected data
4177 type, such as PLTE, is allowed.  If "seq" is not \-1, and multiple items
4178 are allowed for the data type identified in the mask, such as text or
4179 sPLT, only the n'th item in the structure is freed, where n is "seq".
4181 If you allocated data such as a palette that you passed in to libpng
4182 with png_set_*, you must not free it until just before the call to
4183 png_destroy_write_struct().
4185 The default behavior is only to free data that was allocated internally
4186 by libpng.  This can be changed, so that libpng will not free the data,
4187 or so that it will free data that was allocated by the user with png_malloc()
4188 or png_calloc() and passed in via a png_set_*() function, with
4190     png_data_freer(png_ptr, info_ptr, freer, mask)
4192     freer  - one of
4193                PNG_DESTROY_WILL_FREE_DATA
4194                PNG_SET_WILL_FREE_DATA
4195                PNG_USER_WILL_FREE_DATA
4197     mask   - which data elements are affected
4198              same choices as in png_free_data()
4200 For example, to transfer responsibility for some data from a read structure
4201 to a write structure, you could use
4203     png_data_freer(read_ptr, read_info_ptr,
4204        PNG_USER_WILL_FREE_DATA,
4205        PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
4207     png_data_freer(write_ptr, write_info_ptr,
4208        PNG_DESTROY_WILL_FREE_DATA,
4209        PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
4211 thereby briefly reassigning responsibility for freeing to the user but
4212 immediately afterwards reassigning it once more to the write_destroy
4213 function.  Having done this, it would then be safe to destroy the read
4214 structure and continue to use the PLTE, tRNS, and hIST data in the write
4215 structure.
4217 This function only affects data that has already been allocated.
4218 You can call this function before calling after the png_set_*() functions
4219 to control whether the user or png_destroy_*() is supposed to free the data.
4220 When the user assumes responsibility for libpng-allocated data, the
4221 application must use
4222 png_free() to free it, and when the user transfers responsibility to libpng
4223 for data that the user has allocated, the user must have used png_malloc()
4224 or png_calloc() to allocate it.
4226 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
4227 separately, do not transfer responsibility for freeing text_ptr to libpng,
4228 because when libpng fills a png_text structure it combines these members with
4229 the key member, and png_free_data() will free only text_ptr.key.  Similarly,
4230 if you transfer responsibility for free'ing text_ptr from libpng to your
4231 application, your application must not separately free those members.
4232 For a more compact example of writing a PNG image, see the file example.c.
4234 .SH V. Simplified API
4236 The simplified API, which became available in libpng-1.6.0, hides the details
4237 of both libpng and the PNG file format itself.
4238 It allows PNG files to be read into a very limited number of
4239 in-memory bitmap formats or to be written from the same formats.  If these
4240 formats do not accommodate your needs then you can, and should, use the more
4241 sophisticated APIs above - these support a wide variety of in-memory formats
4242 and a wide variety of sophisticated transformations to those formats as well
4243 as a wide variety of APIs to manipulate ancilliary information.
4245 To read a PNG file using the simplified API:
4247   1) Declare a 'png_image' structure (see below) on the stack, set the
4248      version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
4249      (this is REQUIRED, your program may crash if you don't do it.)
4251   2) Call the appropriate png_image_begin_read... function.
4253   3) Set the png_image 'format' member to the required sample format.
4255   4) Allocate a buffer for the image and, if required, the color-map.
4257   5) Call png_image_finish_read to read the image and, if required, the
4258      color-map into your buffers.
4260 There are no restrictions on the format of the PNG input itself; all valid
4261 color types, bit depths, and interlace methods are acceptable, and the
4262 input image is transformed as necessary to the requested in-memory format
4263 during the png_image_finish_read() step.  The only caveat is that if you
4264 request a color-mapped image from a PNG that is full-color or makes
4265 complex use of an alpha channel the transformation is extremely lossy and the
4266 result may look terrible.
4268 To write a PNG file using the simplified API:
4270   1) Declare a 'png_image' structure on the stack and memset()
4271      it to all zero.
4273   2) Initialize the members of the structure that describe the
4274      image, setting the 'format' member to the format of the
4275      image samples.
4277   3) Call the appropriate png_image_write... function with a
4278      pointer to the image and, if necessary, the color-map to write
4279      the PNG data.
4281 png_image is a structure that describes the in-memory format of an image
4282 when it is being read or defines the in-memory format of an image that you
4283 need to write.  The "png_image" structure contains the following members:
4285    png_controlp opaque  Initialize to NULL, free with png_image_free
4286    png_uint_32  version Set to PNG_IMAGE_VERSION
4287    png_uint_32  width   Image width in pixels (columns)
4288    png_uint_32  height  Image height in pixels (rows)
4289    png_uint_32  format  Image format as defined below
4290    png_uint_32  flags   A bit mask containing informational flags
4291    png_uint_32  colormap_entries; Number of entries in the color-map
4292    png_uint_32  warning_or_error;
4293    char         message[64];
4295 In the event of an error or warning the "warning_or_error"
4296 field will be set to a non-zero value and the 'message' field will contain
4297 a '\0' terminated string with the libpng error or warning message.  If both
4298 warnings and an error were encountered, only the error is recorded.  If there
4299 are multiple warnings, only the first one is recorded.
4301 The upper 30 bits of the "warning_or_error" value are reserved; the low two
4302 bits contain a two bit code such that a value more than 1 indicates a failure
4303 in the API just called:
4305    0 - no warning or error
4306    1 - warning
4307    2 - error
4308    3 - error preceded by warning
4310 The pixels (samples) of the image have one to four channels whose components
4311 have original values in the range 0 to 1.0:
4313   1: A single gray or luminance channel (G).
4314   2: A gray/luminance channel and an alpha channel (GA).
4315   3: Three red, green, blue color channels (RGB).
4316   4: Three color channels and an alpha channel (RGBA).
4318 The channels are encoded in one of two ways:
4320   a) As a small integer, value 0..255, contained in a single byte.  For the
4321 alpha channel the original value is simply value/255.  For the color or
4322 luminance channels the value is encoded according to the sRGB specification
4323 and matches the 8-bit format expected by typical display devices.
4325 The color/gray channels are not scaled (pre-multiplied) by the alpha
4326 channel and are suitable for passing to color management software.
4328   b) As a value in the range 0..65535, contained in a 2-byte integer, in
4329 the native byte order of the platform on which the application is running.
4330 All channels can be converted to the original value by dividing by 65535; all
4331 channels are linear.  Color channels use the RGB encoding (RGB end-points) of
4332 the sRGB specification.  This encoding is identified by the
4333 PNG_FORMAT_FLAG_LINEAR flag below.
4335 When the simplified API needs to convert between sRGB and linear colorspaces,
4336 the actual sRGB transfer curve defined in the sRGB specification (see the
4337 article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
4338 approximation used elsewhere in libpng.
4340 When an alpha channel is present it is expected to denote pixel coverage
4341 of the color or luminance channels and is returned as an associated alpha
4342 channel: the color/gray channels are scaled (pre-multiplied) by the alpha
4343 value.
4345 The samples are either contained directly in the image data, between 1 and 8
4346 bytes per pixel according to the encoding, or are held in a color-map indexed
4347 by bytes in the image data.  In the case of a color-map the color-map entries
4348 are individual samples, encoded as above, and the image data has one byte per
4349 pixel to select the relevant sample from the color-map.
4351 PNG_FORMAT_*
4353 The #defines to be used in png_image::format.  Each #define identifies a
4354 particular layout of channel data and, if present, alpha values.  There are
4355 separate defines for each of the two component encodings.
4357 A format is built up using single bit flag values.  All combinations are
4358 valid.  Formats can be built up from the flag values or you can use one of
4359 the predefined values below.  When testing formats always use the FORMAT_FLAG
4360 macros to test for individual features - future versions of the library may
4361 add new flags.
4363 When reading or writing color-mapped images the format should be set to the
4364 format of the entries in the color-map then png_image_{read,write}_colormap
4365 called to read or write the color-map and set the format correctly for the
4366 image data.  Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
4368 NOTE: libpng can be built with particular features disabled. If you see
4369 compiler errors because the definition of one of the following flags has been
4370 compiled out it is because libpng does not have the required support.  It is
4371 possible, however, for the libpng configuration to enable the format on just
4372 read or just write; in that case you may see an error at run time.
4373 You can guard against this by checking for the definition of the
4374 appropriate "_SUPPORTED" macro, one of:
4376    PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
4378    PNG_FORMAT_FLAG_ALPHA    format with an alpha channel
4379    PNG_FORMAT_FLAG_COLOR    color format: otherwise grayscale
4380    PNG_FORMAT_FLAG_LINEAR   2-byte channels else 1-byte
4381    PNG_FORMAT_FLAG_COLORMAP image data is color-mapped
4382    PNG_FORMAT_FLAG_BGR      BGR colors, else order is RGB
4383    PNG_FORMAT_FLAG_AFIRST   alpha channel comes first
4385 Supported formats are as follows.  Future versions of libpng may support more
4386 formats; for compatibility with older versions simply check if the format
4387 macro is defined using #ifdef.  These defines describe the in-memory layout
4388 of the components of the pixels of the image.
4390 First the single byte (sRGB) formats:
4392    PNG_FORMAT_GRAY
4393    PNG_FORMAT_GA
4394    PNG_FORMAT_AG
4395    PNG_FORMAT_RGB
4396    PNG_FORMAT_BGR
4397    PNG_FORMAT_RGBA
4398    PNG_FORMAT_ARGB
4399    PNG_FORMAT_BGRA
4400    PNG_FORMAT_ABGR
4402 Then the linear 2-byte formats.  When naming these "Y" is used to
4403 indicate a luminance (gray) channel.  The component order within the pixel
4404 is always the same - there is no provision for swapping the order of the
4405 components in the linear format.  The components are 16-bit integers in
4406 the native byte order for your platform, and there is no provision for
4407 swapping the bytes to a different endian condition.
4409    PNG_FORMAT_LINEAR_Y
4410    PNG_FORMAT_LINEAR_Y_ALPHA
4411    PNG_FORMAT_LINEAR_RGB
4412    PNG_FORMAT_LINEAR_RGB_ALPHA
4414 With color-mapped formats the image data is one byte for each pixel. The byte
4415 is an index into the color-map which is formatted as above.  To obtain a
4416 color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
4417 to one of the above definitions, or you can use one of the definitions below.
4419    PNG_FORMAT_RGB_COLORMAP
4420    PNG_FORMAT_BGR_COLORMAP
4421    PNG_FORMAT_RGBA_COLORMAP
4422    PNG_FORMAT_ARGB_COLORMAP
4423    PNG_FORMAT_BGRA_COLORMAP
4424    PNG_FORMAT_ABGR_COLORMAP
4426 PNG_IMAGE macros
4428 These are convenience macros to derive information from a png_image
4429 structure.  The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
4430 actual image sample values - either the entries in the color-map or the
4431 pixels in the image.  The PNG_IMAGE_PIXEL_ macros return corresponding values
4432 for the pixels and will always return 1 for color-mapped formats.  The
4433 remaining macros return information about the rows in the image and the
4434 complete image.
4436 NOTE: All the macros that take a png_image::format parameter are compile time
4437 constants if the format parameter is, itself, a constant.  Therefore these
4438 macros can be used in array declarations and case labels where required.
4439 Similarly the macros are also pre-processor constants (sizeof is not used) so
4440 they can be used in #if tests.
4442   PNG_IMAGE_SAMPLE_CHANNELS(fmt)
4443     Returns the total number of channels in a given format: 1..4
4445   PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)
4446     Returns the size in bytes of a single component of a pixel or color-map
4447     entry (as appropriate) in the image: 1 or 2.
4449   PNG_IMAGE_SAMPLE_SIZE(fmt)
4450     This is the size of the sample data for one sample.  If the image is
4451     color-mapped it is the size of one color-map entry (and image pixels are
4452     one byte in size), otherwise it is the size of one image pixel.
4454   PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)
4455     The maximum size of the color-map required by the format expressed in a
4456     count of components.  This can be used to compile-time allocate a
4457     color-map:
4459     png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
4461     png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
4463     Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
4464     information from one of the png_image_begin_read_ APIs and dynamically
4465     allocate the required memory.
4467   PNG_IMAGE_COLORMAP_SIZE(fmt)
4468    The size of the color-map required by the format; this is the size of the
4469    color-map buffer passed to the png_image_{read,write}_colormap APIs. It is
4470    a fixed number determined by the format so can easily be allocated on the
4471    stack if necessary.
4473 Corresponding information about the pixels
4475   PNG_IMAGE_PIXEL_CHANNELS(fmt)
4476    The number of separate channels (components) in a pixel; 1 for a
4477    color-mapped image.
4479   PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
4480    The size, in bytes, of each component in a pixel; 1 for a color-mapped
4481    image.
4483   PNG_IMAGE_PIXEL_SIZE(fmt)
4484    The size, in bytes, of a complete pixel; 1 for a color-mapped image.
4486 Information about the whole row, or whole image
4488   PNG_IMAGE_ROW_STRIDE(image)
4489    Returns the total number of components in a single row of the image; this
4490    is the minimum 'row stride', the minimum count of components between each
4491    row.  For a color-mapped image this is the minimum number of bytes in a
4492    row.
4494    If you need the stride measured in bytes, row_stride_bytes is
4495    PNG_IMAGE_ROW_STRIDE(image) * PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)
4496    plus any padding bytes that your application might need, for example
4497    to start the next row on a 4-byte boundary.
4499   PNG_IMAGE_BUFFER_SIZE(image, row_stride)
4500    Return the size, in bytes, of an image buffer given a png_image and a row
4501    stride - the number of components to leave space for in each row.
4503   PNG_IMAGE_SIZE(image)
4504    Return the size, in bytes, of the image in memory given just a png_image;
4505    the row stride is the minimum stride required for the image.
4507   PNG_IMAGE_COLORMAP_SIZE(image)
4508    Return the size, in bytes, of the color-map of this image.  If the image
4509    format is not a color-map format this will return a size sufficient for
4510    256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
4511    you don't want to allocate a color-map in this case.
4513 PNG_IMAGE_FLAG_*
4515 Flags containing additional information about the image are held in
4516 the 'flags' field of png_image.
4518   PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB == 0x01
4519     This indicates the the RGB values of the in-memory bitmap do not
4520     correspond to the red, green and blue end-points defined by sRGB.
4522   PNG_IMAGE_FLAG_FAST == 0x02
4523    On write emphasise speed over compression; the resultant PNG file will be
4524    larger but will be produced significantly faster, particular for large
4525    images.  Do not use this option for images which will be distributed, only
4526    used it when producing intermediate files that will be read back in
4527    repeatedly.  For a typical 24-bit image the option will double the read
4528    speed at the cost of increasing the image size by 25%, however for many
4529    more compressible images the PNG file can be 10 times larger with only a
4530    slight speed gain.
4532   PNG_IMAGE_FLAG_16BIT_sRGB == 0x04
4533     On read if the image is a 16-bit per component image and there is no gAMA
4534     or sRGB chunk assume that the components are sRGB encoded.  Notice that
4535     images output by the simplified API always have gamma information; setting
4536     this flag only affects the interpretation of 16-bit images from an
4537     external source.  It is recommended that the application expose this flag
4538     to the user; the user can normally easily recognize the difference between
4539     linear and sRGB encoding.  This flag has no effect on write - the data
4540     passed to the write APIs must have the correct encoding (as defined
4541     above.)
4543     If the flag is not set (the default) input 16-bit per component data is
4544     assumed to be linear.
4546     NOTE: the flag can only be set after the png_image_begin_read_ call,
4547     because that call initializes the 'flags' field.
4549 READ APIs
4551    The png_image passed to the read APIs must have been initialized by setting
4552    the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.)
4554    int png_image_begin_read_from_file( png_imagep image,
4555      const char *file_name)
4557      The named file is opened for read and the image header
4558      is filled in from the PNG header in the file.
4560    int png_image_begin_read_from_stdio (png_imagep image,
4561      FILE* file)
4563       The PNG header is read from the stdio FILE object.
4565    int png_image_begin_read_from_memory(png_imagep image,
4566       png_const_voidp memory, png_size_t size)
4568       The PNG header is read from the given memory buffer.
4570    int png_image_finish_read(png_imagep image,
4571       png_colorp background, void *buffer,
4572       png_int_32 row_stride, void *colormap));
4574       Finish reading the image into the supplied buffer and
4575       clean up the png_image structure.
4577       row_stride is the step, in png_byte or png_uint_16 units
4578       as appropriate, between adjacent rows.  A positive stride
4579       indicates that the top-most row is first in the buffer -
4580       the normal top-down arrangement.  A negative stride
4581       indicates that the bottom-most row is first in the buffer.
4583       background need only be supplied if an alpha channel must
4584       be removed from a png_byte format and the removal is to be
4585       done by compositing on a solid color; otherwise it may be
4586       NULL and any composition will be done directly onto the
4587       buffer.  The value is an sRGB color to use for the
4588       background, for grayscale output the green channel is used.
4590       For linear output removing the alpha channel is always done
4591       by compositing on black.
4593    void png_image_free(png_imagep image)
4595       Free any data allocated by libpng in image->opaque,
4596       setting the pointer to NULL.  May be called at any time
4597       after the structure is initialized.
4599 When the simplified API needs to convert between sRGB and linear colorspaces,
4600 the actual sRGB transfer curve defined in the sRGB specification (see the
4601 article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
4602 approximation used elsewhere in libpng.
4604 WRITE APIS
4606 For write you must initialize a png_image structure to describe the image to
4607 be written:
4609    version: must be set to PNG_IMAGE_VERSION
4610    opaque: must be initialized to NULL
4611    width: image width in pixels
4612    height: image height in rows
4613    format: the format of the data you wish to write
4614    flags: set to 0 unless one of the defined flags applies; set
4615       PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images
4616       where the RGB values do not correspond to the colors in sRGB.
4617    colormap_entries: set to the number of entries in the color-map (0 to 256)
4619    int png_image_write_to_file, (png_imagep image,
4620       const char *file, int convert_to_8bit, const void *buffer,
4621       png_int_32 row_stride, const void *colormap));
4623       Write the image to the named file.
4625    int png_image_write_to_memory (png_imagep image, void *memory,
4626       png_alloc_size_t * PNG_RESTRICT memory_bytes,
4627       int convert_to_8_bit, const void *buffer, ptrdiff_t row_stride,
4628       const void *colormap));
4630       Write the image to memory.
4632    int png_image_write_to_stdio(png_imagep image, FILE *file,
4633       int convert_to_8_bit, const void *buffer,
4634       png_int_32 row_stride, const void *colormap)
4636       Write the image to the given (FILE*).
4638 With all write APIs if image is in one of the linear formats with
4639 (png_uint_16) data then setting convert_to_8_bit will cause the output to be
4640 a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise
4641 a 16-bit linear encoded PNG file is written.
4643 With all APIs row_stride is handled as in the read APIs - it is the spacing
4644 from one row to the next in component sized units (float) and if negative
4645 indicates a bottom-up row layout in the buffer.  If you pass zero, libpng will
4646 calculate the row_stride for you from the width and number of channels.
4648 Note that the write API does not support interlacing, sub-8-bit pixels,
4649 indexed (paletted) images, or most ancillary chunks.
4651 .SH VI. Modifying/Customizing libpng
4653 There are two issues here.  The first is changing how libpng does
4654 standard things like memory allocation, input/output, and error handling.
4655 The second deals with more complicated things like adding new chunks,
4656 adding new transformations, and generally changing how libpng works.
4657 Both of those are compile-time issues; that is, they are generally
4658 determined at the time the code is written, and there is rarely a need
4659 to provide the user with a means of changing them.
4661 Memory allocation, input/output, and error handling
4663 All of the memory allocation, input/output, and error handling in libpng
4664 goes through callbacks that are user-settable.  The default routines are
4665 in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively.  To change
4666 these functions, call the appropriate png_set_*_fn() function.
4668 Memory allocation is done through the functions png_malloc(), png_calloc(),
4669 and png_free().  The png_malloc() and png_free() functions currently just
4670 call the standard C functions and png_calloc() calls png_malloc() and then
4671 clears the newly allocated memory to zero; note that png_calloc(png_ptr, size)
4672 is not the same as the calloc(number, size) function provided by stdlib.h.
4673 There is limited support for certain systems with segmented memory
4674 architectures and the types of pointers declared by png.h match this; you
4675 will have to use appropriate pointers in your application.  If you prefer
4676 to use a different method of allocating and freeing data, you can use
4677 png_create_read_struct_2() or png_create_write_struct_2() to register your
4678 own functions as described above.  These functions also provide a void
4679 pointer that can be retrieved via
4681     mem_ptr=png_get_mem_ptr(png_ptr);
4683 Your replacement memory functions must have prototypes as follows:
4685     png_voidp malloc_fn(png_structp png_ptr,
4686        png_alloc_size_t size);
4688     void free_fn(png_structp png_ptr, png_voidp ptr);
4690 Your malloc_fn() must return NULL in case of failure.  The png_malloc()
4691 function will normally call png_error() if it receives a NULL from the
4692 system memory allocator or from your replacement malloc_fn().
4694 Your free_fn() will never be called with a NULL ptr, since libpng's
4695 png_free() checks for NULL before calling free_fn().
4697 Input/Output in libpng is done through png_read() and png_write(),
4698 which currently just call fread() and fwrite().  The FILE * is stored in
4699 png_struct and is initialized via png_init_io().  If you wish to change
4700 the method of I/O, the library supplies callbacks that you can set
4701 through the function png_set_read_fn() and png_set_write_fn() at run
4702 time, instead of calling the png_init_io() function.  These functions
4703 also provide a void pointer that can be retrieved via the function
4704 png_get_io_ptr().  For example:
4706     png_set_read_fn(png_structp read_ptr,
4707         voidp read_io_ptr, png_rw_ptr read_data_fn)
4709     png_set_write_fn(png_structp write_ptr,
4710         voidp write_io_ptr, png_rw_ptr write_data_fn,
4711         png_flush_ptr output_flush_fn);
4713     voidp read_io_ptr = png_get_io_ptr(read_ptr);
4714     voidp write_io_ptr = png_get_io_ptr(write_ptr);
4716 The replacement I/O functions must have prototypes as follows:
4718     void user_read_data(png_structp png_ptr,
4719         png_bytep data, png_size_t length);
4721     void user_write_data(png_structp png_ptr,
4722         png_bytep data, png_size_t length);
4724     void user_flush_data(png_structp png_ptr);
4726 The user_read_data() function is responsible for detecting and
4727 handling end-of-data errors.
4729 Supplying NULL for the read, write, or flush functions sets them back
4730 to using the default C stream functions, which expect the io_ptr to
4731 point to a standard *FILE structure.  It is probably a mistake
4732 to use NULL for one of write_data_fn and output_flush_fn but not both
4733 of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
4734 It is an error to read from a write stream, and vice versa.
4736 Error handling in libpng is done through png_error() and png_warning().
4737 Errors handled through png_error() are fatal, meaning that png_error()
4738 should never return to its caller.  Currently, this is handled via
4739 setjmp() and longjmp() (unless you have compiled libpng with
4740 PNG_NO_SETJMP, in which case it is handled via PNG_ABORT()),
4741 but you could change this to do things like exit() if you should wish,
4742 as long as your function does not return.
4744 On non-fatal errors, png_warning() is called
4745 to print a warning message, and then control returns to the calling code.
4746 By default png_error() and png_warning() print a message on stderr via
4747 fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
4748 (because you don't want the messages) or PNG_NO_STDIO defined (because
4749 fprintf() isn't available).  If you wish to change the behavior of the error
4750 functions, you will need to set up your own message callbacks.  These
4751 functions are normally supplied at the time that the png_struct is created.
4752 It is also possible to redirect errors and warnings to your own replacement
4753 functions after png_create_*_struct() has been called by calling:
4755     png_set_error_fn(png_structp png_ptr,
4756         png_voidp error_ptr, png_error_ptr error_fn,
4757         png_error_ptr warning_fn);
4759     png_voidp error_ptr = png_get_error_ptr(png_ptr);
4761 If NULL is supplied for either error_fn or warning_fn, then the libpng
4762 default function will be used, calling fprintf() and/or longjmp() if a
4763 problem is encountered.  The replacement error functions should have
4764 parameters as follows:
4766     void user_error_fn(png_structp png_ptr,
4767         png_const_charp error_msg);
4769     void user_warning_fn(png_structp png_ptr,
4770         png_const_charp warning_msg);
4772 The motivation behind using setjmp() and longjmp() is the C++ throw and
4773 catch exception handling methods.  This makes the code much easier to write,
4774 as there is no need to check every return code of every function call.
4775 However, there are some uncertainties about the status of local variables
4776 after a longjmp, so the user may want to be careful about doing anything
4777 after setjmp returns non-zero besides returning itself.  Consult your
4778 compiler documentation for more details.  For an alternative approach, you
4779 may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net),
4780 which is illustrated in pngvalid.c and in contrib/visupng.
4782 Beginning in libpng-1.4.0, the png_set_benign_errors() API became available.
4783 You can use this to handle certain errors (normally handled as errors)
4784 as warnings.
4786     png_set_benign_errors (png_ptr, int allowed);
4788     allowed: 0: treat png_benign_error() as an error.
4789              1: treat png_benign_error() as a warning.
4791 As of libpng-1.6.0, the default condition is to treat benign errors as
4792 warnings while reading and as errors while writing.
4794 .SS Custom chunks
4796 If you need to read or write custom chunks, you may need to get deeper
4797 into the libpng code.  The library now has mechanisms for storing
4798 and writing chunks of unknown type; you can even declare callbacks
4799 for custom chunks.  However, this may not be good enough if the
4800 library code itself needs to know about interactions between your
4801 chunk and existing `intrinsic' chunks.
4803 If you need to write a new intrinsic chunk, first read the PNG
4804 specification. Acquire a first level of understanding of how it works.
4805 Pay particular attention to the sections that describe chunk names,
4806 and look at how other chunks were designed, so you can do things
4807 similarly.  Second, check out the sections of libpng that read and
4808 write chunks.  Try to find a chunk that is similar to yours and use
4809 it as a template.  More details can be found in the comments inside
4810 the code.  It is best to handle private or unknown chunks in a generic method,
4811 via callback functions, instead of by modifying libpng functions. This
4812 is illustrated in pngtest.c, which uses a callback function to handle a
4813 private "vpAg" chunk and the new "sTER" chunk, which are both unknown to
4814 libpng.
4816 If you wish to write your own transformation for the data, look through
4817 the part of the code that does the transformations, and check out some of
4818 the simpler ones to get an idea of how they work.  Try to find a similar
4819 transformation to the one you want to add and copy off of it.  More details
4820 can be found in the comments inside the code itself.
4822 .SS Configuring for gui/windowing platforms:
4824 You will need to write new error and warning functions that use the GUI
4825 interface, as described previously, and set them to be the error and
4826 warning functions at the time that png_create_*_struct() is called,
4827 in order to have them available during the structure initialization.
4828 They can be changed later via png_set_error_fn().  On some compilers,
4829 you may also have to change the memory allocators (png_malloc, etc.).
4831 .SS Configuring zlib:
4833 There are special functions to configure the compression.  Perhaps the
4834 most useful one changes the compression level, which currently uses
4835 input compression values in the range 0 - 9.  The library normally
4836 uses the default compression level (Z_DEFAULT_COMPRESSION = 6).  Tests
4837 have shown that for a large majority of images, compression values in
4838 the range 3-6 compress nearly as well as higher levels, and do so much
4839 faster.  For online applications it may be desirable to have maximum speed
4840 (Z_BEST_SPEED = 1).  With versions of zlib after v0.99, you can also
4841 specify no compression (Z_NO_COMPRESSION = 0), but this would create
4842 files larger than just storing the raw bitmap.  You can specify the
4843 compression level by calling:
4845     #include zlib.h
4846     png_set_compression_level(png_ptr, level);
4848 Another useful one is to reduce the memory level used by the library.
4849 The memory level defaults to 8, but it can be lowered if you are
4850 short on memory (running DOS, for example, where you only have 640K).
4851 Note that the memory level does have an effect on compression; among
4852 other things, lower levels will result in sections of incompressible
4853 data being emitted in smaller stored blocks, with a correspondingly
4854 larger relative overhead of up to 15% in the worst case.
4856     #include zlib.h
4857     png_set_compression_mem_level(png_ptr, level);
4859 The other functions are for configuring zlib.  They are not recommended
4860 for normal use and may result in writing an invalid PNG file.  See
4861 zlib.h for more information on what these mean.
4863     #include zlib.h
4864     png_set_compression_strategy(png_ptr,
4865         strategy);
4867     png_set_compression_window_bits(png_ptr,
4868         window_bits);
4870     png_set_compression_method(png_ptr, method);
4872 This controls the size of the IDAT chunks (default 8192):
4874     png_set_compression_buffer_size(png_ptr, size);
4876 As of libpng version 1.5.4, additional APIs became
4877 available to set these separately for non-IDAT
4878 compressed chunks such as zTXt, iTXt, and iCCP:
4880     #include zlib.h
4881     #if PNG_LIBPNG_VER >= 10504
4882     png_set_text_compression_level(png_ptr, level);
4884     png_set_text_compression_mem_level(png_ptr, level);
4886     png_set_text_compression_strategy(png_ptr,
4887         strategy);
4889     png_set_text_compression_window_bits(png_ptr,
4890         window_bits);
4892     png_set_text_compression_method(png_ptr, method);
4893     #endif
4895 .SS Controlling row filtering
4897 If you want to control whether libpng uses filtering or not, which
4898 filters are used, and how it goes about picking row filters, you
4899 can call one of these functions.  The selection and configuration
4900 of row filters can have a significant impact on the size and
4901 encoding speed and a somewhat lesser impact on the decoding speed
4902 of an image.  Filtering is enabled by default for RGB and grayscale
4903 images (with and without alpha), but not for paletted images nor
4904 for any images with bit depths less than 8 bits/pixel.
4906 The 'method' parameter sets the main filtering method, which is
4907 currently only '0' in the PNG 1.2 specification.  The 'filters'
4908 parameter sets which filter(s), if any, should be used for each
4909 scanline.  Possible values are PNG_ALL_FILTERS, PNG_NO_FILTERS,
4910 or PNG_FAST_FILTERS to turn filtering on and off, or to turn on
4911 just the fast-decoding subset of filters, respectively.
4913 Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
4914 PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
4915 ORed together with '|' to specify one or more filters to use.
4916 These filters are described in more detail in the PNG specification.
4917 If you intend to change the filter type during the course of writing
4918 the image, you should start with flags set for all of the filters
4919 you intend to use so that libpng can initialize its internal
4920 structures appropriately for all of the filter types.  (Note that this
4921 means the first row must always be adaptively filtered, because libpng
4922 currently does not allocate the filter buffers until png_write_row()
4923 is called for the first time.)
4925     filters = PNG_NO_FILTERS;
4926     filters = PNG_ALL_FILTERS;
4927     filters = PNG_FAST_FILTERS;
4929     or
4931     filters = PNG_FILTER_NONE | PNG_FILTER_SUB |
4932               PNG_FILTER_UP | PNG_FILTER_AVG |
4933               PNG_FILTER_PAETH;
4935     png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
4936        filters);
4938               The second parameter can also be
4939               PNG_INTRAPIXEL_DIFFERENCING if you are
4940               writing a PNG to be embedded in a MNG
4941               datastream.  This parameter must be the
4942               same as the value of filter_method used
4943               in png_set_IHDR().
4945 .SS Requesting debug printout
4947 The macro definition PNG_DEBUG can be used to request debugging
4948 printout.  Set it to an integer value in the range 0 to 3.  Higher
4949 numbers result in increasing amounts of debugging information.  The
4950 information is printed to the "stderr" file, unless another file
4951 name is specified in the PNG_DEBUG_FILE macro definition.
4953 When PNG_DEBUG > 0, the following functions (macros) become available:
4955    png_debug(level, message)
4956    png_debug1(level, message, p1)
4957    png_debug2(level, message, p1, p2)
4959 in which "level" is compared to PNG_DEBUG to decide whether to print
4960 the message, "message" is the formatted string to be printed,
4961 and p1 and p2 are parameters that are to be embedded in the string
4962 according to printf-style formatting directives.  For example,
4964    png_debug1(2, "foo=%d", foo);
4966 is expanded to
4968    if (PNG_DEBUG > 2)
4969       fprintf(PNG_DEBUG_FILE, "foo=%d\en", foo);
4971 When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
4972 can still use PNG_DEBUG to control your own debugging:
4974    #ifdef PNG_DEBUG
4975        fprintf(stderr, ...
4976    #endif
4978 When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
4979 having level = 0 will be printed.  There aren't any such statements in
4980 this version of libpng, but if you insert some they will be printed.
4982 .SH VII.  MNG support
4984 The MNG specification (available at http://www.libpng.org/pub/mng) allows
4985 certain extensions to PNG for PNG images that are embedded in MNG datastreams.
4986 Libpng can support some of these extensions.  To enable them, use the
4987 png_permit_mng_features() function:
4989    feature_set = png_permit_mng_features(png_ptr, mask)
4991    mask is a png_uint_32 containing the bitwise OR of the
4992         features you want to enable.  These include
4993         PNG_FLAG_MNG_EMPTY_PLTE
4994         PNG_FLAG_MNG_FILTER_64
4995         PNG_ALL_MNG_FEATURES
4997    feature_set is a png_uint_32 that is the bitwise AND of
4998       your mask with the set of MNG features that is
4999       supported by the version of libpng that you are using.
5001 It is an error to use this function when reading or writing a standalone
5002 PNG file with the PNG 8-byte signature.  The PNG datastream must be wrapped
5003 in a MNG datastream.  As a minimum, it must have the MNG 8-byte signature
5004 and the MHDR and MEND chunks.  Libpng does not provide support for these
5005 or any other MNG chunks; your application must provide its own support for
5006 them.  You may wish to consider using libmng (available at
5007 http://www.libmng.com) instead.
5009 .SH VIII.  Changes to Libpng from version 0.88
5011 It should be noted that versions of libpng later than 0.96 are not
5012 distributed by the original libpng author, Guy Schalnat, nor by
5013 Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
5014 distributed versions 0.89 through 0.96, but rather by another member
5015 of the original PNG Group, Glenn Randers-Pehrson.  Guy and Andreas are
5016 still alive and well, but they have moved on to other things.
5018 The old libpng functions png_read_init(), png_write_init(),
5019 png_info_init(), png_read_destroy(), and png_write_destroy() have been
5020 moved to PNG_INTERNAL in version 0.95 to discourage their use.  These
5021 functions will be removed from libpng version 1.4.0.
5023 The preferred method of creating and initializing the libpng structures is
5024 via the png_create_read_struct(), png_create_write_struct(), and
5025 png_create_info_struct() because they isolate the size of the structures
5026 from the application, allow version error checking, and also allow the
5027 use of custom error handling routines during the initialization, which
5028 the old functions do not.  The functions png_read_destroy() and
5029 png_write_destroy() do not actually free the memory that libpng
5030 allocated for these structs, but just reset the data structures, so they
5031 can be used instead of png_destroy_read_struct() and
5032 png_destroy_write_struct() if you feel there is too much system overhead
5033 allocating and freeing the png_struct for each image read.
5035 Setting the error callbacks via png_set_message_fn() before
5036 png_read_init() as was suggested in libpng-0.88 is no longer supported
5037 because this caused applications that do not use custom error functions
5038 to fail if the png_ptr was not initialized to zero.  It is still possible
5039 to set the error callbacks AFTER png_read_init(), or to change them with
5040 png_set_error_fn(), which is essentially the same function, but with a new
5041 name to force compilation errors with applications that try to use the old
5042 method.
5044 Support for the sCAL, iCCP, iTXt, and sPLT chunks was added at libpng-1.0.6;
5045 however, iTXt support was not enabled by default.
5047 Starting with version 1.0.7, you can find out which version of the library
5048 you are using at run-time:
5050    png_uint_32 libpng_vn = png_access_version_number();
5052 The number libpng_vn is constructed from the major version, minor
5053 version with leading zero, and release number with leading zero,
5054 (e.g., libpng_vn for version 1.0.7 is 10007).
5056 Note that this function does not take a png_ptr, so you can call it
5057 before you've created one.
5059 You can also check which version of png.h you used when compiling your
5060 application:
5062    png_uint_32 application_vn = PNG_LIBPNG_VER;
5064 .SH IX.  Changes to Libpng from version 1.0.x to 1.2.x
5066 Support for user memory management was enabled by default.  To
5067 accomplish this, the functions png_create_read_struct_2(),
5068 png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
5069 png_malloc_default(), and png_free_default() were added.
5071 Support for the iTXt chunk has been enabled by default as of
5072 version 1.2.41.
5074 Support for certain MNG features was enabled.
5076 Support for numbered error messages was added.  However, we never got
5077 around to actually numbering the error messages.  The function
5078 png_set_strip_error_numbers() was added (Note: the prototype for this
5079 function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
5080 builds of libpng-1.2.15.  It was restored in libpng-1.2.36).
5082 The png_malloc_warn() function was added at libpng-1.2.3.  This issues
5083 a png_warning and returns NULL instead of aborting when it fails to
5084 acquire the requested memory allocation.
5086 Support for setting user limits on image width and height was enabled
5087 by default.  The functions png_set_user_limits(), png_get_user_width_max(),
5088 and png_get_user_height_max() were added at libpng-1.2.6.
5090 The png_set_add_alpha() function was added at libpng-1.2.7.
5092 The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
5093 Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
5094 tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
5095 deprecated.
5097 A number of macro definitions in support of runtime selection of
5098 assembler code features (especially Intel MMX code support) were
5099 added at libpng-1.2.0:
5101     PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
5102     PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
5103     PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
5104     PNG_ASM_FLAG_MMX_READ_INTERLACE
5105     PNG_ASM_FLAG_MMX_READ_FILTER_SUB
5106     PNG_ASM_FLAG_MMX_READ_FILTER_UP
5107     PNG_ASM_FLAG_MMX_READ_FILTER_AVG
5108     PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
5109     PNG_ASM_FLAGS_INITIALIZED
5110     PNG_MMX_READ_FLAGS
5111     PNG_MMX_FLAGS
5112     PNG_MMX_WRITE_FLAGS
5113     PNG_MMX_FLAGS
5115 We added the following functions in support of runtime
5116 selection of assembler code features:
5118     png_get_mmx_flagmask()
5119     png_set_mmx_thresholds()
5120     png_get_asm_flags()
5121     png_get_mmx_bitdepth_threshold()
5122     png_get_mmx_rowbytes_threshold()
5123     png_set_asm_flags()
5125 We replaced all of these functions with simple stubs in libpng-1.2.20,
5126 when the Intel assembler code was removed due to a licensing issue.
5128 These macros are deprecated:
5130     PNG_READ_TRANSFORMS_NOT_SUPPORTED
5131     PNG_PROGRESSIVE_READ_NOT_SUPPORTED
5132     PNG_NO_SEQUENTIAL_READ_SUPPORTED
5133     PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
5134     PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
5135     PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
5137 They have been replaced, respectively, by:
5139     PNG_NO_READ_TRANSFORMS
5140     PNG_NO_PROGRESSIVE_READ
5141     PNG_NO_SEQUENTIAL_READ
5142     PNG_NO_WRITE_TRANSFORMS
5143     PNG_NO_READ_ANCILLARY_CHUNKS
5144     PNG_NO_WRITE_ANCILLARY_CHUNKS
5146 PNG_MAX_UINT was replaced with PNG_UINT_31_MAX.  It has been
5147 deprecated since libpng-1.0.16 and libpng-1.2.6.
5149 The function
5150     png_check_sig(sig, num)
5151 was replaced with
5152     !png_sig_cmp(sig, 0, num)
5153 It has been deprecated since libpng-0.90.
5155 The function
5156     png_set_gray_1_2_4_to_8()
5157 which also expands tRNS to alpha was replaced with
5158     png_set_expand_gray_1_2_4_to_8()
5159 which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
5161 .SH X.  Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
5163 Private libpng prototypes and macro definitions were moved from
5164 png.h and pngconf.h into a new pngpriv.h header file.
5166 Functions png_set_benign_errors(), png_benign_error(), and
5167 png_chunk_benign_error() were added.
5169 Support for setting the maximum amount of memory that the application
5170 will allocate for reading chunks was added, as a security measure.
5171 The functions png_set_chunk_cache_max() and png_get_chunk_cache_max()
5172 were added to the library.
5174 We implemented support for I/O states by adding png_ptr member io_state
5175 and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c
5177 We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level
5178 input transforms.
5180 Checking for and reporting of errors in the IHDR chunk is more thorough.
5182 Support for global arrays was removed, to improve thread safety.
5184 Some obsolete/deprecated macros and functions have been removed.
5186 Typecasted NULL definitions such as
5187    #define png_voidp_NULL            (png_voidp)NULL
5188 were eliminated.  If you used these in your application, just use
5189 NULL instead.
5191 The png_struct and info_struct members "trans" and "trans_values" were
5192 changed to "trans_alpha" and "trans_color", respectively.
5194 The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles
5195 were removed.
5197 The PNG_1_0_X and PNG_1_2_X macros were eliminated.
5199 The PNG_LEGACY_SUPPORTED macro was eliminated.
5201 Many WIN32_WCE #ifdefs were removed.
5203 The functions png_read_init(info_ptr), png_write_init(info_ptr),
5204 png_info_init(info_ptr), png_read_destroy(), and png_write_destroy()
5205 have been removed.  They have been deprecated since libpng-0.95.
5207 The png_permit_empty_plte() was removed. It has been deprecated
5208 since libpng-1.0.9.  Use png_permit_mng_features() instead.
5210 We removed the obsolete stub functions png_get_mmx_flagmask(),
5211 png_set_mmx_thresholds(), png_get_asm_flags(),
5212 png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(),
5213 png_set_asm_flags(), and png_mmx_supported()
5215 We removed the obsolete png_check_sig(), png_memcpy_check(), and
5216 png_memset_check() functions.  Instead use !png_sig_cmp(), memcpy(),
5217 and memset(), respectively.
5219 The function png_set_gray_1_2_4_to_8() was removed. It has been
5220 deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with
5221 png_set_expand_gray_1_2_4_to_8() because the former function also
5222 expanded any tRNS chunk to an alpha channel.
5224 Macros for png_get_uint_16, png_get_uint_32, and png_get_int_32
5225 were added and are used by default instead of the corresponding
5226 functions. Unfortunately,
5227 from libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
5228 function) incorrectly returned a value of type png_uint_32.
5230 We changed the prototype for png_malloc() from
5231     png_malloc(png_structp png_ptr, png_uint_32 size)
5233     png_malloc(png_structp png_ptr, png_alloc_size_t size)
5235 This also applies to the prototype for the user replacement malloc_fn().
5237 The png_calloc() function was added and is used in place of
5238 of "png_malloc(); memset();" except in the case in png_read_png()
5239 where the array consists of pointers; in this case a "for" loop is used
5240 after the png_malloc() to set the pointers to NULL, to give robust.
5241 behavior in case the application runs out of memory part-way through
5242 the process.
5244 We changed the prototypes of png_get_compression_buffer_size() and
5245 png_set_compression_buffer_size() to work with png_size_t instead of
5246 png_uint_32.
5248 Support for numbered error messages was removed by default, since we
5249 never got around to actually numbering the error messages. The function
5250 png_set_strip_error_numbers() was removed from the library by default.
5252 The png_zalloc() and png_zfree() functions are no longer exported.
5253 The png_zalloc() function no longer zeroes out the memory that it
5254 allocates.  Applications that called png_zalloc(png_ptr, number, size)
5255 can call png_calloc(png_ptr, number*size) instead, and can call
5256 png_free() instead of png_zfree().
5258 Support for dithering was disabled by default in libpng-1.4.0, because
5259 it has not been well tested and doesn't actually "dither".
5260 The code was not
5261 removed, however, and could be enabled by building libpng with
5262 PNG_READ_DITHER_SUPPORTED defined.  In libpng-1.4.2, this support
5263 was re-enabled, but the function was renamed png_set_quantize() to
5264 reflect more accurately what it actually does.  At the same time,
5265 the PNG_DITHER_[RED,GREEN_BLUE]_BITS macros were also renamed to
5266 PNG_QUANTIZE_[RED,GREEN,BLUE]_BITS, and PNG_READ_DITHER_SUPPORTED
5267 was renamed to PNG_READ_QUANTIZE_SUPPORTED.
5269 We removed the trailing '.' from the warning and error messages.
5271 .SH XI.  Changes to Libpng from version 1.4.x to 1.5.x
5273 From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
5274 function) incorrectly returned a value of type png_uint_32.
5275 The incorrect macro was removed from libpng-1.4.5.
5277 Checking for invalid palette index on write was added at libpng
5278 1.5.10.  If a pixel contains an invalid (out-of-range) index libpng issues
5279 a benign error.  This is enabled by default because this condition is an
5280 error according to the PNG specification, Clause 11.3.2, but the error can
5281 be ignored in each png_ptr with
5283    png_set_check_for_invalid_index(png_ptr, allowed);
5285       allowed  - one of
5286                  0: disable benign error (accept the
5287                     invalid data without warning).
5288                  1: enable benign error (treat the
5289                     invalid data as an error or a
5290                     warning).
5292 If the error is ignored, or if png_benign_error() treats it as a warning,
5293 any invalid pixels are decoded as opaque black by the decoder and written
5294 as-is by the encoder.
5296 Retrieving the maximum palette index found was added at libpng-1.5.15.
5297 This statement must appear after png_read_png() or png_read_image() while
5298 reading, and after png_write_png() or png_write_image() while writing.
5300    int max_palette = png_get_palette_max(png_ptr, info_ptr);
5302 This will return the maximum palette index found in the image, or "\-1" if
5303 the palette was not checked, or "0" if no palette was found.  Note that this
5304 does not account for any palette index used by ancillary chunks such as the
5305 bKGD chunk; you must check those separately to determine the maximum
5306 palette index actually used.
5308 There are no substantial API changes between the non-deprecated parts of
5309 the 1.4.5 API and the 1.5.0 API; however, the ability to directly access
5310 members of the main libpng control structures, png_struct and png_info,
5311 deprecated in earlier versions of libpng, has been completely removed from
5312 libpng 1.5, and new private "pngstruct.h", "pnginfo.h", and "pngdebug.h"
5313 header files were created.
5315 We no longer include zlib.h in png.h.  The include statement has been moved
5316 to pngstruct.h, where it is not accessible by applications. Applications that
5317 need access to information in zlib.h will need to add the '#include "zlib.h"'
5318 directive.  It does not matter whether this is placed prior to or after
5319 the '"#include png.h"' directive.
5321 The png_sprintf(), png_strcpy(), and png_strncpy() macros are no longer used
5322 and were removed.
5324 We moved the png_strlen(), png_memcpy(), png_memset(), and png_memcmp()
5325 macros into a private header file (pngpriv.h) that is not accessible to
5326 applications.
5328 In png_get_iCCP, the type of "profile" was changed from png_charpp
5329 to png_bytepp, and in png_set_iCCP, from png_charp to png_const_bytep.
5331 There are changes of form in png.h, including new and changed macros to
5332 declare parts of the API.  Some API functions with arguments that are
5333 pointers to data not modified within the function have been corrected to
5334 declare these arguments with PNG_CONST.
5336 Much of the internal use of C macros to control the library build has also
5337 changed and some of this is visible in the exported header files, in
5338 particular the use of macros to control data and API elements visible
5339 during application compilation may require significant revision to
5340 application code.  (It is extremely rare for an application to do this.)
5342 Any program that compiled against libpng 1.4 and did not use deprecated
5343 features or access internal library structures should compile and work
5344 against libpng 1.5, except for the change in the prototype for
5345 png_get_iCCP() and png_set_iCCP() API functions mentioned above.
5347 libpng 1.5.0 adds PNG_ PASS macros to help in the reading and writing of
5348 interlaced images.  The macros return the number of rows and columns in
5349 each pass and information that can be used to de-interlace and (if
5350 absolutely necessary) interlace an image.
5352 libpng 1.5.0 adds an API png_longjmp(png_ptr, value).  This API calls
5353 the application-provided png_longjmp_ptr on the internal, but application
5354 initialized, longjmp buffer.  It is provided as a convenience to avoid
5355 the need to use the png_jmpbuf macro, which had the unnecessary side
5356 effect of resetting the internal png_longjmp_ptr value.
5358 libpng 1.5.0 includes a complete fixed point API.  By default this is
5359 present along with the corresponding floating point API.  In general the
5360 fixed point API is faster and smaller than the floating point one because
5361 the PNG file format used fixed point, not floating point.  This applies
5362 even if the library uses floating point in internal calculations.  A new
5363 macro, PNG_FLOATING_ARITHMETIC_SUPPORTED, reveals whether the library
5364 uses floating point arithmetic (the default) or fixed point arithmetic
5365 internally for performance critical calculations such as gamma correction.
5366 In some cases, the gamma calculations may produce slightly different
5367 results.  This has changed the results in png_rgb_to_gray and in alpha
5368 composition (png_set_background for example). This applies even if the
5369 original image was already linear (gamma == 1.0) and, therefore, it is
5370 not necessary to linearize the image.  This is because libpng has *not*
5371 been changed to optimize that case correctly, yet.
5373 Fixed point support for the sCAL chunk comes with an important caveat;
5374 the sCAL specification uses a decimal encoding of floating point values
5375 and the accuracy of PNG fixed point values is insufficient for
5376 representation of these values. Consequently a "string" API
5377 (png_get_sCAL_s and png_set_sCAL_s) is the only reliable way of reading
5378 arbitrary sCAL chunks in the absence of either the floating point API or
5379 internal floating point calculations.  Starting with libpng-1.5.0, both
5380 of these functions are present when PNG_sCAL_SUPPORTED is defined.  Prior
5381 to libpng-1.5.0, their presence also depended upon PNG_FIXED_POINT_SUPPORTED
5382 being defined and PNG_FLOATING_POINT_SUPPORTED not being defined.
5384 Applications no longer need to include the optional distribution header
5385 file pngusr.h or define the corresponding macros during application
5386 build in order to see the correct variant of the libpng API.  From 1.5.0
5387 application code can check for the corresponding _SUPPORTED macro:
5389 #ifdef PNG_INCH_CONVERSIONS_SUPPORTED
5390    /* code that uses the inch conversion APIs. */
5391 #endif
5393 This macro will only be defined if the inch conversion functions have been
5394 compiled into libpng.  The full set of macros, and whether or not support
5395 has been compiled in, are available in the header file pnglibconf.h.
5396 This header file is specific to the libpng build.  Notice that prior to
5397 1.5.0 the _SUPPORTED macros would always have the default definition unless
5398 reset by pngusr.h or by explicit settings on the compiler command line.
5399 These settings may produce compiler warnings or errors in 1.5.0 because
5400 of macro redefinition.
5402 Applications can now choose whether to use these macros or to call the
5403 corresponding function by defining PNG_USE_READ_MACROS or
5404 PNG_NO_USE_READ_MACROS before including png.h.  Notice that this is
5405 only supported from 1.5.0; defining PNG_NO_USE_READ_MACROS prior to 1.5.0
5406 will lead to a link failure.
5408 Prior to libpng-1.5.4, the zlib compressor used the same set of parameters
5409 when compressing the IDAT data and textual data such as zTXt and iCCP.
5410 In libpng-1.5.4 we reinitialized the zlib stream for each type of data.
5411 We added five png_set_text_*() functions for setting the parameters to
5412 use with textual data.
5414 Prior to libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
5415 option was off by default, and slightly inaccurate scaling occurred.
5416 This option can no longer be turned off, and the choice of accurate
5417 or inaccurate 16-to-8 scaling is by using the new png_set_scale_16_to_8()
5418 API for accurate scaling or the old png_set_strip_16_to_8() API for simple
5419 chopping.  In libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
5420 macro became PNG_READ_SCALE_16_TO_8_SUPPORTED, and the PNG_READ_16_TO_8
5421 macro became PNG_READ_STRIP_16_TO_8_SUPPORTED, to enable the two
5422 png_set_*_16_to_8() functions separately.
5424 Prior to libpng-1.5.4, the png_set_user_limits() function could only be
5425 used to reduce the width and height limits from the value of
5426 PNG_USER_WIDTH_MAX and PNG_USER_HEIGHT_MAX, although this document said
5427 that it could be used to override them.  Now this function will reduce or
5428 increase the limits.
5430 Starting in libpng-1.5.10, the user limits can be set en masse with the
5431 configuration option PNG_SAFE_LIMITS_SUPPORTED.  If this option is enabled,
5432 a set of "safe" limits is applied in pngpriv.h.  These can be overridden by
5433 application calls to png_set_user_limits(), png_set_user_chunk_cache_max(),
5434 and/or png_set_user_malloc_max() that increase or decrease the limits.  Also,
5435 in libpng-1.5.10 the default width and height limits were increased
5436 from 1,000,000 to 0x7fffffff (i.e., made unlimited).  Therefore, the
5437 limits are now
5438                                default      safe
5439    png_user_width_max        0x7fffffff    1,000,000
5440    png_user_height_max       0x7fffffff    1,000,000
5441    png_user_chunk_cache_max  0 (unlimited)   128
5442    png_user_chunk_malloc_max 0 (unlimited) 8,000,000
5444 The png_set_option() function (and the "options" member of the png struct) was
5445 added to libpng-1.5.15, with option PNG_ARM_NEON.
5447 The library now supports a complete fixed point implementation and can
5448 thus be used on systems that have no floating point support or very
5449 limited or slow support.  Previously gamma correction, an essential part
5450 of complete PNG support, required reasonably fast floating point.
5452 As part of this the choice of internal implementation has been made
5453 independent of the choice of fixed versus floating point APIs and all the
5454 missing fixed point APIs have been implemented.
5456 The exact mechanism used to control attributes of API functions has
5457 changed, as described in the INSTALL file.
5459 A new test program, pngvalid, is provided in addition to pngtest.
5460 pngvalid validates the arithmetic accuracy of the gamma correction
5461 calculations and includes a number of validations of the file format.
5462 A subset of the full range of tests is run when "make check" is done
5463 (in the 'configure' build.)  pngvalid also allows total allocated memory
5464 usage to be evaluated and performs additional memory overwrite validation.
5466 Many changes to individual feature macros have been made. The following
5467 are the changes most likely to be noticed by library builders who
5468 configure libpng:
5470 1) All feature macros now have consistent naming:
5472 #define PNG_NO_feature turns the feature off
5473 #define PNG_feature_SUPPORTED turns the feature on
5475 pnglibconf.h contains one line for each feature macro which is either:
5477 #define PNG_feature_SUPPORTED
5479 if the feature is supported or:
5481 /*#undef PNG_feature_SUPPORTED*/
5483 if it is not.  Library code consistently checks for the 'SUPPORTED' macro.
5484 It does not, and libpng applications should not, check for the 'NO' macro
5485 which will not normally be defined even if the feature is not supported.
5486 The 'NO' macros are only used internally for setting or not setting the
5487 corresponding 'SUPPORTED' macros.
5489 Compatibility with the old names is provided as follows:
5491 PNG_INCH_CONVERSIONS turns on PNG_INCH_CONVERSIONS_SUPPORTED
5493 And the following definitions disable the corresponding feature:
5495 PNG_SETJMP_NOT_SUPPORTED disables SETJMP
5496 PNG_READ_TRANSFORMS_NOT_SUPPORTED disables READ_TRANSFORMS
5497 PNG_NO_READ_COMPOSITED_NODIV disables READ_COMPOSITE_NODIV
5498 PNG_WRITE_TRANSFORMS_NOT_SUPPORTED disables WRITE_TRANSFORMS
5499 PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED disables READ_ANCILLARY_CHUNKS
5500 PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED disables WRITE_ANCILLARY_CHUNKS
5502 Library builders should remove use of the above, inconsistent, names.
5504 2) Warning and error message formatting was previously conditional on
5505 the STDIO feature. The library has been changed to use the
5506 CONSOLE_IO feature instead. This means that if CONSOLE_IO is disabled
5507 the library no longer uses the printf(3) functions, even though the
5508 default read/write implementations use (FILE) style stdio.h functions.
5510 3) Three feature macros now control the fixed/floating point decisions:
5512 PNG_FLOATING_POINT_SUPPORTED enables the floating point APIs
5514 PNG_FIXED_POINT_SUPPORTED enables the fixed point APIs; however, in
5515 practice these are normally required internally anyway (because the PNG
5516 file format is fixed point), therefore in most cases PNG_NO_FIXED_POINT
5517 merely stops the function from being exported.
5519 PNG_FLOATING_ARITHMETIC_SUPPORTED chooses between the internal floating
5520 point implementation or the fixed point one.  Typically the fixed point
5521 implementation is larger and slower than the floating point implementation
5522 on a system that supports floating point; however, it may be faster on a
5523 system which lacks floating point hardware and therefore uses a software
5524 emulation.
5526 4) Added PNG_{READ,WRITE}_INT_FUNCTIONS_SUPPORTED.  This allows the
5527 functions to read and write ints to be disabled independently of
5528 PNG_USE_READ_MACROS, which allows libpng to be built with the functions
5529 even though the default is to use the macros - this allows applications
5530 to choose at app buildtime whether or not to use macros (previously
5531 impossible because the functions weren't in the default build.)
5533 .SH XII.  Changes to Libpng from version 1.5.x to 1.6.x
5535 A "simplified API" has been added (see documentation in png.h and a simple
5536 example in contrib/examples/pngtopng.c).  The new publicly visible API
5537 includes the following:
5539    macros:
5540      PNG_FORMAT_*
5541      PNG_IMAGE_*
5542    structures:
5543      png_control
5544      png_image
5545    read functions
5546      png_image_begin_read_from_file()
5547      png_image_begin_read_from_stdio()
5548      png_image_begin_read_from_memory()
5549      png_image_finish_read()
5550      png_image_free()
5551    write functions
5552      png_image_write_to_file()
5553      png_image_write_to_memory()
5554      png_image_write_to_stdio()
5556 Starting with libpng-1.6.0, you can configure libpng to prefix all exported
5557 symbols, using the PNG_PREFIX macro.
5559 We no longer include string.h in png.h.  The include statement has been moved
5560 to pngpriv.h, where it is not accessible by applications.  Applications that
5561 need access to information in string.h must add an '#include <string.h>'
5562 directive.  It does not matter whether this is placed prior to or after
5563 the '#include "png.h"' directive.
5565 The following API are now DEPRECATED:
5566    png_info_init_3()
5567    png_convert_to_rfc1123() which has been replaced
5568      with png_convert_to_rfc1123_buffer()
5569    png_malloc_default()
5570    png_free_default()
5571    png_reset_zstream()
5573 The following have been removed:
5574    png_get_io_chunk_name(), which has been replaced
5575      with png_get_io_chunk_type().  The new
5576      function returns a 32-bit integer instead of
5577      a string.
5578    The png_sizeof(), png_strlen(), png_memcpy(), png_memcmp(), and
5579      png_memset() macros are no longer used in the libpng sources and
5580      have been removed.  These had already been made invisible to applications
5581      (i.e., defined in the private pngpriv.h header file) since libpng-1.5.0.
5583 The signatures of many exported functions were changed, such that
5584    png_structp became png_structrp or png_const_structrp
5585    png_infop became png_inforp or png_const_inforp
5586 where "rp" indicates a "restricted pointer".
5588 Dropped support for 16-bit platforms. The support for FAR/far types has
5589 been eliminated and the definition of png_alloc_size_t is now controlled
5590 by a flag so that 'small size_t' systems can select it if necessary.
5592 Error detection in some chunks has improved; in particular the iCCP chunk
5593 reader now does pretty complete validation of the basic format.  Some bad
5594 profiles that were previously accepted are now accepted with a warning or
5595 rejected, depending upon the png_set_benign_errors() setting, in particular
5596 the very old broken Microsoft/HP 3144-byte sRGB profile.  Starting with
5597 libpng-1.6.11, recognizing and checking sRGB profiles can be avoided by
5598 means of
5600     #if defined(PNG_SKIP_sRGB_CHECK_PROFILE) && \
5601         defined(PNG_SET_OPTION_SUPPORTED)
5602        png_set_option(png_ptr, PNG_SKIP_sRGB_CHECK_PROFILE,
5603            PNG_OPTION_ON);
5604     #endif
5606 It's not a good idea to do this if you are using the "simplified API",
5607 which needs to be able to recognize sRGB profiles conveyed via the iCCP
5608 chunk.
5610 The PNG spec requirement that only grayscale profiles may appear in images
5611 with color type 0 or 4 and that even if the image only contains gray pixels,
5612 only RGB profiles may appear in images with color type 2, 3, or 6, is now
5613 enforced.  The sRGB chunk is allowed to appear in images with any color type
5614 and is interpreted by libpng to convey a one-tracer-curve gray profile or a
5615 three-tracer-curve RGB profile as appropriate.
5617 Libpng 1.5.x erroneously used /MD for Debug DLL builds; if you used the debug
5618 builds in your app and you changed your app to use /MD you will need to
5619 change it back to /MDd for libpng 1.6.x.
5621 Prior to libpng-1.6.0 a warning would be issued if the iTXt chunk contained
5622 an empty language field or an empty translated keyword.  Both of these
5623 are allowed by the PNG specification, so these warnings are no longer issued.
5625 The library now issues an error if the application attempts to set a
5626 transform after it calls png_read_update_info() or if it attempts to call
5627 both png_read_update_info() and png_start_read_image() or to call either
5628 of them more than once.
5630 The default condition for benign_errors is now to treat benign errors as
5631 warnings while reading and as errors while writing.
5633 The library now issues a warning if both background processing and RGB to
5634 gray are used when gamma correction happens. As with previous versions of
5635 the library the results are numerically very incorrect in this case.
5637 There are some minor arithmetic changes in some transforms such as
5638 png_set_background(), that might be detected by certain regression tests.
5640 Unknown chunk handling has been improved internally, without any API change.
5641 This adds more correct option control of the unknown handling, corrects
5642 a pre-existing bug where the per-chunk 'keep' setting is ignored, and makes
5643 it possible to skip IDAT chunks in the sequential reader.
5645 The machine-generated configure files are no longer included in branches
5646 libpng16 and later of the GIT repository.  They continue to be included
5647 in the tarball releases, however.
5649 Libpng-1.6.0 through 1.6.2 used the CMF bytes at the beginning of the IDAT
5650 stream to set the size of the sliding window for reading instead of using the
5651 default 32-kbyte sliding window size.  It was discovered that there are
5652 hundreds of PNG files in the wild that have incorrect CMF bytes that caused
5653 zlib to issue the "invalid distance too far back" error and reject the file.
5654 Libpng-1.6.3 and later calculate their own safe CMF from the image dimensions,
5655 provide a way to revert to the libpng-1.5.x behavior (ignoring the CMF bytes
5656 and using a 32-kbyte sliding window), by using
5658     png_set_option(png_ptr, PNG_MAXIMUM_INFLATE_WINDOW,
5659         PNG_OPTION_ON);
5661 and provide a tool (contrib/tools/pngfix) for rewriting a PNG file while
5662 optimizing the CMF bytes in its IDAT chunk correctly.
5664 Libpng-1.6.0 and libpng-1.6.1 wrote uncompressed iTXt chunks with the wrong
5665 length, which resulted in PNG files that cannot be read beyond the bad iTXt
5666 chunk.  This error was fixed in libpng-1.6.3, and a tool (called
5667 contrib/tools/png-fix-itxt) has been added to the libpng distribution.
5669 Starting with libpng-1.6.17, the PNG_SAFE_LIMITS macro was eliminated
5670 and safe limits are used by default (users who need larger limits
5671 can still override them at compile time or run time, as described above).
5673 The new limits are
5674                                 default   spec limit
5675    png_user_width_max         1,000,000  2,147,483,647
5676    png_user_height_max        1,000,000  2,147,483,647
5677    png_user_chunk_cache_max         128  unlimited
5678    png_user_chunk_malloc_max  8,000,000  unlimited
5680 Starting with libpng-1.6.18, a PNG_RELEASE_BUILD macro was added, which allows
5681 library builders to control compilation for an installed system (a release build).
5682 It can be set for testing debug or beta builds to ensure that they will compile
5683 when the build type is switched to RC or STABLE. In essence this overrides the
5684 PNG_LIBPNG_BUILD_BASE_TYPE definition which is not directly user controllable.
5686 Starting with libpng-1.6.19, attempting to set an over-length PLTE chunk
5687 is an error. Previously this requirement of the PNG specification was not
5688 enforced, and the palette was always limited to 256 entries. An over-length
5689 PLTE chunk found in an input PNG is silently truncated.
5691 .SH XIII.  Detecting libpng
5693 The png_get_io_ptr() function has been present since libpng-0.88, has never
5694 changed, and is unaffected by conditional compilation macros.  It is the
5695 best choice for use in configure scripts for detecting the presence of any
5696 libpng version since 0.88.  In an autoconf "configure.in" you could use
5698     AC_CHECK_LIB(png, png_get_io_ptr, ...
5700 .SH XV. Source code repository
5702 Since about February 2009, version 1.2.34, libpng has been under "git" source
5703 control.  The git repository was built from old libpng-x.y.z.tar.gz files
5704 going back to version 0.70.  You can access the git repository (read only)
5707     git://git.code.sf.net/p/libpng/code
5709 or you can browse it with a web browser by selecting the "code" button at
5711     https://sourceforge.net/projects/libpng
5713 Patches can be sent to glennrp at users.sourceforge.net or to
5714 png-mng-implement at lists.sourceforge.net or you can upload them to
5715 the libpng bug tracker at
5717     http://libpng.sourceforge.net
5719 We also accept patches built from the tar or zip distributions, and
5720 simple verbal discriptions of bug fixes, reported either to the
5721 SourceForge bug tracker, to the png-mng-implement at lists.sf.net
5722 mailing list, or directly to glennrp.
5724 .SH XV. Coding style
5726 Our coding style is similar to the "Allman" style
5727 (See http://en.wikipedia.org/wiki/Indent_style#Allman_style), with curly
5728 braces on separate lines:
5730     if (condition)
5731     {
5732        action;
5733     }
5735     else if (another condition)
5736     {
5737        another action;
5738     }
5740 The braces can be omitted from simple one-line actions:
5742     if (condition)
5743        return (0);
5745 We use 3-space indentation, except for continued statements which
5746 are usually indented the same as the first line of the statement
5747 plus four more spaces.
5749 For macro definitions we use 2-space indentation, always leaving the "#"
5750 in the first column.
5752     #ifndef PNG_NO_FEATURE
5753     #  ifndef PNG_FEATURE_SUPPORTED
5754     #    define PNG_FEATURE_SUPPORTED
5755     #  endif
5756     #endif
5758 Comments appear with the leading "/*" at the same indentation as
5759 the statement that follows the comment:
5761     /* Single-line comment */
5762     statement;
5764     /* This is a multiple-line
5765      * comment.
5766      */
5767     statement;
5769 Very short comments can be placed after the end of the statement
5770 to which they pertain:
5772     statement;    /* comment */
5774 We don't use C++ style ("//") comments. We have, however,
5775 used them in the past in some now-abandoned MMX assembler
5776 code.
5778 Functions and their curly braces are not indented, and
5779 exported functions are marked with PNGAPI:
5781  /* This is a public function that is visible to
5782   * application programmers. It does thus-and-so.
5783   */
5784  void PNGAPI
5785  png_exported_function(png_ptr, png_info, foo)
5787     body;
5790 The return type and decorations are placed on a separate line
5791 ahead of the function name, as illustrated above.
5793 The prototypes for all exported functions appear in png.h,
5794 above the comment that says
5796     /* Maintainer: Put new public prototypes here ... */
5798 We mark all non-exported functions with "/* PRIVATE */"":
5800  void /* PRIVATE */
5801  png_non_exported_function(png_ptr, png_info, foo)
5803     body;
5806 The prototypes for non-exported functions (except for those in
5807 pngtest) appear in pngpriv.h above the comment that says
5809   /* Maintainer: Put new private prototypes here ^ */
5811 To avoid polluting the global namespace, the names of all exported
5812 functions and variables begin with "png_", and all publicly visible C
5813 preprocessor macros begin with "PNG".  We request that applications that
5814 use libpng *not* begin any of their own symbols with either of these strings.
5816 We put a space after the "sizeof" operator and we omit the
5817 optional parentheses around its argument when the argument
5818 is an expression, not a type name, and we always enclose the
5819 sizeof operator, with its argument, in parentheses:
5821   (sizeof (png_uint_32))
5822   (sizeof array)
5824 Prior to libpng-1.6.0 we used a "png_sizeof()" macro, formatted as
5825 though it were a function.
5827 Control keywords if, for, while, and switch are always followed by a space
5828 to distinguish them from function calls, which have no trailing space. 
5830 We put a space after each comma and after each semicolon
5831 in "for" statements, and we put spaces before and after each
5832 C binary operator and after "for" or "while", and before
5833 "?".  We don't put a space between a typecast and the expression
5834 being cast, nor do we put one between a function name and the
5835 left parenthesis that follows it:
5837     for (i = 2; i > 0; \-\-i)
5838        y[i] = a(x) + (int)b;
5840 We prefer #ifdef and #ifndef to #if defined() and #if !defined()
5841 when there is only one macro being tested.  We always use parentheses
5842 with "defined".
5844 We express integer constants that are used as bit masks in hex format,
5845 with an even number of lower-case hex digits, and to make them unsigned
5846 (e.g., 0x00U, 0xffU, 0x0100U) and long if they are greater than 0x7fff
5847 (e.g., 0xffffUL).
5849 We prefer to use underscores rather than camelCase in names, except
5850 for a few type names that we inherit from zlib.h.
5852 We prefer "if (something != 0)" and "if (something == 0)" over
5853 "if (something)" and if "(!something)", respectively, and for pointers
5854 we prefer "if (some_pointer != NULL)" or "if (some_pointer == NULL)". 
5856 We do not use the TAB character for indentation in the C sources.
5858 Lines do not exceed 80 characters.
5860 Other rules can be inferred by inspecting the libpng source.
5862 .SH XVI. Y2K Compliance in libpng
5864 Since the PNG Development group is an ad-hoc body, we can't make
5865 an official declaration.
5867 This is your unofficial assurance that libpng from version 0.71 and
5868 upward through 1.6.28 are Y2K compliant.  It is my belief that earlier
5869 versions were also Y2K compliant.
5871 Libpng only has two year fields.  One is a 2-byte unsigned integer
5872 that will hold years up to 65535.  The other, which is deprecated,
5873 holds the date in text format, and will hold years up to 9999.
5875 The integer is
5876     "png_uint_16 year" in png_time_struct.
5878 The string is
5879     "char time_buffer[29]" in png_struct.  This is no longer used
5880 in libpng-1.6.x and will be removed from libpng-1.7.0.
5882 There are seven time-related functions:
5884     png_convert_to_rfc_1123_buffer() in png.c
5885       (formerly png_convert_to_rfc_1152() in error, and
5886       also formerly png_convert_to_rfc_1123())
5887     png_convert_from_struct_tm() in pngwrite.c, called
5888       in pngwrite.c
5889     png_convert_from_time_t() in pngwrite.c
5890     png_get_tIME() in pngget.c
5891     png_handle_tIME() in pngrutil.c, called in pngread.c
5892     png_set_tIME() in pngset.c
5893     png_write_tIME() in pngwutil.c, called in pngwrite.c
5895 All appear to handle dates properly in a Y2K environment.  The
5896 png_convert_from_time_t() function calls gmtime() to convert from system
5897 clock time, which returns (year - 1900), which we properly convert to
5898 the full 4-digit year.  There is a possibility that applications using
5899 libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
5900 function, or that they are incorrectly passing only a 2-digit year
5901 instead of "year - 1900" into the png_convert_from_struct_tm() function,
5902 but this is not under our control.  The libpng documentation has always
5903 stated that it works with 4-digit years, and the APIs have been
5904 documented as such.
5906 The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
5907 integer to hold the year, and can hold years as large as 65535.
5909 zlib, upon which libpng depends, is also Y2K compliant.  It contains
5910 no date-related code.
5913    Glenn Randers-Pehrson
5914    libpng maintainer
5915    PNG Development Group
5917 .SH NOTE
5919 Note about libpng version numbers:
5921 Due to various miscommunications, unforeseen code incompatibilities
5922 and occasional factors outside the authors' control, version numbering
5923 on the library has not always been consistent and straightforward.
5924 The following table summarizes matters since version 0.89c, which was
5925 the first widely used release:
5927  source             png.h  png.h  shared-lib
5928  version            string   int  version
5929  -------            ------  ----- ----------
5930  0.89c "1.0 beta 3"     0.89      89  1.0.89
5931  0.90  "1.0 beta 4"     0.90      90  0.90  [should have been 2.0.90]
5932  0.95  "1.0 beta 5"     0.95      95  0.95  [should have been 2.0.95]
5933  0.96  "1.0 beta 6"     0.96      96  0.96  [should have been 2.0.96]
5934  0.97b "1.00.97 beta 7" 1.00.97   97  1.0.1 [should have been 2.0.97]
5935  0.97c                  0.97      97  2.0.97
5936  0.98                   0.98      98  2.0.98
5937  0.99                   0.99      98  2.0.99
5938  0.99a-m                0.99      99  2.0.99
5939  1.00                   1.00     100  2.1.0 [100 should be 10000]
5940  1.0.0      (from here on, the   100  2.1.0 [100 should be 10000]
5941  1.0.1       png.h string is   10001  2.1.0
5942  1.0.1a-e    identical to the  10002  from here on, the shared library
5943  1.0.2       source version)   10002  is 2.V where V is the source code
5944  1.0.2a-b                      10003  version, except as noted.
5945  1.0.3                         10003
5946  1.0.3a-d                      10004
5947  1.0.4                         10004
5948  1.0.4a-f                      10005
5949  1.0.5 (+ 2 patches)           10005
5950  1.0.5a-d                      10006
5951  1.0.5e-r                      10100 (not source compatible)
5952  1.0.5s-v                      10006 (not binary compatible)
5953  1.0.6 (+ 3 patches)           10006 (still binary incompatible)
5954  1.0.6d-f                      10007 (still binary incompatible)
5955  1.0.6g                        10007
5956  1.0.6h                        10007  10.6h (testing xy.z so-numbering)
5957  1.0.6i                        10007  10.6i
5958  1.0.6j                        10007  2.1.0.6j (incompatible with 1.0.0)
5959  1.0.7beta11-14        DLLNUM  10007  2.1.0.7beta11-14 (binary compatible)
5960  1.0.7beta15-18           1    10007  2.1.0.7beta15-18 (binary compatible)
5961  1.0.7rc1-2               1    10007  2.1.0.7rc1-2 (binary compatible)
5962  1.0.7                    1    10007  (still compatible)
5963  ...
5964  1.0.19                  10    10019  10.so.0.19[.0]
5965  ...
5966  1.2.57                  13    10257  12.so.0.56[.0]
5967  ...
5968  1.5.28                  15    10528  15.so.15.28[.0]
5969  ...
5970  1.6.28                  16    10628  16.so.16.28[.0]
5972 Henceforth the source version will match the shared-library minor
5973 and patch numbers; the shared-library major version number will be
5974 used for changes in backward compatibility, as it is intended.  The
5975 PNG_PNGLIB_VER macro, which is not used within libpng but is available
5976 for applications, is an unsigned integer of the form xyyzz corresponding
5977 to the source version x.y.z (leading zeros in y and z).  Beta versions
5978 were given the previous public release number plus a letter, until
5979 version 1.0.6j; from then on they were given the upcoming public
5980 release number plus "betaNN" or "rcNN".
5982 .SH "SEE ALSO"
5983 .IR libpngpf(3) ", " png(5)
5985 .IR libpng :
5987 http://libpng.sourceforge.net (follow the [DOWNLOAD] link)
5988 http://www.libpng.org/pub/png
5991 .IR zlib :
5993 (generally) at the same location as
5994 .I libpng
5995 or at
5997 ftp://ftp.info-zip.org/pub/infozip/zlib
6000 .IR PNG specification: RFC 2083
6002 (generally) at the same location as
6003 .I libpng
6004 or at
6006 ftp://ftp.rfc-editor.org:/in-notes/rfc2083.txt
6008 or (as a W3C Recommendation) at
6010 http://www.w3.org/TR/REC-png.html
6013 In the case of any inconsistency between the PNG specification
6014 and this library, the specification takes precedence.
6016 .SH AUTHORS
6017 This man page: Glenn Randers-Pehrson
6018 <glennrp at users.sourceforge.net>
6020 The contributing authors would like to thank all those who helped
6021 with testing, bug fixes, and patience.  This wouldn't have been
6022 possible without all of you.
6024 Thanks to Frank J. T. Wojcik for helping with the documentation.
6026 Libpng version 1.6.28 - January 5, 2017:
6027 Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
6028 Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
6030 Supported by the PNG development group
6032 png-mng-implement at lists.sf.net
6033 (subscription required; visit
6034 png-mng-implement at lists.sourceforge.net (subscription required; visit
6035 https://lists.sourceforge.net/lists/listinfo/png-mng-implement
6036 to subscribe).
6038 .SH NOTICES:
6040 This copy of the libpng notices is provided for your convenience.  In case of
6041 any discrepancy between this copy and the notices in the file png.h that is
6042 included in the libpng distribution, the latter shall prevail.
6044 COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
6046 If you modify libpng you may insert additional notices immediately following
6047 this sentence.
6049 This code is released under the libpng license.
6051 libpng versions 1.0.7, July 1, 2000 through 1.6.28, January 5, 2017 are
6052 Copyright (c) 2000-2002, 2004, 2006-2017 Glenn Randers-Pehrson, are
6053 derived from libpng-1.0.6, and are distributed according to the same
6054 disclaimer and license as libpng-1.0.6 with the following individuals
6055 added to the list of Contributing Authors:
6057    Simon-Pierre Cadieux
6058    Eric S. Raymond
6059    Mans Rullgard
6060    Cosmin Truta
6061    Gilles Vollant
6062    James Yu
6063    Mandar Sahastrabuddhe
6065 and with the following additions to the disclaimer:
6067    There is no warranty against interference with your enjoyment of the
6068    library or against infringement.  There is no warranty that our
6069    efforts or the library will fulfill any of your particular purposes
6070    or needs.  This library is provided with all faults, and the entire
6071    risk of satisfactory quality, performance, accuracy, and effort is with
6072    the user.
6074 Some files in the "contrib" directory and some configure-generated
6075 files that are distributed with libpng have other copyright owners and
6076 are released under other open source licenses.
6078 libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
6079 Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from
6080 libpng-0.96, and are distributed according to the same disclaimer and
6081 license as libpng-0.96, with the following individuals added to the list
6082 of Contributing Authors:
6084    Tom Lane
6085    Glenn Randers-Pehrson
6086    Willem van Schaik
6088 libpng versions 0.89, June 1996, through 0.96, May 1997, are
6089 Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,
6090 and are distributed according to the same disclaimer and license as
6091 libpng-0.88, with the following individuals added to the list of
6092 Contributing Authors:
6094    John Bowler
6095    Kevin Bracey
6096    Sam Bushell
6097    Magnus Holmgren
6098    Greg Roelofs
6099    Tom Tanner
6101 Some files in the "scripts" directory have other copyright owners
6102 but are released under this license.
6104 libpng versions 0.5, May 1995, through 0.88, January 1996, are
6105 Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
6107 For the purposes of this copyright and license, "Contributing Authors"
6108 is defined as the following set of individuals:
6110    Andreas Dilger
6111    Dave Martindale
6112    Guy Eric Schalnat
6113    Paul Schmidt
6114    Tim Wegner
6116 The PNG Reference Library is supplied "AS IS".  The Contributing Authors
6117 and Group 42, Inc. disclaim all warranties, expressed or implied,
6118 including, without limitation, the warranties of merchantability and of
6119 fitness for any purpose.  The Contributing Authors and Group 42, Inc.
6120 assume no liability for direct, indirect, incidental, special, exemplary,
6121 or consequential damages, which may result from the use of the PNG
6122 Reference Library, even if advised of the possibility of such damage.
6124 Permission is hereby granted to use, copy, modify, and distribute this
6125 source code, or portions hereof, for any purpose, without fee, subject
6126 to the following restrictions:
6128   1. The origin of this source code must not be misrepresented.
6130   2. Altered versions must be plainly marked as such and must not
6131      be misrepresented as being the original source.
6133   3. This Copyright notice may not be removed or altered from any
6134      source or altered source distribution.
6136 The Contributing Authors and Group 42, Inc. specifically permit, without
6137 fee, and encourage the use of this source code as a component to
6138 supporting the PNG file format in commercial products.  If you use this
6139 source code in a product, acknowledgment is not required but would be
6140 appreciated.
6142 END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.
6144 TRADEMARK:
6146 The name "libpng" has not been registered by the Copyright owner
6147 as a trademark in any jurisdiction.  However, because libpng has
6148 been distributed and maintained world-wide, continually since 1995,
6149 the Copyright owner claims "common-law trademark protection" in any
6150 jurisdiction where common-law trademark is recognized.
6152 OSI CERTIFICATION:
6154 Libpng is OSI Certified Open Source Software.  OSI Certified Open Source is
6155 a certification mark of the Open Source Initiative. OSI has not addressed
6156 the additional disclaimers inserted at version 1.0.7.
6158 EXPORT CONTROL:
6160 The Copyright owner believes that the Export Control Classification
6161 Number (ECCN) for libpng is EAR99, which means not subject to export
6162 controls or International Traffic in Arms Regulations (ITAR) because
6163 it is open source, publicly available software, that does not contain
6164 any encryption software.  See the EAR, paragraphs 734.3(b)(3) and
6165 734.7(b).
6167 A "png_get_copyright" function is available, for convenient use in "about"
6168 boxes and the like:
6170    printf("%s", png_get_copyright(NULL));
6172 Also, the PNG logo (in PNG format, of course) is supplied in the
6173 files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
6175 Glenn Randers-Pehrson
6176 glennrp at users.sourceforge.net
6177 January 5, 2017
6179 .\" end of man page