l4/pkg/libpng/lib/contrib/libpng.3

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