VirtualBox

source: vbox/trunk/src/libs/libpng-1.6.43/libpng.3@ 107044

Last change on this file since 107044 was 105469, checked in by vboxsync, 4 months ago

libpng-1.6.43: Applied and adjusted our libpng changes to 1.6.43. bugref:8515

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette