libpng.3

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