libpng.3 226.8 KB
Newer Older
1
.TH LIBPNG 3 "July 10, 2011"
2
.SH NAME
3
libpng \- Portable Network Graphics (PNG) Reference Library 1.5.5beta01
4
.SH SYNOPSIS
5 6 7 8 9
\fI\fB

\fB#include <png.h>\fP

\fI\fB
10

11 12
\fBpng_uint_32 png_access_version_number \fI(void\fP\fB);\fP

13 14
\fI\fB

15 16
\fBvoid png_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP

17 18
\fI\fB

19 20 21 22 23 24 25 26
\fBvoid png_build_grayscale_palette (int \fP\fIbit_depth\fP\fB, png_colorp \fIpalette\fP\fB);\fP

\fI\fB

\fBpng_voidp png_calloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP

\fI\fB

27 28
\fBvoid png_chunk_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP

29 30
\fI\fB

31 32
\fBvoid png_chunk_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP

33 34
\fI\fB

35 36
\fBvoid png_chunk_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP

37 38
\fI\fB

39 40
\fBvoid png_convert_from_struct_tm (png_timep \fP\fIptime\fP\fB, struct tm FAR * \fIttime\fP\fB);\fP

41 42
\fI\fB

43 44
\fBvoid png_convert_from_time_t (png_timep \fP\fIptime\fP\fB, time_t \fIttime\fP\fB);\fP

45 46
\fI\fB

47 48
\fBpng_charp png_convert_to_rfc1123 (png_structp \fP\fIpng_ptr\fP\fB, png_timep \fIptime\fP\fB);\fP

49 50
\fI\fB

51 52
\fBpng_infop png_create_info_struct (png_structp \fIpng_ptr\fP\fB);\fP

53 54
\fI\fB

55
\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
56

57 58
\fI\fB

59
\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
60

61 62
\fI\fB

63
\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
64

65 66
\fI\fB

67 68 69 70 71
\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

\fI\fB

\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
72

73 74
\fI\fB

75 76
\fBvoid png_destroy_info_struct (png_structp \fP\fIpng_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP

77 78
\fI\fB

79 80
\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

81 82
\fI\fB

83 84
\fBvoid png_destroy_write_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP

85 86
\fI\fB

87 88 89 90
\fBvoid png_err (png_structp \fIpng_ptr\fP\fB);\fP

\fI\fB

91 92
\fBvoid png_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP

93 94
\fI\fB

95 96
\fBvoid png_free (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP

97 98
\fI\fB

99 100
\fBvoid png_free_chunk_list (png_structp \fIpng_ptr\fP\fB);\fP

101 102
\fI\fB

103
\fBvoid png_free_default (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
104

105 106
\fI\fB

107
\fBvoid png_free_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fInum\fP\fB);\fP
108

109 110
\fI\fB

111
\fBpng_byte png_get_bit_depth (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
112

113 114
\fI\fB

115
\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
116

117 118
\fI\fB

119
\fBpng_byte png_get_channels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
120

121 122
\fI\fB

123
\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
124

125 126
\fI\fB

127
\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
128

129 130
\fI\fB

131
\fBpng_uint_32 png_get_chunk_cache_max (png_const_structp \fIpng_ptr\fP\fB);\fP
132

133 134
\fI\fB

135 136
\fI\fB

137
\fBpng_alloc_size_t png_get_chunk_malloc_max (png_const_structp \fIpng_ptr\fP\fB);\fP
138 139 140

\fI\fB

141
\fBpng_byte png_get_color_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
142

143 144
\fI\fB

145
\fBpng_uint_32 png_get_compression_buffer_size (png_const_structp \fIpng_ptr\fP\fB);\fP
146

147 148
\fI\fB

149
\fBpng_byte png_get_compression_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
150

151 152
\fI\fB

153
\fBpng_byte png_get_copyright (png_const_structp \fIpng_ptr\fP\fB);\fP
154

155 156
\fI\fB

157 158 159 160 161 162 163 164
\fBpng_uint_32 png_get_current_row_number \fI(png_const_structp\fP\fB);\fP

\fI\fB

\fBpng_byte png_get_current_pass_number \fI(png_const_structp\fP\fB);\fP

\fI\fB

165
\fBpng_voidp png_get_error_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
166

167 168
\fI\fB

169
\fBpng_byte png_get_filter_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
170

171 172
\fI\fB

173
\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
174

175 176
\fI\fB

177
\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
178

179 180
\fI\fB

181
\fBpng_byte png_get_header_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
182

183 184
\fI\fB

185
\fBpng_byte png_get_header_version (png_const_structp \fIpng_ptr\fP\fB);\fP
186

187 188
\fI\fB

189
\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
190

191 192
\fI\fB

193
\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
194

195 196
\fI\fB

197 198
\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

199 200
\fI\fB

201
\fBpng_uint_32 png_get_image_height (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
202

203 204
\fI\fB

205
\fBpng_uint_32 png_get_image_width (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
206

207 208 209 210 211
\fI\fB

\fBpng_int_32 png_get_int_32 (png_bytep \fIbuf\fP\fB);\fP

\fI\fB
212

213
\fBpng_byte png_get_interlace_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
214

215 216
\fI\fB

217
\fBpng_const_bytep png_get_io_chunk_name (png_structp \fIpng_ptr\fP\fB);\fP
218 219 220

\fI\fB

221
\fBpng_uint_32 png_get_io_chunk_type (png_const_structp \fIpng_ptr\fP\fB);\fP
222

223 224
\fI\fB

225
\fBpng_voidp png_get_io_ptr (png_structp \fIpng_ptr\fP\fB);\fP
226 227 228

\fI\fB

229
\fBpng_uint_32 png_get_io_state (png_structp \fIpng_ptr\fP\fB);\fP
230 231 232

\fI\fB

233
\fBpng_byte png_get_libpng_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
234

235 236
\fI\fB

237
\fBpng_voidp png_get_mem_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
238 239 240

\fI\fB

241
\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
242 243 244

\fI\fB

245
\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
246 247 248

\fI\fB

249
\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
250

251 252
\fI\fB

253
\fBfloat png_get_pixel_aspect_ratio (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
254

255 256
\fI\fB

257
\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
258

259 260
\fI\fB

261
\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
262

263 264
\fI\fB

265
\fBpng_uint_32 png_get_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
266 267 268

\fI\fB

269
\fBpng_uint_32 png_get_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
270

271 272
\fI\fB

273
\fBpng_voidp png_get_progressive_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
274

275 276
\fI\fB

277
\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
278

279 280
\fI\fB

281
\fBpng_byte png_get_rgb_to_gray_status (png_const_structp \fIpng_ptr)
282

283
\fBpng_uint_32 png_get_rowbytes (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
284 285

\fI\fB
286

287
\fBpng_bytepp png_get_rows (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
288

289 290
\fI\fB

291
\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
292

293 294
\fI\fB

295
\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
296 297 298

\fI\fB

299
\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
300 301 302

\fI\fB

303
\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
304 305 306

\fI\fB

307
\fBpng_bytep png_get_signature (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
308

309 310
\fI\fB

311
\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
312

313 314
\fI\fB

315
\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
316

317 318
\fI\fB

319
\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
320

321 322
\fI\fB

323
\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
324

325 326
\fI\fB

327
\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
328

329 330 331 332 333 334 335
\fI\fB

\fB/* This function is really an inline macro. \fI*/

\fBpng_uint_16 png_get_uint_16 (png_bytep \fIbuf\fP\fB);\fP

\fI\fB
336

337
\fBpng_uint_32 png_get_uint_31 (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIbuf\fP\fB);\fP
338

339 340 341 342 343 344 345
\fI\fB

\fB/* This function is really an inline macro. \fI*/

\fBpng_uint_32 png_get_uint_32 (png_bytep \fIbuf\fP\fB);\fP

\fI\fB
346

347
\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
348

349 350
\fI\fB

351
\fBpng_voidp png_get_user_chunk_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
352

353 354
\fI\fB

355
\fBpng_uint_32 png_get_user_height_max (png_const_structp \fIpng_ptr\fP\fB);\fP
356

357 358
\fI\fB

359
\fBpng_voidp png_get_user_transform_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
360

361 362
\fI\fB

363
\fBpng_uint_32 png_get_user_width_max (png_const_structp \fIpng_ptr\fP\fB);\fP
364

365 366
\fI\fB

367
\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
368

369 370
\fI\fB

371
\fBfloat png_get_x_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
372 373 374

\fI\fB

375
\fBpng_fixed_point png_get_x_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
376 377 378

\fI\fB

379
\fBpng_int_32 png_get_x_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
380

381 382
\fI\fB

383
\fBpng_int_32 png_get_x_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
384

385 386
\fI\fB

387
\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
388 389 390

\fI\fB

391
\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
392

393 394
\fI\fB

395
\fBfloat png_get_y_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
396 397 398

\fI\fB

399
\fBpng_fixed_point png_get_y_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
400 401 402

\fI\fB

403
\fBpng_int_32 png_get_y_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
404

405 406
\fI\fB

407
\fBpng_int_32 png_get_y_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
408

409 410
\fI\fB

411
\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
412 413 414

\fI\fB

415
\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
416

417 418
\fI\fB

419 420
\fBint png_handle_as_unknown (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIchunk_name\fP\fB);\fP

421 422
\fI\fB

423 424 425 426
\fBvoid png_info_init_3 (png_infopp \fP\fIinfo_ptr\fP\fB, png_size_t \fIpng_info_struct_size\fP\fB);\fP

\fI\fB

427
\fBvoid png_init_io (png_structp \fP\fIpng_ptr\fP\fB, FILE \fI*fp\fP\fB);\fP
428

429 430
\fI\fB

431 432 433 434
\fBvoid png_longjmp (png_structp \fP\fIpng_ptr\fP\fB, int \fIval\fP\fB);\fP

\fI\fB

435
\fBpng_voidp png_malloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
436

437 438
\fI\fB

439 440 441 442 443 444 445 446 447
\fBpng_voidp png_malloc_default (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP

\fI\fB

\fBpng_voidp png_malloc_warn (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP

\fI\fB

\fBpng_uint_32 png_permit_mng_features (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fImng_features_permitted\fP\fB);\fP
448

449 450
\fI\fB

451
\fBvoid png_process_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fIbuffer\fP\fB, png_size_t \fIbuffer_size\fP\fB);\fP
452

453 454
\fI\fB

455 456 457 458 459 460 461 462
\fBpng_size_t png_process_data_pause \fP\fI(png_structp\fP\fB, int \fIsave\fP\fB);\fP

\fI\fB

\fBpng_uint_32 png_process_data_skip \fI(png_structp\fP\fB);\fP

\fI\fB

463
\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
464

465 466
\fI\fB

467
\fBvoid png_read_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
468

469 470
\fI\fB

471
\fBvoid png_read_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
472

473 474
\fI\fB

475
\fBvoid png_read_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
476

477 478
\fI\fB

479
\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
480

481 482
\fI\fB

483
\fBvoid png_read_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIrow\fP\fB, png_bytep \fIdisplay_row\fP\fB);\fP
484

485 486
\fI\fB

487
\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
488

489 490
\fI\fB

491
\fBvoid png_read_update_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
492

493 494
\fI\fB

495 496 497 498 499
\fBint png_reset_zstream (png_structp \fIpng_ptr\fP\fB);\fP

\fI\fB

\fBvoid png_save_int_32 (png_bytep \fP\fIbuf\fP\fB, png_int_32 \fIi\fP\fB);\fP
500 501

\fI\fB
502 503 504

\fBvoid png_save_uint_16 (png_bytep \fP\fIbuf\fP\fB, unsigned int \fIi\fP\fB);\fP

505 506
\fI\fB

507 508
\fBvoid png_save_uint_32 (png_bytep \fP\fIbuf\fP\fB, png_uint_32 \fIi\fP\fB);\fP

509 510 511 512 513
\fI\fB

\fBvoid png_set_add_alpha (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP

\fI\fB
514

515 516 517 518 519 520 521 522
\fBvoid png_set_alpha_mode (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, double \fIoutput_gamma\fP\fB);\fP

\fI\fB

\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

\fI\fB

523
\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
524

525 526
\fI\fB

527 528 529 530
\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

\fI\fB

531 532 533 534
\fBvoid png_set_benign_errors (png_structp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP

\fI\fB

535
\fBvoid png_set_bgr (png_structp \fIpng_ptr\fP\fB);\fP
536

537 538
\fI\fB

539
\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
540

541 542
\fI\fB

543
\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
544

545 546
\fI\fB

547 548
\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

549 550
\fI\fB

551 552
\fBvoid png_set_chunk_cache_max (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIuser_chunk_cache_max\fP\fB);\fP

553 554
\fI\fB

555
\fBvoid png_set_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
556

557 558
\fI\fB

559
\fBvoid png_set_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
560

561 562
\fI\fB

563
\fBvoid png_set_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
564

565 566
\fI\fB

567
\fBvoid png_set_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
568

569 570
\fI\fB

571
\fBvoid png_set_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
572

573 574
\fI\fB

575
\fBvoid png_set_crc_action (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIcrit_action\fP\fB, int \fIancil_action\fP\fB);\fP
576

577 578
\fI\fB

579
\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
580

581 582
\fI\fB

583
\fBvoid png_set_expand (png_structp \fIpng_ptr\fP\fB);\fP
584 585 586

\fI\fB

587
\fBvoid png_set_expand_16 (png_structp \fIpng_ptr\fP\fB);\fP
588

589 590
\fI\fB

591
\fBvoid png_set_expand_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
592

593 594
\fI\fB

595
\fBvoid png_set_filler (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
596

597 598
\fI\fB

599
\fBvoid png_set_filter (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImethod\fP\fB, int \fIfilters\fP\fB);\fP
600

601 602
\fI\fB

603
\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
604

605 606
\fI\fB

607 608 609 610
\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

\fI\fB

611
\fBvoid png_set_flush (png_structp \fP\fIpng_ptr\fP\fB, int \fInrows\fP\fB);\fP
612

613 614
\fI\fB

615
\fBvoid png_set_gamma (png_structp \fP\fIpng_ptr\fP\fB, double \fP\fIscreen_gamma\fP\fB, double \fIdefault_file_gamma\fP\fB);\fP
616

617 618
\fI\fB

619 620 621 622
\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

\fI\fB

623
\fBvoid png_set_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fIfile_gamma\fP\fB);\fP
624

625 626
\fI\fB

627 628
\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

629 630
\fI\fB

631
\fBvoid png_set_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
632

633 634
\fI\fB

635
\fBvoid png_set_gray_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
636

637 638
\fI\fB

639
\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
640

641 642
\fI\fB

643
\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
644

645 646
\fI\fB

647
\fBint png_set_interlace_handling (png_structp \fIpng_ptr\fP\fB);\fP
648

649 650
\fI\fB

651 652
\fBvoid png_set_invalid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fImask\fP\fB);\fP

653 654
\fI\fB

655
\fBvoid png_set_invert_alpha (png_structp \fIpng_ptr\fP\fB);\fP
656

657 658
\fI\fB

659
\fBvoid png_set_invert_mono (png_structp \fIpng_ptr\fP\fB);\fP
660

661 662
\fI\fB

663
\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
664

665 666
\fI\fB

667
\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
668

669 670
\fI\fB

671 672 673 674
\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

\fI\fB

675 676 677 678
\fBvoid png_set_chunk_malloc_max (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIuser_chunk_cache_max\fP\fB);\fP

\fI\fB

679 680 681 682 683
\fBvoid png_set_compression_buffer_size (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP

\fI\fB

\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
684

685 686
\fI\fB

687
\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
688

689 690
\fI\fB

691
\fBvoid png_set_packing (png_structp \fIpng_ptr\fP\fB);\fP
692

693 694
\fI\fB

695
\fBvoid png_set_packswap (png_structp \fIpng_ptr\fP\fB);\fP
696

697 698
\fI\fB

699
\fBvoid png_set_palette_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
700

701 702
\fI\fB

703
\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
704

705 706
\fI\fB

707
\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
708

709 710
\fI\fB

711
\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
712

713 714
\fI\fB

715
\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
716

717 718
\fI\fB

719 720 721 722
\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

\fI\fB

723
\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
724

725 726
\fI\fB

727
\fBvoid png_set_read_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_read_status_ptr \fIread_row_fn\fP\fB);\fP
728

729 730
\fI\fB

731 732 733 734
\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

\fI\fB

735
\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
736

737 738
\fI\fB

739 740
\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

741 742
\fI\fB

743
\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
744

745 746
\fI\fB

747 748
\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

749 750
\fI\fB

751 752
\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

753 754
\fI\fB

755 756 757 758 759 760 761 762 763 764 765 766
\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

\fI\fB

\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

\fI\fB

\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

\fI\fB

767 768 769 770
\fBvoid png_set_scale_16 (png_structp \fIpng_ptr\fP\fB);\fP

\fI\fB

771 772
\fBvoid png_set_shift (png_structp \fP\fIpng_ptr\fP\fB, png_color_8p \fItrue_bits\fP\fB);\fP

773 774
\fI\fB

775 776
\fBvoid png_set_sig_bytes (png_structp \fP\fIpng_ptr\fP\fB, int \fInum_bytes\fP\fB);\fP

777 778
\fI\fB

779
\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
780

781 782
\fI\fB

783
\fBvoid png_set_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
784

785 786
\fI\fB

787
\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
788

789 790
\fI\fB

791 792
\fBvoid png_set_strip_16 (png_structp \fIpng_ptr\fP\fB);\fP

793 794
\fI\fB

795 796
\fBvoid png_set_strip_alpha (png_structp \fIpng_ptr\fP\fB);\fP

797 798
\fI\fB

799 800 801 802
\fBvoid png_set_strip_error_numbers (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIstrip_mode\fP\fB);\fP

\fI\fB

803 804
\fBvoid png_set_swap (png_structp \fIpng_ptr\fP\fB);\fP

805 806
\fI\fB

807 808
\fBvoid png_set_swap_alpha (png_structp \fIpng_ptr\fP\fB);\fP

809 810
\fI\fB

811 812
\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

813 814
\fI\fB

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
\fBvoid png_set_text_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP

\fI\fB

\fBvoid png_set_text_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP

\fI\fB

\fBvoid png_set_text_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP

\fI\fB

\fBvoid png_set_text_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP

\fI\fB

\fBvoid \fP\fIpng_set_text_compression_method\fP\fB, (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod)\fP\fB);\fP

\fI\fB

835 836
\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

837 838
\fI\fB

839
\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
840

841 842
\fI\fB

843
\fBvoid png_set_tRNS_to_alpha (png_structp \fIpng_ptr\fP\fB);\fP
844

845 846
\fI\fB

847 848
\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

849 850
\fI\fB

851
\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
852

853 854
\fI\fB

855 856
\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

857 858
\fI\fB

859 860
\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

861 862
\fI\fB

863 864
\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

865 866
\fI\fB

867 868
\fBvoid png_set_write_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_write_status_ptr \fIwrite_row_fn\fP\fB);\fP

869 870
\fI\fB

871 872
\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

873 874
\fI\fB

875 876
\fBint png_sig_cmp (png_bytep \fP\fIsig\fP\fB, png_size_t \fP\fIstart\fP\fB, png_size_t \fInum_to_check\fP\fB);\fP

877 878
\fI\fB

879 880
\fBvoid png_start_read_image (png_structp \fIpng_ptr\fP\fB);\fP

881 882
\fI\fB

883 884
\fBvoid png_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP

885 886
\fI\fB

887 888
\fBvoid png_write_chunk (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIchunk_name\fP\fB, png_bytep \fP\fIdata\fP\fB, png_size_t \fIlength\fP\fB);\fP

889 890
\fI\fB

891 892
\fBvoid png_write_chunk_data (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIdata\fP\fB, png_size_t \fIlength\fP\fB);\fP

893 894
\fI\fB

895 896
\fBvoid png_write_chunk_end (png_structp \fIpng_ptr\fP\fB);\fP

897 898
\fI\fB

899 900
\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

901 902
\fI\fB

903 904
\fBvoid png_write_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP

905 906
\fI\fB

907 908
\fBvoid png_write_flush (png_structp \fIpng_ptr\fP\fB);\fP

909 910
\fI\fB

911 912
\fBvoid png_write_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP

913 914
\fI\fB

915 916
\fBvoid png_write_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP

917 918
\fI\fB

919 920
\fBvoid png_write_info_before_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP

921 922
\fI\fB

923
\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
924

925 926
\fI\fB

927 928
\fBvoid png_write_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIrow\fP\fB);\fP

929 930
\fI\fB

931 932
\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

933 934
\fI\fB

935 936
\fBvoid png_write_sig (png_structp \fIpng_ptr\fP\fB);\fP

937 938
\fI\fB

939 940
\fBvoidpf png_zalloc (voidpf \fP\fIpng_ptr\fP\fB, uInt \fP\fIitems\fP\fB, uInt \fIsize\fP\fB);\fP

941 942
\fI\fB

943 944
\fBvoid png_zfree (voidpf \fP\fIpng_ptr\fP\fB, voidpf \fIptr\fP\fB);\fP

945 946
\fI\fB

947 948 949 950 951 952 953
.SH DESCRIPTION
The
.I libpng
library supports encoding, decoding, and various manipulations of
the Portable Network Graphics (PNG) format image files.  It uses the
.IR zlib(3)
compression library.
954
Following is a copy of the libpng-manual.txt file that accompanies libpng.
955
.SH LIBPNG.TXT
956
libpng-manual.txt - A description on how to use and modify libpng
957

958
 libpng version 1.5.5beta01 - July 10, 2011
959
 Updated and distributed by Glenn Randers-Pehrson
960
 <glennrp at users.sourceforge.net>
961
 Copyright (c) 1998-2011 Glenn Randers-Pehrson
962

963
 This document is released under the libpng license.
964
 For conditions of distribution and use, see the disclaimer
965
 and license in png.h
966

967 968
 Based on:

969
 libpng versions 0.97, January 1998, through 1.5.5beta01 - July 10, 2011
970
 Updated and distributed by Glenn Randers-Pehrson
971
 Copyright (c) 1998-2011 Glenn Randers-Pehrson
972

973
 libpng 1.0 beta 6  version 0.96 May 28, 1997
974
 Updated and distributed by Andreas Dilger
975 976
 Copyright (c) 1996, 1997 Andreas Dilger

977
 libpng 1.0 beta 2 - version 0.88  January 26, 1996
978 979
 For conditions of distribution and use, see copyright
 notice in png.h. Copyright (c) 1995, 1996 Guy Eric
980
 Schalnat, Group 42, Inc.
981 982

 Updated/rewritten per request in the libpng FAQ
983 984
 Copyright (c) 1995, 1996 Frank J. T. Wojcik
 December 18, 1995 & January 20, 1996
985 986 987 988 989 990 991 992 993

.SH I. Introduction

This file describes how to use and modify the PNG reference library
(known as libpng) for your own use.  There are five sections to this
file: introduction, structures, reading, writing, and modification and
configuration notes for various special platforms.  In addition to this
file, example.c is a good starting point for using the library, as
it is heavily commented and should include everything most people
994 995
will need.  We assume that libpng is already installed; see the
INSTALL file for instructions on how to install libpng.
996

997
For examples of libpng usage, see the files "example.c", "pngtest.c",
998 999
and the files in the "contrib" directory, all of which are included in
the libpng distribution.
1000

1001 1002
Libpng was written as a companion to the PNG specification, as a way
of reducing the amount of time and effort it takes to support the PNG
1003 1004
file format in application programs.

1005 1006 1007 1008 1009 1010
The PNG specification (second edition), November 2003, is available as
a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2003 (E)) at
<http://www.w3.org/TR/2003/REC-PNG-20031110/
The W3C and ISO documents have identical technical content.

The PNG-1.2 specification is available at
1011 1012
<http://www.libpng.org/pub/png/documents/>.  It is technically equivalent
to the PNG specification (second edition) but has some additional material.
1013 1014

The PNG-1.0 specification is available
1015
as RFC 2083 <http://www.libpng.org/pub/png/documents/> and as a
1016 1017 1018
W3C Recommendation <http://www.w3.org/TR/REC.png.html>.

Some additional chunks are described in the special-purpose public chunks
1019
documents at <http://www.libpng.org/pub/png/documents/>.
1020 1021

Other information
1022
about PNG, and the latest version of libpng, can be found at the PNG home
1023
page, <http://www.libpng.org/pub/png/>.
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

Most users will not have to modify the library significantly; advanced
users may want to modify it more.  All attempts were made to make it as
complete as possible, while keeping the code easy to understand.
Currently, this library only supports C.  Support for other languages
is being considered.

Libpng has been designed to handle multiple sessions at one time,
to be easily modifiable, to be portable to the vast majority of
machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
to use.  The ultimate goal of libpng is to promote the acceptance of
the PNG file format in whatever way possible.  While there is still
work to be done (see the TODO file), libpng should cover the
majority of the needs of its users.

Libpng uses zlib for its compression and decompression of PNG files.
1040
Further information about zlib, and the latest version of zlib, can
1041
be found at the zlib home page, <http://www.info-zip.org/pub/infozip/zlib/>.
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
The zlib compression utility is a general purpose utility that is
useful for more than PNG files, and can be used without libpng.
See the documentation delivered with zlib for more details.
You can usually find the source files for the zlib utility wherever you
find the libpng source files.

Libpng is thread safe, provided the threads are using different
instances of the structures.  Each thread should have its own
png_struct and png_info instances, and thus its own image.
Libpng does not protect itself against two threads using the
1052
same instance of a structure.
1053 1054 1055 1056

.SH II. Structures

There are two main structures that are important to libpng, png_struct
1057 1058
and png_info.  Both are internal structures that are no longer exposed
in the libpng interface (as of libpng 1.5.0).
1059 1060 1061 1062 1063

The png_info structure is designed to provide information about the
PNG file.  At one time, the fields of png_info were intended to be
directly accessible to the user.  However, this tended to cause problems
with applications using dynamically loaded libraries, and as a result
1064
a set of interface functions for png_info (the png_get_*() and png_set_*()
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
functions) was developed.

The png_struct structure is the object used by the library to decode a
single image.  As of 1.5.0 this structure is also not exposed.

Almost all libpng APIs require a pointer to a png_struct as the first argument.
Many (in particular the png_set and png_get APIs) also require a pointer
to png_info as the second argument.  Some application visible macros
defined in png.h designed for basic data access (reading and writing
integers in the PNG format) break this rule, but it's almost always safe
to assume that a (png_struct*) has to be passed to call an API function.
1076 1077 1078 1079 1080 1081

The png.h header file is an invaluable reference for programming with libpng.
And while I'm on the topic, make sure you include the libpng header file:

#include <png.h>

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
.SS Types

The png.h header file defines a number of integral types used by the
APIs.  Most of these are fairly obvious; for example types corresponding
to integers of particular sizes and types for passing color values.

One exception is how non-integral numbers are handled.  For application
convenience most APIs that take such numbers have C (double) arguments,
however internally PNG, and libpng, use 32 bit signed integers and encode
the value by multiplying by 100,000.  As of libpng 1.5.0 a convenience
macro PNG_FP_1 is defined in png.h along with a type (png_fixed_point)
which is simply (png_int_32).

All APIs that take (double) arguments also have an matching API that
takes the corresponding fixed point integer arguments.  The fixed point
API has the same name as the floating point one with _fixed appended.
The actual range of values permitted in the APIs is frequently less than
the full range of (png_fixed_point) (-21474 to +21474).  When APIs require
a non-negative argument the type is recorded as png_uint_32 above.  Consult
the header file and the text below for more information.

1103 1104 1105 1106
Special care must be take with sCAL chunk handling because the chunk itself
uses non-integral values encoded as strings containing decimal floating point
numbers.  See the comments in the header file.

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
.SS Configuration

The main header file function declarations are frequently protected by C
preprocessing directives of the form:

    #ifdef PNG_feature_SUPPORTED
    declare-function
    #endif

The library can be built without support for these APIs, although a
standard build will have all implemented APIs.  Application programs
should check the feature macros before using an API for maximum
portability.  From libpng 1.5.0 the feature macros set during the build
of libpng are recorded in the header file "pnglibconf.h" and this file
is always included by png.h.

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
If you don't need to change the library configuration from the default skip to
the next section ("Reading").

Notice that some of the makefiles in the 'scripts' directory and (in 1.5.0) all
of the build project files in the 'projects' directory simply copy
scripts/pnglibconf.h.prebuilt to pnglibconf.h.  This means that these build
systems do not permit easy auto-configuration of the library - they only
support the default configuration.

The easiest way to make minor changes to the libpng configuration when
auto-configuration is supported is to add definitions to the command line
using (typically) CPPFLAGS.  For example:

CPPFLAGS=-DPNG_NO_FLOATING_ARITHMETIC

will change the internal libpng math implementation for gamma correction and
other arithmetic calculations to fixed point, avoiding the need for fast
floating point support.  The result can be seen in the generated pnglibconf.h -
make sure it contains the changed feature macro setting.

If you need to make more extensive configuration changes - more than one or two
feature macro settings - you can either add -DPNG_USER_CONFIG to the build
command line and put a list of feature macro settings in pngusr.h or you can set
DFA_XTRA (a makefile variable) to a file containing the same information in the
form of 'option' settings.

A. Changing pnglibconf.h

A variety of methods exist to build libpng.  Not all of these support
reconfiguration of pnglibconf.h.  To reconfigure pnglibconf.h it must either be
rebuilt from scripts/pnglibconf.dfa using awk or it must be edited by hand.

Hand editing is achieved by copying scripts/pnglibconf.h.prebuilt and changing
1156 1157 1158
the lines defining the supported features, paying very close attention to
the 'option' information in scripts/pnglibconf.dfa that describes those
features and their requirements.  This is easy to get wrong.
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231

B. Configuration using DFA_XTRA

Rebuilding from pnglibconf.dfa is easy if a functioning 'awk', or a later
variant such as 'nawk' or 'gawk', is available.  The configure build will
automatically find an appropriate awk and build pnglibconf.h.
scripts/pnglibconf.mak contains a set of make rules for doing the same thing if
configure is not used, and many of the makefiles in the scripts directory use
this approach.

When rebuilding simply write new file containing changed options and set
DFA_XTRA to the name of this file.  This causes the build to append the new file
to the end of scripts/pnglibconf.dfa.  pngusr.dfa should contain lines of the
following forms:

everything = off

This turns all optional features off.  Include it at the start of pngusr.dfa to
make it easier to build a minimal configuration.  You will need to turn at least
some features on afterward to enable either reading or writing code, or both.

option feature on
option feature off

Enable or disable a single feature.  This will automatically enable other
features required by a feature that is turned on or disable other features that
require a feature which is turned off.  Conflicting settings will cause an error
message to be emitted by awk.

setting feature default value

Changes the default value of setting 'feature' to 'value'.  There are a small
number of settings listed at the top of pnglibconf.h, they are documented in the
source code.  Most of these values have performance implications for the library
but most of them have no visible effect on the API.  Some can also be overridden
from the API.

C. Configuration using PNG_USR_CONFIG

If -DPNG_USR_CONFIG is added to the CFLAGS when pnglibconf.h is built the file
pngusr.h will automatically be included before the options in
scripts/pnglibconf.dfa are processed.  pngusr.h should contain only macro
definitions turning features on or off or setting settings.

Apart from the global setting "everything = off" all the options listed above
can be set using macros in pngusr.h:

#define PNG_feature_SUPPORTED

is equivalent to:

option feature on

#define PNG_NO_feature

is equivalent to:

option feature off

#define PNG_feature value

is equivalent to:

setting feature default value

Notice that in both cases, pngusr.dfa and pngusr.h, the contents of the
pngusr file you supply override the contents of scripts/pnglibconf.dfa

If confusing or incomprehensible behavior results it is possible to
examine the intermediate file pnglibconf.dfn to find the full set of
dependency information for each setting and option.  Simply locate the
feature in the file and read the C comments that precede it.

1232 1233 1234
.SH III. Reading

We'll now walk you through the possible functions to call when reading
1235 1236 1237 1238 1239 1240 1241
in a PNG file sequentially, briefly explaining the syntax and purpose
of each one.  See example.c and png.h for more detail.  While
progressive reading is covered in the next section, you will still
need some of the functions discussed in this section to read a PNG
file.

.SS Setup
1242 1243 1244 1245 1246

You will want to do the I/O initialization(*) before you get into libpng,
so if it doesn't work, you don't have much to undo.  Of course, you
will also want to insure that you are, in fact, dealing with a PNG
file.  Libpng provides a simple check to see if a file is a PNG file.
1247
To use it, pass in the first 1 to 8 bytes of the file to the function
1248 1249 1250 1251
png_sig_cmp(), and it will return 0 (false) if the bytes match the
corresponding bytes of the PNG signature, or nonzero (true) otherwise.
Of course, the more bytes you pass in, the greater the accuracy of the
prediction.
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266

If you are intending to keep the file pointer open for use in libpng,
you must ensure you don't read more than 8 bytes from the beginning
of the file, and you also have to make a call to png_set_sig_bytes_read()
with the number of bytes you read from the beginning.  Libpng will
then only check the bytes (if any) that your program didn't read.

(*): If you are not using the standard I/O functions, you will need
to replace them with custom functions.  See the discussion under
Customizing libpng.


    FILE *fp = fopen(file_name, "rb");
    if (!fp)
    {
1267
       return (ERROR);
1268
    }
1269

1270
    fread(header, 1, number, fp);
1271
    is_png = !png_sig_cmp(header, 0, number);
1272

1273 1274
    if (!is_png)
    {
1275
       return (NOT_PNG);
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
    }


Next, png_struct and png_info need to be allocated and initialized.  In
order to ensure that the size of these structures is correct even with a
dynamically linked libpng, there are functions to initialize and
allocate the structures.  We also pass the library version, optional
pointers to error handling functions, and a pointer to a data struct for
use by the error functions, if necessary (the pointer and functions can
be NULL if the default error handlers are to be used).  See the section
on Changes to Libpng below regarding the old initialization functions.
1287 1288
The structure allocation functions quietly return NULL if they fail to
create the structure, so your application should check for that.
1289 1290

    png_structp png_ptr = png_create_read_struct
1291
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
1292
        user_error_fn, user_warning_fn);
1293

1294
    if (!png_ptr)
1295
       return (ERROR);
1296 1297

    png_infop info_ptr = png_create_info_struct(png_ptr);
1298

1299 1300
    if (!info_ptr)
    {
1301
       png_destroy_read_struct(&png_ptr,
1302
           (png_infopp)NULL, (png_infopp)NULL);
1303
       return (ERROR);
1304 1305
    }

1306
If you want to use your own memory allocation routines,
1307
use a libpng that was built with PNG_USER_MEM_SUPPORTED defined, and use
1308 1309 1310
png_create_read_struct_2() instead of png_create_read_struct():

    png_structp png_ptr = png_create_read_struct_2
1311
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
1312 1313 1314 1315 1316 1317 1318
        user_error_fn, user_warning_fn, (png_voidp)
        user_mem_ptr, user_malloc_fn, user_free_fn);

The error handling routines passed to png_create_read_struct()
and the memory alloc/free routines passed to png_create_struct_2()
are only necessary if you are not using the libpng supplied error
handling and memory alloc/free functions.
1319

1320
When libpng encounters an error, it expects to longjmp back
1321
to your routine.  Therefore, you will need to call setjmp and pass
1322
your png_jmpbuf(png_ptr).  If you read the file from different
1323
routines, you will need to update the longjmp buffer every time you enter
1324
a new routine that will call a png_*() function.
1325 1326

See your documentation of setjmp/longjmp for your compiler for more
1327 1328 1329
information on setjmp/longjmp.  See the discussion on libpng error
handling in the Customizing Libpng section below for more information
on the libpng error handling.  If an error occurs, and libpng longjmp's
1330 1331 1332
back to your setjmp, you will want to call png_destroy_read_struct() to
free any memory.

1333
    if (setjmp(png_jmpbuf(png_ptr)))
1334
    {
1335
       png_destroy_read_struct(&png_ptr, &info_ptr,
1336
           &end_info);
1337 1338
       fclose(fp);
       return (ERROR);
1339 1340
    }

1341 1342 1343
Pass (png_infopp)NULL instead of &end_info if you didn't create
an end_info structure.

1344
If you would rather avoid the complexity of setjmp/longjmp issues,
1345
you can compile libpng with PNG_NO_SETJMP, in which case
1346 1347
errors will result in a call to PNG_ABORT() which defaults to abort().

1348 1349 1350 1351
You can #define PNG_ABORT() to a function that does something
more useful than abort(), as long as your function does not
return.

1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
Now you need to set up the input code.  The default for libpng is to
use the C function fread().  If you use this, you will need to pass a
valid FILE * in the function png_init_io().  Be sure that the file is
opened in binary mode.  If you wish to handle reading data in another
way, you need not call the png_init_io() function, but you must then
implement the libpng I/O methods discussed in the Customizing Libpng
section below.

    png_init_io(png_ptr, fp);

If you had previously opened the file and read any of the signature from
the beginning in order to see if this was a PNG file, you need to let
libpng know that there are some bytes missing from the start of the file.

    png_set_sig_bytes(png_ptr, number);

1368 1369 1370 1371 1372 1373 1374 1375 1376
You can change the zlib compression buffer size to be used while
reading compressed data with

    png_set_compression_buffer_size(png_ptr, buffer_size);

where the default size is 8192 bytes.  Note that the buffer size
is changed immediately and the buffer is reallocated immediately,
instead of setting a flag to be acted upon later.

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
If you want CRC errors to be handled in a different manner than
the default, use

    png_set_crc_action(png_ptr, crit_action, ancil_action);

The values for png_set_crc_action() say how libpng is to handle CRC errors in
ancillary and critical chunks, and whether to use the data contained
therein.  Note that it is impossible to "discard" data in a critical
chunk.

Choices for (int) crit_action are
   PNG_CRC_DEFAULT      0  error/quit
   PNG_CRC_ERROR_QUIT   1  error/quit
   PNG_CRC_WARN_USE     3  warn/use data
   PNG_CRC_QUIET_USE    4  quiet/use data
   PNG_CRC_NO_CHANGE    5  use the current value

Choices for (int) ancil_action are
   PNG_CRC_DEFAULT      0  error/quit
   PNG_CRC_ERROR_QUIT   1  error/quit
   PNG_CRC_WARN_DISCARD 2  warn/discard data
   PNG_CRC_WARN_USE     3  warn/use data
   PNG_CRC_QUIET_USE    4  quiet/use data
   PNG_CRC_NO_CHANGE    5  use the current value

1402 1403 1404 1405 1406
.SS Setting up callback code

You can set up a callback function to handle any unknown chunks in the
input stream. You must supply the function

1407
    read_chunk_callback(png_structp png_ptr,
1408 1409 1410
         png_unknown_chunkp chunk);
    {
       /* The unknown chunk structure contains your
1411 1412 1413
          chunk data, along with similar data for any other
          unknown chunks: */

1414 1415 1416
           png_byte name[5];
           png_byte *data;
           png_size_t size;
1417

1418 1419
       /* Note that libpng has already taken care of
          the CRC handling */
1420

1421 1422 1423
       /* put your code here.  Search for your chunk in the
          unknown chunk structure, process it, and return one
          of the following: */
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

       return (-n); /* chunk had an error */
       return (0); /* did not recognize */
       return (n); /* success */
    }

(You can give your function another name that you like instead of
"read_chunk_callback")

To inform libpng about your function, use

    png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
        read_chunk_callback);

This names not only the callback function, but also a user pointer that
you can retrieve with

    png_get_user_chunk_ptr(png_ptr);

1443 1444 1445 1446 1447
If you call the png_set_read_user_chunk_fn() function, then all unknown
chunks will be saved when read, in case your callback function will need
one or more of them.  This behavior can be changed with the
png_set_keep_unknown_chunks() function, described below.

1448 1449 1450 1451 1452
At this point, you can set up a callback function that will be
called after each row has been read, which you can use to control
a progress meter or the like.  It's demonstrated in pngtest.c.
You must supply a function

1453 1454
    void read_row_callback(png_structp png_ptr,
       png_uint_32 row, int pass);
1455 1456 1457 1458 1459 1460 1461 1462 1463
    {
      /* put your code here */
    }

(You can give it another name that you like instead of "read_row_callback")

To inform libpng about your function, use

    png_set_read_status_fn(png_ptr, read_row_callback);
1464

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
When this function is called the row has already been completely processed and
the 'row' and 'pass' refer to the next row to be handled.  For the
non-interlaced case the row that was just handled is simply one less than the
passed in row number, and pass will always be 0.  For the interlaced case the
same applies unless the row value is 0, in which case the row just handled was
the last one from one of the preceding passes.  Because interlacing may skip a
pass you cannot be sure that the preceding pass is just 'pass-1', if you really
need to know what the last pass is record (row,pass) from the callback and use
the last recorded value each time.

As with the user transform you can find the output row using the
PNG_ROW_FROM_PASS_ROW macro.

1478 1479 1480 1481 1482
.SS Unknown-chunk handling

Now you get to set the way the library processes unknown chunks in the
input PNG stream. Both known and unknown chunks will be read.  Normal
behavior is that known chunks will be parsed into information in
1483 1484 1485
various info_ptr members while unknown chunks will be discarded. This
behavior can be wasteful if your application will never use some known
chunk types. To change this, you can call:
1486

1487
    png_set_keep_unknown_chunks(png_ptr, keep,
1488
        chunk_list, num_chunks);
1489 1490
    keep       - 0: default unknown chunk handling
                 1: ignore; do not keep
1491 1492
                 2: keep only if safe-to-copy
                 3: keep even if unsafe-to-copy
1493

1494 1495 1496 1497 1498
               You can use these definitions:
                 PNG_HANDLE_CHUNK_AS_DEFAULT   0
                 PNG_HANDLE_CHUNK_NEVER        1
                 PNG_HANDLE_CHUNK_IF_SAFE      2
                 PNG_HANDLE_CHUNK_ALWAYS       3
1499

1500 1501 1502
    chunk_list - list of chunks affected (a byte string,
                 five bytes per chunk, NULL or '\0' if
                 num_chunks is 0)
1503

1504
    num_chunks - number of chunks affected; if 0, all
1505 1506 1507
                 unknown chunks are affected.  If nonzero,
                 only the chunks in the list are affected

1508 1509 1510 1511 1512
Unknown chunks declared in this way will be saved as raw data onto a
list of png_unknown_chunk structures.  If a chunk that is normally
known to libpng is named in the list, it will be handled as unknown,
according to the "keep" directive.  If a chunk is named in successive
instances of png_set_keep_unknown_chunks(), the final instance will
1513 1514
take precedence.  The IHDR and IEND chunks should not be named in
chunk_list; if they are, libpng will process them normally anyway.
1515

1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
Here is an example of the usage of png_set_keep_unknown_chunks(),
where the private "vpAg" chunk will later be processed by a user chunk
callback function:

    png_byte vpAg[5]={118, 112,  65, 103, (png_byte) '\0'};

    #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
      png_byte unused_chunks[]=
      {
        104,  73,  83,  84, (png_byte) '\0',   /* hIST */
        105,  84,  88, 116, (png_byte) '\0',   /* iTXt */
        112,  67,  65,  76, (png_byte) '\0',   /* pCAL */
        115,  67,  65,  76, (png_byte) '\0',   /* sCAL */
        115,  80,  76,  84, (png_byte) '\0',   /* sPLT */
        116,  73,  77,  69, (png_byte) '\0',   /* tIME */
      };
    #endif

    ...

    #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
      /* ignore all unknown chunks: */
      png_set_keep_unknown_chunks(read_ptr, 1, NULL, 0);
1539

1540 1541
      /* except for vpAg: */
      png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
1542

1543 1544 1545 1546 1547
      /* also ignore unused known chunks: */
      png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
         (int)sizeof(unused_chunks)/5);
    #endif

1548 1549 1550 1551 1552 1553 1554
.SS User limits

The PNG specification allows the width and height of an image to be as
large as 2^31-1 (0x7fffffff), or about 2.147 billion rows and columns.
Since very few applications really need to process such large images,
we have imposed an arbitrary 1-million limit on rows and columns.
Larger images will be rejected immediately with a png_error() call. If
1555
you wish to change this limit, you can use
1556 1557 1558 1559 1560 1561 1562 1563 1564

   png_set_user_limits(png_ptr, width_max, height_max);

to set your own limits, or use width_max = height_max = 0x7fffffffL
to allow all valid dimensions (libpng may reject some very large images
anyway because of potential buffer overflow conditions).

You should put this statement after you create the PNG structure and
before calling png_read_info(), png_read_png(), or png_process_data().
1565 1566 1567 1568

When writing a PNG datastream, put this statement before calling
png_write_info() or png_write_png().

1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
If you need to retrieve the limits that are being applied, use

   width_max = png_get_user_width_max(png_ptr);
   height_max = png_get_user_height_max(png_ptr);

The PNG specification sets no limit on the number of ancillary chunks
allowed in a PNG datastream.  You can impose a limit on the total number
of sPLT, tEXt, iTXt, zTXt, and unknown chunks that will be stored, with

   png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);

where 0x7fffffffL means unlimited.  You can retrieve this limit with

   chunk_cache_max = png_get_chunk_cache_max(png_ptr);

1584 1585 1586
This limit also applies to the number of buffers that can be allocated
by png_decompress_chunk() while decompressing iTXt, zTXt, and iCCP chunks.

1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
You can also set a limit on the amount of memory that a compressed chunk
other than IDAT can occupy, with

   png_set_chunk_malloc_max(png_ptr, user_chunk_malloc_max);

and you can retrieve the limit with

   chunk_malloc_max = png_get_chunk_malloc_max(png_ptr);

Any chunks that would cause either of these limits to be exceeded will
be ignored.

1599 1600 1601 1602 1603 1604
.SS Information about your system

If you intend to display the PNG or to incorporate it in other image data you
need to tell libpng information about your display or drawing surface so that
libpng can convert the values in the image to match the display.

1605
From libpng-1.5.4 this information can be set before reading the PNG file
1606 1607 1608 1609
header.  In earlier versions png_set_gamma() existed but behaved incorrectly if
called before the PNG file header had been read and png_set_alpha_mode() did not
exist.

1610
If you need to support versions prior to libpng-1.5.4 test the version number
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
and follow the procedures described in the appropriate manual page.

You give libpng the encoding expected by your system expressed as a 'gamma'
value.  You can also specify a default encoding for the PNG file in
case the required information is missing from the file.  By default libpng
assumes that the PNG data matches your system, to keep this default call:

   png_set_gamma(png_ptr, screen_gamma, 1/screen_gamma/*file gamma*/);

or you can use the fixed point equivalent:

   png_set_gamma_fixed(png_ptr, PNG_FP_1*screen_gamma, PNG_FP_1/screen_gamma);

If you don't know the gamma for you system it is probably 2.2 - a good
approximation to the IEC standard for display systems (sRGB).  If images are
too contrasty or washed out you got the value wrong - check your system
documentation!

Many systems permit the system gamma to be changed via a lookup table in the
display driver, a few systems, including older Macs, change the response by
1631
default.  As of 1.5.4 three special values are available to handle common
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
situations:

   PNG_DEFAULT_sRGB: Indicates that the system conforms to the IEC 61966-2-1
                     standard.  This matches almost all systems.
   PNG_GAMMA_MAC_18: Indicates that the system is an older (pre Mac OS 10.6)
                     Apple Macintosh system with the default settings.
   PNG_GAMMA_LINEAR: Just the fixed point value for 1.0 - indicates that the
                     system expects data with no gamma encoding.

You would use the linear (unencoded) value if you need to process the pixel
values further because this avoids the need to decode and reencode each
component value whenever arithmetic is performed.  A lot of graphics software
uses linear values for this reason, often with higher precision component values
to preserve overall accuracy.

The second thing you may need to tell libpng about is how your system handles
alpha channel information.  Some, but not all, PNG files contain an alpha
channel.  To display these files correctly you need to compose the data onto a
suitable background, as described in the PNG specification.

Libpng only supports composing onto a single color (using png_set_background;
see below.)  Otherwise you must do the composition yourself and, in this case,
you may need to call png_set_alpha_mode:

   png_set_alpha_mode(png_ptr, mode, screen_gamma);

The screen_gamma value is the same as the argument to png_set_gamma, however how
1659
it affects the output depends on the mode.  png_set_alpha_mode() sets the file
1660
gamma default to 1/screen_gamma, so normally you don't need to call
1661 1662 1663
png_set_gamma.  If you need different defaults call png_set_gamma() before
png_set_alpha_mode() - if you call it after it will override the settings made
by png_set_alpha_mode().
1664 1665 1666

The mode is as follows:

1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
    PNG_ALPHA_PNG: The data is encoded according to the PNG specification.  Red,
green and blue, or gray, components are gamma encoded color
values and are not premultiplied by the alpha value.  The
alpha value is a linear measure of the contribution of the
pixel to the corresponding final output pixel.

You should normally use this format if you intend to perform
color correction on the color values; most, maybe all, color
correction software has no handling for the alpha channel and,
anyway, the math to handle pre-multiplied component values is
unnecessarily complex.

Before you do any arithmetic on the component values you need
to remove the gamma encoding and multiply out the alpha
channel.  See the PNG specification for more detail.  It is
important to note that when an image with an alpha channel is
scaled, linear encoded, pre-multiplied component values must
be used!
1685 1686 1687 1688 1689

The remaining modes assume you don't need to do any further color correction or
that if you do your color correction software knows all about alpha (it
probably doesn't!)

1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
    PNG_ALPHA_STANDARD:  The data libpng produces is encoded in the standard way
assumed by most correctly written graphics software.
The gamma encoding will be removed by libpng and the
linear component values will be pre-multiplied by the
alpha channel.

With this format the final image must be re-encoded to
match the display gamma before the image is displayed.
If your system doesn't do that, yet still seems to
perform arithmetic on the pixels without decoding them,
it is broken - check out the modes below.

With PNG_ALPHA_STANDARD libpng always produces linear
component values, whatever screen_gamma you supply.  The
screen_gamma value is, however, used as a default for
the file gamma if the PNG file has no gamma information.

If you call png_set_gamma() after png_set_alpha_mode() you
will override the linear encoding.  Instead the
pre-multiplied pixel values will be gamma encoded but
the alpha channel will still be linear.  This may
actually match the requirements of some broken software,
but it is unlikely.

While linear 8-bit data is often used it has
insufficient precision for any image with a reasonable
dynamic range.  To avoid problems, and if your software
supports it, use png_set_expand_16() to force all
components to 16 bits.

    PNG_ALPHA_OPTIMIZED: This mode is the same as PNG_ALPHA_STANDARD except that
completely opaque pixels are gamma encoded according to
the screen_gamma value.  Pixels with alpha less than 1.0
will still have linear components.

Use this format if you have control over your
compositing software and do don't do other arithmetic
(such as scaling) on the data you get from libpng.  Your
compositing software can simply copy opaque pixels to
the output but still has linear values for the
non-opaque pixels.

In normal compositing, where the alpha channel encodes
partial pixel coverage (as opposed to broad area
translucency), the inaccuracies of the 8-bit
representation of non-opaque pixels are irrelevant.

You can also try this format if your software is broken;
it might look better.

    PNG_ALPHA_BROKEN: This is PNG_ALPHA_STANDARD however all component values,
including the alpha channel are gamma encoded.  This is
an appropriate format to try if your software, or more
likely hardware, is totally broken: if it performs
linear arithmetic directly on gamma encoded values.
1745 1746 1747 1748 1749 1750 1751 1752

In most cases of broken software or hardware the bug in the final display
manifests as a subtle halo around composited parts of the image.  You may not
even perceive this as a halo; the composited part of the image may simply appear
separate from the background, as though it had been cut out of paper and pasted
on afterward.

If you don't have to deal with bugs in software or hardware, or if you can fix
1753
them, there are three recommended ways of using png_set_alpha_mode():
1754

1755 1756
   png_set_alpha_mode(png_ptr, PNG_ALPHA_PNG,
       screen_gamma);
1757

1758 1759 1760 1761 1762 1763
You can do color correction on the result (libpng does not currently
support color correction internally.)  When you handle the alpha channel
you need to undo the gamma encoding and multiply out the alpha.

   png_set_alpha_mode(png_ptr, PNG_ALPHA_STANDARD,
       screen_gamma);
1764 1765
   png_set_expand_16(png_ptr);

1766 1767 1768 1769 1770 1771 1772 1773
If you are using the high level interface don't call png_set_expand_16();
instead pass PNG_TRANSFORM_EXPAND_16 to the interface.

With this mode you can't do color correction, but you can do arithmetic,
including composition and scaling, on the data without further processing.

   png_set_alpha_mode(png_ptr, PNG_ALPHA_OPTIMIZED,
       screen_gamma);
1774

1775 1776 1777 1778 1779
You can avoid the expansion to 16-bit components with this mode, but you
lose the ability to scale the image or perform other linear arithmetic.
All you can do is compose the result onto a matching output.  Since this
mode is libpng specific you also need to write your own composition
software.
1780 1781

If you don't need, or can't handle, the alpha channel you can call
1782 1783
png_set_background() to remove it by compositing against a fixed color.  Don't
call png_set_strip_alpha() to do this - it will leave spurious pixel values in
1784 1785
transparent parts of this image.

1786 1787
   png_set_background(png_ptr, &background_color,
       PNG_BACKGROUND_GAMMA_SCREEN, 0, 1);
1788 1789 1790 1791 1792 1793 1794 1795

The background_color is an RGB or grayscale value according to the data format
libpng will produce for you.  Because you don't yet know the format of the PNG
file if you call png_set_background at this point you must arrange for the
format produced by libpng to always have 8-bit or 16-bit components and then
store the color as an 8-bit or 16-bit color as appropriate.  The color contains
separate gray and RGB component values, so you can let libpng produce gray or
RGB output according to the input format, but low bit depth grayscale images
1796
must always be converted to at least 8-bit format.  (Even though low bit depth
1797 1798 1799 1800 1801
grayscale images can't have an alpha channel they can have a transparent
color!)

You set the transforms you need later, either as flags to the high level
interface or libpng API calls for the low level interface.  For reference the
1802
settings and API calls required are:
1803 1804

8-bit values:
1805 1806
   PNG_TRANSFORM_SCALE_16 | PNG_EXPAND
   png_set_expand(png_ptr); png_set_scale_16(png_ptr);
1807

1808 1809
   If you must get exactly the same inaccurate results
   produced by default in versions prior to libpng-1.5.4,
1810
   use PNG_TRANSFORM_STRIP_16 and png_set_strip_16(png_ptr)
1811 1812
   instead.

1813 1814 1815 1816 1817 1818 1819 1820 1821
16-bit values:
   PNG_TRANSFORM_EXPAND_16
   png_set_expand_16(png_ptr);

In either case palette image data will be expanded to RGB.  If you just want
color data you can add PNG_TRANSFORM_GRAY_TO_RGB or png_set_gray_to_rgb(png_ptr)
to the list.

Calling png_set_background before the PNG file header is read will not work
1822
prior to libpng-1.5.4.  Because the failure may result in unexpected warnings or
1823
errors it is therefore much safer to call png_set_background after the head has
1824
been read.  Unfortunately this means that prior to libpng-1.5.4 it cannot be
1825 1826
used with the high level interface.

1827 1828 1829 1830 1831 1832 1833 1834 1835
.SS The high-level read interface

At this point there are two ways to proceed; through the high-level
read interface, or through a sequence of low-level read operations.
You can use the high-level interface if (a) you are willing to read
the entire image into memory, and (b) the input transformations
you want to do are limited to the following set:

    PNG_TRANSFORM_IDENTITY      No transformation
1836 1837 1838 1839
    PNG_TRANSFORM_SCALE_16      Strip 16-bit samples to
                                8-bit accurately
    PNG_TRANSFORM_STRIP_16      Chop 16-bit samples to
                                8-bit less accurately
1840
    PNG_TRANSFORM_STRIP_ALPHA   Discard the alpha channel
1841 1842 1843 1844
    PNG_TRANSFORM_PACKING       Expand 1, 2 and 4-bit
                                samples to bytes
    PNG_TRANSFORM_PACKSWAP      Change order of packed
                                pixels to LSB first
1845 1846
    PNG_TRANSFORM_EXPAND        Perform set_expand()
    PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
1847 1848 1849 1850 1851 1852 1853 1854
    PNG_TRANSFORM_SHIFT         Normalize pixels to the
                                sBIT depth
    PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
                                to BGRA
    PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
                                to AG
    PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
                                to transparency
1855
    PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
1856 1857
    PNG_TRANSFORM_GRAY_TO_RGB   Expand grayscale samples
                                to RGB (or GA to RGBA)
1858
    PNG_TRANSFORM_EXPAND_16     Expand samples to 16 bits
1859 1860

(This excludes setting a background color, doing gamma transformation,
1861
quantizing, and setting filler.)  If this is the case, simply do this:
1862 1863 1864

    png_read_png(png_ptr, info_ptr, png_transforms, NULL)

1865 1866
where png_transforms is an integer containing the bitwise OR of some
set of transformation flags.  This call is equivalent to png_read_info(),
1867
followed the set of transformations indicated by the transform mask,
1868
then png_read_image(), and finally png_read_end().
1869

1870 1871 1872
(The final parameter of this call is not yet used.  Someday it might point
to transformation parameters required by some future input transform.)

1873 1874 1875
You must use png_transforms and not call any png_set_transform() functions
when you use png_read_png().

1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
After you have called png_read_png(), you can retrieve the image data
with

   row_pointers = png_get_rows(png_ptr, info_ptr);

where row_pointers is an array of pointers to the pixel data for each row:

   png_bytep row_pointers[height];

If you know your image size and pixel size ahead of time, you can allocate
row_pointers prior to calling png_read_png() with

1888
   if (height > PNG_UINT_32_MAX/png_sizeof(png_byte))
1889
      png_error (png_ptr,
1890 1891
          "Image is too tall to process in memory");

1892 1893
   if (width > PNG_UINT_32_MAX/pixel_size)
      png_error (png_ptr,
1894 1895
          "Image is too wide to process in memory");

1896
   row_pointers = png_malloc(png_ptr,
1897 1898
       height*png_sizeof(png_bytep));

1899 1900
   for (int i=0; i<height, i++)
      row_pointers[i]=NULL;  /* security precaution */
1901

1902
   for (int i=0; i<height, i++)
1903
      row_pointers[i]=png_malloc(png_ptr,
1904 1905
          width*pixel_size);

1906
   png_set_rows(png_ptr, info_ptr, &row_pointers);
1907 1908 1909 1910 1911 1912 1913 1914

Alternatively you could allocate your image in one big block and define
row_pointers[i] to point into the proper places in your block.

If you use png_set_rows(), the application is responsible for freeing
row_pointers (and row_pointers[i], if they were separately allocated).

If you don't allocate row_pointers ahead of time, png_read_png() will
1915
do it, and it'll be free'ed by libpng when you call png_destroy_*().
1916 1917 1918 1919 1920 1921

.SS The low-level read interface

If you are going the low-level route, you are now ready to read all
the file information up to the actual image data.  You do this with a
call to png_read_info().
1922 1923 1924

    png_read_info(png_ptr, info_ptr);

1925 1926
This will process all chunks up to but not including the image data.

1927 1928 1929 1930 1931 1932
This also copies some of the data from the PNG file into the decode structure
for use in later transformations.  Important information copied in is:

1) The PNG file gamma from the gAMA chunk.  This overwrites the default value
provided by an earlier call to png_set_gamma or png_set_alpha_mode.

1933
2) Prior to libpng-1.5.4 the background color from a bKGd chunk.  This
1934
damages the information provided by an earlier call to png_set_background
1935
resulting in unexpected behavior.  Libpng-1.5.4 no longer does this.
1936 1937 1938 1939 1940 1941 1942

3) The number of significant bits in each component value.  Libpng uses this to
optimize gamma handling by reducing the internal lookup table sizes.

4) The transparent color information from a tRNS chunk.  This can be modified by
a later call to png_set_tRNS.

1943
.SS Querying the info structure
1944

1945 1946 1947
Functions are used to get the information from the info_ptr once it
has been read.  Note that these fields may not be completely filled
in until png_read_end() has read the chunk data following the image.
1948 1949 1950

    png_get_IHDR(png_ptr, info_ptr, &width, &height,
       &bit_depth, &color_type, &interlace_type,
1951
       &compression_type, &filter_method);
1952 1953 1954

    width          - holds the width of the image
                     in pixels (up to 2^31).
1955

1956 1957
    height         - holds the height of the image
                     in pixels (up to 2^31).
1958

1959 1960 1961 1962 1963
    bit_depth      - holds the bit depth of one of the
                     image channels.  (valid values are
                     1, 2, 4, 8, 16 and depend also on
                     the color_type.  See also
                     significant bits (sBIT) below).
1964

1965 1966 1967 1968
    color_type     - describes which color/alpha channels
                         are present.
                     PNG_COLOR_TYPE_GRAY
                        (bit depths 1, 2, 4, 8, 16)
1969
                     PNG_COLOR_TYPE_GRAY_ALPHA
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
                        (bit depths 8, 16)
                     PNG_COLOR_TYPE_PALETTE
                        (bit depths 1, 2, 4, 8)
                     PNG_COLOR_TYPE_RGB
                        (bit_depths 8, 16)
                     PNG_COLOR_TYPE_RGB_ALPHA
                        (bit_depths 8, 16)

                     PNG_COLOR_MASK_PALETTE
                     PNG_COLOR_MASK_COLOR
                     PNG_COLOR_MASK_ALPHA

1982 1983 1984 1985 1986 1987
    interlace_type - (PNG_INTERLACE_NONE or
                     PNG_INTERLACE_ADAM7)

    compression_type - (must be PNG_COMPRESSION_TYPE_BASE
                     for PNG 1.0)

1988 1989 1990 1991 1992
    filter_method  - (must be PNG_FILTER_TYPE_BASE
                     for PNG 1.0, and can also be
                     PNG_INTRAPIXEL_DIFFERENCING if
                     the PNG datastream is embedded in
                     a MNG-1.0 datastream)
1993 1994

    Any or all of interlace_type, compression_type, or
1995 1996
    filter_method can be NULL if you are
    not interested in their values.
1997

1998 1999 2000 2001 2002 2003 2004 2005 2006
    Note that png_get_IHDR() returns 32-bit data into
    the application's width and height variables.
    This is an unsafe situation if these are 16-bit
    variables.  In such situations, the
    png_get_image_width() and png_get_image_height()
    functions described below are safer.

    width            = png_get_image_width(png_ptr,
                         info_ptr);
2007

2008 2009
    height           = png_get_image_height(png_ptr,
                         info_ptr);
2010

2011 2012
    bit_depth        = png_get_bit_depth(png_ptr,
                         info_ptr);
2013

2014 2015
    color_type       = png_get_color_type(png_ptr,
                         info_ptr);
2016

2017
    interlace_type   = png_get_interlace_type(png_ptr,
2018
                         info_ptr);
2019

2020 2021
    compression_type = png_get_compression_type(png_ptr,
                         info_ptr);
2022

2023
    filter_method    = png_get_filter_type(png_ptr,
2024 2025
                         info_ptr);

2026
    channels = png_get_channels(png_ptr, info_ptr);
2027

2028 2029 2030 2031
    channels       - number of channels of info for the
                     color type (valid values are 1 (GRAY,
                     PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
                     4 (RGB_ALPHA or RGB + filler byte))
2032

2033
    rowbytes = png_get_rowbytes(png_ptr, info_ptr);
2034

2035 2036 2037
    rowbytes       - number of bytes needed to hold a row

    signature = png_get_signature(png_ptr, info_ptr);
2038

2039 2040 2041
    signature      - holds the signature read from the
                     file (if any).  The data is kept in
                     the same offset it would be if the
2042
                     whole signature were read (i.e. if an
2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
                     application had already read in 4
                     bytes of signature before starting
                     libpng, the remaining 4 bytes would
                     be in signature[4] through signature[7]
                     (see png_set_sig_bytes())).

These are also important, but their validity depends on whether the chunk
has been read.  The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
data has been read, or zero if it is missing.  The parameters to the
2053 2054
png_get_<chunk> are set directly if they are simple data types, or a
pointer into the info_ptr is returned for any complex types.
2055 2056 2057

    png_get_PLTE(png_ptr, info_ptr, &palette,
                     &num_palette);
2058

2059 2060
    palette        - the palette for the file
                     (array of png_color)
2061

2062 2063
    num_palette    - number of entries in the palette

2064
    png_get_gAMA(png_ptr, info_ptr, &file_gamma);
2065
    png_get_gAMA_fixed(png_ptr, info_ptr, &int_file_gamma);
2066

2067 2068 2069 2070 2071
    file_gamma     - the gamma at which the file is
                     written (PNG_INFO_gAMA)

    int_file_gamma - 100,000 times the gamma at which the
                     file is written
2072 2073

    png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
2074

2075
    file_srgb_intent - the rendering intent (PNG_INFO_sRGB)
2076 2077 2078 2079 2080 2081
                     The presence of the sRGB chunk
                     means that the pixel data is in the
                     sRGB color space.  This chunk also
                     implies specific values of gAMA and
                     cHRM.

2082 2083
    png_get_iCCP(png_ptr, info_ptr, &name,
       &compression_type, &profile, &proflen);
2084

2085
    name             - The profile name.
2086

2087 2088 2089 2090
    compression_type - The compression type; always
                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
                       You may give NULL to this argument to
                       ignore it.
2091

2092 2093
    profile          - International Color Consortium color
                       profile data. May contain NULs.
2094

2095
    proflen          - length of profile data in bytes.
2096

2097
    png_get_sBIT(png_ptr, info_ptr, &sig_bit);
2098

2099 2100 2101 2102 2103 2104
    sig_bit        - the number of significant bits for
                     (PNG_INFO_sBIT) each of the gray,
                     red, green, and blue channels,
                     whichever are appropriate for the
                     given color type (png_color_16)

2105 2106
    png_get_tRNS(png_ptr, info_ptr, &trans_alpha,
                     &num_trans, &trans_color);
2107

2108 2109
    trans_alpha    - array of alpha (transparency)
                     entries for palette (PNG_INFO_tRNS)
2110

2111 2112
    num_trans      - number of transparent entries
                     (PNG_INFO_tRNS)
2113

2114
    trans_color    - graylevel or color sample values of
2115 2116
                     the single transparent color for
                     non-paletted images (PNG_INFO_tRNS)
2117 2118 2119

    png_get_hIST(png_ptr, info_ptr, &hist);
                     (PNG_INFO_hIST)
2120

2121
    hist           - histogram of palette (array of
2122
                     png_uint_16)
2123 2124

    png_get_tIME(png_ptr, info_ptr, &mod_time);
2125

2126 2127 2128 2129
    mod_time       - time image was last modified
                    (PNG_VALID_tIME)

    png_get_bKGD(png_ptr, info_ptr, &background);
2130

2131 2132
    background     - background color (of type
                     png_color_16p) (PNG_VALID_bKGD)
2133 2134
                     valid 16-bit red, green and blue
                     values, regardless of color_type
2135

2136 2137
    num_comments   = png_get_text(png_ptr, info_ptr,
                     &text_ptr, &num_text);
2138

2139
    num_comments   - number of comments
2140

2141 2142
    text_ptr       - array of png_text holding image
                     comments
2143

2144
    text_ptr[i].compression - type of compression used
2145 2146 2147 2148
                 on "text" PNG_TEXT_COMPRESSION_NONE
                           PNG_TEXT_COMPRESSION_zTXt
                           PNG_ITXT_COMPRESSION_NONE
                           PNG_ITXT_COMPRESSION_zTXt
2149

2150 2151
    text_ptr[i].key   - keyword for comment.  Must contain
                         1-79 characters.
2152

2153
    text_ptr[i].text  - text comments for current
2154
                         keyword.  Can be empty.
2155

2156
    text_ptr[i].text_length - length of text string,
2157
                 after decompression, 0 for iTXt
2158

2159
    text_ptr[i].itxt_length - length of itxt string,
2160
                 after decompression, 0 for tEXt/zTXt
2161

2162 2163
    text_ptr[i].lang  - language of comment (empty
                         string for unknown).
2164

2165
    text_ptr[i].lang_key  - keyword in UTF-8
2166
                         (empty string for unknown).
2167

2168 2169 2170 2171
    Note that the itxt_length, lang, and lang_key
    members of the text_ptr structure only exist
    when the library is built with iTXt chunk support.

2172 2173 2174
    num_text       - number of comments (same as
                     num_comments; you can put NULL here
                     to avoid the duplication)
2175

2176 2177 2178 2179 2180 2181 2182 2183
    Note while png_set_text() will accept text, language,
    and translated keywords that can be NULL pointers, the
    structure returned by png_get_text will always contain
    regular zero-terminated C strings.  They might be
    empty strings but they will never be NULL pointers.

    num_spalettes = png_get_sPLT(png_ptr, info_ptr,
       &palette_ptr);
2184 2185 2186

    num_spalettes  - number of sPLT chunks read.

2187
    palette_ptr    - array of palette structures holding
2188 2189
                     contents of one or more sPLT chunks
                     read.
2190

2191
    png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
2192
       &unit_type);
2193

2194 2195
    offset_x       - positive offset from the left edge
                     of the screen
2196

2197 2198
    offset_y       - positive offset from the top edge
                     of the screen
2199

2200 2201 2202
    unit_type      - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER

    png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
2203
       &unit_type);
2204

2205 2206
    res_x          - pixels/unit physical resolution in
                     x direction
2207

2208 2209
    res_y          - pixels/unit physical resolution in
                     x direction
2210

2211
    unit_type      - PNG_RESOLUTION_UNKNOWN,
2212 2213
                     PNG_RESOLUTION_METER

2214 2215
    png_get_sCAL(png_ptr, info_ptr, &unit, &width,
       &height)
2216

2217
    unit        - physical scale units (an integer)
2218

2219
    width       - width of a pixel in physical scale units
2220

2221
    height      - height of a pixel in physical scale units
2222 2223
                 (width and height are doubles)

2224 2225
    png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
       &height)
2226

2227
    unit        - physical scale units (an integer)
2228

2229
    width       - width of a pixel in physical scale units
2230

2231 2232
    height      - height of a pixel in physical scale units
                 (width and height are strings like "2.54")
2233

2234 2235
    num_unknown_chunks = png_get_unknown_chunks(png_ptr,
       info_ptr, &unknowns)
2236

2237 2238
    unknowns          - array of png_unknown_chunk
                        structures holding unknown chunks
2239

2240
    unknowns[i].name  - name of unknown chunk
2241

2242
    unknowns[i].data  - data of unknown chunk
2243

2244
    unknowns[i].size  - size of unknown chunk's data
2245

2246
    unknowns[i].location - position of chunk in file
2247

2248 2249 2250
    The value of "i" corresponds to the order in which the
    chunks were read from the PNG file or inserted with the
    png_set_unknown_chunks() function.
2251

2252 2253 2254
The data from the pHYs chunk can be retrieved in several convenient
forms:

2255
    res_x = png_get_x_pixels_per_meter(png_ptr,
2256
       info_ptr)
2257

2258
    res_y = png_get_y_pixels_per_meter(png_ptr,
2259
       info_ptr)
2260

2261
    res_x_and_y = png_get_pixels_per_meter(png_ptr,
2262
       info_ptr)
2263

2264
    res_x = png_get_x_pixels_per_inch(png_ptr,
2265
       info_ptr)
2266

2267
    res_y = png_get_y_pixels_per_inch(png_ptr,
2268
       info_ptr)
2269

2270
    res_x_and_y = png_get_pixels_per_inch(png_ptr,
2271
       info_ptr)
2272

2273
    aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
2274
       info_ptr)
2275

2276
    Each of these returns 0 [signifying "unknown"] if
2277
       the data is not present or if res_x is 0;
2278 2279 2280 2281 2282 2283 2284 2285
       res_x_and_y is 0 if res_x != res_y

    Note that because of the way the resolutions are
       stored internally, the inch conversions won't
       come out to exactly even number.  For example,
       72 dpi is stored as 0.28346 pixels/meter, and
       when this is retrieved it is 71.9988 dpi, so
       be sure to round the returned value appropriately
2286
       if you want to display a reasonable-looking result.
2287

2288 2289 2290 2291
The data from the oFFs chunk can be retrieved in several convenient
forms:

    x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
2292

2293
    y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
2294

2295
    x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
2296

2297 2298
    y_offset = png_get_y_offset_inches(png_ptr, info_ptr);

2299
    Each of these returns 0 [signifying "unknown" if both
2300
       x and y are 0] if the data is not present or if the
2301 2302 2303 2304 2305
       chunk is present but the unit is the pixel.  The
       remark about inexact inch conversions applies here
       as well, because a value in inches can't always be
       converted to microns and back without some loss
       of precision.
2306

2307
For more information, see the
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
PNG specification for chunk contents.  Be careful with trusting
rowbytes, as some of the transformations could increase the space
needed to hold a row (expand, filler, gray_to_rgb, etc.).
See png_read_update_info(), below.

A quick word about text_ptr and num_text.  PNG stores comments in
keyword/text pairs, one pair per chunk, with no limit on the number
of text chunks, and a 2^31 byte limit on their size.  While there are
suggested keywords, there is no requirement to restrict the use to these
strings.  It is strongly suggested that keywords and text be sensible
to humans (that's the point), so don't use abbreviations.  Non-printing
symbols are not allowed.  See the PNG specification for more details.
There is also no requirement to have text after the keyword.

Keywords should be limited to 79 Latin-1 characters without leading or
trailing spaces, but non-consecutive spaces are allowed within the
keyword.  It is possible to have the same keyword any number of times.
2325 2326
The text_ptr is an array of png_text structures, each holding a
pointer to a language string, a pointer to a keyword and a pointer to
2327 2328
a text string.  The text string, language code, and translated
keyword may be empty or NULL pointers.  The keyword/text
2329 2330 2331 2332 2333
pairs are put into the array in the order that they are received.
However, some or all of the text chunks may be after the image, so, to
make sure you have read all the text chunks, don't mess with these
until after you read the stuff after the image.  This will be
mentioned again below in the discussion that goes with png_read_end().
2334

2335 2336
.SS Input transformations

2337 2338 2339 2340 2341
After you've read the header information, you can set up the library
to handle any special transformations of the image data.  The various
ways to transform the data will be described in the order that they
should occur.  This is important, as some of these change the color
type and/or bit depth of the data, and some others only work on
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
certain color types and bit depths.

Transformations you request are ignored if they don't have any meaning for a
particular input data format.  However some transformations can have an effect
as a result of a previous transformation.  If you specify a contradictory set of
transformations, for example both adding and removing the alpha channel, you
cannot predict the final result.

The color used for the transparency values should be supplied in the same
format/depth as the current image data.  It is stored in the same format/depth
as the image data in a tRNS chunk, so this is what libpng expects for this data.
2353

2354 2355
The color used for the background value depends on the need_expand argument as
described below.
2356 2357 2358 2359 2360 2361

Data will be decoded into the supplied row buffers packed into bytes
unless the library has been told to transform it into another format.
For example, 4 bit/pixel paletted or grayscale data will be returned
2 pixels/byte with the leftmost pixel in the high-order bits of the
byte, unless png_set_packing() is called.  8-bit RGB data will be stored
2362 2363 2364
in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
is called to insert filler bytes, either before or after each RGB triplet.
16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
2365
byte of the color value first, unless png_set_scale_16() is called to
2366 2367 2368
transform it to regular RGB RGB triplets, or png_set_filler() or
png_set_add alpha() is called to insert filler bytes, either before or
after each RRGGBB triplet.  Similarly, 8-bit or 16-bit grayscale data can
2369 2370
be modified with png_set_filler(), png_set_add_alpha(), png_set_strip_16(),
or png_set_scale_16().
2371 2372 2373 2374 2375 2376 2377

The following code transforms grayscale images of less than 8 to 8 bits,
changes paletted images to RGB, and adds a full alpha channel if there is
transparency information in a tRNS chunk.  This is most useful on
grayscale images with bit depths of 2 or 4 or if there is a multiple-image
viewing application that wishes to treat all images in the same way.

2378 2379
    if (color_type == PNG_COLOR_TYPE_PALETTE)
        png_set_palette_to_rgb(png_ptr);
2380 2381

    if (png_get_valid(png_ptr, info_ptr,
2382 2383
        PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);

2384 2385 2386 2387
    if (color_type == PNG_COLOR_TYPE_GRAY &&
        bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);

The first two functions are actually aliases for png_set_expand(), added
2388 2389 2390
in libpng version 1.0.4, with the function names expanded to improve code
readability.  In some future version they may actually do different
things.
2391

2392 2393
As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
added.  It expands the sample depth without changing tRNS to alpha.
2394

2395
As of libpng version 1.5.2, png_set_expand_16() was added.  It behaves as
2396 2397
png_set_expand(), however, the resultant channels have 16 bits rather than 8.
Use this when the output color or gray channels are made linear to avoid fairly
2398
severe accuracy loss.
2399

2400 2401
   if (bit_depth < 16)
      png_set_expand_16(png_ptr);
2402

2403
PNG can have files with 16 bits per channel.  If you only can handle
2404
8 bits per channel, this will strip the pixels down to 8-bit.
2405 2406

    if (bit_depth == 16)
2407
       png_set_scale_16(png_ptr);
2408

2409 2410 2411
If you need to process the alpha channel on the image separately from the image
data (for example if you convert it to a bitmap mask) it is possible to have
libpng strip the channel leaving just RGB or gray data:
2412 2413

    if (color_type & PNG_COLOR_MASK_ALPHA)
2414
       png_set_strip_alpha(png_ptr);
2415

2416 2417 2418
If you strip the alpha channel you need to find some other way of dealing with
the information.  If, instead, you want to convert the image to an opaque
version with no alpha channel use png_set_background; see below.
2419 2420

As of libpng version 1.5.2, almost all useful expansions are supported, the
2421 2422
major ommissions are conversion of grayscale to indexed images (which can be
done trivially in the application) and conversion of indexed to grayscale (which
2423 2424 2425 2426 2427 2428 2429
can be done by a trivial manipulation of the palette.)

In the following table, the 01 means grayscale with depth<8, 31 means
indexed with depth<8, other numerals represent the color type, "T" means
the tRNS chunk is present, A means an alpha channel is present, and O
means tRNS or alpha is present but all pixels in the image are opaque.

2430
  FROM  01  31   0  0T  0O   2  2T  2O   3  3T  3O  4A  4O  6A  6O
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
   TO
   01    -  [G]  -   -   -   -   -   -   -   -   -   -   -   -   -
   31   [Q]  Q  [Q] [Q] [Q]  Q   Q   Q   Q   Q   Q  [Q] [Q]  Q   Q
    0    1   G   +   .   .   G   G   G   G   G   G   B   B  GB  GB
   0T    lt  Gt  t   +   .   Gt  G   G   Gt  G   G   Bt  Bt GBt GBt
   0O    lt  Gt  t   .   +   Gt  Gt  G   Gt  Gt  G   Bt  Bt GBt GBt
    2    C   P   C   C   C   +   .   .   C   -   -  CB  CB   B   B
   2T    Ct  -   Ct  C   C   t   +   t   -   -   -  CBt CBt  Bt  Bt
   2O    Ct  -   Ct  C   C   t   t   +   -   -   -  CBt CBt  Bt  Bt
    3   [Q]  p  [Q] [Q] [Q]  Q   Q   Q   +   .   .  [Q] [Q]  Q   Q
   3T   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   +   t  [Qt][Qt] Qt  Qt
   3O   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   t   +  [Qt][Qt] Qt  Qt
   4A    lA  G   A   T   T   GA  GT  GT  GA  GT  GT  +   BA  G  GBA
   4O    lA GBA  A   T   T   GA  GT  GT  GA  GT  GT  BA  +  GBA  G
   6A    CA  PA  CA  C   C   A   T  tT   PA  P   P   C  CBA  +   BA
   6O    CA PBA  CA  C   C   A  tT   T   PA  P   P  CBA  C   BA  +

Within the matrix,
     "+" identifies entries where 'from' and 'to' are the same.
     "-" means the transformation is not supported.
     "." means nothing is necessary (a tRNS chunk can just be ignored).
     "t" means the transformation is obtained by png_set_tRNS.
     "A" means the transformation is obtained by png_set_add_alpha().
     "X" means the transformation is obtained by png_set_expand().
     "1" means the transformation is obtained by
         png_set_expand_gray_1_2_4_to_8() (and by png_set_expand() if there
         is no transparency in the original or the final format).
     "C" means the transformation is obtained by png_set_gray_to_rgb().
2459
     "G" means the transformation is obtained by png_set_rgb_to_gray().
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473
     "P" means the transformation is obtained by
         png_set_expand_palette_to_rgb().
     "p" means the transformation is obtained by png_set_packing().
     "Q" means the transformation is obtained by png_set_quantize().
     "T" means the transformation is obtained by png_set_tRNS_to_alpha().
     "B" means the transformation is obtained by png_set_background(), or
         png_strip_alpha().

When an entry has multiple transforms listed all are required to cause the
right overall transformation.  When two transforms are separated by a comma
either will do the job.  When transforms are enclosed in [] the transform should
do the job but this is currently unimplemented - a different format will result
if the suggested transformations are used.

2474 2475 2476 2477 2478 2479 2480 2481 2482
In PNG files, the alpha channel in an image
is the level of opacity.  If you need the alpha channel in an image to
be the level of transparency instead of opacity, you can invert the
alpha channel (or the tRNS chunk data) after it's read, so that 0 is
fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
images) is fully transparent, with

    png_set_invert_alpha(png_ptr);

2483 2484 2485 2486 2487 2488
PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
they can, resulting in, for example, 8 pixels per byte for 1 bit
files.  This code expands to 1 pixel per byte without changing the
values of the pixels:

    if (bit_depth < 8)
2489
       png_set_packing(png_ptr);
2490 2491 2492

PNG files have possible bit depths of 1, 2, 4, 8, and 16.  All pixels
stored in a PNG image have been "scaled" or "shifted" up to the next
2493 2494 2495 2496
higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
to 8 bits/sample in the range [0, 255]).  However, it is also possible
to convert the PNG pixel data back to the original bit depth of the
image.  This call reduces the pixels back down to the original bit depth:
2497

2498
    png_color_8p sig_bit;
2499 2500

    if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
2501
       png_set_shift(png_ptr, sig_bit);
2502 2503 2504 2505 2506 2507

PNG files store 3-color pixels in red, green, blue order.  This code
changes the storage of the pixels to blue, green, red:

    if (color_type == PNG_COLOR_TYPE_RGB ||
        color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2508
       png_set_bgr(png_ptr);
2509

2510 2511
PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
into 4 or 8 bytes for windowing systems that need them in this format:
2512

2513
    if (color_type == PNG_COLOR_TYPE_RGB)
2514
       png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
2515

2516
where "filler" is the 8 or 16-bit number to fill with, and the location is
2517 2518
either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
you want the filler before the RGB or after.  This transformation
2519 2520 2521
does not affect images that already have full alpha channels.  To add an
opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER which
will generate RGBA pixels.
2522

2523 2524 2525 2526
Note that png_set_filler() does not change the color type.  If you want
to do that, you can add a true alpha channel with

    if (color_type == PNG_COLOR_TYPE_RGB ||
2527 2528
       color_type == PNG_COLOR_TYPE_GRAY)
       png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
2529 2530

where "filler" contains the alpha value to assign to each pixel.
2531
This function was added in libpng-1.2.7.
2532

2533 2534 2535 2536
If you are reading an image with an alpha channel, and you need the
data as ARGB instead of the normal PNG format RGBA:

    if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2537
       png_set_swap_alpha(png_ptr);
2538 2539 2540 2541 2542 2543

For some uses, you may want a grayscale image to be represented as
RGB.  This code will do that conversion:

    if (color_type == PNG_COLOR_TYPE_GRAY ||
        color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
2544
       png_set_gray_to_rgb(png_ptr);
2545

2546
Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
2547
with alpha.
2548 2549 2550

    if (color_type == PNG_COLOR_TYPE_RGB ||
        color_type == PNG_COLOR_TYPE_RGB_ALPHA)
2551 2552
       png_set_rgb_to_gray(png_ptr, error_action, double red_weight,
          double green_weight);
2553 2554

    error_action = 1: silently do the conversion
2555

2556 2557 2558
    error_action = 2: issue a warning if the original
                      image has any pixel where
                      red != green or red != blue
2559

2560 2561 2562 2563 2564
    error_action = 3: issue an error and abort the
                      conversion if the original
                      image has any pixel where
                      red != green or red != blue

2565
    red_weight:       weight of red component
2566

2567
    green_weight:     weight of green component
2568
                      If either weight is negative, default
2569 2570 2571 2572 2573 2574 2575
                      weights are used.

In the corresponding fixed point API the red_weight and green_weight values are
simply scaled by 100,000:

    png_set_rgb_to_gray(png_ptr, error_action, png_fixed_point red_weight,
       png_fixed_point green_weight);
2576 2577 2578 2579 2580

If you have set error_action = 1 or 2, you can
later check whether the image really was gray, after processing
the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
It will return a png_byte that is zero if the image was gray or
2581
1 if there were any non-gray pixels.  Background and sBIT data
2582
will be silently converted to grayscale, using the green channel
2583
data for sBIT, regardless of the error_action setting.
2584

2585 2586 2587 2588
The default values come from the PNG file cHRM chunk if present, otherwise the
defaults correspond to the ITU-R recommendation 709, and also the sRGB color
space, as recommended in the Charles Poynton's Colour FAQ,
<http://www.poynton.com/>, in section 9:
2589

2590
   <http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC9>
2591 2592 2593 2594

    Y = 0.212671 * R + 0.715160 * G + 0.072169 * B

The calculation is done in a linear colorspace, if the image gamma
2595
can be determined.
2596

2597 2598 2599
The png_set_background() function has been described already, it tells libpng to
composite images with alpha or simple transparency against the supplied
background color.  For compatibility with versions of libpng earlier than
2600
libpng-1.5.4 it is recommended that you call the function after reading the file
2601 2602 2603 2604 2605 2606
header, even if you don't want to use the color in a bKGD chunk, if one exists.

If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
you may use this color, or supply another color more suitable for
the current display (e.g., the background color from a web page).  You
need to tell libpng how the color is represented, both the format of the
2607
component values in the color (the number of bits) and the gamma encoding of the
2608
color.  The function takes two arguments, background_gamma_mode and need_expand
2609 2610
to convey this information, however only two combinations are likely to be
useful:
2611

2612 2613
    png_color_16 my_background;
    png_color_16p image_background;
2614

2615
    if (png_get_bKGD(png_ptr, info_ptr, &image_background))
2616
       png_set_background(png_ptr, image_background,
2617
           PNG_BACKGROUND_GAMMA_FILE, 1/*needs to be expanded*/, 1);
2618
    else
2619
       png_set_background(png_ptr, &my_background,
2620
           PNG_BACKGROUND_GAMMA_SCREEN, 0/*do not expand*/, 1);
2621

2622 2623
The second call was described above - my_background is in the format of the
final, display, output produced by libpng.  Because you now know the format of
2624 2625 2626 2627 2628
the PNG it is possible to avoid the need to choose either 8-bit or 16-bit
output and to retain palette images (the palette colors will be modified
appropriately and the tRNS chunk removed.)  However, if you are doing this,
take great care not to ask for transformations without checking first that
they apply!
2629

2630 2631 2632 2633
In the first call the background color has the original bit depth and color type
of the PNG file.  So, for palette images the color is supplied as a palette
index and for low bit greyscale images the color is a reduced bit value in
image_background->gray.
2634

2635 2636
If you didn't call png_set_gamma() before reading the file header, for example
if you need your code to remain compatible with older versions of libpng prior
2637
to libpng-1.5.4, this is the place to call it.
2638

2639 2640 2641 2642
Do not call it if you called png_set_alpha_mode(); doing so will damage the
settings put in place by png_set_alpha_mode().  (If png_set_alpha_mode() is
supported then you can certainly do png_set_gamma() before reading the PNG
header.)
2643

2644 2645 2646 2647 2648
This API unconditionally sets the screen and file gamma values, so it will
override the value in the PNG file unless it is called before the PNG file
reading starts.  For this reason you must always call it with the PNG file
value when you call it in this position:

2649 2650
   if (png_get_gAMA(png_ptr, info_ptr, &file_gamma))
      png_set_gamma(png_ptr, screen_gamma, file_gamma);
2651

2652
   else
2653
      png_set_gamma(png_ptr, screen_gamma, 0.45455);
2654

2655 2656
If you need to reduce an RGB file to a paletted file, or if a paletted
file has more entries then will fit on your screen, png_set_quantize()
2657
will do that.  Note that this is a simple match quantization that merely
2658
finds the closest color available.  This should work fairly well with
2659
optimized palettes, but fairly badly with linear color cubes.  If you
2660 2661 2662 2663 2664 2665 2666 2667 2668
pass a palette that is larger then maximum_colors, the file will
reduce the number of colors in the palette so it will fit into
maximum_colors.  If there is a histogram, it will use it to make
more intelligent choices when reducing the palette.  If there is no
histogram, it may not do as good a job.

   if (color_type & PNG_COLOR_MASK_COLOR)
   {
      if (png_get_valid(png_ptr, info_ptr,
2669
          PNG_INFO_PLTE))
2670 2671 2672 2673
      {
         png_uint_16p histogram = NULL;

         png_get_hIST(png_ptr, info_ptr,
2674
             &histogram);
2675 2676 2677
         png_set_quantize(png_ptr, palette, num_palette,
            max_screen_colors, histogram, 1);
      }
2678

2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
      else
      {
         png_color std_color_cube[MAX_SCREEN_COLORS] =
            { ... colors ... };

         png_set_quantize(png_ptr, std_color_cube,
            MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
            NULL,0);
      }
   }

2690 2691 2692 2693
PNG files describe monochrome as black being zero and white being one.
The following code will reverse this (make black be one and white be
zero):

2694 2695 2696 2697 2698 2699
   if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
      png_set_invert_mono(png_ptr);

This function can also be used to invert grayscale and gray-alpha images:

   if (color_type == PNG_COLOR_TYPE_GRAY ||
2700
       color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
2701 2702
      png_set_invert_mono(png_ptr);

2703
PNG files store 16-bit pixels in network byte order (big-endian,
2704 2705
ie. most significant bits first).  This code changes the storage to the
other way (little-endian, i.e. least significant bits first, the
2706 2707 2708
way PCs store them):

    if (bit_depth == 16)
2709
       png_set_swap(png_ptr);
2710 2711 2712 2713 2714 2715 2716

If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
need to change the order the pixels are packed into bytes, you can use:

    if (bit_depth < 8)
       png_set_packswap(png_ptr);

2717 2718 2719 2720 2721
Finally, you can write your own transformation function if none of
the existing ones meets your needs.  This is done by setting a callback
with

    png_set_read_user_transform_fn(png_ptr,
2722
        read_transform_fn);
2723 2724 2725

You must supply the function

2726
    void read_transform_fn(png_structp png_ptr, png_row_infop
2727
        row_info, png_bytep data)
2728 2729

See pngtest.c for a working example.  Your function will be called
2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743
after all of the other transformations have been processed.  Take care with
interlaced images if you do the interlace yourself - the width of the row is the
width in 'row_info', not the overall image width.

If supported libpng provides two information routines that you can use to find
where you are in processing the image:

   png_get_current_pass_number(png_structp png_ptr);
   png_get_current_row_number(png_structp png_ptr);

Don't try using these outside a transform callback - firstly they are only
supported if user transforms are supported, secondly they may well return
unexpected results unless the row is actually being processed at the moment they
are called.
2744

2745 2746 2747 2748 2749 2750 2751 2752
With interlaced
images the value returned is the row in the input sub-image image.  Use
PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).

The discussion of interlace handling above contains more information on how to
use these values.

2753 2754 2755 2756 2757 2758
You can also set up a pointer to a user structure for use by your
callback function, and you can inform libpng that your transform
function will change the number of channels or bit depth with the
function

    png_set_user_transform_info(png_ptr, user_ptr,
2759
        user_depth, user_channels);
2760 2761 2762 2763 2764 2765 2766 2767

The user's application, not libpng, is responsible for allocating and
freeing any memory required for the user structure.

You can retrieve the pointer via the function
png_get_user_transform_ptr().  For example:

    voidp read_user_transform_ptr =
2768
        png_get_user_transform_ptr(png_ptr);
2769

2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792
The last thing to handle is interlacing; this is covered in detail below,
but you must call the function here if you want libpng to handle expansion
of the interlaced image.

    number_of_passes = png_set_interlace_handling(png_ptr);

After setting the transformations, libpng can update your png_info
structure to reflect any transformations you've requested with this
call.  This is most useful to update the info structure's rowbytes
field so you can use it to allocate your image memory.  This function
will also update your palette with the correct screen_gamma and
background if these have been given with the calls above.

    png_read_update_info(png_ptr, info_ptr);

After you call png_read_update_info(), you can allocate any
memory you need to hold the image.  The row data is simply
raw byte data for all forms of images.  As the actual allocation
varies among applications, no example will be given.  If you
are allocating one large chunk, you will need to build an
array of pointers to each row, as it will be needed for some
of the functions below.

2793
Remember: Before you call png_read_update_info(), the png_get_
2794 2795 2796
functions return the values corresponding to the original PNG image.
After you call png_read_update_info the values refer to the image
that libpng will output.  Consequently you must call all the png_set_
2797 2798 2799
functions before you call png_read_update_info().  This is particularly
important for png_set_interlace_handling() - if you are going to call
png_read_update_info() you must call png_set_interlace_handling() before
2800 2801
it unless you want to receive interlaced output.

2802 2803
.SS Reading image data

2804 2805 2806 2807 2808 2809 2810
After you've allocated memory, you can read the image data.
The simplest way to do this is in one function call.  If you are
allocating enough memory to hold the whole image, you can just
call png_read_image() and libpng will read in all the image data
and put it in the memory area supplied.  You will need to pass in
an array of pointers to each row.

2811 2812 2813 2814
This function automatically handles interlacing, so you don't
need to call png_set_interlace_handling() (unless you call
png_read_update_info()) or call this function multiple times, or any
of that other stuff necessary with png_read_rows().
2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825

   png_read_image(png_ptr, row_pointers);

where row_pointers is:

   png_bytep row_pointers[height];

You can point to void or char or whatever you use for pixels.

If you don't want to read in the whole image at once, you can
use png_read_rows() instead.  If there is no interlacing (check
2826
interlace_type == PNG_INTERLACE_NONE), this is simple:
2827 2828

    png_read_rows(png_ptr, row_pointers, NULL,
2829
        number_of_rows);
2830 2831 2832 2833

where row_pointers is the same as in the png_read_image() call.

If you are doing this just one row at a time, you can do this with
2834
a single row_pointer instead of an array of row_pointers:
2835

2836
    png_bytep row_pointer = row;
2837
    png_read_row(png_ptr, row_pointer, NULL);
2838

2839 2840
If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
get somewhat harder.  The only current (PNG Specification version 1.2)
2841 2842
interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7);
a somewhat complicated 2D interlace scheme, known as Adam7, that
2843
breaks down an image into seven smaller images of varying size, based
2844 2845
on an 8x8 grid.  This number is defined (from libpng 1.5) as
PNG_INTERLACE_ADAM7_PASSES in png.h
2846 2847

libpng can fill out those images or it can give them to you "as is".
2848 2849
It is almost always better to have libpng handle the interlacing for you.
If you want the images filled out, there are two ways to do that.  The one
2850 2851 2852 2853 2854 2855 2856 2857 2858
mentioned in the PNG specification is to expand each pixel to cover
those pixels that have not been read yet (the "rectangle" method).
This results in a blocky image for the first pass, which gradually
smooths out as more pixels are read.  The other method is the "sparkle"
method, where pixels are drawn only in their final locations, with the
rest of the image remaining whatever colors they were initialized to
before the start of the read.  The first method usually looks better,
but tends to be slower, as there are more pixels to put in the rows.

2859 2860
If, as is likely, you want libpng to expand the images, call this before
calling png_start_read_image() or png_read_update_info():
2861

2862
    if (interlace_type == PNG_INTERLACE_ADAM7)
2863
       number_of_passes
2864 2865
           = png_set_interlace_handling(png_ptr);

2866 2867 2868 2869 2870 2871 2872
This will return the number of passes needed.  Currently, this is seven,
but may change if another interlace type is added.  This function can be
called even if the file is not interlaced, where it will return one pass.
You then need to read the whole image 'number_of_passes' times.  Each time
will distribute the pixels from the current pass to the correct place in
the output image, so you need to supply the same rows to png_read_rows in
each pass.
2873

2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
If you are not going to display the image after each pass, but are
going to wait until the entire image is read in, use the sparkle
effect.  This effect is faster and the end result of either method
is exactly the same.  If you are planning on displaying the image
after each pass, the "rectangle" effect is generally considered the
better looking one.

If you only want the "sparkle" effect, just call png_read_rows() as
normal, with the third parameter NULL.  Make sure you make pass over
the image number_of_passes times, and you don't change the data in the
rows between calls.  You can change the locations of the data, just
not the data.  Each pass only writes the pixels appropriate for that
pass, and assumes the data from previous passes is still valid.

    png_read_rows(png_ptr, row_pointers, NULL,
2889
        number_of_rows);
2890 2891 2892 2893 2894 2895

If you only want the first effect (the rectangles), do the same as
before except pass the row buffer in the third parameter, and leave
the second parameter NULL.

    png_read_rows(png_ptr, NULL, row_pointers,
2896
        number_of_rows);
2897

2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948
If you don't want libpng to handle the interlacing details, just call
png_read_rows() PNG_INTERLACE_ADAM7_PASSES times to read in all the images.
Each of the images is a valid image by itself, however you will almost
certainly need to distribute the pixels from each sub-image to the
correct place.  This is where everything gets very tricky.

If you want to retrieve the separate images you must pass the correct
number of rows to each successive call of png_read_rows().  The calculation
gets pretty complicated for small images, where some sub-images may
not even exist because either their width or height ends up zero.
libpng provides two macros to help you in 1.5 and later versions:

   png_uint_32 width = PNG_PASS_COLS(image_width, pass_number);
   png_uint_32 height = PNG_PASS_ROWS(image_height, pass_number);

Respectively these tell you the width and height of the sub-image
corresponding to the numbered pass.  'pass' is in in the range 0 to 6 -
this can be confusing because the specification refers to the same passes
as 1 to 7!  Be careful, you must check both the width and height before
calling png_read_rows() and not call it for that pass if either is zero.

You can, of course, read each sub-image row by row.  If you want to
produce optimal code to make a pixel-by-pixel transformation of an
interlaced image this is the best approach; read each row of each pass,
transform it, and write it out to a new interlaced image.

If you want to de-interlace the image yourself libpng provides further
macros to help that tell you where to place the pixels in the output image.
Because the interlacing scheme is rectangular - sub-image pixels are always
arranged on a rectangular grid - all you need to know for each pass is the
starting column and row in the output image of the first pixel plus the
spacing between each pixel.  As of libpng 1.5 there are four macros to
retrieve this information:

   png_uint_32 x = PNG_PASS_START_COL(pass);
   png_uint_32 y = PNG_PASS_START_ROW(pass);
   png_uint_32 xStep = 1U << PNG_PASS_COL_SHIFT(pass);
   png_uint_32 yStep = 1U << PNG_PASS_ROW_SHIFT(pass);

These allow you to write the obvious loop:

   png_uint_32 input_y = 0;
   png_uint_32 output_y = PNG_PASS_START_ROW(pass);

   while (output_y < output_image_height)
   {
      png_uint_32 input_x = 0;
      png_uint_32 output_x = PNG_PASS_START_COL(pass);

      while (output_x < output_image_width)
      {
2949 2950 2951
         image[output_y][output_x] =
             subimage[pass][input_y][input_x++];

2952 2953 2954 2955
         output_x += xStep;
      }

      ++input_y;
2956
      output_y += yStep;
2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
   }

Notice that the steps between successive output rows and columns are
returned as shifts.  This is possible because the pixels in the subimages
are always a power of 2 apart - 1, 2, 4 or 8 pixels - in the original
image.  In practice you may need to directly calculate the output coordinate
given an input coordinate.  libpng provides two further macros for this
purpose:

   png_uint_32 output_x = PNG_COL_FROM_PASS_COL(input_x, pass);
   png_uint_32 output_y = PNG_ROW_FROM_PASS_ROW(input_y, pass);

Finally a pair of macros are provided to tell you if a particular image
row or column appears in a given pass:

   int col_in_pass = PNG_COL_IN_INTERLACE_PASS(output_x, pass);
   int row_in_pass = PNG_ROW_IN_INTERLACE_PASS(output_y, pass);

Bear in mind that you will probably also need to check the width and height
of the pass in addition to the above to be sure the pass even exists!

With any luck you are convinced by now that you don't want to do your own
interlace handling.  In reality normally the only good reason for doing this
is if you are processing PNG files on a pixel-by-pixel basis and don't want
to load the whole file into memory when it is interlaced.

libpng includes a test program, pngvalid, that illustrates reading and
writing of interlaced images.  If you can't get interlacing to work in your
code and don't want to leave it to libpng (the recommended approach) see
how pngvalid.c does it.

2988 2989
.SS Finishing a sequential read

2990 2991
After you are finished reading the image through the
low-level interface, you can finish reading the file.  If you are
2992 2993 2994
interested in comments or time, which may be stored either before or
after the image data, you should pass the separate png_info struct if
you want to keep the comments from before and after the image
2995 2996 2997 2998 2999 3000 3001 3002 3003 3004
separate.

    png_infop end_info = png_create_info_struct(png_ptr);

    if (!end_info)
    {
       png_destroy_read_struct(&png_ptr, &info_ptr,
           (png_infopp)NULL);
       return (ERROR);
    }
3005 3006 3007

   png_read_end(png_ptr, end_info);

3008 3009 3010 3011 3012
If you are not interested, you should still call png_read_end()
but you can pass NULL, avoiding the need to create an end_info structure.

   png_read_end(png_ptr, (png_infop)NULL);

3013 3014 3015 3016 3017
If you don't call png_read_end(), then your file pointer will be
left pointing to the first chunk after the last IDAT, which is probably
not what you want if you expect to read something beyond the end of
the PNG datastream.

3018 3019 3020 3021 3022
When you are done, you can free all memory allocated by libpng like this:

   png_destroy_read_struct(&png_ptr, &info_ptr,
       &end_info);

3023 3024 3025 3026 3027
or, if you didn't create an end_info structure,

   png_destroy_read_struct(&png_ptr, &info_ptr,
       (png_infopp)NULL);

3028
It is also possible to individually free the info_ptr members that
3029
point to libpng-allocated storage with the following function:
3030

3031
    png_free_data(png_ptr, info_ptr, mask, seq)
3032

3033
    mask - identifies data to be freed, a mask
3034
           containing the bitwise OR of one or
3035 3036 3037 3038 3039 3040 3041
           more of
             PNG_FREE_PLTE, PNG_FREE_TRNS,
             PNG_FREE_HIST, PNG_FREE_ICCP,
             PNG_FREE_PCAL, PNG_FREE_ROWS,
             PNG_FREE_SCAL, PNG_FREE_SPLT,
             PNG_FREE_TEXT, PNG_FREE_UNKN,
           or simply PNG_FREE_ALL
3042

3043
    seq  - sequence number of item to be freed
3044
           (-1 for all items)
3045

3046
This function may be safely called when the relevant storage has
3047
already been freed, or has not yet been allocated, or was allocated
3048 3049 3050 3051 3052
by the user and not by libpng,  and will in those cases do nothing.
The "seq" parameter is ignored if only one item of the selected data
type, such as PLTE, is allowed.  If "seq" is not -1, and multiple items
are allowed for the data type identified in the mask, such as text or
sPLT, only the n'th item in the structure is freed, where n is "seq".
3053

3054 3055
The default behavior is only to free data that was allocated internally
by libpng.  This can be changed, so that libpng will not free the data,
3056 3057
or so that it will free data that was allocated by the user with png_malloc()
or png_zalloc() and passed in via a png_set_*() function, with
3058 3059

    png_data_freer(png_ptr, info_ptr, freer, mask)
3060

3061 3062 3063 3064
    freer  - one of
               PNG_DESTROY_WILL_FREE_DATA
               PNG_SET_WILL_FREE_DATA
               PNG_USER_WILL_FREE_DATA
3065

3066 3067 3068
    mask   - which data elements are affected
             same choices as in png_free_data()

3069 3070 3071 3072 3073
This function only affects data that has already been allocated.
You can call this function after reading the PNG data but before calling
any png_set_*() functions, to control whether the user or the png_set_*()
function is responsible for freeing any existing data that might be present,
and again after the png_set_*() functions to control whether the user
3074 3075
or png_destroy_*() is supposed to free the data.  When the user assumes
responsibility for libpng-allocated data, the application must use
3076 3077
png_free() to free it, and when the user transfers responsibility to libpng
for data that the user has allocated, the user must have used png_malloc()
3078
or png_zalloc() to allocate it.
3079 3080 3081 3082 3083

If you allocated your row_pointers in a single block, as suggested above in
the description of the high level read interface, you must not transfer
responsibility for freeing it to the png_set_rows or png_read_destroy function,
because they would also try to free the individual row_pointers[i].
3084

3085 3086 3087 3088 3089 3090 3091
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
separately, do not transfer responsibility for freeing text_ptr to libpng,
because when libpng fills a png_text structure it combines these members with
the key member, and png_free_data() will free only text_ptr.key.  Similarly,
if you transfer responsibility for free'ing text_ptr from libpng to your
application, your application must not separately free those members.

3092
The png_free_data() function will turn off the "valid" flag for anything
3093 3094
it frees.  If you need to turn the flag off for a chunk that was freed by
your application instead of by libpng, you can use
3095 3096

    png_set_invalid(png_ptr, info_ptr, mask);
3097

3098
    mask - identifies the chunks to be made invalid,
3099
           containing the bitwise OR of one or
3100
           more of
3101 3102 3103 3104 3105 3106 3107 3108 3109
             PNG_INFO_gAMA, PNG_INFO_sBIT,
             PNG_INFO_cHRM, PNG_INFO_PLTE,
             PNG_INFO_tRNS, PNG_INFO_bKGD,
             PNG_INFO_hIST, PNG_INFO_pHYs,
             PNG_INFO_oFFs, PNG_INFO_tIME,
             PNG_INFO_pCAL, PNG_INFO_sRGB,
             PNG_INFO_iCCP, PNG_INFO_sPLT,
             PNG_INFO_sCAL, PNG_INFO_IDAT

3110 3111
For a more compact example of reading a PNG image, see the file example.c.

3112
.SS Reading PNG files progressively
3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134

The progressive reader is slightly different then the non-progressive
reader.  Instead of calling png_read_info(), png_read_rows(), and
png_read_end(), you make one call to png_process_data(), which calls
callbacks when it has the info, a row, or the end of the image.  You
set up these callbacks with png_set_progressive_read_fn().  You don't
have to worry about the input/output functions of libpng, as you are
giving the library the data directly in png_process_data().  I will
assume that you have read the section on reading PNG files above,
so I will only highlight the differences (although I will show
all of the code).

png_structp png_ptr;
png_infop info_ptr;

 /*  An example code fragment of how you would
     initialize the progressive reader in your
     application. */
 int
 initialize_png_reader()
 {
    png_ptr = png_create_read_struct
3135
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
3136
         user_error_fn, user_warning_fn);
3137

3138
    if (!png_ptr)
3139
        return (ERROR);
3140

3141
    info_ptr = png_create_info_struct(png_ptr);
3142

3143 3144
    if (!info_ptr)
    {
3145 3146 3147
       png_destroy_read_struct(&png_ptr,
          (png_infopp)NULL, (png_infopp)NULL);
       return (ERROR);
3148 3149
    }

3150
    if (setjmp(png_jmpbuf(png_ptr)))
3151
    {
3152 3153 3154
       png_destroy_read_struct(&png_ptr, &info_ptr,
          (png_infopp)NULL);
       return (ERROR);
3155 3156 3157 3158 3159 3160
    }

    /* This one's new.  You can provide functions
       to be called when the header info is valid,
       when each row is completed, and when the image
       is finished.  If you aren't using all functions,
3161 3162 3163
       you can specify NULL parameters.  Even when all
       three functions are NULL, you need to call
       png_set_progressive_read_fn().  You can use
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
       any struct as the user_ptr (cast to a void pointer
       for the function call), and retrieve the pointer
       from inside the callbacks using the function

          png_get_progressive_ptr(png_ptr);

       which will return a void pointer, which you have
       to cast appropriately.
     */
    png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
        info_callback, row_callback, end_callback);

    return 0;
 }

 /* A code fragment that you call as you receive blocks
   of data */
 int
 process_data(png_bytep buffer, png_uint_32 length)
 {
3184
    if (setjmp(png_jmpbuf(png_ptr)))
3185
    {
3186
       png_destroy_read_struct(&png_ptr, &info_ptr,
3187
           (png_infopp)NULL);
3188
       return (ERROR);
3189 3190 3191 3192 3193 3194
    }

    /* This one's new also.  Simply give it a chunk
       of data from the file stream (in order, of
       course).  On machines with segmented memory
       models machines, don't give it any more than
3195
       64K.  The library seems to run fine with sizes
3196 3197 3198 3199 3200 3201
       of 4K. Although you can give it much less if
       necessary (I assume you can give it chunks of
       1 byte, I haven't tried less then 256 bytes
       yet).  When this function returns, you may
       want to display any rows that were generated
       in the row callback if you don't already do
3202
       so there.
3203 3204
     */
    png_process_data(png_ptr, info_ptr, buffer, length);
3205 3206 3207 3208 3209 3210

    /* At this point you can call png_process_data_skip if
       you want to handle data the library will skip yourself;
       it simply returns the number of bytes to skip (and stops
       libpng skipping that number of bytes on the next
       png_process_data call).
3211 3212 3213 3214
    return 0;
 }

 /* This function is called (as set by
3215
    png_set_progressive_read_fn() above) when enough data
3216 3217 3218 3219
    has been supplied so all of the header has been
    read.
 */
 void
3220
 info_callback(png_structp png_ptr, png_infop info)
3221 3222 3223 3224 3225 3226 3227 3228 3229 3230
 {
    /* Do any setup here, including setting any of
       the transformations mentioned in the Reading
       PNG files section.  For now, you _must_ call
       either png_start_read_image() or
       png_read_update_info() after all the
       transformations are set (even if you don't set
       any).  You may start getting rows before
       png_process_data() returns, so this is your
       last chance to prepare for that.
3231 3232 3233

       This is where you turn on interlace handling,
       assuming you don't want to do it yourself.
3234 3235 3236 3237 3238 3239 3240 3241 3242 3243

       If you need to you can stop the processing of
       your original input data at this point by calling
       png_process_data_pause.  This returns the number
       of unprocessed bytes from the last png_process_data
       call - it is up to you to ensure that the next call
       sees these bytes again.  If you don't want to bother
       with this you can get libpng to cache the unread
       bytes by setting the 'save' parameter (see png.h) but
       then libpng will have to copy the data internally.
3244 3245 3246 3247 3248 3249 3250
     */
 }

 /* This function is called when each row of image
    data is complete */
 void
 row_callback(png_structp png_ptr, png_bytep new_row,
3251
    png_uint_32 row_num, int pass)
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263
 {
    /* If the image is interlaced, and you turned
       on the interlace handler, this function will
       be called for every row in every pass.  Some
       of these rows will not be changed from the
       previous pass.  When the row is not changed,
       the new_row variable will be NULL.  The rows
       and passes are called in order, so you don't
       really need the row_num and pass, but I'm
       supplying them because it may make your life
       easier.

3264 3265 3266 3267 3268 3269 3270 3271 3272
       If you did not turn on interlace handling then
       the callback is called for each row of each
       sub-image when the image is interlaced.  In this
       case 'row_num' is the row in the sub-image, not
       the row in the output image as it is in all other
       cases.

       For the non-NULL rows of interlaced images when
       you have switched on libpng interlace handling,
3273 3274 3275 3276 3277 3278
       you must call png_progressive_combine_row()
       passing in the row and the old row.  You can
       call this function for NULL rows (it will just
       return) and for non-interlaced images (it just
       does the memcpy for you) if it will make the
       code easier.  Thus, you can just do this for
3279
       all cases if you switch on interlace handling;
3280 3281 3282 3283 3284 3285
     */

        png_progressive_combine_row(png_ptr, old_row,
          new_row);

    /* where old_row is what was displayed for
3286 3287
       previously for the row.  Note that the first
       pass (pass == 0, really) will completely cover
3288 3289 3290 3291 3292
       the old row, so the rows do not have to be
       initialized.  After the first pass (and only
       for interlaced images), you will have to pass
       the current row, and the function will combine
       the old row and the new row.
3293 3294 3295

       You can also call png_process_data_pause in this
       callback - see above.
3296
    */
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313
 }

 void
 end_callback(png_structp png_ptr, png_infop info)
 {
    /* This function is called after the whole image
       has been read, including any chunks after the
       image (up to and including the IEND).  You
       will usually have the same info chunk as you
       had in the header, although some data may have
       been added to the comments and time fields.

       Most people won't do much here, perhaps setting
       a flag that marks the image as finished.
     */
 }

3314 3315


3316
.SH IV. Writing
3317 3318 3319 3320 3321

Much of this is very similar to reading.  However, everything of
importance is repeated here, so you won't have to constantly look
back up in the reading section to understand writing.

3322 3323
.SS Setup

3324 3325 3326 3327
You will want to do the I/O initialization before you get into libpng,
so if it doesn't work, you don't have anything to undo. If you are not
using the standard I/O functions, you will need to replace them with
custom writing functions.  See the discussion under Customizing libpng.
3328

3329
    FILE *fp = fopen(file_name, "wb");
3330

3331
    if (!fp)
3332
       return (ERROR);
3333 3334 3335 3336

Next, png_struct and png_info need to be allocated and initialized.
As these can be both relatively large, you may not want to store these
on the stack, unless you have stack space to spare.  Of course, you
3337 3338 3339 3340
will want to check if they return NULL.  If you are also reading,
you won't want to name your read structure and your write structure
both "png_ptr"; you can call them anything you like, such as
"read_ptr" and "write_ptr".  Look at pngtest.c, for example.
3341 3342

    png_structp png_ptr = png_create_write_struct
3343
       (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
3344
        user_error_fn, user_warning_fn);
3345

3346
    if (!png_ptr)
3347
       return (ERROR);
3348 3349 3350 3351 3352

    png_infop info_ptr = png_create_info_struct(png_ptr);
    if (!info_ptr)
    {
       png_destroy_write_struct(&png_ptr,
3353
           (png_infopp)NULL);
3354
       return (ERROR);
3355 3356
    }

3357 3358
If you want to use your own memory allocation routines,
define PNG_USER_MEM_SUPPORTED and use
3359
png_create_write_struct_2() instead of png_create_write_struct():
3360 3361 3362 3363 3364 3365

    png_structp png_ptr = png_create_write_struct_2
       (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
        user_error_fn, user_warning_fn, (png_voidp)
        user_mem_ptr, user_malloc_fn, user_free_fn);

3366 3367 3368
After you have these structures, you will need to set up the
error handling.  When libpng encounters an error, it expects to
longjmp() back to your routine.  Therefore, you will need to call
3369
setjmp() and pass the png_jmpbuf(png_ptr).  If you
3370
write the file from different routines, you will need to update
3371 3372
the png_jmpbuf(png_ptr) every time you enter a new routine that will
call a png_*() function.  See your documentation of setjmp/longjmp
3373 3374 3375
for your compiler for more information on setjmp/longjmp.  See
the discussion on libpng error handling in the Customizing Libpng
section below for more information on the libpng error handling.
3376

3377
    if (setjmp(png_jmpbuf(png_ptr)))
3378
    {
3379
    png_destroy_write_struct(&png_ptr, &info_ptr);
3380 3381
       fclose(fp);
       return (ERROR);
3382
    }
3383 3384
    ...
    return;
3385

3386
If you would rather avoid the complexity of setjmp/longjmp issues,
3387
you can compile libpng with PNG_NO_SETJMP, in which case
3388 3389
errors will result in a call to PNG_ABORT() which defaults to abort().

3390 3391 3392 3393
You can #define PNG_ABORT() to a function that does something
more useful than abort(), as long as your function does not
return.

3394 3395 3396 3397 3398 3399 3400 3401 3402
Now you need to set up the output code.  The default for libpng is to
use the C function fwrite().  If you use this, you will need to pass a
valid FILE * in the function png_init_io().  Be sure that the file is
opened in binary mode.  Again, if you wish to handle writing data in
another way, see the discussion on libpng I/O handling in the Customizing
Libpng section below.

    png_init_io(png_ptr, fp);

3403 3404 3405 3406 3407 3408 3409 3410
If you are embedding your PNG into a datastream such as MNG, and don't
want libpng to write the 8-byte signature, or if you have already
written the signature in your application, use

    png_set_sig_bytes(png_ptr, 8);

to inform libpng that it should not write a signature.

3411 3412
.SS Write callbacks

3413 3414 3415 3416 3417
At this point, you can set up a callback function that will be
called after each row has been written, which you can use to control
a progress meter or the like.  It's demonstrated in pngtest.c.
You must supply a function

3418
    void write_row_callback(png_structp png_ptr, png_uint_32 row,
3419
       int pass);
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429
    {
      /* put your code here */
    }

(You can give it another name that you like instead of "write_row_callback")

To inform libpng about your function, use

    png_set_write_status_fn(png_ptr, write_row_callback);

3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443
When this function is called the row has already been completely processed and
it has also been written out.  The 'row' and 'pass' refer to the next row to be
handled.  For the
non-interlaced case the row that was just handled is simply one less than the
passed in row number, and pass will always be 0.  For the interlaced case the
same applies unless the row value is 0, in which case the row just handled was
the last one from one of the preceding passes.  Because interlacing may skip a
pass you cannot be sure that the preceding pass is just 'pass-1', if you really
need to know what the last pass is record (row,pass) from the callback and use
the last recorded value each time.

As with the user transform you can find the output row using the
PNG_ROW_FROM_PASS_ROW macro.

3444 3445 3446 3447 3448 3449 3450 3451
You now have the option of modifying how the compression library will
run.  The following functions are mainly for testing, but may be useful
in some cases, like if you need to write PNG files extremely fast and
are willing to give up some compression, or if you want to get the
maximum possible compression at the expense of slower writing.  If you
have no special needs in this area, let the library do what it wants by
not calling this function at all, as it has been tuned to deliver a good
speed/compression ratio. The second parameter to png_set_filter() is
3452 3453 3454 3455
the filter method, for which the only valid values are 0 (as of the
July 1999 PNG specification, version 1.2) or 64 (if you are writing
a PNG datastream that is to be embedded in a MNG datastream).  The third
parameter is a flag that indicates which filter type(s) are to be tested
3456 3457
for each scanline.  See the PNG specification for details on the specific
filter types.
3458

3459

3460
    /* turn on or off filtering, and/or choose
3461
       specific filters.  You can use either a single
3462
       PNG_FILTER_VALUE_NAME or the bitwise OR of one
3463 3464
       or more PNG_FILTER_NAME masks.
     */
3465
    png_set_filter(png_ptr, 0,
3466 3467 3468
       PNG_FILTER_NONE  | PNG_FILTER_VALUE_NONE |
       PNG_FILTER_SUB   | PNG_FILTER_VALUE_SUB  |
       PNG_FILTER_UP    | PNG_FILTER_VALUE_UP   |
3469
       PNG_FILTER_AVG   | PNG_FILTER_VALUE_AVG  |
3470 3471 3472
       PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
       PNG_ALL_FILTERS);

3473 3474 3475 3476
If an application wants to start and stop using particular filters during
compression, it should start out with all of the filters (to ensure that
the previous row of pixels will be stored in case it's needed later),
and then add and remove them after the start of compression.
3477

3478 3479 3480
If you are writing a PNG datastream that is to be embedded in a MNG
datastream, the second parameter can be either 0 or 64.

3481
The png_set_compression_*() functions interface to the zlib compression
3482 3483 3484
library, and should mostly be ignored unless you really know what you are
doing.  The only generally useful call is png_set_compression_level()
which changes how much time zlib spends on trying to compress the image
3485 3486
data.  See the Compression Library (zlib.h and algorithm.txt, distributed
with zlib) for details on the compression levels.
3487

3488 3489
    #include zlib.h

3490
    /* Set the zlib compression level */
3491 3492 3493
    png_set_compression_level(png_ptr,
        Z_BEST_COMPRESSION);

3494
    /* Set other zlib parameters for compressing IDAT */
3495 3496 3497 3498 3499
    png_set_compression_mem_level(png_ptr, 8);
    png_set_compression_strategy(png_ptr,
        Z_DEFAULT_STRATEGY);
    png_set_compression_window_bits(png_ptr, 15);
    png_set_compression_method(png_ptr, 8);
3500 3501
    png_set_compression_buffer_size(png_ptr, 8192)

3502 3503 3504 3505
    /* Set zlib parameters for text compression
     * If you don't call these, the parameters
     * fall back on those defined for IDAT chunks
     */
3506 3507 3508 3509 3510
    png_set_text_compression_mem_level(png_ptr, 8);
    png_set_text_compression_strategy(png_ptr,
        Z_DEFAULT_STRATEGY);
    png_set_text_compression_window_bits(png_ptr, 15);
    png_set_text_compression_method(png_ptr, 8);
3511

3512 3513
.SS Setting the contents of info for output

3514 3515 3516
You now need to fill in the png_info structure with all the data you
wish to write before the actual image.  Note that the only thing you
are allowed to write after the image is the text chunks and the time
3517
chunk (as of PNG Specification 1.2, anyway).  See png_write_end() and
3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
the latest PNG specification for more information on that.  If you
wish to write them before the image, fill them in now, and flag that
data as being valid.  If you want to wait until after the data, don't
fill them until png_write_end().  For all the fields in png_info and
their data types, see png.h.  For explanations of what the fields
contain, see the PNG specification.

Some of the more important parts of the png_info are:

    png_set_IHDR(png_ptr, info_ptr, width, height,
       bit_depth, color_type, interlace_type,
3529
       compression_type, filter_method)
3530

3531 3532
    width          - holds the width of the image
                     in pixels (up to 2^31).
3533

3534 3535
    height         - holds the height of the image
                     in pixels (up to 2^31).
3536

3537 3538 3539 3540 3541 3542
    bit_depth      - holds the bit depth of one of the
                     image channels.
                     (valid values are 1, 2, 4, 8, 16
                     and depend also on the
                     color_type.  See also significant
                     bits (sBIT) below).
3543

3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560
    color_type     - describes which color/alpha
                     channels are present.
                     PNG_COLOR_TYPE_GRAY
                        (bit depths 1, 2, 4, 8, 16)
                     PNG_COLOR_TYPE_GRAY_ALPHA
                        (bit depths 8, 16)
                     PNG_COLOR_TYPE_PALETTE
                        (bit depths 1, 2, 4, 8)
                     PNG_COLOR_TYPE_RGB
                        (bit_depths 8, 16)
                     PNG_COLOR_TYPE_RGB_ALPHA
                        (bit_depths 8, 16)

                     PNG_COLOR_MASK_PALETTE
                     PNG_COLOR_MASK_COLOR
                     PNG_COLOR_MASK_ALPHA

3561 3562
    interlace_type - PNG_INTERLACE_NONE or
                     PNG_INTERLACE_ADAM7
3563

3564 3565
    compression_type - (must be
                     PNG_COMPRESSION_TYPE_DEFAULT)
3566

3567 3568 3569 3570 3571
    filter_method  - (must be PNG_FILTER_TYPE_DEFAULT
                     or, if you are writing a PNG to
                     be embedded in a MNG datastream,
                     can also be
                     PNG_INTRAPIXEL_DIFFERENCING)
3572

3573
If you call png_set_IHDR(), the call must appear before any of the
3574
other png_set_*() functions, because they might require access to some of
3575 3576 3577
the IHDR settings.  The remaining png_set_*() functions can be called
in any order.

G
Glenn Randers-Pehrson 已提交
3578 3579 3580
If you wish, you can reset the compression_type, interlace_type, or
filter_method later by calling png_set_IHDR() again; if you do this, the
width, height, bit_depth, and color_type must be the same in each call.
3581

3582 3583
    png_set_PLTE(png_ptr, info_ptr, palette,
       num_palette);
3584

3585 3586 3587 3588
    palette        - the palette for the file
                     (array of png_color)
    num_palette    - number of entries in the palette

3589 3590 3591 3592 3593
    png_set_gAMA(png_ptr, info_ptr, file_gamma);
    png_set_gAMA_fixed(png_ptr, info_ptr, int_file_gamma);

    file_gamma     - the gamma at which the image was
                     created (PNG_INFO_gAMA)
3594

3595 3596
    int_file_gamma - 100,000 times the gamma at which
                     the image was created
3597 3598

    png_set_sRGB(png_ptr, info_ptr, srgb_intent);
3599

3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610
    srgb_intent    - the rendering intent
                     (PNG_INFO_sRGB) The presence of
                     the sRGB chunk means that the pixel
                     data is in the sRGB color space.
                     This chunk also implies specific
                     values of gAMA and cHRM.  Rendering
                     intent is the CSS-1 property that
                     has been defined by the International
                     Color Consortium
                     (http://www.color.org).
                     It can be one of
3611 3612 3613 3614
                     PNG_sRGB_INTENT_SATURATION,
                     PNG_sRGB_INTENT_PERCEPTUAL,
                     PNG_sRGB_INTENT_ABSOLUTE, or
                     PNG_sRGB_INTENT_RELATIVE.
3615

3616 3617 3618

    png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
       srgb_intent);
3619

3620 3621 3622 3623 3624 3625 3626 3627 3628
    srgb_intent    - the rendering intent
                     (PNG_INFO_sRGB) The presence of the
                     sRGB chunk means that the pixel
                     data is in the sRGB color space.
                     This function also causes gAMA and
                     cHRM chunks with the specific values
                     that are consistent with sRGB to be
                     written.

3629
    png_set_iCCP(png_ptr, info_ptr, name, compression_type,
3630
                       profile, proflen);
3631

3632
    name             - The profile name.
3633

3634 3635 3636 3637
    compression_type - The compression type; always
                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
                       You may give NULL to this argument to
                       ignore it.
3638

3639 3640
    profile          - International Color Consortium color
                       profile data. May contain NULs.
3641

3642
    proflen          - length of profile data in bytes.
3643

3644
    png_set_sBIT(png_ptr, info_ptr, sig_bit);
3645

3646 3647 3648 3649 3650 3651
    sig_bit        - the number of significant bits for
                     (PNG_INFO_sBIT) each of the gray, red,
                     green, and blue channels, whichever are
                     appropriate for the given color type
                     (png_color_16)

3652 3653
    png_set_tRNS(png_ptr, info_ptr, trans_alpha,
       num_trans, trans_color);
3654

3655 3656
    trans_alpha    - array of alpha (transparency)
                     entries for palette (PNG_INFO_tRNS)
3657

G
Glenn Randers-Pehrson 已提交
3658 3659 3660
    trans_color    - graylevel or color sample values
                     (in order red, green, blue) of the
                     single transparent color for
3661
                     non-paletted images (PNG_INFO_tRNS)
3662

3663 3664 3665 3666
    num_trans      - number of transparent entries
                     (PNG_INFO_tRNS)

    png_set_hIST(png_ptr, info_ptr, hist);
3667

3668
    hist           - histogram of palette (array of
3669
                     png_uint_16) (PNG_INFO_hIST)
3670 3671

    png_set_tIME(png_ptr, info_ptr, mod_time);
3672

3673 3674 3675 3676
    mod_time       - time image was last modified
                     (PNG_VALID_tIME)

    png_set_bKGD(png_ptr, info_ptr, background);
3677

3678 3679
    background     - background color (of type
                     png_color_16p) (PNG_VALID_bKGD)
3680 3681

    png_set_text(png_ptr, info_ptr, text_ptr, num_text);
3682

3683 3684
    text_ptr       - array of png_text holding image
                     comments
3685

3686
    text_ptr[i].compression - type of compression used
3687 3688 3689 3690
                 on "text" PNG_TEXT_COMPRESSION_NONE
                           PNG_TEXT_COMPRESSION_zTXt
                           PNG_ITXT_COMPRESSION_NONE
                           PNG_ITXT_COMPRESSION_zTXt
3691 3692 3693 3694 3695
    text_ptr[i].key   - keyword for comment.  Must contain
                 1-79 characters.
    text_ptr[i].text  - text comments for current
                         keyword.  Can be NULL or empty.
    text_ptr[i].text_length - length of text string,
3696
                 after decompression, 0 for iTXt
3697
    text_ptr[i].itxt_length - length of itxt string,
3698
                 after decompression, 0 for tEXt/zTXt
3699 3700 3701 3702
    text_ptr[i].lang  - language of comment (NULL or
                         empty for unknown).
    text_ptr[i].translated_keyword  - keyword in UTF-8 (NULL
                         or empty for unknown).
3703 3704 3705 3706
    Note that the itxt_length, lang, and lang_key
    members of the text_ptr structure only exist
    when the library is built with iTXt chunk support.

3707
    num_text       - number of comments
3708

3709 3710
    png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
       num_spalettes);
3711

3712 3713 3714 3715 3716
    palette_ptr    - array of png_sPLT_struct structures
                     to be added to the list of palettes
                     in the info structure.
    num_spalettes  - number of palette structures to be
                     added.
3717

3718 3719
    png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
        unit_type);
3720

3721 3722
    offset_x  - positive offset from the left
                     edge of the screen
3723

3724 3725
    offset_y  - positive offset from the top
                     edge of the screen
3726

3727 3728 3729 3730
    unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER

    png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
        unit_type);
3731

3732 3733
    res_x       - pixels/unit physical resolution
                  in x direction
3734

3735 3736
    res_y       - pixels/unit physical resolution
                  in y direction
3737

3738
    unit_type   - PNG_RESOLUTION_UNKNOWN,
3739 3740
                  PNG_RESOLUTION_METER

3741
    png_set_sCAL(png_ptr, info_ptr, unit, width, height)
3742

3743
    unit        - physical scale units (an integer)
3744

3745
    width       - width of a pixel in physical scale units
3746

3747 3748 3749 3750
    height      - height of a pixel in physical scale units
                  (width and height are doubles)

    png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
3751

3752
    unit        - physical scale units (an integer)
3753

3754
    width       - width of a pixel in physical scale units
3755

3756
    height      - height of a pixel in physical scale units
3757
                 (width and height are strings like "2.54")
3758

3759 3760
    png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
       num_unknowns)
3761

3762 3763
    unknowns          - array of png_unknown_chunk
                        structures holding unknown chunks
3764 3765
    unknowns[i].name  - name of unknown chunk
    unknowns[i].data  - data of unknown chunk
3766
    unknowns[i].size  - size of unknown chunk's data
3767 3768 3769 3770 3771
    unknowns[i].location - position to write chunk in file
                           0: do not write chunk
                           PNG_HAVE_IHDR: before PLTE
                           PNG_HAVE_PLTE: before IDAT
                           PNG_AFTER_IDAT: after IDAT
3772 3773 3774 3775 3776 3777 3778 3779 3780

The "location" member is set automatically according to
what part of the output file has already been written.
You can change its value after calling png_set_unknown_chunks()
as demonstrated in pngtest.c.  Within each of the "locations",
the chunks are sequenced according to their position in the
structure (that is, the value of "i", which is the order in which
the chunk was either read from the input file or defined with
png_set_unknown_chunks).
3781 3782 3783

A quick word about text and num_text.  text is an array of png_text
structures.  num_text is the number of valid structures in the array.
3784 3785
Each png_text structure holds a language code, a keyword, a text value,
and a compression type.
3786

3787 3788 3789
The compression types have the same valid numbers as the compression
types of the image data.  Currently, the only valid number is zero.
However, you can store text either compressed or uncompressed, unlike
3790
images, which always have to be compressed.  So if you don't want the
3791
text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
3792 3793 3794
Because tEXt and zTXt chunks don't have a language field, if you
specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
any language code or translated keyword will not be written out.
3795

3796 3797 3798 3799
Until text gets around 1000 bytes, it is not worth compressing it.
After the text has been written out to the file, the compression type
is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
so that it isn't written out again at the end (in case you are calling
3800
png_write_end() with the same struct).
3801 3802 3803 3804 3805

The keywords that are given in the PNG Specification are:

    Title            Short (one line) title or
                     caption for image
3806

3807
    Author           Name of image's creator
3808

3809
    Description      Description of image (possibly long)
3810

3811
    Copyright        Copyright notice
3812

3813
    Creation Time    Time of original image creation
3814
                     (usually RFC 1123 format, see below)
3815

3816
    Software         Software used to create the image
3817

3818
    Disclaimer       Legal disclaimer
3819

3820
    Warning          Warning of nature of content
3821

3822
    Source           Device used to create the image
3823

3824 3825 3826 3827 3828
    Comment          Miscellaneous comment; conversion
                     from other image format

The keyword-text pairs work like this.  Keywords should be short
simple descriptions of what the comment is about.  Some typical
3829
keywords are found in the PNG specification, as is some recommendations
3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
on keywords.  You can repeat keywords in a file.  You can even write
some text before the image and some after.  For example, you may want
to put a description of the image before the image, but leave the
disclaimer until after, so viewers working over modem connections
don't have to wait for the disclaimer to go over the modem before
they start seeing the image.  Finally, keywords should be full
words, not abbreviations.  Keywords and text are in the ISO 8859-1
(Latin-1) character set (a superset of regular ASCII) and can not
contain NUL characters, and should not contain control or other
unprintable characters.  To make the comments widely readable, stick
with basic ASCII, and avoid machine specific character set extensions
like the IBM-PC character set.  The keyword must be present, but
you can leave off the text string on non-compressed pairs.
Compressed pairs must have a text string, as only the text string
is compressed anyway, so the compression would be meaningless.

PNG supports modification time via the png_time structure.  Two
3847
conversion routines are provided, png_convert_from_time_t() for
3848 3849 3850 3851 3852
time_t and png_convert_from_struct_tm() for struct tm.  The
time_t routine uses gmtime().  You don't have to use either of
these, but if you wish to fill in the png_time structure directly,
you should provide the time in universal time (GMT) if possible
instead of your local time.  Note that the year number is the full
3853
year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
3854 3855 3856 3857 3858 3859 3860 3861 3862
that months start with 1.

If you want to store the time of the original image creation, you should
use a plain tEXt chunk with the "Creation Time" keyword.  This is
necessary because the "creation time" of a PNG image is somewhat vague,
depending on whether you mean the PNG file, the time the image was
created in a non-PNG format, a still photo from which the image was
scanned, or possibly the subject matter itself.  In order to facilitate
machine-readable dates, it is recommended that the "Creation Time"
3863
tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
3864 3865 3866 3867 3868 3869
although this isn't a requirement.  Unlike the tIME chunk, the
"Creation Time" tEXt chunk is not expected to be automatically changed
by the software.  To facilitate the use of RFC 1123 dates, a function
png_convert_to_rfc1123(png_timep) is provided to convert from PNG
time to an RFC 1123 format string.

3870 3871
.SS Writing unknown chunks

3872 3873 3874 3875 3876 3877 3878 3879
You can use the png_set_unknown_chunks function to queue up chunks
for writing.  You give it a chunk name, raw data, and a size; that's
all there is to it.  The chunks will be written by the next following
png_write_info_before_PLTE, png_write_info, or png_write_end function.
Any chunks previously read into the info structure's unknown-chunk
list will also be written out in a sequence that satisfies the PNG
specification's ordering rules.

3880 3881 3882 3883 3884
.SS The high-level write interface

At this point there are two ways to proceed; through the high-level
write interface, or through a sequence of low-level write operations.
You can use the high-level interface if your image data is present
3885
in the info structure.  All defined output
3886
transformations are permitted, enabled by the following masks.
3887 3888 3889

    PNG_TRANSFORM_IDENTITY      No transformation
    PNG_TRANSFORM_PACKING       Pack 1, 2 and 4-bit samples
3890 3891
    PNG_TRANSFORM_PACKSWAP      Change order of packed
                                pixels to LSB first
3892
    PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
3893 3894 3895 3896 3897 3898 3899 3900
    PNG_TRANSFORM_SHIFT         Normalize pixels to the
                                sBIT depth
    PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
                                to BGRA
    PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
                                to AG
    PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
                                to transparency
3901
    PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
3902 3903 3904 3905 3906 3907
    PNG_TRANSFORM_STRIP_FILLER        Strip out filler
                                      bytes (deprecated).
    PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
                                      filler bytes
    PNG_TRANSFORM_STRIP_FILLER_AFTER  Strip out trailing
                                      filler bytes
3908

3909 3910
If you have valid image data in the info structure (you can use
png_set_rows() to put image data in the info structure), simply do this:
3911 3912 3913

    png_write_png(png_ptr, info_ptr, png_transforms, NULL)

3914
where png_transforms is an integer containing the bitwise OR of some set of
3915
transformation flags.  This call is equivalent to png_write_info(),
3916 3917
followed the set of transformations indicated by the transform mask,
then png_write_image(), and finally png_write_end().
3918

3919 3920
(The final parameter of this call is not yet used.  Someday it might point
to transformation parameters required by some future output transform.)
3921

3922 3923 3924
You must use png_transforms and not call any png_set_transform() functions
when you use png_write_png().

3925 3926 3927 3928 3929
.SS The low-level write interface

If you are going the low-level route instead, you are now ready to
write all the file information up to the actual image data.  You do
this with a call to png_write_info().
3930 3931 3932

    png_write_info(png_ptr, info_ptr);

3933 3934
Note that there is one transformation you may need to do before
png_write_info().  In PNG files, the alpha channel in an image is the
3935 3936 3937 3938
level of opacity.  If your data is supplied as a level of transparency,
you can invert the alpha channel before you write it, so that 0 is
fully transparent and 255 (in 8-bit or paletted images) or 65535
(in 16-bit images) is fully opaque, with
3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949

    png_set_invert_alpha(png_ptr);

This must appear before png_write_info() instead of later with the
other transformations because in the case of paletted images the tRNS
chunk data has to be inverted before the tRNS chunk is written.  If
your image is not a paletted image, the tRNS data (which in such cases
represents a single color to be rendered as transparent) won't need to
be changed, and you can safely do this transformation after your
png_write_info() call.

3950 3951 3952 3953 3954
If you need to write a private chunk that you want to appear before
the PLTE chunk when PLTE is present, you can write the PNG info in
two steps, and insert code to write your own chunk between them:

    png_write_info_before_PLTE(png_ptr, info_ptr);
3955
    png_set_unknown_chunks(png_ptr, info_ptr, ...);
3956 3957
    png_write_info(png_ptr, info_ptr);

3958 3959 3960 3961 3962 3963
After you've written the file information, you can set up the library
to handle any special transformations of the image data.  The various
ways to transform the data will be described in the order that they
should occur.  This is important, as some of these change the color
type and/or bit depth of the data, and some others only work on
certain color types and bit depths.  Even though each transformation
3964
checks to see if it has data that it can do something with, you should
3965 3966 3967
make sure to only enable a transformation if it will be valid for the
data.  For example, don't swap red and blue on grayscale data.

3968
PNG files store RGB pixels packed into 3 or 6 bytes.  This code tells
3969
the library to strip input data that has 4 or 8 bytes per pixel down
3970 3971
to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
bytes per pixel).
3972 3973 3974

    png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

3975
where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
3976 3977
PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
is stored XRGB or RGBX.
3978 3979 3980 3981 3982 3983 3984 3985 3986 3987

PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
they can, resulting in, for example, 8 pixels per byte for 1 bit files.
If the data is supplied at 1 pixel per byte, use this code, which will
correctly pack the pixels into a single byte:

    png_set_packing(png_ptr);

PNG files reduce possible bit depths to 1, 2, 4, 8, and 16.  If your
data is of another bit depth, you can write an sBIT chunk into the
3988
file so that decoders can recover the original data if desired.
3989

3990 3991 3992
    /* Set the true bit depth of the image data */
    if (color_type & PNG_COLOR_MASK_COLOR)
    {
3993 3994 3995
       sig_bit.red = true_bit_depth;
       sig_bit.green = true_bit_depth;
       sig_bit.blue = true_bit_depth;
3996
    }
3997

3998 3999
    else
    {
4000
       sig_bit.gray = true_bit_depth;
4001
    }
4002

4003 4004
    if (color_type & PNG_COLOR_MASK_ALPHA)
    {
4005
       sig_bit.alpha = true_bit_depth;
4006 4007 4008 4009 4010
    }

    png_set_sBIT(png_ptr, info_ptr, &sig_bit);

If the data is stored in the row buffer in a bit depth other than
4011
one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
4012 4013 4014 4015 4016
this will scale the values to appear to be the correct bit depth as
is required by PNG.

    png_set_shift(png_ptr, &sig_bit);

4017
PNG files store 16-bit pixels in network byte order (big-endian,
4018
ie. most significant bits first).  This code would be used if they are
4019 4020
supplied the other way (little-endian, i.e. least significant bits
first, the way PCs store them):
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041

    if (bit_depth > 8)
       png_set_swap(png_ptr);

If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
need to change the order the pixels are packed into bytes, you can use:

    if (bit_depth < 8)
       png_set_packswap(png_ptr);

PNG files store 3 color pixels in red, green, blue order.  This code
would be used if they are supplied as blue, green, red:

    png_set_bgr(png_ptr);

PNG files describe monochrome as black being zero and white being
one. This code would be used if the pixels are supplied with this reversed
(black being one and white being zero):

    png_set_invert_mono(png_ptr);

4042 4043 4044 4045 4046 4047 4048 4049 4050
Finally, you can write your own transformation function if none of
the existing ones meets your needs.  This is done by setting a callback
with

    png_set_write_user_transform_fn(png_ptr,
       write_transform_fn);

You must supply the function

4051 4052
    void write_transform_fn(png_structp png_ptr, png_row_infop
       row_info, png_bytep data)
4053 4054

See pngtest.c for a working example.  Your function will be called
4055 4056 4057 4058 4059
before any of the other transformations are processed.  If supported
libpng also supplies an information routine that may be called from
your callback:

   png_get_current_row_number(png_ptr);
4060 4061 4062 4063 4064 4065
   png_get_current_pass_number(png_ptr);

This returns the current row passed to the transform.  With interlaced
images the value returned is the row in the input sub-image image.  Use
PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
4066

4067 4068
The discussion of interlace handling above contains more information on how to
use these values.
4069 4070 4071 4072 4073 4074 4075 4076 4077

You can also set up a pointer to a user structure for use by your
callback function.

    png_set_user_transform_info(png_ptr, user_ptr, 0, 0);

The user_channels and user_depth parameters of this function are ignored
when writing; you can set them to zero as shown.

4078 4079
You can retrieve the pointer via the function png_get_user_transform_ptr().
For example:
4080 4081 4082

    voidp write_user_transform_ptr =
       png_get_user_transform_ptr(png_ptr);
4083

4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098
It is possible to have libpng flush any pending output, either manually,
or automatically after a certain number of lines have been written.  To
flush the output stream a single time call:

    png_write_flush(png_ptr);

and to have libpng flush the output stream periodically after a certain
number of scanlines have been written, call:

    png_set_flush(png_ptr, nrows);

Note that the distance between rows is from the last time png_write_flush()
was called, or the first row of the image if it has never been called.
So if you write 50 lines, and then png_set_flush 25, it will flush the
output on the next scanline, and every 25 lines thereafter, unless
4099
png_write_flush() is called before 25 more lines have been written.
4100
If nrows is too small (less than about 10 lines for a 640 pixel wide
4101
RGB image) the image compression may decrease noticeably (although this
4102 4103 4104 4105
may be acceptable for real-time applications).  Infrequent flushing will
only degrade the compression performance by a few percent over images
that do not use flushing.

4106 4107
.SS Writing the image data

4108
That's it for the transformations.  Now you can write the image data.
4109
The simplest way to do this is in one function call.  If you have the
4110 4111 4112 4113 4114 4115 4116 4117 4118 4119
whole image in memory, you can just call png_write_image() and libpng
will write the image.  You will need to pass in an array of pointers to
each row.  This function automatically handles interlacing, so you don't
need to call png_set_interlace_handling() or call this function multiple
times, or any of that other stuff necessary with png_write_rows().

    png_write_image(png_ptr, row_pointers);

where row_pointers is:

4120
    png_byte *row_pointers[height];
4121 4122 4123

You can point to void or char or whatever you use for pixels.

4124
If you don't want to write the whole image at once, you can
4125 4126 4127 4128 4129 4130 4131 4132 4133
use png_write_rows() instead.  If the file is not interlaced,
this is simple:

    png_write_rows(png_ptr, row_pointers,
       number_of_rows);

row_pointers is the same as in the png_write_image() call.

If you are just writing one row at a time, you can do this with
4134
a single row_pointer instead of an array of row_pointers:
4135 4136 4137

    png_bytep row_pointer = row;

4138
    png_write_row(png_ptr, row_pointer);
4139

4140 4141 4142 4143 4144 4145 4146
When the file is interlaced, things can get a good deal more complicated.
The only currently (as of the PNG Specification version 1.2, dated July
1999) defined interlacing scheme for PNG files is the "Adam7" interlace
scheme, that breaks down an image into seven smaller images of varying
size.  libpng will build these images for you, or you can do them
yourself.  If you want to build them yourself, see the PNG specification
for details of which pixels to write when.
4147 4148 4149

If you don't want libpng to handle the interlacing details, just
use png_set_interlace_handling() and call png_write_rows() the
4150 4151
correct number of times to write all the sub-images
(png_set_interlace_handling() returns the number of sub-images.)
4152 4153 4154 4155

If you want libpng to build the sub-images, call this before you start
writing any rows:

4156
    number_of_passes = png_set_interlace_handling(png_ptr);
4157

4158 4159
This will return the number of passes needed.  Currently, this is seven,
but may change if another interlace type is added.
4160 4161 4162

Then write the complete image number_of_passes times.

4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175
    png_write_rows(png_ptr, row_pointers, number_of_rows);

Think carefully before you write an interlaced image.  Typically code that
reads such images reads all the image data into memory, uncompressed, before
doing any processing.  Only code that can display an image on the fly can
take advantage of the interlacing and even then the image has to be exactly
the correct size for the output device, because scaling an image requires
adjacent pixels and these are not available until all the passes have been
read.

If you do write an interlaced image you will hardly ever need to handle
the interlacing yourself.  Call png_set_interlace_handling() and use the
approach described above.
4176

4177 4178 4179 4180 4181 4182
The only time it is conceivable that you will really need to write an
interlaced image pass-by-pass is when you have read one pass by pass and
made some pixel-by-pixel transformation to it, as described in the read
code above.  In this case use the PNG_PASS_ROWS and PNG_PASS_COLS macros
to determine the size of each sub-image in turn and simply write the rows
you obtained from the read code.
4183

4184 4185
.SS Finishing a sequential write

4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196
After you are finished writing the image, you should finish writing
the file.  If you are interested in writing comments or time, you should
pass an appropriately filled png_info pointer.  If you are not interested,
you can pass NULL.

    png_write_end(png_ptr, info_ptr);

When you are done, you can free all memory used by libpng like this:

    png_destroy_write_struct(&png_ptr, &info_ptr);

4197
It is also possible to individually free the info_ptr members that
4198
point to libpng-allocated storage with the following function:
4199

4200
    png_free_data(png_ptr, info_ptr, mask, seq)
4201

4202
    mask  - identifies data to be freed, a mask
4203
            containing the bitwise OR of one or
4204 4205 4206 4207 4208 4209 4210
            more of
              PNG_FREE_PLTE, PNG_FREE_TRNS,
              PNG_FREE_HIST, PNG_FREE_ICCP,
              PNG_FREE_PCAL, PNG_FREE_ROWS,
              PNG_FREE_SCAL, PNG_FREE_SPLT,
              PNG_FREE_TEXT, PNG_FREE_UNKN,
            or simply PNG_FREE_ALL
4211

4212
    seq   - sequence number of item to be freed
4213
            (-1 for all items)
4214

4215
This function may be safely called when the relevant storage has
4216
already been freed, or has not yet been allocated, or was allocated
4217 4218 4219 4220 4221 4222 4223 4224
by the user  and not by libpng,  and will in those cases do nothing.
The "seq" parameter is ignored if only one item of the selected data
type, such as PLTE, is allowed.  If "seq" is not -1, and multiple items
are allowed for the data type identified in the mask, such as text or
sPLT, only the n'th item in the structure is freed, where n is "seq".

If you allocated data such as a palette that you passed in to libpng
with png_set_*, you must not free it until just before the call to
4225
png_destroy_write_struct().
4226

4227 4228
The default behavior is only to free data that was allocated internally
by libpng.  This can be changed, so that libpng will not free the data,
4229 4230
or so that it will free data that was allocated by the user with png_malloc()
or png_zalloc() and passed in via a png_set_*() function, with
4231 4232

    png_data_freer(png_ptr, info_ptr, freer, mask)
4233

4234 4235 4236 4237
    freer  - one of
               PNG_DESTROY_WILL_FREE_DATA
               PNG_SET_WILL_FREE_DATA
               PNG_USER_WILL_FREE_DATA
4238

4239 4240 4241
    mask   - which data elements are affected
             same choices as in png_free_data()

4242 4243 4244 4245 4246 4247
For example, to transfer responsibility for some data from a read structure
to a write structure, you could use

    png_data_freer(read_ptr, read_info_ptr,
       PNG_USER_WILL_FREE_DATA,
       PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
4248

4249 4250 4251 4252
    png_data_freer(write_ptr, write_info_ptr,
       PNG_DESTROY_WILL_FREE_DATA,
       PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)

4253
thereby briefly reassigning responsibility for freeing to the user but
4254 4255 4256 4257 4258
immediately afterwards reassigning it once more to the write_destroy
function.  Having done this, it would then be safe to destroy the read
structure and continue to use the PLTE, tRNS, and hIST data in the write
structure.

4259 4260 4261 4262
This function only affects data that has already been allocated.
You can call this function before calling after the png_set_*() functions
to control whether the user or png_destroy_*() is supposed to free the data.
When the user assumes responsibility for libpng-allocated data, the
4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273
application must use
png_free() to free it, and when the user transfers responsibility to libpng
for data that the user has allocated, the user must have used png_malloc()
or png_zalloc() to allocate it.

If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
separately, do not transfer responsibility for freeing text_ptr to libpng,
because when libpng fills a png_text structure it combines these members with
the key member, and png_free_data() will free only text_ptr.key.  Similarly,
if you transfer responsibility for free'ing text_ptr from libpng to your
application, your application must not separately free those members.
4274 4275
For a more compact example of writing a PNG image, see the file example.c.

4276
.SH V. Modifying/Customizing libpng:
4277

4278
There are two issues here.  The first is changing how libpng does
4279 4280 4281
standard things like memory allocation, input/output, and error handling.
The second deals with more complicated things like adding new chunks,
adding new transformations, and generally changing how libpng works.
4282 4283
Both of those are compile-time issues; that is, they are generally
determined at the time the code is written, and there is rarely a need
4284
to provide the user with a means of changing them.
4285 4286

Memory allocation, input/output, and error handling
4287 4288

All of the memory allocation, input/output, and error handling in libpng
4289
goes through callbacks that are user-settable.  The default routines are
4290
in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively.  To change
4291
these functions, call the appropriate png_set_*_fn() function.
4292

4293 4294
Memory allocation is done through the functions png_malloc(), png_calloc(),
and png_free().  These currently just call the standard C functions.
4295 4296 4297 4298 4299
png_calloc() calls png_malloc() and then clears the newly
allocated memory to zero.  There is limited support for certain systems
with segmented memory architectures and the types of pointers declared by
png.h match this; you will have to use appropriate pointers in your
application.  Since it is
4300 4301 4302 4303 4304 4305 4306
unlikely that the method of handling memory allocation on a platform
will change between applications, these functions must be modified in
the library at compile time.  If you prefer to use a different method
of allocating and freeing data, you can use png_create_read_struct_2() or
png_create_write_struct_2() to register your own functions as described
above.  These functions also provide a void pointer that can be retrieved
via
4307 4308 4309 4310 4311

    mem_ptr=png_get_mem_ptr(png_ptr);

Your replacement memory functions must have prototypes as follows:

4312
    png_voidp malloc_fn(png_structp png_ptr,
4313
       png_alloc_size_t size);
4314

4315
    void free_fn(png_structp png_ptr, png_voidp ptr);
4316

4317 4318 4319
Your malloc_fn() must return NULL in case of failure.  The png_malloc()
function will normally call png_error() if it receives a NULL from the
system memory allocator or from your replacement malloc_fn().
4320

4321 4322 4323
Your free_fn() will never be called with a NULL ptr, since libpng's
png_free() checks for NULL before calling free_fn().

4324 4325 4326 4327 4328
Input/Output in libpng is done through png_read() and png_write(),
which currently just call fread() and fwrite().  The FILE * is stored in
png_struct and is initialized via png_init_io().  If you wish to change
the method of I/O, the library supplies callbacks that you can set
through the function png_set_read_fn() and png_set_write_fn() at run
4329
time, instead of calling the png_init_io() function.  These functions
4330 4331 4332
also provide a void pointer that can be retrieved via the function
png_get_io_ptr().  For example:

4333 4334
    png_set_read_fn(png_structp read_ptr,
        voidp read_io_ptr, png_rw_ptr read_data_fn)
4335

4336 4337
    png_set_write_fn(png_structp write_ptr,
        voidp write_io_ptr, png_rw_ptr write_data_fn,
4338 4339
        png_flush_ptr output_flush_fn);

4340 4341
    voidp read_io_ptr = png_get_io_ptr(read_ptr);
    voidp write_io_ptr = png_get_io_ptr(write_ptr);
4342

4343
The replacement I/O functions must have prototypes as follows:
4344 4345

    void user_read_data(png_structp png_ptr,
4346
        png_bytep data, png_size_t length);
4347

4348
    void user_write_data(png_structp png_ptr,
4349
        png_bytep data, png_size_t length);
4350

4351 4352
    void user_flush_data(png_structp png_ptr);

4353 4354 4355
The user_read_data() function is responsible for detecting and
handling end-of-data errors.

4356
Supplying NULL for the read, write, or flush functions sets them back
4357 4358 4359 4360 4361
to using the default C stream functions, which expect the io_ptr to
point to a standard *FILE structure.  It is probably a mistake
to use NULL for one of write_data_fn and output_flush_fn but not both
of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
It is an error to read from a write stream, and vice versa.
4362 4363 4364 4365

Error handling in libpng is done through png_error() and png_warning().
Errors handled through png_error() are fatal, meaning that png_error()
should never return to its caller.  Currently, this is handled via
4366
setjmp() and longjmp() (unless you have compiled libpng with
4367
PNG_NO_SETJMP, in which case it is handled via PNG_ABORT()),
4368
but you could change this to do things like exit() if you should wish,
4369
as long as your function does not return.
4370 4371

On non-fatal errors, png_warning() is called
4372 4373
to print a warning message, and then control returns to the calling code.
By default png_error() and png_warning() print a message on stderr via
4374 4375 4376 4377 4378
fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
(because you don't want the messages) or PNG_NO_STDIO defined (because
fprintf() isn't available).  If you wish to change the behavior of the error
functions, you will need to set up your own message callbacks.  These
functions are normally supplied at the time that the png_struct is created.
4379 4380
It is also possible to redirect errors and warnings to your own replacement
functions after png_create_*_struct() has been called by calling:
4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394

    png_set_error_fn(png_structp png_ptr,
        png_voidp error_ptr, png_error_ptr error_fn,
        png_error_ptr warning_fn);

    png_voidp error_ptr = png_get_error_ptr(png_ptr);

If NULL is supplied for either error_fn or warning_fn, then the libpng
default function will be used, calling fprintf() and/or longjmp() if a
problem is encountered.  The replacement error functions should have
parameters as follows:

    void user_error_fn(png_structp png_ptr,
        png_const_charp error_msg);
4395

4396 4397 4398 4399 4400 4401 4402
    void user_warning_fn(png_structp png_ptr,
        png_const_charp warning_msg);

The motivation behind using setjmp() and longjmp() is the C++ throw and
catch exception handling methods.  This makes the code much easier to write,
as there is no need to check every return code of every function call.
However, there are some uncertainties about the status of local variables
4403 4404 4405 4406
after a longjmp, so the user may want to be careful about doing anything
after setjmp returns non-zero besides returning itself.  Consult your
compiler documentation for more details.  For an alternative approach, you
may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net).
4407

4408 4409 4410 4411 4412
.SS Custom chunks

If you need to read or write custom chunks, you may need to get deeper
into the libpng code.  The library now has mechanisms for storing
and writing chunks of unknown type; you can even declare callbacks
4413
for custom chunks.  However, this may not be good enough if the
4414 4415 4416 4417
library code itself needs to know about interactions between your
chunk and existing `intrinsic' chunks.

If you need to write a new intrinsic chunk, first read the PNG
4418 4419 4420 4421 4422 4423 4424 4425
specification. Acquire a first level of understanding of how it works.
Pay particular attention to the sections that describe chunk names,
and look at how other chunks were designed, so you can do things
similarly.  Second, check out the sections of libpng that read and
write chunks.  Try to find a chunk that is similar to yours and use
it as a template.  More details can be found in the comments inside
the code.  It is best to handle unknown chunks in a generic method,
via callback functions, instead of by modifying libpng functions.
4426 4427 4428 4429 4430 4431 4432

If you wish to write your own transformation for the data, look through
the part of the code that does the transformations, and check out some of
the simpler ones to get an idea of how they work.  Try to find a similar
transformation to the one you want to add and copy off of it.  More details
can be found in the comments inside the code itself.

4433
.SS Configuring for 16-bit platforms
4434

4435
You will want to look into zconf.h to tell zlib (and thus libpng) that
4436
it cannot allocate more then 64K at a time.  Even if you can, the memory
4437
won't be accessible.  So limit zlib and libpng to 64K by defining MAXSEG_64K.
4438

4439
.SS Configuring for DOS
4440

4441
For DOS users who only have access to the lower 640K, you will
4442 4443 4444
have to limit zlib's memory usage via a png_set_compression_mem_level()
call.  See zlib.h or zconf.h in the zlib library for more information.

4445
.SS Configuring for Medium Model
4446 4447 4448 4449 4450 4451 4452

Libpng's support for medium model has been tested on most of the popular
compilers.  Make sure MAXSEG_64K gets defined, USE_FAR_KEYWORD gets
defined, and FAR gets defined to far in pngconf.h, and you should be
all set.  Everything in the library (except for zlib's structure) is
expecting far data.  You must use the typedefs with the p or pp on
the end for pointers (or at least look at them and be careful).  Make
4453
note that the rows of data are defined as png_bytepp, which is an
4454 4455
unsigned char far * far *.

4456
.SS Configuring for gui/windowing platforms:
4457 4458 4459

You will need to write new error and warning functions that use the GUI
interface, as described previously, and set them to be the error and
4460
warning functions at the time that png_create_*_struct() is called,
4461
in order to have them available during the structure initialization.
4462
They can be changed later via png_set_error_fn().  On some compilers,
4463 4464
you may also have to change the memory allocators (png_malloc, etc.).

4465
.SS Configuring for compiler xxx:
4466

4467
All includes for libpng are in pngconf.h.  If you need to add, change
4468 4469 4470 4471 4472
or delete an include, this is the place to do it.
The includes that are not needed outside libpng are placed in pngpriv.h,
which is only used by the routines inside libpng itself.
The files in libpng proper only include pngpriv.h and png.h, which
in turn includes pngconf.h.
4473

4474
.SS Configuring zlib:
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487

There are special functions to configure the compression.  Perhaps the
most useful one changes the compression level, which currently uses
input compression values in the range 0 - 9.  The library normally
uses the default compression level (Z_DEFAULT_COMPRESSION = 6).  Tests
have shown that for a large majority of images, compression values in
the range 3-6 compress nearly as well as higher levels, and do so much
faster.  For online applications it may be desirable to have maximum speed
(Z_BEST_SPEED = 1).  With versions of zlib after v0.99, you can also
specify no compression (Z_NO_COMPRESSION = 0), but this would create
files larger than just storing the raw bitmap.  You can specify the
compression level by calling:

4488
    #include zlib.h
4489 4490 4491 4492 4493
    png_set_compression_level(png_ptr, level);

Another useful one is to reduce the memory level used by the library.
The memory level defaults to 8, but it can be lowered if you are
short on memory (running DOS, for example, where you only have 640K).
4494 4495 4496 4497
Note that the memory level does have an effect on compression; among
other things, lower levels will result in sections of incompressible
data being emitted in smaller stored blocks, with a correspondingly
larger relative overhead of up to 15% in the worst case.
4498

4499
    #include zlib.h
4500 4501 4502 4503 4504 4505
    png_set_compression_mem_level(png_ptr, level);

The other functions are for configuring zlib.  They are not recommended
for normal use and may result in writing an invalid PNG file.  See
zlib.h for more information on what these mean.

4506
    #include zlib.h
4507 4508
    png_set_compression_strategy(png_ptr,
        strategy);
4509

4510 4511
    png_set_compression_window_bits(png_ptr,
        window_bits);
4512

4513
    png_set_compression_method(png_ptr, method);
4514
    png_set_compression_buffer_size(png_ptr, size);
4515

4516
.SS Controlling row filtering
4517 4518 4519 4520 4521 4522 4523

If you want to control whether libpng uses filtering or not, which
filters are used, and how it goes about picking row filters, you
can call one of these functions.  The selection and configuration
of row filters can have a significant impact on the size and
encoding speed and a somewhat lesser impact on the decoding speed
of an image.  Filtering is enabled by default for RGB and grayscale
4524 4525
images (with and without alpha), but not for paletted images nor
for any images with bit depths less than 8 bits/pixel.
4526 4527

The 'method' parameter sets the main filtering method, which is
4528
currently only '0' in the PNG 1.2 specification.  The 'filters'
4529 4530 4531 4532 4533 4534
parameter sets which filter(s), if any, should be used for each
scanline.  Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS
to turn filtering on and off, respectively.

Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
4535
ORed together with '|' to specify one or more filters to use.
4536 4537
These filters are described in more detail in the PNG specification.
If you intend to change the filter type during the course of writing
4538 4539
the image, you should start with flags set for all of the filters
you intend to use so that libpng can initialize its internal
4540 4541 4542 4543
structures appropriately for all of the filter types.  (Note that this
means the first row must always be adaptively filtered, because libpng
currently does not allocate the filter buffers until png_write_row()
is called for the first time.)
4544 4545

    filters = PNG_FILTER_NONE | PNG_FILTER_SUB
4546
              PNG_FILTER_UP | PNG_FILTER_AVG |
4547 4548
              PNG_FILTER_PAETH | PNG_ALL_FILTERS;

4549 4550
    png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
       filters);
4551 4552 4553 4554 4555 4556
              The second parameter can also be
              PNG_INTRAPIXEL_DIFFERENCING if you are
              writing a PNG to be embedded in a MNG
              datastream.  This parameter must be the
              same as the value of filter_method used
              in png_set_IHDR().
4557 4558

It is also possible to influence how libpng chooses from among the
4559 4560 4561
available filters.  This is done in one or both of two ways - by
telling it how important it is to keep the same filter for successive
rows, and by telling it the relative computational costs of the filters.
4562 4563 4564 4565 4566

    double weights[3] = {1.5, 1.3, 1.1},
       costs[PNG_FILTER_VALUE_LAST] =
       {1.0, 1.3, 1.3, 1.5, 1.7};

4567 4568
    png_set_filter_heuristics(png_ptr,
       PNG_FILTER_HEURISTIC_WEIGHTED, 3,
4569 4570
       weights, costs);

4571 4572 4573 4574
The weights are multiplying factors that indicate to libpng that the
row filter should be the same for successive rows unless another row filter
is that many times better than the previous filter.  In the above example,
if the previous 3 filters were SUB, SUB, NONE, the SUB filter could have a
4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585
"sum of absolute differences" 1.5 x 1.3 times higher than other filters
and still be chosen, while the NONE filter could have a sum 1.1 times
higher than other filters and still be chosen.  Unspecified weights are
taken to be 1.0, and the specified weights should probably be declining
like those above in order to emphasize recent filters over older filters.

The filter costs specify for each filter type a relative decoding cost
to be considered when selecting row filters.  This means that filters
with higher costs are less likely to be chosen over filters with lower
costs, unless their "sum of absolute differences" is that much smaller.
The costs do not necessarily reflect the exact computational speeds of
4586
the various filters, since this would unduly influence the final image
4587 4588 4589 4590 4591 4592
size.

Note that the numbers above were invented purely for this example and
are given only to help explain the function usage.  Little testing has
been done to find optimum values for either the costs or the weights.

4593
.SS Removing unwanted object code
4594 4595 4596

There are a bunch of #define's in pngconf.h that control what parts of
libpng are compiled.  All the defines end in _SUPPORTED.  If you are
4597 4598 4599 4600 4601
never going to use a capability, you can change the #define to #undef
before recompiling libpng and save yourself code and data space, or
you can turn off individual capabilities with defines that begin with
PNG_NO_.

4602 4603
In libpng-1.5.0 and later, the #define's are in pnglibconf.h instead.

4604
You can also turn all of the transforms and ancillary chunk capabilities
4605
off en masse with compiler directives that define
4606 4607
PNG_NO_READ[or WRITE]_TRANSFORMS, or PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS,
or all four,
4608
along with directives to turn on any of the capabilities that you do
4609 4610 4611 4612 4613 4614 4615 4616
want.  The PNG_NO_READ[or WRITE]_TRANSFORMS directives disable the extra
transformations but still leave the library fully capable of reading
and writing PNG files with all known public chunks. Use of the
PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS directive produces a library
that is incapable of reading or writing ancillary chunks.  If you are
not using the progressive reading capability, you can turn that off
with PNG_NO_PROGRESSIVE_READ (don't confuse this with the INTERLACING
capability, which you'll still have).
4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630

All the reading and writing specific code are in separate files, so the
linker should only grab the files it needs.  However, if you want to
make sure, or if you are building a stand alone library, all the
reading files start with pngr and all the writing files start with
pngw.  The files that don't match either (like png.c, pngtrans.c, etc.)
are used for both reading and writing, and always need to be included.
The progressive reader is in pngpread.c

If you are creating or distributing a dynamically linked library (a .so
or DLL file), you should not remove or disable any parts of the library,
as this will cause applications linked with different versions of the
library to fail if they call functions not available in your library.
The size of the library itself should not be an issue, because only
4631 4632
those sections that are actually used will be loaded into memory.

4633
.SS Requesting debug printout
4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655

The macro definition PNG_DEBUG can be used to request debugging
printout.  Set it to an integer value in the range 0 to 3.  Higher
numbers result in increasing amounts of debugging information.  The
information is printed to the "stderr" file, unless another file
name is specified in the PNG_DEBUG_FILE macro definition.

When PNG_DEBUG > 0, the following functions (macros) become available:

   png_debug(level, message)
   png_debug1(level, message, p1)
   png_debug2(level, message, p1, p2)

in which "level" is compared to PNG_DEBUG to decide whether to print
the message, "message" is the formatted string to be printed,
and p1 and p2 are parameters that are to be embedded in the string
according to printf-style formatting directives.  For example,

   png_debug1(2, "foo=%d\n", foo);

is expanded to

4656 4657
   if (PNG_DEBUG > 2)
      fprintf(PNG_DEBUG_FILE, "foo=%d\n", foo);
4658 4659 4660 4661 4662 4663 4664

When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
can still use PNG_DEBUG to control your own debugging:

   #ifdef PNG_DEBUG
       fprintf(stderr, ...
   #endif
4665

4666 4667 4668
When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
having level = 0 will be printed.  There aren't any such statements in
this version of libpng, but if you insert some they will be printed.
4669

4670
.SH VI.  MNG support
4671 4672 4673 4674 4675 4676 4677

The MNG specification (available at http://www.libpng.org/pub/mng) allows
certain extensions to PNG for PNG images that are embedded in MNG datastreams.
Libpng can support some of these extensions.  To enable them, use the
png_permit_mng_features() function:

   feature_set = png_permit_mng_features(png_ptr, mask)
4678

4679
   mask is a png_uint_32 containing the bitwise OR of the
4680 4681 4682 4683
        features you want to enable.  These include
        PNG_FLAG_MNG_EMPTY_PLTE
        PNG_FLAG_MNG_FILTER_64
        PNG_ALL_MNG_FEATURES
4684

4685
   feature_set is a png_uint_32 that is the bitwise AND of
4686 4687 4688
      your mask with the set of MNG features that is
      supported by the version of libpng that you are using.

4689 4690
It is an error to use this function when reading or writing a standalone
PNG file with the PNG 8-byte signature.  The PNG datastream must be wrapped
4691 4692 4693 4694 4695
in a MNG datastream.  As a minimum, it must have the MNG 8-byte signature
and the MHDR and MEND chunks.  Libpng does not provide support for these
or any other MNG chunks; your application must provide its own support for
them.  You may wish to consider using libmng (available at
http://www.libmng.com) instead.
4696

4697
.SH VII.  Changes to Libpng from version 0.88
4698 4699 4700 4701 4702 4703 4704 4705 4706

It should be noted that versions of libpng later than 0.96 are not
distributed by the original libpng author, Guy Schalnat, nor by
Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
distributed versions 0.89 through 0.96, but rather by another member
of the original PNG Group, Glenn Randers-Pehrson.  Guy and Andreas are
still alive and well, but they have moved on to other things.

The old libpng functions png_read_init(), png_write_init(),
4707
png_info_init(), png_read_destroy(), and png_write_destroy() have been
4708
moved to PNG_INTERNAL in version 0.95 to discourage their use.  These
4709
functions will be removed from libpng version 1.4.0.
4710 4711

The preferred method of creating and initializing the libpng structures is
4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724
via the png_create_read_struct(), png_create_write_struct(), and
png_create_info_struct() because they isolate the size of the structures
from the application, allow version error checking, and also allow the
use of custom error handling routines during the initialization, which
the old functions do not.  The functions png_read_destroy() and
png_write_destroy() do not actually free the memory that libpng
allocated for these structs, but just reset the data structures, so they
can be used instead of png_destroy_read_struct() and
png_destroy_write_struct() if you feel there is too much system overhead
allocating and freeing the png_struct for each image read.

Setting the error callbacks via png_set_message_fn() before
png_read_init() as was suggested in libpng-0.88 is no longer supported
4725
because this caused applications that do not use custom error functions
4726 4727
to fail if the png_ptr was not initialized to zero.  It is still possible
to set the error callbacks AFTER png_read_init(), or to change them with
4728 4729 4730
png_set_error_fn(), which is essentially the same function, but with a new
name to force compilation errors with applications that try to use the old
method.
4731

4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745
Starting with version 1.0.7, you can find out which version of the library
you are using at run-time:

   png_uint_32 libpng_vn = png_access_version_number();

The number libpng_vn is constructed from the major version, minor
version with leading zero, and release number with leading zero,
(e.g., libpng_vn for version 1.0.7 is 10007).

You can also check which version of png.h you used when compiling your
application:

   png_uint_32 application_vn = PNG_LIBPNG_VER;

4746
.SH VIII.  Changes to Libpng from version 1.0.x to 1.2.x
4747

4748 4749 4750 4751 4752
Support for user memory management was enabled by default.  To
accomplish this, the functions png_create_read_struct_2(),
png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
png_malloc_default(), and png_free_default() were added.

4753 4754 4755
Support for the iTXt chunk has been enabled by default as of
version 1.2.41.

4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809
Support for certain MNG features was enabled.

Support for numbered error messages was added.  However, we never got
around to actually numbering the error messages.  The function
png_set_strip_error_numbers() was added (Note: the prototype for this
function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
builds of libpng-1.2.15.  It was restored in libpng-1.2.36).

The png_malloc_warn() function was added at libpng-1.2.3.  This issues
a png_warning and returns NULL instead of aborting when it fails to
acquire the requested memory allocation.

Support for setting user limits on image width and height was enabled
by default.  The functions png_set_user_limits(), png_get_user_width_max(),
and png_get_user_height_max() were added at libpng-1.2.6.

The png_set_add_alpha() function was added at libpng-1.2.7.

The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
deprecated.

A number of macro definitions in support of runtime selection of
assembler code features (especially Intel MMX code support) were
added at libpng-1.2.0:

    PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
    PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
    PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
    PNG_ASM_FLAG_MMX_READ_INTERLACE
    PNG_ASM_FLAG_MMX_READ_FILTER_SUB
    PNG_ASM_FLAG_MMX_READ_FILTER_UP
    PNG_ASM_FLAG_MMX_READ_FILTER_AVG
    PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
    PNG_ASM_FLAGS_INITIALIZED
    PNG_MMX_READ_FLAGS
    PNG_MMX_FLAGS
    PNG_MMX_WRITE_FLAGS
    PNG_MMX_FLAGS

We added the following functions in support of runtime
selection of assembler code features:

    png_get_mmx_flagmask()
    png_set_mmx_thresholds()
    png_get_asm_flags()
    png_get_mmx_bitdepth_threshold()
    png_get_mmx_rowbytes_threshold()
    png_set_asm_flags()

We replaced all of these functions with simple stubs in libpng-1.2.20,
when the Intel assembler code was removed due to a licensing issue.

4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
These macros are deprecated:

    PNG_READ_TRANSFORMS_NOT_SUPPORTED
    PNG_PROGRESSIVE_READ_NOT_SUPPORTED
    PNG_NO_SEQUENTIAL_READ_SUPPORTED
    PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
    PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
    PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED

They have been replaced, respectively, by:

    PNG_NO_READ_TRANSFORMS
    PNG_NO_PROGRESSIVE_READ
    PNG_NO_SEQUENTIAL_READ
    PNG_NO_WRITE_TRANSFORMS
    PNG_NO_READ_ANCILLARY_CHUNKS
    PNG_NO_WRITE_ANCILLARY_CHUNKS

4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841
PNG_MAX_UINT was replaced with PNG_UINT_31_MAX.  It has been
deprecated since libpng-1.0.16 and libpng-1.2.6.

The function
    png_check_sig(sig, num)
was replaced with
    !png_sig_cmp(sig, 0, num)
It has been deprecated since libpng-0.90.

The function
    png_set_gray_1_2_4_to_8()
which also expands tRNS to alpha was replaced with
    png_set_expand_gray_1_2_4_to_8()
which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
4842

4843 4844 4845 4846 4847
.SH IX.  Changes to Libpng from version 1.0.x/1.2.x to 1.4.x

Private libpng prototypes and macro definitions were moved from
png.h and pngconf.h into a new pngpriv.h header file.

4848 4849 4850 4851 4852 4853 4854 4855
Functions png_set_benign_errors(), png_benign_error(), and
png_chunk_benign_error() were added.

Support for setting the maximum amount of memory that the application
will allocate for reading chunks was added, as a security measure.
The functions png_set_chunk_cache_max() and png_get_chunk_cache_max()
were added to the library.

4856 4857
We implemented support for I/O states by adding png_ptr member io_state
and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c
4858

4859 4860 4861 4862 4863
We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level
input transforms.

Checking for and reporting of errors in the IHDR chunk is more thorough.

4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876
Support for global arrays was removed, to improve thread safety.

Some obsolete/deprecated macros and functions have been removed.

Typecasted NULL definitions such as
   #define png_voidp_NULL            (png_voidp)NULL
were eliminated.  If you used these in your application, just use
NULL instead.

The png_struct and info_struct members "trans" and "trans_values" were
changed to "trans_alpha" and "trans_color", respectively.

The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles
4877
were removed.
4878 4879 4880

The PNG_1_0_X and PNG_1_2_X macros were eliminated.

4881 4882 4883 4884 4885 4886 4887 4888
The PNG_LEGACY_SUPPORTED macro was eliminated.

Many WIN32_WCE #ifdefs were removed.

The functions png_read_init(info_ptr), png_write_init(info_ptr),
png_info_init(info_ptr), png_read_destroy(), and png_write_destroy()
have been removed.  They have been deprecated since libpng-0.95.

4889 4890 4891 4892 4893 4894 4895 4896
The png_permit_empty_plte() was removed. It has been deprecated
since libpng-1.0.9.  Use png_permit_mng_features() instead.

We removed the obsolete stub functions png_get_mmx_flagmask(),
png_set_mmx_thresholds(), png_get_asm_flags(),
png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(),
png_set_asm_flags(), and png_mmx_supported()

4897
We removed the obsolete png_check_sig(), png_memcpy_check(), and
4898 4899
png_memset_check() functions.  Instead use !png_sig_cmp(), memcpy(),
and memset(), respectively.
4900

4901 4902 4903
The function png_set_gray_1_2_4_to_8() was removed. It has been
deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with
png_set_expand_gray_1_2_4_to_8() because the former function also
4904
expanded any tRNS chunk to an alpha channel.
4905

4906 4907 4908
Macros for png_get_uint_16, png_get_uint_32, and png_get_int_32
were added and are used by default instead of the corresponding
functions. Unfortunately,
4909
from libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
4910 4911
function) incorrectly returned a value of type png_uint_32.

4912 4913 4914 4915 4916
We changed the prototype for png_malloc() from
    png_malloc(png_structp png_ptr, png_uint_32 size)
to
    png_malloc(png_structp png_ptr, png_alloc_size_t size)

4917 4918
This also applies to the prototype for the user replacement malloc_fn().

4919
The png_calloc() function was added and is used in place of
4920
of "png_malloc(); memset();" except in the case in png_read_png()
4921 4922 4923 4924 4925
where the array consists of pointers; in this case a "for" loop is used
after the png_malloc() to set the pointers to NULL, to give robust.
behavior in case the application runs out of memory part-way through
the process.

4926 4927 4928 4929
We changed the prototypes of png_get_compression_buffer_size() and
png_set_compression_buffer_size() to work with png_size_t instead of
png_uint_32.

4930 4931 4932
Support for numbered error messages was removed by default, since we
never got around to actually numbering the error messages. The function
png_set_strip_error_numbers() was removed from the library by default.
4933 4934

The png_zalloc() and png_zfree() functions are no longer exported.
4935 4936
The png_zalloc() function no longer zeroes out the memory that it
allocates.
4937

4938
Support for dithering was disabled by default in libpng-1.4.0, because
4939 4940
it has not been well tested and doesn't actually "dither".
The code was not
4941 4942 4943 4944 4945
removed, however, and could be enabled by building libpng with
PNG_READ_DITHER_SUPPORTED defined.  In libpng-1.4.2, this support
was reenabled, but the function was renamed png_set_quantize() to
reflect more accurately what it actually does.  At the same time,
the PNG_DITHER_[RED,GREEN_BLUE]_BITS macros were also renamed to
4946 4947
PNG_QUANTIZE_[RED,GREEN,BLUE]_BITS, and PNG_READ_DITHER_SUPPORTED
was renamed to PNG_READ_QUANTIZE_SUPPORTED.
4948

4949 4950
We removed the trailing '.' from the warning and error messages.

4951 4952
.SH X.  Changes to Libpng from version 1.4.x to 1.5.x

4953
From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
4954 4955
function) incorrectly returned a value of type png_uint_32.

4956 4957 4958 4959 4960 4961 4962 4963
A. Changes that affect users of libpng

There are no substantial API changes between the non-deprecated parts of
the 1.4.5 API and the 1.5.0 API, however the ability to directly access
the main libpng control structures, png_struct and png_info, deprecated
in earlier versions of libpng, has been completely removed from
libpng 1.5.

4964 4965 4966 4967 4968 4969 4970 4971 4972
We no longer include zlib.h in png.h.  Applications that need access
to information in zlib.h will need to add the '#include "zlib.h"'
directive.  It does not matter whether it is placed prior to or after
the '"#include png.h"' directive.

We moved the png_strcpy(), png_strncpy(), png_strlen(), png_memcpy(),
png_memcmp(), png_sprintf, and png_memcpy() macros into a private
header file (pngpriv.h) that is not accessible to applications.

4973
In png_get_iCCP, the type of "profile" was changed from png_charpp
4974
to png_bytepp, and in png_set_iCCP, from png_charp to png_const_bytep.
4975

4976 4977
There are changes of form in png.h, including new and changed macros to
declare
4978
parts of the API.  Some API functions with arguments that are pointers to
4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989
data not modified within the function have been corrected to declare
these arguments with PNG_CONST.

Much of the internal use of C macros to control the library build has also
changed and some of this is visible in the exported header files, in
particular the use of macros to control data and API elements visible
during application compilation may require significant revision to
application code.  (It is extremely rare for an application to do this.)

Any program that compiled against libpng 1.4 and did not use deprecated
features or access internal library structures should compile and work
4990 4991
against libpng 1.5, except for the change in the prototype for
png_get_iCCP() and png_set_iCCP() API functions mentioned above.
4992

4993 4994 4995 4996
libpng 1.5.0 adds PNG_ PASS macros to help in the reading and writing of
interlaced images.  The macros return the number of rows and columns in
each pass and information that can be used to de-interlace and (if
absolutely necessary) interlace an image.
4997 4998

libpng 1.5.0 adds an API png_longjmp(png_ptr, value).  This API calls
4999
the application-provided png_longjmp_ptr on the internal, but application
5000 5001 5002 5003
initialized, jmpbuf.  It is provided as a convenience to avoid the need
initialized, longjmp buffer.  It is provided as a convenience to avoid
the need to use the png_jmpbuf macro, which had the unnecessary side
effect of resetting the internal png_longjmp_ptr value.
5004 5005 5006 5007 5008 5009 5010 5011 5012

libpng 1.5.0 includes a complete fixed point API.  By default this is
present along with the corresponding floating point API.  In general the
fixed point API is faster and smaller than the floating point one because
the PNG file format used fixed point, not floating point.  This applies
even if the library uses floating point in internal calculations.  A new
macro, PNG_FLOATING_ARITHMETIC_SUPPORTED, reveals whether the library
uses floating point arithmetic (the default) or fixed point arithmetic
internally for performance critical calculations such as gamma correction.
5013 5014 5015 5016 5017 5018
In some cases, the gamma calculations may produce slightly different
results.  This has changed the results in png_rgb_to_gray and in alpha
composition (png_set_background for example). This applies even if the
original image was already linear (gamma == 1.0) and, therefore, it is
not necessary to linearize the image.  This is because libpng has *not*
been changed to optimize that case correctly, yet.
5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045

Fixed point support for the sCAL chunk comes with an important caveat;
the sCAL specification uses a decimal encoding of floating point values
and the accuracy of PNG fixed point values is insufficient for
representation of these values. Consequently a "string" API
(png_get_sCAL_s and png_set_sCAL_s) is the only reliable way of reading
arbitrary sCAL chunks in the absence of either the floating point API or
internal floating point calculations.

Applications no longer need to include the optional distribution header
file pngusr.h or define the corresponding macros during application
build in order to see the correct variant of the libpng API.  From 1.5.0
application code can check for the corresponding _SUPPORTED macro:

#ifdef PNG_INCH_CONVERSIONS_SUPPORTED
   /* code that uses the inch conversion APIs. */
#endif

This macro will only be defined if the inch conversion functions have been
compiled into libpng.  The full set of macros, and whether or not support
has been compiled in, are available in the header file pnglibconf.h.
This header file is specific to the libpng build.  Notice that prior to
1.5.0 the _SUPPORTED macros would always have the default definition unless
reset by pngusr.h or by explicit settings on the compiler command line.
These settings may produce compiler warnings or errors in 1.5.0 because
of macro redefinition.

5046
From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
5047 5048 5049 5050 5051 5052 5053 5054 5055
function) incorrectly returned a value of type png_uint_32.  libpng 1.5.0
is consistent with the implementation in 1.4.5 and 1.2.x (where the macro
did not exist.)

Applications can now choose whether to use these macros or to call the
corresponding function by defining PNG_USE_READ_MACROS or
PNG_NO_USE_READ_MACROS before including png.h.  Notice that this is
only supported from 1.5.0 -defining PNG_NO_USE_READ_MACROS prior to 1.5.0
 will lead to a link failure.
5056

5057
Prior to libpng-1.5.4, the zlib compressor used the same set of parameters
5058
when compressing the IDAT data and textual data such as zTXt and iCCP.
5059
In libpng-1.5.4 we reinitialized the zlib stream for each type of data.
5060 5061 5062
We added five png_set_text_*() functions for setting the parameters to
use with textual data.

5063
Prior to libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
5064
option was off by default, and slightly inaccurate scaling occurred.
5065 5066 5067 5068
This option can no longer be turned off, and the choice of accurate
or inaccurate 16-to-8 scaling is by using the new png_set_scale_16_to_8()
API for accurate scaling or the old png_set_strip_16_to_8() API for simple
chopping.
5069

5070
Prior to libpng-1.5.4, the png_set_user_limits() function could only be
5071 5072 5073 5074
used to reduce the width and height limits from the value of
PNG_USER_WIDTH_MAX and PNG_USER_HEIGHT_MAX, although this document said
that it could be used to override them.  Now this function will reduce or
increase the limits.
5075

5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109
B. Changes to the build and configuration of libpng

Details of internal changes to the library code can be found in the CHANGES
file.  These will be of no concern to the vast majority of library users or
builders, however the few who configure libpng to a non-default feature
set may need to change how this is done.

There should be no need for library builders to alter build scripts if
these use the distributed build support - configure or the makefiles -
however users of the makefiles may care to update their build scripts
to build pnglibconf.h where the corresponding makefile does not do so.

Building libpng with a non-default configuration has changed completely.
The old method using pngusr.h should still work correctly even though the
way pngusr.h is used in the build has been changed, however library
builders will probably want to examine the changes to take advantage of
new capabilities and to simplify their build system.

B.1 Specific changes to library configuration capabilities

The library now supports a complete fixed point implementation and can
thus be used on systems which have no floating point support or very
limited or slow support.  Previously gamma correction, an essential part
of complete PNG support, required reasonably fast floating point.

As part of this the choice of internal implementation has been made
independent of the choice of fixed versus floating point APIs and all the
missing fixed point APIs have been implemented.

The exact mechanism used to control attributes of API functions has
changed.  A single set of operating system independent macro definitions
is used and operating system specific directives are defined in
pnglibconf.h

5110 5111
As part of this the mechanism used to choose procedure call standards on
those systems that allow a choice has been changed.  At present this only
5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128
affects certain Microsoft (DOS, Windows) and IBM (OS/2) operating systems
running on Intel processors.  As before PNGAPI is defined where required
to control the exported API functions; however, two new macros, PNGCBAPI
and PNGCAPI, are used instead for callback functions (PNGCBAPI) and
(PNGCAPI) for functions that must match a C library prototype (currently
only png_longjmp_ptr, which must match the C longjmp function.)  The new
approach is documented in pngconf.h

Despite these changes libpng 1.5.0 only supports the native C function
calling standard on those platforms tested so far (__cdecl on Microsoft
Windows).  This is because the support requirements for alternative
calling conventions seem to no longer exist.  Developers who find it
necessary to set PNG_API_RULE to 1 should advise the mailing list
(png-mng-implement) of this and library builders who use Openwatcom and
therefore set PNG_API_RULE to 2 should also contact the mailing list.

A new test program, pngvalid, is provided in addition to pngtest.
5129
pngvalid validates the arithmetic accuracy of the gamma correction
5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211
calculations and includes a number of validations of the file format.
A subset of the full range of tests is run when "make check" is done
(in the 'configure' build.)  pngvalid also allows total allocated memory
usage to be evaluated and performs additional memory overwrite validation.

Many changes to individual feature macros have been made. The following
are the changes most likely to be noticed by library builders who
configure libpng:

1) All feature macros now have consistent naming:

#define PNG_NO_feature turns the feature off
#define PNG_feature_SUPPORTED turns the feature on

pnglibconf.h contains one line for each feature macro which is either:

#define PNG_feature_SUPPORTED

if the feature is supported or:

/*#undef PNG_feature_SUPPORTED*/

if it is not.  Library code consistently checks for the 'SUPPORTED' macro.
It does not, and should not, check for the 'NO' macro which will not
normally be defined even if the feature is not supported.

Compatibility with the old names is provided as follows:

PNG_INCH_CONVERSIONS turns on PNG_INCH_CONVERSIONS_SUPPORTED

And the following definitions disable the corresponding feature:

PNG_SETJMP_NOT_SUPPORTED disables SETJMP
PNG_READ_TRANSFORMS_NOT_SUPPORTED disables READ_TRANSFORMS
PNG_NO_READ_COMPOSITED_NODIV disables READ_COMPOSITE_NODIV
PNG_WRITE_TRANSFORMS_NOT_SUPPORTED disables WRITE_TRANSFORMS
PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED disables READ_ANCILLARY_CHUNKS
PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED disables WRITE_ANCILLARY_CHUNKS

Library builders should remove use of the above, inconsistent, names.

2) Warning and error message formatting was previously conditional on
the STDIO feature. The library has been changed to use the
CONSOLE_IO feature instead. This means that if CONSOLE_IO is disabled
the library no longer uses the printf(3) functions, even though the
default read/write implementations use (FILE) style stdio.h functions.

3) Three feature macros now control the fixed/floating point decisions:

PNG_FLOATING_POINT_SUPPORTED enables the floating point APIs

PNG_FIXED_POINT_SUPPORTED enables the fixed point APIs; however, in
practice these are normally required internally anyway (because the PNG
file format is fixed point), therefore in most cases PNG_NO_FIXED_POINT
merely stops the function from being exported.

PNG_FLOATING_ARITHMETIC_SUPPORTED chooses between the internal floating
point implementation or the fixed point one.  Typically the fixed point
implementation is larger and slower than the floating point implementation
on a system that supports floating point, however it may be faster on a
system which lacks floating point hardware and therefore uses a software
emulation.

4) Added PNG_{READ,WRITE}_INT_FUNCTIONS_SUPPORTED.  This allows the
functions to read and write ints to be disabled independently of
PNG_USE_READ_MACROS, which allows libpng to be built with the functions
even though the default is to use the macros - this allows applications
to choose at app buildtime whether or not to use macros (previously
impossible because the functions weren't in the default build.)

B.2 Changes to the configuration mechanism

Prior to libpng-1.5.0 library builders who needed to configure libpng
had either to modify the exported pngconf.h header file to add system
specific configuration or had to write feature selection macros into
pngusr.h and cause this to be included into pngconf.h by defining
PNG_USER_CONFIG. The latter mechanism had the disadvantage that an
application built without PNG_USER_CONFIG defined would see the
unmodified, default, libpng API and thus would probably fail to link.

These mechanisms still work in the configure build and in any makefile
build that builds pnglibconf.h although the feature selection macros
5212 5213
have changed somewhat as described above.  In 1.5.0, however, pngusr.h is
processed only once, when the exported header file pnglibconf.h is built.
5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239
pngconf.h no longer includes pngusr.h, therefore it is ignored after the
build of pnglibconf.h and it is never included in an application build.

The rarely used alternative of adding a list of feature macros to the
CFLAGS setting in the build also still works, however the macros will be
copied to pnglibconf.h and this may produce macro redefinition warnings
when the individual C files are compiled.

All configuration now only works if pnglibconf.h is built from
scripts/pnglibconf.dfa.  This requires the program awk.  Brian Kernighan
(the original author of awk) maintains C source code of that awk and this
and all known later implementations (often called by subtly different
names - nawk and gawk for example) are adequate to build pnglibconf.h.
The Sun Microsystems (now Oracle) program 'awk' is an earlier version
and does not work, this may also apply to other systems that have a
functioning awk called 'nawk'.

Configuration options are now documented in scripts/pnglibconf.dfa.  This
file also includes dependency information that ensures a configuration is
consistent; that is, if a feature is switched off dependent features are
also removed.  As a recommended alternative to using feature macros in
pngusr.h a system builder may also define equivalent options in pngusr.dfa
(or, indeed, any file) and add that to the configuration by setting
DFA_XTRA to the file name.  The makefiles in contrib/pngminim illustrate
how to do this, and a case where pngusr.h is still required.

5240
.SH XI. Detecting libpng
5241 5242 5243 5244

The png_get_io_ptr() function has been present since libpng-0.88, has never
changed, and is unaffected by conditional compilation macros.  It is the
best choice for use in configure scripts for detecting the presence of any
5245 5246 5247
libpng version since 0.88.  In an autoconf "configure.in" you could use

    AC_CHECK_LIB(png, png_get_io_ptr, ...
5248

5249
.SH XII. Source code repository
5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267

Since about February 2009, version 1.2.34, libpng has been under "git" source
control.  The git repository was built from old libpng-x.y.z.tar.gz files
going back to version 0.70.  You can access the git repository (read only)
at

    git://libpng.git.sourceforge.net/gitroot/libpng

or you can browse it via "gitweb" at

    http://libpng.git.sourceforge.net/git/gitweb.cgi?p=libpng

Patches can be sent to glennrp at users.sourceforge.net or to
png-mng-implement at lists.sourceforge.net or you can upload them to
the libpng bug tracker at

    http://libpng.sourceforge.net

5268 5269 5270 5271 5272
We also accept patches built from the tar or zip distributions, and
simple verbal discriptions of bug fixes, reported either to the
SourceForge bug tracker or to the png-mng-implement at lists.sf.net
mailing list.

5273
.SH XIII. Coding style
5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296

Our coding style is similar to the "Allman" style, with curly
braces on separate lines:

    if (condition)
    {
       action;
    }

    else if (another condition)
    {
       another action;
    }

The braces can be omitted from simple one-line actions:

    if (condition)
       return (0);

We use 3-space indentation, except for continued statements which
are usually indented the same as the first line of the statement
plus four more spaces.

5297 5298 5299 5300 5301 5302 5303 5304 5305
For macro definitions we use 2-space indentation, always leaving the "#"
in the first column.

    #ifndef PNG_NO_FEATURE
    #  ifndef PNG_FEATURE_SUPPORTED
    #    define PNG_FEATURE_SUPPORTED
    #  endif
    #endif

5306 5307 5308 5309 5310 5311
Comments appear with the leading "/*" at the same indentation as
the statement that follows the comment:

    /* Single-line comment */
    statement;

5312 5313
    /* This is a multiple-line
     * comment.
5314 5315 5316
     */
    statement;

5317
Very short comments can be placed after the end of the statement
5318 5319 5320 5321 5322 5323 5324 5325
to which they pertain:

    statement;    /* comment */

We don't use C++ style ("//") comments. We have, however,
used them in the past in some now-abandoned MMX assembler
code.

G
Glenn Randers-Pehrson 已提交
5326
Functions and their curly braces are not indented, and
5327 5328 5329
exported functions are marked with PNGAPI:

 /* This is a public function that is visible to
5330
  * application programmers. It does thus-and-so.
5331 5332 5333 5334 5335 5336 5337
  */
 void PNGAPI
 png_exported_function(png_ptr, png_info, foo)
 {
    body;
 }

5338 5339 5340 5341
The prototypes for all exported functions appear in png.h,
above the comment that says

    /* Maintainer: Put new public prototypes here ... */
5342 5343 5344 5345 5346 5347 5348 5349 5350

We mark all non-exported functions with "/* PRIVATE */"":

 void /* PRIVATE */
 png_non_exported_function(png_ptr, png_info, foo)
 {
    body;
 }

5351
The prototypes for non-exported functions (except for those in
5352 5353
pngtest) appear in
pngpriv.h
5354 5355 5356
above the comment that says

  /* Maintainer: Put new private prototypes here ^ and in libpngpf.3 */
5357

5358 5359 5360 5361
To avoid polluting the global namespace, the names of all exported
functions and variables begin with  "png_", and all publicly visible C
preprocessor macros begin with "PNG_".  We request that applications that
use libpng *not* begin any of their own symbols with either of these strings.
5362 5363

We put a space after each comma and after each semicolon
5364
in "for" statements, and we put spaces before and after each
5365 5366 5367
C binary operator and after "for" or "while", and before
"?".  We don't put a space between a typecast and the expression
being cast, nor do we put one between a function name and the
5368 5369 5370
left parenthesis that follows it:

    for (i = 2; i > 0; --i)
5371
       y[i] = a(x) + (int)b;
5372

5373 5374 5375
We prefer #ifdef and #ifndef to #if defined() and if !defined()
when there is only one macro being tested.

5376 5377
We do not use the TAB character for indentation in the C sources.

5378 5379
Lines do not exceed 80 characters.

5380
Other rules can be inferred by inspecting the libpng source.
5381

5382
.SH XIV. Y2K Compliance in libpng
5383

5384
July 10, 2011
5385 5386 5387 5388

Since the PNG Development group is an ad-hoc body, we can't make
an official declaration.

5389
This is your unofficial assurance that libpng from version 0.71 and
5390
upward through 1.5.5beta01 are Y2K compliant.  It is my belief that earlier
5391
versions were also Y2K compliant.
5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405

Libpng only has three year fields.  One is a 2-byte unsigned integer that
will hold years up to 65535.  The other two hold the date in text
format, and will hold years up to 9999.

The integer is
    "png_uint_16 year" in png_time_struct.

The strings are
    "png_charp time_buffer" in png_struct and
    "near_time_buffer", which is a local character string in png.c.

There are seven time-related functions:

5406
    png_convert_to_rfc_1123() in png.c
5407
      (formerly png_convert_to_rfc_1152() in error)
5408 5409
    png_convert_from_struct_tm() in pngwrite.c, called
      in pngwrite.c
5410 5411 5412 5413 5414 5415
    png_convert_from_time_t() in pngwrite.c
    png_get_tIME() in pngget.c
    png_handle_tIME() in pngrutil.c, called in pngread.c
    png_set_tIME() in pngset.c
    png_write_tIME() in pngwutil.c, called in pngwrite.c

5416
All appear to handle dates properly in a Y2K environment.  The
5417 5418 5419 5420
png_convert_from_time_t() function calls gmtime() to convert from system
clock time, which returns (year - 1900), which we properly convert to
the full 4-digit year.  There is a possibility that applications using
libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
5421 5422 5423 5424 5425
function, or that they are incorrectly passing only a 2-digit year
instead of "year - 1900" into the png_convert_from_struct_tm() function,
but this is not under our control.  The libpng documentation has always
stated that it works with 4-digit years, and the APIs have been
documented as such.
5426 5427 5428 5429

The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
integer to hold the year, and can hold years as large as 65535.

5430 5431 5432
zlib, upon which libpng depends, is also Y2K compliant.  It contains
no date-related code.

5433 5434 5435 5436 5437

   Glenn Randers-Pehrson
   libpng maintainer
   PNG Development Group

5438 5439 5440 5441 5442 5443 5444 5445 5446 5447
.SH NOTE

Note about libpng version numbers:

Due to various miscommunications, unforeseen code incompatibilities
and occasional factors outside the authors' control, version numbering
on the library has not always been consistent and straightforward.
The following table summarizes matters since version 0.89c, which was
the first widely used release:

5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483
 source             png.h  png.h  shared-lib
 version            string   int  version
 -------            ------  ----- ----------
 0.89c ("beta 3")  0.89       89  1.0.89
 0.90  ("beta 4")  0.90       90  0.90
 0.95  ("beta 5")  0.95       95  0.95
 0.96  ("beta 6")  0.96       96  0.96
 0.97b ("beta 7")  1.00.97    97  1.0.1
 0.97c             0.97       97  2.0.97
 0.98              0.98       98  2.0.98
 0.99              0.99       98  2.0.99
 0.99a-m           0.99       99  2.0.99
 1.00              1.00      100  2.1.0
 1.0.0             1.0.0     100  2.1.0
 1.0.0   (from here on, the  100  2.1.0
 1.0.1    png.h string is  10001  2.1.0
 1.0.1a-e identical to the 10002  from here on, the
 1.0.2    source version)  10002  shared library is 2.V
 1.0.2a-b                  10003  where V is the source
 1.0.1                     10001  code version except as
 1.0.1a-e                  10002  2.1.0.1a-e   noted.
 1.0.2                     10002  2.1.0.2
 1.0.2a-b                  10003  2.1.0.2a-b
 1.0.3                     10003  2.1.0.3
 1.0.3a-d                  10004  2.1.0.3a-d
 1.0.4                     10004  2.1.0.4
 1.0.4a-f                  10005  2.1.0.4a-f
 1.0.5 (+ 2 patches)       10005  2.1.0.5
 1.0.5a-d                  10006  2.1.0.5a-d
 1.0.5e-r                  10100  2.1.0.5e-r
 1.0.5s-v                  10006  2.1.0.5s-v
 1.0.6 (+ 3 patches)       10006  2.1.0.6
 1.0.6d-g                  10007  2.1.0.6d-g
 1.0.6h                    10007  10.6h
 1.0.6i                    10007  10.6i
 1.0.6j                    10007  2.1.0.6j
5484
 1.0.7beta11-14    DLLNUM  10007  2.1.0.7beta11-14
5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495
 1.0.7beta15-18       1    10007  2.1.0.7beta15-18
 1.0.7rc1-2           1    10007  2.1.0.7rc1-2
 1.0.7                1    10007  2.1.0.7
 1.0.8beta1-4         1    10008  2.1.0.8beta1-4
 1.0.8rc1             1    10008  2.1.0.8rc1
 1.0.8                1    10008  2.1.0.8
 1.0.9beta1-6         1    10009  2.1.0.9beta1-6
 1.0.9rc1             1    10009  2.1.0.9rc1
 1.0.9beta7-10        1    10009  2.1.0.9beta7-10
 1.0.9rc2             1    10009  2.1.0.9rc2
 1.0.9                1    10009  2.1.0.9
5496
 1.0.10beta1          1    10010  2.1.0.10beta1
5497
 1.0.10rc1            1    10010  2.1.0.10rc1
5498
 1.0.10               1    10010  2.1.0.10
5499
 1.0.11beta1-3        1    10011  2.1.0.11beta1-3
5500
 1.0.11rc1            1    10011  2.1.0.11rc1
5501
 1.0.11               1    10011  2.1.0.11
5502 5503 5504 5505
 1.0.12beta1-2        2    10012  2.1.0.12beta1-2
 1.0.12rc1            2    10012  2.1.0.12rc1
 1.0.12               2    10012  2.1.0.12
 1.1.0a-f             -    10100  2.1.1.0a-f abandoned
5506
 1.2.0beta1-2         2    10200  2.1.2.0beta1-2
5507 5508 5509
 1.2.0beta3-5         3    10200  3.1.2.0beta3-5
 1.2.0rc1             3    10200  3.1.2.0rc1
 1.2.0                3    10200  3.1.2.0
5510
 1.2.1beta-4          3    10201  3.1.2.1beta1-4
5511 5512
 1.2.1rc1-2           3    10201  3.1.2.1rc1-2
 1.2.1                3    10201  3.1.2.1
5513
 1.2.2beta1-6        12    10202  12.so.0.1.2.2beta1-6
5514 5515 5516
 1.0.13beta1         10    10013  10.so.0.1.0.13beta1
 1.0.13rc1           10    10013  10.so.0.1.0.13rc1
 1.2.2rc1            12    10202  12.so.0.1.2.2rc1
5517 5518
 1.0.13              10    10013  10.so.0.1.0.13
 1.2.2               12    10202  12.so.0.1.2.2
5519 5520
 1.2.3rc1-6          12    10203  12.so.0.1.2.3rc1-6
 1.2.3               12    10203  12.so.0.1.2.3
5521
 1.2.4beta1-3        13    10204  12.so.0.1.2.4beta1-3
5522
 1.2.4rc1            13    10204  12.so.0.1.2.4rc1
5523 5524
 1.0.14              10    10014  10.so.0.1.0.14
 1.2.4               13    10204  12.so.0.1.2.4
5525 5526
 1.2.5beta1-2        13    10205  12.so.0.1.2.5beta1-2
 1.0.15rc1           10    10015  10.so.0.1.0.15rc1
5527 5528 5529
 1.0.15              10    10015  10.so.0.1.0.15
 1.2.5               13    10205  12.so.0.1.2.5
 1.2.6beta1-4        13    10206  12.so.0.1.2.6beta1-4
5530 5531 5532
 1.2.6rc1-5          13    10206  12.so.0.1.2.6rc1-5
 1.0.16              10    10016  10.so.0.1.0.16
 1.2.6               13    10206  12.so.0.1.2.6
5533
 1.2.7beta1-2        13    10207  12.so.0.1.2.7beta1-2
5534 5535
 1.0.17rc1           10    10017  12.so.0.1.0.17rc1
 1.2.7rc1            13    10207  12.so.0.1.2.7rc1
5536 5537
 1.0.17              10    10017  12.so.0.1.0.17
 1.2.7               13    10207  12.so.0.1.2.7
5538
 1.2.8beta1-5        13    10208  12.so.0.1.2.8beta1-5
5539 5540
 1.0.18rc1-5         10    10018  12.so.0.1.0.18rc1-5
 1.2.8rc1-5          13    10208  12.so.0.1.2.8rc1-5
5541 5542
 1.0.18              10    10018  12.so.0.1.0.18
 1.2.8               13    10208  12.so.0.1.2.8
5543
 1.2.9beta1-3        13    10209  12.so.0.1.2.9beta1-3
5544
 1.2.9beta4-11       13    10209  12.so.0.9[.0]
5545
 1.2.9rc1            13    10209  12.so.0.9[.0]
5546
 1.2.9               13    10209  12.so.0.9[.0]
5547
 1.2.10beta1-7       13    10210  12.so.0.10[.0]
5548
 1.2.10rc1-2         13    10210  12.so.0.10[.0]
5549
 1.2.10              13    10210  12.so.0.10[.0]
5550
 1.4.0beta1-6        14    10400  14.so.0.0[.0]
5551
 1.2.11beta1-4       13    10210  12.so.0.11[.0]
5552
 1.4.0beta7-8        14    10400  14.so.0.0[.0]
5553 5554 5555 5556
 1.2.11              13    10211  12.so.0.11[.0]
 1.2.12              13    10212  12.so.0.12[.0]
 1.4.0beta9-14       14    10400  14.so.0.0[.0]
 1.2.13              13    10213  12.so.0.13[.0]
5557
 1.4.0beta15-36      14    10400  14.so.0.0[.0]
5558
 1.4.0beta37-87      14    10400  14.so.14.0[.0]
5559
 1.4.0rc01           14    10400  14.so.14.0[.0]
5560
 1.4.0beta88-109     14    10400  14.so.14.0[.0]
5561
 1.4.0rc02-08        14    10400  14.so.14.0[.0]
5562
 1.4.0               14    10400  14.so.14.0[.0]
5563 5564
 1.4.1beta01-03      14    10401  14.so.14.1[.0]
 1.4.1rc01           14    10401  14.so.14.1[.0]
5565
 1.4.1beta04-12      14    10401  14.so.14.1[.0]
5566
 1.4.1               14    10401  14.so.14.1[.0]
5567 5568
 1.4.2               14    10402  14.so.14.2[.0]
 1.4.3               14    10403  14.so.14.3[.0]
5569
 1.4.4               14    10404  14.so.14.4[.0]
5570
 1.5.0beta01-58      15    10500  15.so.15.0[.0]
5571
 1.5.0rc01-07        15    10500  15.so.15.0[.0]
5572
 1.5.0               15    10500  15.so.15.0[.0]
5573
 1.5.1beta01-11      15    10501  15.so.15.1[.0]
5574 5575
 1.5.1rc01-02        15    10501  15.so.15.1[.0]
 1.5.1               15    10501  15.so.15.1[.0]
5576
 1.5.2beta01-03      15    10502  15.so.15.2[.0]
5577
 1.5.2rc01-03        15    10502  15.so.15.2[.0]
5578
 1.5.2               15    10502  15.so.15.2[.0]
5579
 1.5.3beta01-10      15    10503  15.so.15.3[.0]
5580
 1.5.3rc01-02        15    10503  15.so.15.3[.0]
5581 5582
 1.5.3beta11         15    10503  15.so.15.3[.0]
 1.5.3 [omitted]
5583
 1.5.4beta01-08      15    10504  15.so.15.4[.0]
5584
 1.5.4rc01           15    10504  15.so.15.4[.0]
5585
 1.5.4               15    10504  15.so.15.4[.0]
5586 5587 5588 5589 5590 5591 5592

Henceforth the source version will match the shared-library minor
and patch numbers; the shared-library major version number will be
used for changes in backward compatibility, as it is intended.  The
PNG_PNGLIB_VER macro, which is not used within libpng but is available
for applications, is an unsigned integer of the form xyyzz corresponding
to the source version x.y.z (leading zeros in y and z).  Beta versions
5593 5594 5595
were given the previous public release number plus a letter, until
version 1.0.6j; from then on they were given the upcoming public
release number plus "betaNN" or "rcN".
5596

5597
.SH "SEE ALSO"
5598
.BR "png"(5), " libpngpf"(3), " zlib"(3), " deflate"(5), " " and " zlib"(5)
5599

5600
.LP
5601 5602
.IR libpng :
.IP
5603
http://libpng.sourceforge.net (follow the [DOWNLOAD] link)
5604
http://www.libpng.org/pub/png
5605

5606
.LP
5607 5608 5609 5610 5611 5612
.IR zlib :
.IP
(generally) at the same location as
.I libpng
or at
.br
5613
ftp://ftp.info-zip.org/pub/infozip/zlib
5614

5615 5616
.LP
.IR PNG specification: RFC 2083
5617 5618 5619 5620 5621 5622 5623 5624 5625 5626
.IP
(generally) at the same location as
.I libpng
or at
.br
ftp://ds.internic.net/rfc/rfc2083.txt
.br
or (as a W3C Recommendation) at
.br
http://www.w3.org/TR/REC-png.html
5627

5628
.LP
5629 5630 5631
In the case of any inconsistency between the PNG specification
and this library, the specification takes precedence.

5632
.SH AUTHORS
5633
This man page: Glenn Randers-Pehrson
5634
<glennrp at users.sourceforge.net>
5635 5636 5637 5638 5639 5640

The contributing authors would like to thank all those who helped
with testing, bug fixes, and patience.  This wouldn't have been
possible without all of you.

Thanks to Frank J. T. Wojcik for helping with the documentation.
5641

5642
Libpng version 1.5.5beta01 - July 10, 2011:
5643
Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
5644
Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
5645

5646 5647
Supported by the PNG development group
.br
5648 5649
png-mng-implement at lists.sf.net
(subscription required; visit
5650
png-mng-implement at lists.sourceforge.net (subscription required; visit
5651 5652
https://lists.sourceforge.net/lists/listinfo/png-mng-implement
to subscribe).
5653

5654
.SH COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
5655

5656 5657 5658 5659
(This copy of the libpng notices is provided for your convenience.  In case of
any discrepancy between this copy and the notices in the file png.h that is
included in the libpng distribution, the latter shall prevail.)

5660 5661
If you modify libpng you may insert additional notices immediately following
this sentence.
5662

5663
This code is released under the libpng license.
5664

5665
libpng versions 1.2.6, August 15, 2004, through 1.5.5beta01, July 10, 2011, are
5666
Copyright (c) 2004,2006-2007 Glenn Randers-Pehrson, and are
5667
distributed according to the same disclaimer and license as libpng-1.2.5
5668
with the following individual added to the list of Contributing Authors
5669 5670 5671 5672

   Cosmin Truta

libpng versions 1.0.7, July 1, 2000, through 1.2.5 - October 3, 2002, are
5673
Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
5674
distributed according to the same disclaimer and license as libpng-1.0.6
5675 5676 5677 5678 5679 5680 5681 5682
with the following individuals added to the list of Contributing Authors

   Simon-Pierre Cadieux
   Eric S. Raymond
   Gilles Vollant

and with the following additions to the disclaimer:

5683 5684 5685 5686 5687 5688 5689
   There is no warranty against interference with your
   enjoyment of the library or against infringement.
   There is no warranty that our efforts or the library
   will fulfill any of your particular purposes or needs.
   This library is provided with all faults, and the entire
   risk of satisfactory quality, performance, accuracy, and
   effort is with the user.
5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703

libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Copyright (c) 1998, 1999 Glenn Randers-Pehrson
Distributed according to the same disclaimer and license as libpng-0.96,
with the following individuals added to the list of Contributing Authors:

   Tom Lane
   Glenn Randers-Pehrson
   Willem van Schaik

libpng versions 0.89, June 1996, through 0.96, May 1997, are
Copyright (c) 1996, 1997 Andreas Dilger
Distributed according to the same disclaimer and license as libpng-0.88,
with the following individuals added to the list of Contributing Authors:
5704 5705 5706 5707 5708 5709

   John Bowler
   Kevin Bracey
   Sam Bushell
   Magnus Holmgren
   Greg Roelofs
5710 5711 5712 5713 5714 5715 5716 5717 5718 5719
   Tom Tanner

libpng versions 0.5, May 1995, through 0.88, January 1996, are
Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.

For the purposes of this copyright and license, "Contributing Authors"
is defined as the following set of individuals:

   Andreas Dilger
   Dave Martindale
5720 5721 5722
   Guy Eric Schalnat
   Paul Schmidt
   Tim Wegner
5723

5724 5725
The PNG Reference Library is supplied "AS IS".  The Contributing Authors
and Group 42, Inc. disclaim all warranties, expressed or implied,
5726 5727 5728 5729 5730
including, without limitation, the warranties of merchantability and of
fitness for any purpose.  The Contributing Authors and Group 42, Inc.
assume no liability for direct, indirect, incidental, special, exemplary,
or consequential damages, which may result from the use of the PNG
Reference Library, even if advised of the possibility of such damage.
5731

5732 5733 5734 5735
Permission is hereby granted to use, copy, modify, and distribute this
source code, or portions hereof, for any purpose, without fee, subject
to the following restrictions:

5736
1. The origin of this source code must not be misrepresented.
5737

5738 5739
2. Altered versions must be plainly marked as such and
   must not be misrepresented as being the original source.
5740

5741 5742
3. This Copyright notice may not be removed or altered from
   any source or altered source distribution.
5743 5744 5745 5746 5747 5748 5749

The Contributing Authors and Group 42, Inc. specifically permit, without
fee, and encourage the use of this source code as a component to
supporting the PNG file format in commercial products.  If you use this
source code in a product, acknowledgment is not required but would be
appreciated.

5750

5751 5752 5753 5754 5755 5756
A "png_get_copyright" function is available, for convenient use in "about"
boxes and the like:

   printf("%s",png_get_copyright(NULL));

Also, the PNG logo (in PNG format, of course) is supplied in the
5757
files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
5758

5759
Libpng is OSI Certified Open Source Software.  OSI Certified Open Source is a
5760 5761
certification mark of the Open Source Initiative.

5762
Glenn Randers-Pehrson
5763
glennrp at users.sourceforge.net
5764
July 10, 2011
5765

5766 5767
.\" end of man page