fukasawa e60969
.TH LIBPNG 3 "January 15, 2016"
fukasawa e60969
.SH NAME
fukasawa e60969
libpng \- Portable Network Graphics (PNG) Reference Library 1.6.21
fukasawa e60969
.SH SYNOPSIS
fukasawa e60969
\fB
fukasawa e60969
#include <png.h>\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_access_version_number \fI(void\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_build_grayscale_palette (int \fP\fIbit_depth\fP\fB, png_colorp \fIpalette\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_calloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_chunk_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_chunk_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_chunk_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_convert_from_struct_tm (png_timep \fP\fIptime\fP\fB, struct tm FAR * \fIttime\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_convert_from_time_t (png_timep \fP\fIptime\fP\fB, time_t \fIttime\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_charp png_convert_to_rfc1123 (png_structp \fP\fIpng_ptr\fP\fB, png_timep \fIptime\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_infop png_create_info_struct (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_destroy_info_struct (png_structp \fP\fIpng_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_destroy_write_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_err (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_free (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_free_chunk_list (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_free_default (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_free_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fInum\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_bit_depth (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_channels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_chunk_cache_max (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_alloc_size_t png_get_chunk_malloc_max (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_color_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_compression_buffer_size (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_compression_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_copyright (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_current_row_number \fI(png_const_structp\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_current_pass_number \fI(png_const_structp\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_error_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_filter_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_header_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_header_version (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_image_height (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_image_width (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_int_32 png_get_int_32 (png_bytep \fIbuf\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_interlace_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_io_chunk_type (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_io_ptr (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_io_state (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_libpng_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBint png_get_palette_max(png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_mem_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBfloat png_get_pixel_aspect_ratio (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_progressive_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_byte png_get_rgb_to_gray_status (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_rowbytes (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_bytepp png_get_rows (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_bytep png_get_signature (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fB/* This function is really an inline macro. \fI*/
fukasawa e60969
fukasawa e60969
\fBpng_uint_16 png_get_uint_16 (png_bytep \fIbuf\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_uint_31 (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIbuf\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fB/* This function is really an inline macro. \fI*/
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_uint_32 (png_bytep \fIbuf\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_user_chunk_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_user_height_max (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_get_user_transform_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_get_user_width_max (png_const_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBfloat png_get_x_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_fixed_point png_get_x_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_int_32 png_get_x_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_int_32 png_get_x_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBfloat png_get_y_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_fixed_point png_get_y_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_int_32 png_get_y_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_int_32 png_get_y_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBint png_handle_as_unknown (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIchunk_name\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBint png_image_begin_read_from_file (png_imagep \fP\fIimage\fP\fB, const char \fI*file_name\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBint png_image_begin_read_from_stdio (png_imagep \fP\fIimage\fP\fB, FILE* \fIfile\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_image_free (png_imagep \fIimage\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_info_init_3 (png_infopp \fP\fIinfo_ptr\fP\fB, png_size_t \fIpng_info_struct_size\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_init_io (png_structp \fP\fIpng_ptr\fP\fB, FILE \fI*fp\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_longjmp (png_structp \fP\fIpng_ptr\fP\fB, int \fIval\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_malloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_malloc_default (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_voidp png_malloc_warn (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_permit_mng_features (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fImng_features_permitted\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBpng_size_t png_process_data_pause \fP\fI(png_structp\fP\fB, int \fIsave\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBpng_uint_32 png_process_data_skip \fI(png_structp\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_read_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_read_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_read_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_read_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIrow\fP\fB, png_bytep \fIdisplay_row\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_read_update_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBint png_reset_zstream (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_save_int_32 (png_bytep \fP\fIbuf\fP\fB, png_int_32 \fIi\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_save_uint_16 (png_bytep \fP\fIbuf\fP\fB, unsigned int \fIi\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_save_uint_32 (png_bytep \fP\fIbuf\fP\fB, png_uint_32 \fIi\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_add_alpha (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_alpha_mode (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, double \fIoutput_gamma\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_benign_errors (png_structp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_bgr (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_check_for_invalid_index(png_structrp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_chunk_cache_max (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIuser_chunk_cache_max\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_crc_action (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIcrit_action\fP\fB, int \fIancil_action\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_expand (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_expand_16 (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_expand_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_filler (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_filter (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImethod\fP\fB, int \fIfilters\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_flush (png_structp \fP\fIpng_ptr\fP\fB, int \fInrows\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_gamma (png_structp \fP\fIpng_ptr\fP\fB, double \fP\fIscreen_gamma\fP\fB, double \fIdefault_file_gamma\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fIfile_gamma\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_gray_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBint png_set_interlace_handling (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_invalid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fImask\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_invert_alpha (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_invert_mono (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_chunk_malloc_max (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIuser_chunk_cache_max\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_compression_buffer_size (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBint png_set_option(png_structrp \fP\fIpng_ptr\fP\fB, int \fP\fIoption\fP\fB, int \fIonoff\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_packing (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_packswap (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_palette_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_read_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_read_status_ptr \fIread_row_fn\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_scale_16 (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_shift (png_structp \fP\fIpng_ptr\fP\fB, png_color_8p \fItrue_bits\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_sig_bytes (png_structp \fP\fIpng_ptr\fP\fB, int \fInum_bytes\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_strip_16 (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_strip_alpha (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_strip_error_numbers (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIstrip_mode\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_swap (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_swap_alpha (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_text_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_text_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_text_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_set_text_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid \fP\fIpng_set_text_compression_method\fP\fB, (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod)\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_tRNS_to_alpha (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_set_write_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_write_status_ptr \fIwrite_row_fn\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_start_read_image (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_write_chunk_end (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_write_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_write_flush (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_write_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_write_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\fBvoid png_write_info_before_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_write_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIrow\fP\fB);\fP
fukasawa e60969
fukasawa e60969
\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
fukasawa e60969
fukasawa e60969
\fBvoid png_write_sig (png_structp \fIpng_ptr\fP\fB);\fP
fukasawa e60969
fukasawa e60969
.SH DESCRIPTION
fukasawa e60969
The
fukasawa e60969
.I libpng
fukasawa e60969
library supports encoding, decoding, and various manipulations of
fukasawa e60969
the Portable Network Graphics (PNG) format image files.  It uses the
fukasawa e60969
.IR zlib(3)
fukasawa e60969
compression library.
fukasawa e60969
Following is a copy of the libpng-manual.txt file that accompanies libpng.
fukasawa e60969
.SH LIBPNG.TXT
fukasawa e60969
libpng-manual.txt - A description on how to use and modify libpng
fukasawa e60969
fukasawa e60969
 libpng version 1.6.21 - January 15, 2016
fukasawa e60969
 Updated and distributed by Glenn Randers-Pehrson
fukasawa e60969
 <glennrp at users.sourceforge.net>
fukasawa e60969
 Copyright (c) 1998-2016 Glenn Randers-Pehrson
fukasawa e60969
fukasawa e60969
 This document is released under the libpng license.
fukasawa e60969
 For conditions of distribution and use, see the disclaimer
fukasawa e60969
 and license in png.h
fukasawa e60969
fukasawa e60969
 Based on:
fukasawa e60969
fukasawa e60969
 libpng versions 0.97, January 1998, through 1.6.21 - January 15, 2016
fukasawa e60969
 Updated and distributed by Glenn Randers-Pehrson
fukasawa e60969
 Copyright (c) 1998-2016 Glenn Randers-Pehrson
fukasawa e60969
fukasawa e60969
 libpng 1.0 beta 6 - version 0.96 - May 28, 1997
fukasawa e60969
 Updated and distributed by Andreas Dilger
fukasawa e60969
 Copyright (c) 1996, 1997 Andreas Dilger
fukasawa e60969
fukasawa e60969
 libpng 1.0 beta 2 - version 0.88 - January 26, 1996
fukasawa e60969
 For conditions of distribution and use, see copyright
fukasawa e60969
 notice in png.h. Copyright (c) 1995, 1996 Guy Eric
fukasawa e60969
 Schalnat, Group 42, Inc.
fukasawa e60969
fukasawa e60969
 Updated/rewritten per request in the libpng FAQ
fukasawa e60969
 Copyright (c) 1995, 1996 Frank J. T. Wojcik
fukasawa e60969
 December 18, 1995 & January 20, 1996
fukasawa e60969
fukasawa e60969
 TABLE OF CONTENTS
fukasawa e60969
fukasawa e60969
    I. Introduction
fukasawa e60969
   II. Structures
fukasawa e60969
  III. Reading
fukasawa e60969
   IV. Writing
fukasawa e60969
    V. Simplified API
fukasawa e60969
   VI. Modifying/Customizing libpng
fukasawa e60969
  VII. MNG support
fukasawa e60969
 VIII. Changes to Libpng from version 0.88
fukasawa e60969
   IX. Changes to Libpng from version 1.0.x to 1.2.x
fukasawa e60969
    X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
fukasawa e60969
   XI. Changes to Libpng from version 1.4.x to 1.5.x
fukasawa e60969
  XII. Changes to Libpng from version 1.5.x to 1.6.x
fukasawa e60969
 XIII. Detecting libpng
fukasawa e60969
  XIV. Source code repository
fukasawa e60969
   XV. Coding style
fukasawa e60969
  XVI. Y2K Compliance in libpng
fukasawa e60969
fukasawa e60969
.SH I. Introduction
fukasawa e60969
fukasawa e60969
This file describes how to use and modify the PNG reference library
fukasawa e60969
(known as libpng) for your own use.  In addition to this
fukasawa e60969
file, example.c is a good starting point for using the library, as
fukasawa e60969
it is heavily commented and should include everything most people
fukasawa e60969
will need.  We assume that libpng is already installed; see the
fukasawa e60969
INSTALL file for instructions on how to configure and install libpng.
fukasawa e60969
fukasawa e60969
For examples of libpng usage, see the files "example.c", "pngtest.c",
fukasawa e60969
and the files in the "contrib" directory, all of which are included in
fukasawa e60969
the libpng distribution.
fukasawa e60969
fukasawa e60969
Libpng was written as a companion to the PNG specification, as a way
fukasawa e60969
of reducing the amount of time and effort it takes to support the PNG
fukasawa e60969
file format in application programs.
fukasawa e60969
fukasawa e60969
The PNG specification (second edition), November 2003, is available as
fukasawa e60969
a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2004 (E)) at
fukasawa e60969
fukasawa e60969
The W3C and ISO documents have identical technical content.
fukasawa e60969
fukasawa e60969
The PNG-1.2 specification is available at
fukasawa e60969
<http://png-mng.sourceforge.net/pub/png/spec/1.2/>.
fukasawa e60969
It is technically equivalent
fukasawa e60969
to the PNG specification (second edition) but has some additional material.
fukasawa e60969
fukasawa e60969
The PNG-1.0 specification is available as RFC 2083 
fukasawa e60969
<http://png-mng.sourceforge.net/pub/png/spec/1.0/> and as a
fukasawa e60969
W3C Recommendation <http://www.w3.org/TR/REC-png-961001>.
fukasawa e60969
fukasawa e60969
Some additional chunks are described in the special-purpose public chunks
fukasawa e60969
documents at <http://www.libpng.org/pub/png/spec/register/>
fukasawa e60969
fukasawa e60969
Other information
fukasawa e60969
about PNG, and the latest version of libpng, can be found at the PNG home
fukasawa e60969
page, <http://www.libpng.org/pub/png/>.
fukasawa e60969
fukasawa e60969
Most users will not have to modify the library significantly; advanced
fukasawa e60969
users may want to modify it more.  All attempts were made to make it as
fukasawa e60969
complete as possible, while keeping the code easy to understand.
fukasawa e60969
Currently, this library only supports C.  Support for other languages
fukasawa e60969
is being considered.
fukasawa e60969
fukasawa e60969
Libpng has been designed to handle multiple sessions at one time,
fukasawa e60969
to be easily modifiable, to be portable to the vast majority of
fukasawa e60969
machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
fukasawa e60969
to use.  The ultimate goal of libpng is to promote the acceptance of
fukasawa e60969
the PNG file format in whatever way possible.  While there is still
fukasawa e60969
work to be done (see the TODO file), libpng should cover the
fukasawa e60969
majority of the needs of its users.
fukasawa e60969
fukasawa e60969
Libpng uses zlib for its compression and decompression of PNG files.
fukasawa e60969
Further information about zlib, and the latest version of zlib, can
fukasawa e60969
be found at the zlib home page, <http://zlib.net/>.
fukasawa e60969
The zlib compression utility is a general purpose utility that is
fukasawa e60969
useful for more than PNG files, and can be used without libpng.
fukasawa e60969
See the documentation delivered with zlib for more details.
fukasawa e60969
You can usually find the source files for the zlib utility wherever you
fukasawa e60969
find the libpng source files.
fukasawa e60969
fukasawa e60969
Libpng is thread safe, provided the threads are using different
fukasawa e60969
instances of the structures.  Each thread should have its own
fukasawa e60969
png_struct and png_info instances, and thus its own image.
fukasawa e60969
Libpng does not protect itself against two threads using the
fukasawa e60969
same instance of a structure.
fukasawa e60969
fukasawa e60969
.SH II. Structures
fukasawa e60969
fukasawa e60969
There are two main structures that are important to libpng, png_struct
fukasawa e60969
and png_info.  Both are internal structures that are no longer exposed
fukasawa e60969
in the libpng interface (as of libpng 1.5.0).
fukasawa e60969
fukasawa e60969
The png_info structure is designed to provide information about the
fukasawa e60969
PNG file.  At one time, the fields of png_info were intended to be
fukasawa e60969
directly accessible to the user.  However, this tended to cause problems
fukasawa e60969
with applications using dynamically loaded libraries, and as a result
fukasawa e60969
a set of interface functions for png_info (the png_get_*() and png_set_*()
fukasawa e60969
functions) was developed, and direct access to the png_info fields was
fukasawa e60969
deprecated..
fukasawa e60969
fukasawa e60969
The png_struct structure is the object used by the library to decode a
fukasawa e60969
single image.  As of 1.5.0 this structure is also not exposed.
fukasawa e60969
fukasawa e60969
Almost all libpng APIs require a pointer to a png_struct as the first argument.
fukasawa e60969
Many (in particular the png_set and png_get APIs) also require a pointer
fukasawa e60969
to png_info as the second argument.  Some application visible macros
fukasawa e60969
defined in png.h designed for basic data access (reading and writing
fukasawa e60969
integers in the PNG format) don't take a png_info pointer, but it's almost
fukasawa e60969
always safe to assume that a (png_struct*) has to be passed to call an API
fukasawa e60969
function.
fukasawa e60969
fukasawa e60969
You can have more than one png_info structure associated with an image,
fukasawa e60969
as illustrated in pngtest.c, one for information valid prior to the
fukasawa e60969
IDAT chunks and another (called "end_info" below) for things after them.
fukasawa e60969
fukasawa e60969
The png.h header file is an invaluable reference for programming with libpng.
fukasawa e60969
And while I'm on the topic, make sure you include the libpng header file:
fukasawa e60969
fukasawa e60969
#include <png.h>
fukasawa e60969
fukasawa e60969
and also (as of libpng-1.5.0) the zlib header file, if you need it:
fukasawa e60969
fukasawa e60969
#include <zlib.h>
fukasawa e60969
fukasawa e60969
.SS Types
fukasawa e60969
fukasawa e60969
The png.h header file defines a number of integral types used by the
fukasawa e60969
APIs.  Most of these are fairly obvious; for example types corresponding
fukasawa e60969
to integers of particular sizes and types for passing color values.
fukasawa e60969
fukasawa e60969
One exception is how non-integral numbers are handled.  For application
fukasawa e60969
convenience most APIs that take such numbers have C (double) arguments;
fukasawa e60969
however, internally PNG, and libpng, use 32 bit signed integers and encode
fukasawa e60969
the value by multiplying by 100,000.  As of libpng 1.5.0 a convenience
fukasawa e60969
macro PNG_FP_1 is defined in png.h along with a type (png_fixed_point)
fukasawa e60969
which is simply (png_int_32).
fukasawa e60969
fukasawa e60969
All APIs that take (double) arguments also have a matching API that
fukasawa e60969
takes the corresponding fixed point integer arguments.  The fixed point
fukasawa e60969
API has the same name as the floating point one with "_fixed" appended.
fukasawa e60969
The actual range of values permitted in the APIs is frequently less than
fukasawa e60969
the full range of (png_fixed_point) (\-21474 to +21474).  When APIs require
fukasawa e60969
a non-negative argument the type is recorded as png_uint_32 above.  Consult
fukasawa e60969
the header file and the text below for more information.
fukasawa e60969
fukasawa e60969
Special care must be take with sCAL chunk handling because the chunk itself
fukasawa e60969
uses non-integral values encoded as strings containing decimal floating point
fukasawa e60969
numbers.  See the comments in the header file.
fukasawa e60969
fukasawa e60969
.SS Configuration
fukasawa e60969
fukasawa e60969
The main header file function declarations are frequently protected by C
fukasawa e60969
preprocessing directives of the form:
fukasawa e60969
fukasawa e60969
    #ifdef PNG_feature_SUPPORTED
fukasawa e60969
    declare-function
fukasawa e60969
    #endif
fukasawa e60969
    ...
fukasawa e60969
    #ifdef PNG_feature_SUPPORTED
fukasawa e60969
    use-function
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
The library can be built without support for these APIs, although a
fukasawa e60969
standard build will have all implemented APIs.  Application programs
fukasawa e60969
should check the feature macros before using an API for maximum
fukasawa e60969
portability.  From libpng 1.5.0 the feature macros set during the build
fukasawa e60969
of libpng are recorded in the header file "pnglibconf.h" and this file
fukasawa e60969
is always included by png.h.
fukasawa e60969
fukasawa e60969
If you don't need to change the library configuration from the default, skip to
fukasawa e60969
the next section ("Reading").
fukasawa e60969
fukasawa e60969
Notice that some of the makefiles in the 'scripts' directory and (in 1.5.0) all
fukasawa e60969
of the build project files in the 'projects' directory simply copy
fukasawa e60969
scripts/pnglibconf.h.prebuilt to pnglibconf.h.  This means that these build
fukasawa e60969
systems do not permit easy auto-configuration of the library - they only
fukasawa e60969
support the default configuration.
fukasawa e60969
fukasawa e60969
The easiest way to make minor changes to the libpng configuration when
fukasawa e60969
auto-configuration is supported is to add definitions to the command line
fukasawa e60969
using (typically) CPPFLAGS.  For example:
fukasawa e60969
fukasawa e60969
CPPFLAGS=\-DPNG_NO_FLOATING_ARITHMETIC
fukasawa e60969
fukasawa e60969
will change the internal libpng math implementation for gamma correction and
fukasawa e60969
other arithmetic calculations to fixed point, avoiding the need for fast
fukasawa e60969
floating point support.  The result can be seen in the generated pnglibconf.h -
fukasawa e60969
make sure it contains the changed feature macro setting.
fukasawa e60969
fukasawa e60969
If you need to make more extensive configuration changes - more than one or two
fukasawa e60969
feature macro settings - you can either add \-DPNG_USER_CONFIG to the build
fukasawa e60969
command line and put a list of feature macro settings in pngusr.h or you can set
fukasawa e60969
DFA_XTRA (a makefile variable) to a file containing the same information in the
fukasawa e60969
form of 'option' settings.
fukasawa e60969
fukasawa e60969
A. Changing pnglibconf.h
fukasawa e60969
fukasawa e60969
A variety of methods exist to build libpng.  Not all of these support
fukasawa e60969
reconfiguration of pnglibconf.h.  To reconfigure pnglibconf.h it must either be
fukasawa e60969
rebuilt from scripts/pnglibconf.dfa using awk or it must be edited by hand.
fukasawa e60969
fukasawa e60969
Hand editing is achieved by copying scripts/pnglibconf.h.prebuilt to
fukasawa e60969
pnglibconf.h and changing the lines defining the supported features, paying
fukasawa e60969
very close attention to the 'option' information in scripts/pnglibconf.dfa
fukasawa e60969
that describes those features and their requirements.  This is easy to get
fukasawa e60969
wrong.
fukasawa e60969
fukasawa e60969
B. Configuration using DFA_XTRA
fukasawa e60969
fukasawa e60969
Rebuilding from pnglibconf.dfa is easy if a functioning 'awk', or a later
fukasawa e60969
variant such as 'nawk' or 'gawk', is available.  The configure build will
fukasawa e60969
automatically find an appropriate awk and build pnglibconf.h.
fukasawa e60969
The scripts/pnglibconf.mak file contains a set of make rules for doing the
fukasawa e60969
same thing if configure is not used, and many of the makefiles in the scripts
fukasawa e60969
directory use this approach.
fukasawa e60969
fukasawa e60969
When rebuilding simply write a new file containing changed options and set
fukasawa e60969
DFA_XTRA to the name of this file.  This causes the build to append the new file
fukasawa e60969
to the end of scripts/pnglibconf.dfa.  The pngusr.dfa file should contain lines
fukasawa e60969
of the following forms:
fukasawa e60969
fukasawa e60969
everything = off
fukasawa e60969
fukasawa e60969
This turns all optional features off.  Include it at the start of pngusr.dfa to
fukasawa e60969
make it easier to build a minimal configuration.  You will need to turn at least
fukasawa e60969
some features on afterward to enable either reading or writing code, or both.
fukasawa e60969
fukasawa e60969
option feature on
fukasawa e60969
option feature off
fukasawa e60969
fukasawa e60969
Enable or disable a single feature.  This will automatically enable other
fukasawa e60969
features required by a feature that is turned on or disable other features that
fukasawa e60969
require a feature which is turned off.  Conflicting settings will cause an error
fukasawa e60969
message to be emitted by awk.
fukasawa e60969
fukasawa e60969
setting feature default value
fukasawa e60969
fukasawa e60969
Changes the default value of setting 'feature' to 'value'.  There are a small
fukasawa e60969
number of settings listed at the top of pnglibconf.h, they are documented in the
fukasawa e60969
source code.  Most of these values have performance implications for the library
fukasawa e60969
but most of them have no visible effect on the API.  Some can also be overridden
fukasawa e60969
from the API.
fukasawa e60969
fukasawa e60969
This method of building a customized pnglibconf.h is illustrated in
fukasawa e60969
contrib/pngminim/*.  See the "$(PNGCONF):" target in the makefile and
fukasawa e60969
pngusr.dfa in these directories.
fukasawa e60969
fukasawa e60969
C. Configuration using PNG_USER_CONFIG
fukasawa e60969
fukasawa e60969
If \-DPNG_USER_CONFIG is added to the CPPFLAGS when pnglibconf.h is built,
fukasawa e60969
the file pngusr.h will automatically be included before the options in
fukasawa e60969
scripts/pnglibconf.dfa are processed.  Your pngusr.h file should contain only
fukasawa e60969
macro definitions turning features on or off or setting settings.
fukasawa e60969
fukasawa e60969
Apart from the global setting "everything = off" all the options listed above
fukasawa e60969
can be set using macros in pngusr.h:
fukasawa e60969
fukasawa e60969
#define PNG_feature_SUPPORTED
fukasawa e60969
fukasawa e60969
is equivalent to:
fukasawa e60969
fukasawa e60969
option feature on
fukasawa e60969
fukasawa e60969
#define PNG_NO_feature
fukasawa e60969
fukasawa e60969
is equivalent to:
fukasawa e60969
fukasawa e60969
option feature off
fukasawa e60969
fukasawa e60969
#define PNG_feature value
fukasawa e60969
fukasawa e60969
is equivalent to:
fukasawa e60969
fukasawa e60969
setting feature default value
fukasawa e60969
fukasawa e60969
Notice that in both cases, pngusr.dfa and pngusr.h, the contents of the
fukasawa e60969
pngusr file you supply override the contents of scripts/pnglibconf.dfa
fukasawa e60969
fukasawa e60969
If confusing or incomprehensible behavior results it is possible to
fukasawa e60969
examine the intermediate file pnglibconf.dfn to find the full set of
fukasawa e60969
dependency information for each setting and option.  Simply locate the
fukasawa e60969
feature in the file and read the C comments that precede it.
fukasawa e60969
fukasawa e60969
This method is also illustrated in the contrib/pngminim/* makefiles and
fukasawa e60969
pngusr.h.
fukasawa e60969
fukasawa e60969
.SH III. Reading
fukasawa e60969
fukasawa e60969
We'll now walk you through the possible functions to call when reading
fukasawa e60969
in a PNG file sequentially, briefly explaining the syntax and purpose
fukasawa e60969
of each one.  See example.c and png.h for more detail.  While
fukasawa e60969
progressive reading is covered in the next section, you will still
fukasawa e60969
need some of the functions discussed in this section to read a PNG
fukasawa e60969
file.
fukasawa e60969
fukasawa e60969
.SS Setup
fukasawa e60969
fukasawa e60969
You will want to do the I/O initialization(*) before you get into libpng,
fukasawa e60969
so if it doesn't work, you don't have much to undo.  Of course, you
fukasawa e60969
will also want to insure that you are, in fact, dealing with a PNG
fukasawa e60969
file.  Libpng provides a simple check to see if a file is a PNG file.
fukasawa e60969
To use it, pass in the first 1 to 8 bytes of the file to the function
fukasawa e60969
png_sig_cmp(), and it will return 0 (false) if the bytes match the
fukasawa e60969
corresponding bytes of the PNG signature, or nonzero (true) otherwise.
fukasawa e60969
Of course, the more bytes you pass in, the greater the accuracy of the
fukasawa e60969
prediction.
fukasawa e60969
fukasawa e60969
If you are intending to keep the file pointer open for use in libpng,
fukasawa e60969
you must ensure you don't read more than 8 bytes from the beginning
fukasawa e60969
of the file, and you also have to make a call to png_set_sig_bytes()
fukasawa e60969
with the number of bytes you read from the beginning.  Libpng will
fukasawa e60969
then only check the bytes (if any) that your program didn't read.
fukasawa e60969
fukasawa e60969
(*): If you are not using the standard I/O functions, you will need
fukasawa e60969
to replace them with custom functions.  See the discussion under
fukasawa e60969
Customizing libpng.
fukasawa e60969
fukasawa e60969
    FILE *fp = fopen(file_name, "rb");
fukasawa e60969
    if (!fp)
fukasawa e60969
    {
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    if (fread(header, 1, number, fp) != number)
fukasawa e60969
    {
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    is_png = !png_sig_cmp(header, 0, number);
fukasawa e60969
    if (!is_png)
fukasawa e60969
    {
fukasawa e60969
       return (NOT_PNG);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
Next, png_struct and png_info need to be allocated and initialized.  In
fukasawa e60969
order to ensure that the size of these structures is correct even with a
fukasawa e60969
dynamically linked libpng, there are functions to initialize and
fukasawa e60969
allocate the structures.  We also pass the library version, optional
fukasawa e60969
pointers to error handling functions, and a pointer to a data struct for
fukasawa e60969
use by the error functions, if necessary (the pointer and functions can
fukasawa e60969
be NULL if the default error handlers are to be used).  See the section
fukasawa e60969
on Changes to Libpng below regarding the old initialization functions.
fukasawa e60969
The structure allocation functions quietly return NULL if they fail to
fukasawa e60969
create the structure, so your application should check for that.
fukasawa e60969
fukasawa e60969
    png_structp png_ptr = png_create_read_struct
fukasawa e60969
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
fukasawa e60969
        user_error_fn, user_warning_fn);
fukasawa e60969
fukasawa e60969
    if (!png_ptr)
fukasawa e60969
       return (ERROR);
fukasawa e60969
fukasawa e60969
    png_infop info_ptr = png_create_info_struct(png_ptr);
fukasawa e60969
fukasawa e60969
    if (!info_ptr)
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr,
fukasawa e60969
           (png_infopp)NULL, (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
If you want to use your own memory allocation routines,
fukasawa e60969
use a libpng that was built with PNG_USER_MEM_SUPPORTED defined, and use
fukasawa e60969
png_create_read_struct_2() instead of png_create_read_struct():
fukasawa e60969
fukasawa e60969
    png_structp png_ptr = png_create_read_struct_2
fukasawa e60969
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
fukasawa e60969
        user_error_fn, user_warning_fn, (png_voidp)
fukasawa e60969
        user_mem_ptr, user_malloc_fn, user_free_fn);
fukasawa e60969
fukasawa e60969
The error handling routines passed to png_create_read_struct()
fukasawa e60969
and the memory alloc/free routines passed to png_create_struct_2()
fukasawa e60969
are only necessary if you are not using the libpng supplied error
fukasawa e60969
handling and memory alloc/free functions.
fukasawa e60969
fukasawa e60969
When libpng encounters an error, it expects to longjmp back
fukasawa e60969
to your routine.  Therefore, you will need to call setjmp and pass
fukasawa e60969
your png_jmpbuf(png_ptr).  If you read the file from different
fukasawa e60969
routines, you will need to update the longjmp buffer every time you enter
fukasawa e60969
a new routine that will call a png_*() function.
fukasawa e60969
fukasawa e60969
See your documentation of setjmp/longjmp for your compiler for more
fukasawa e60969
information on setjmp/longjmp.  See the discussion on libpng error
fukasawa e60969
handling in the Customizing Libpng section below for more information
fukasawa e60969
on the libpng error handling.  If an error occurs, and libpng longjmp's
fukasawa e60969
back to your setjmp, you will want to call png_destroy_read_struct() to
fukasawa e60969
free any memory.
fukasawa e60969
fukasawa e60969
    if (setjmp(png_jmpbuf(png_ptr)))
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
           &end_info);
fukasawa e60969
       fclose(fp);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
Pass (png_infopp)NULL instead of &end_info if you didn't create
fukasawa e60969
an end_info structure.
fukasawa e60969
fukasawa e60969
If you would rather avoid the complexity of setjmp/longjmp issues,
fukasawa e60969
you can compile libpng with PNG_NO_SETJMP, in which case
fukasawa e60969
errors will result in a call to PNG_ABORT() which defaults to abort().
fukasawa e60969
fukasawa e60969
You can #define PNG_ABORT() to a function that does something
fukasawa e60969
more useful than abort(), as long as your function does not
fukasawa e60969
return.
fukasawa e60969
fukasawa e60969
Now you need to set up the input code.  The default for libpng is to
fukasawa e60969
use the C function fread().  If you use this, you will need to pass a
fukasawa e60969
valid FILE * in the function png_init_io().  Be sure that the file is
fukasawa e60969
opened in binary mode.  If you wish to handle reading data in another
fukasawa e60969
way, you need not call the png_init_io() function, but you must then
fukasawa e60969
implement the libpng I/O methods discussed in the Customizing Libpng
fukasawa e60969
section below.
fukasawa e60969
fukasawa e60969
    png_init_io(png_ptr, fp);
fukasawa e60969
fukasawa e60969
If you had previously opened the file and read any of the signature from
fukasawa e60969
the beginning in order to see if this was a PNG file, you need to let
fukasawa e60969
libpng know that there are some bytes missing from the start of the file.
fukasawa e60969
fukasawa e60969
    png_set_sig_bytes(png_ptr, number);
fukasawa e60969
fukasawa e60969
You can change the zlib compression buffer size to be used while
fukasawa e60969
reading compressed data with
fukasawa e60969
fukasawa e60969
    png_set_compression_buffer_size(png_ptr, buffer_size);
fukasawa e60969
fukasawa e60969
where the default size is 8192 bytes.  Note that the buffer size
fukasawa e60969
is changed immediately and the buffer is reallocated immediately,
fukasawa e60969
instead of setting a flag to be acted upon later.
fukasawa e60969
fukasawa e60969
If you want CRC errors to be handled in a different manner than
fukasawa e60969
the default, use
fukasawa e60969
fukasawa e60969
    png_set_crc_action(png_ptr, crit_action, ancil_action);
fukasawa e60969
fukasawa e60969
The values for png_set_crc_action() say how libpng is to handle CRC errors in
fukasawa e60969
ancillary and critical chunks, and whether to use the data contained
fukasawa e60969
therein.  Note that it is impossible to "discard" data in a critical
fukasawa e60969
chunk.
fukasawa e60969
fukasawa e60969
Choices for (int) crit_action are
fukasawa e60969
   PNG_CRC_DEFAULT      0  error/quit
fukasawa e60969
   PNG_CRC_ERROR_QUIT   1  error/quit
fukasawa e60969
   PNG_CRC_WARN_USE     3  warn/use data
fukasawa e60969
   PNG_CRC_QUIET_USE    4  quiet/use data
fukasawa e60969
   PNG_CRC_NO_CHANGE    5  use the current value
fukasawa e60969
fukasawa e60969
Choices for (int) ancil_action are
fukasawa e60969
   PNG_CRC_DEFAULT      0  error/quit
fukasawa e60969
   PNG_CRC_ERROR_QUIT   1  error/quit
fukasawa e60969
   PNG_CRC_WARN_DISCARD 2  warn/discard data
fukasawa e60969
   PNG_CRC_WARN_USE     3  warn/use data
fukasawa e60969
   PNG_CRC_QUIET_USE    4  quiet/use data
fukasawa e60969
   PNG_CRC_NO_CHANGE    5  use the current value
fukasawa e60969
fukasawa e60969
.SS Setting up callback code
fukasawa e60969
fukasawa e60969
You can set up a callback function to handle any unknown chunks in the
fukasawa e60969
input stream. You must supply the function
fukasawa e60969
fukasawa e60969
    read_chunk_callback(png_structp png_ptr,
fukasawa e60969
         png_unknown_chunkp chunk);
fukasawa e60969
    {
fukasawa e60969
       /* The unknown chunk structure contains your
fukasawa e60969
          chunk data, along with similar data for any other
fukasawa e60969
          unknown chunks: */
fukasawa e60969
fukasawa e60969
           png_byte name[5];
fukasawa e60969
           png_byte *data;
fukasawa e60969
           png_size_t size;
fukasawa e60969
fukasawa e60969
       /* Note that libpng has already taken care of
fukasawa e60969
          the CRC handling */
fukasawa e60969
fukasawa e60969
       /* put your code here.  Search for your chunk in the
fukasawa e60969
          unknown chunk structure, process it, and return one
fukasawa e60969
          of the following: */
fukasawa e60969
fukasawa e60969
       return (\-n); /* chunk had an error */
fukasawa e60969
       return (0); /* did not recognize */
fukasawa e60969
       return (n); /* success */
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
(You can give your function another name that you like instead of
fukasawa e60969
"read_chunk_callback")
fukasawa e60969
fukasawa e60969
To inform libpng about your function, use
fukasawa e60969
fukasawa e60969
    png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
fukasawa e60969
        read_chunk_callback);
fukasawa e60969
fukasawa e60969
This names not only the callback function, but also a user pointer that
fukasawa e60969
you can retrieve with
fukasawa e60969
fukasawa e60969
    png_get_user_chunk_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
If you call the png_set_read_user_chunk_fn() function, then all unknown
fukasawa e60969
chunks which the callback does not handle will be saved when read.  You can
fukasawa e60969
cause them to be discarded by returning '1' ("handled") instead of '0'.  This
fukasawa e60969
behavior will change in libpng 1.7 and the default handling set by the
fukasawa e60969
png_set_keep_unknown_chunks() function, described below, will be used when the
fukasawa e60969
callback returns 0.  If you want the existing behavior you should set the global
fukasawa e60969
default to PNG_HANDLE_CHUNK_IF_SAFE now; this is compatible with all current
fukasawa e60969
versions of libpng and with 1.7.  Libpng 1.6 issues a warning if you keep the
fukasawa e60969
default, or PNG_HANDLE_CHUNK_NEVER, and the callback returns 0.
fukasawa e60969
fukasawa e60969
At this point, you can set up a callback function that will be
fukasawa e60969
called after each row has been read, which you can use to control
fukasawa e60969
a progress meter or the like.  It's demonstrated in pngtest.c.
fukasawa e60969
You must supply a function
fukasawa e60969
fukasawa e60969
    void read_row_callback(png_structp png_ptr,
fukasawa e60969
       png_uint_32 row, int pass);
fukasawa e60969
    {
fukasawa e60969
      /* put your code here */
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
(You can give it another name that you like instead of "read_row_callback")
fukasawa e60969
fukasawa e60969
To inform libpng about your function, use
fukasawa e60969
fukasawa e60969
    png_set_read_status_fn(png_ptr, read_row_callback);
fukasawa e60969
fukasawa e60969
When this function is called the row has already been completely processed and
fukasawa e60969
the 'row' and 'pass' refer to the next row to be handled.  For the
fukasawa e60969
non-interlaced case the row that was just handled is simply one less than the
fukasawa e60969
passed in row number, and pass will always be 0.  For the interlaced case the
fukasawa e60969
same applies unless the row value is 0, in which case the row just handled was
fukasawa e60969
the last one from one of the preceding passes.  Because interlacing may skip a
fukasawa e60969
pass you cannot be sure that the preceding pass is just 'pass\-1', if you really
fukasawa e60969
need to know what the last pass is record (row,pass) from the callback and use
fukasawa e60969
the last recorded value each time.
fukasawa e60969
fukasawa e60969
As with the user transform you can find the output row using the
fukasawa e60969
PNG_ROW_FROM_PASS_ROW macro.
fukasawa e60969
fukasawa e60969
.SS Unknown-chunk handling
fukasawa e60969
fukasawa e60969
Now you get to set the way the library processes unknown chunks in the
fukasawa e60969
input PNG stream. Both known and unknown chunks will be read.  Normal
fukasawa e60969
behavior is that known chunks will be parsed into information in
fukasawa e60969
various info_ptr members while unknown chunks will be discarded. This
fukasawa e60969
behavior can be wasteful if your application will never use some known
fukasawa e60969
chunk types. To change this, you can call:
fukasawa e60969
fukasawa e60969
    png_set_keep_unknown_chunks(png_ptr, keep,
fukasawa e60969
        chunk_list, num_chunks);
fukasawa e60969
fukasawa e60969
    keep       - 0: default unknown chunk handling
fukasawa e60969
                 1: ignore; do not keep
fukasawa e60969
                 2: keep only if safe-to-copy
fukasawa e60969
                 3: keep even if unsafe-to-copy
fukasawa e60969
fukasawa e60969
               You can use these definitions:
fukasawa e60969
                 PNG_HANDLE_CHUNK_AS_DEFAULT   0
fukasawa e60969
                 PNG_HANDLE_CHUNK_NEVER        1
fukasawa e60969
                 PNG_HANDLE_CHUNK_IF_SAFE      2
fukasawa e60969
                 PNG_HANDLE_CHUNK_ALWAYS       3
fukasawa e60969
fukasawa e60969
    chunk_list - list of chunks affected (a byte string,
fukasawa e60969
                 five bytes per chunk, NULL or '\0' if
fukasawa e60969
                 num_chunks is positive; ignored if
fukasawa e60969
                 numchunks <= 0).
fukasawa e60969
fukasawa e60969
    num_chunks - number of chunks affected; if 0, all
fukasawa e60969
                 unknown chunks are affected.  If positive,
fukasawa e60969
                 only the chunks in the list are affected,
fukasawa e60969
                 and if negative all unknown chunks and
fukasawa e60969
                 all known chunks except for the IHDR,
fukasawa e60969
                 PLTE, tRNS, IDAT, and IEND chunks are
fukasawa e60969
                 affected.
fukasawa e60969
fukasawa e60969
Unknown chunks declared in this way will be saved as raw data onto a
fukasawa e60969
list of png_unknown_chunk structures.  If a chunk that is normally
fukasawa e60969
known to libpng is named in the list, it will be handled as unknown,
fukasawa e60969
according to the "keep" directive.  If a chunk is named in successive
fukasawa e60969
instances of png_set_keep_unknown_chunks(), the final instance will
fukasawa e60969
take precedence.  The IHDR and IEND chunks should not be named in
fukasawa e60969
chunk_list; if they are, libpng will process them normally anyway.
fukasawa e60969
If you know that your application will never make use of some particular
fukasawa e60969
chunks, use PNG_HANDLE_CHUNK_NEVER (or 1) as demonstrated below.
fukasawa e60969
fukasawa e60969
Here is an example of the usage of png_set_keep_unknown_chunks(),
fukasawa e60969
where the private "vpAg" chunk will later be processed by a user chunk
fukasawa e60969
callback function:
fukasawa e60969
fukasawa e60969
    png_byte vpAg[5]={118, 112,  65, 103, (png_byte) '\0'};
fukasawa e60969
fukasawa e60969
    #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
fukasawa e60969
      png_byte unused_chunks[]=
fukasawa e60969
      {
fukasawa e60969
        104,  73,  83,  84, (png_byte) '\0',   /* hIST */
fukasawa e60969
        105,  84,  88, 116, (png_byte) '\0',   /* iTXt */
fukasawa e60969
        112,  67,  65,  76, (png_byte) '\0',   /* pCAL */
fukasawa e60969
        115,  67,  65,  76, (png_byte) '\0',   /* sCAL */
fukasawa e60969
        115,  80,  76,  84, (png_byte) '\0',   /* sPLT */
fukasawa e60969
        116,  73,  77,  69, (png_byte) '\0',   /* tIME */
fukasawa e60969
      };
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
    ...
fukasawa e60969
fukasawa e60969
    #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
fukasawa e60969
      /* ignore all unknown chunks
fukasawa e60969
       * (use global setting "2" for libpng16 and earlier):
fukasawa e60969
       */
fukasawa e60969
      png_set_keep_unknown_chunks(read_ptr, 2, NULL, 0);
fukasawa e60969
fukasawa e60969
      /* except for vpAg: */
fukasawa e60969
      png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
fukasawa e60969
fukasawa e60969
      /* also ignore unused known chunks: */
fukasawa e60969
      png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
fukasawa e60969
         (int)(sizeof unused_chunks)/5);
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
.SS User limits
fukasawa e60969
fukasawa e60969
The PNG specification allows the width and height of an image to be as
fukasawa e60969
large as 2^(31\-1 (0x7fffffff), or about 2.147 billion rows and columns.
fukasawa e60969
For safety, libpng imposes a default limit of 1 million rows and columns.
fukasawa e60969
Larger images will be rejected immediately with a png_error() call. If
fukasawa e60969
you wish to change these limits, you can use
fukasawa e60969
fukasawa e60969
   png_set_user_limits(png_ptr, width_max, height_max);
fukasawa e60969
fukasawa e60969
to set your own limits (libpng may reject some very wide images
fukasawa e60969
anyway because of potential buffer overflow conditions).
fukasawa e60969
fukasawa e60969
You should put this statement after you create the PNG structure and
fukasawa e60969
before calling png_read_info(), png_read_png(), or png_process_data().
fukasawa e60969
fukasawa e60969
When writing a PNG datastream, put this statement before calling
fukasawa e60969
png_write_info() or png_write_png().
fukasawa e60969
fukasawa e60969
If you need to retrieve the limits that are being applied, use
fukasawa e60969
fukasawa e60969
   width_max = png_get_user_width_max(png_ptr);
fukasawa e60969
   height_max = png_get_user_height_max(png_ptr);
fukasawa e60969
fukasawa e60969
The PNG specification sets no limit on the number of ancillary chunks
fukasawa e60969
allowed in a PNG datastream.  By default, libpng imposes a limit of
fukasawa e60969
a total of 1000 sPLT, tEXt, iTXt, zTXt, and unknown chunks to be stored.
fukasawa e60969
If you have set up both info_ptr and end_info_ptr, the limit applies
fukasawa e60969
separately to each.  You can change the limit on the total number of such
fukasawa e60969
chunks that will be stored, with
fukasawa e60969
fukasawa e60969
   png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);
fukasawa e60969
fukasawa e60969
where 0x7fffffffL means unlimited.  You can retrieve this limit with
fukasawa e60969
fukasawa e60969
   chunk_cache_max = png_get_chunk_cache_max(png_ptr);
fukasawa e60969
fukasawa e60969
Libpng imposes a limit of 8 Megabytes (8,000,000 bytes) on the amount of
fukasawa e60969
memory that a compressed chunk other than IDAT can occupy, when decompressed.
fukasawa e60969
You can change this limit with
fukasawa e60969
fukasawa e60969
   png_set_chunk_malloc_max(png_ptr, user_chunk_malloc_max);
fukasawa e60969
fukasawa e60969
and you can retrieve the limit with
fukasawa e60969
fukasawa e60969
   chunk_malloc_max = png_get_chunk_malloc_max(png_ptr);
fukasawa e60969
fukasawa e60969
Any chunks that would cause either of these limits to be exceeded will
fukasawa e60969
be ignored.
fukasawa e60969
fukasawa e60969
.SS Information about your system
fukasawa e60969
fukasawa e60969
If you intend to display the PNG or to incorporate it in other image data you
fukasawa e60969
need to tell libpng information about your display or drawing surface so that
fukasawa e60969
libpng can convert the values in the image to match the display.
fukasawa e60969
fukasawa e60969
From libpng-1.5.4 this information can be set before reading the PNG file
fukasawa e60969
header.  In earlier versions png_set_gamma() existed but behaved incorrectly if
fukasawa e60969
called before the PNG file header had been read and png_set_alpha_mode() did not
fukasawa e60969
exist.
fukasawa e60969
fukasawa e60969
If you need to support versions prior to libpng-1.5.4 test the version number
fukasawa e60969
as illustrated below using "PNG_LIBPNG_VER >= 10504" and follow the procedures
fukasawa e60969
described in the appropriate manual page.
fukasawa e60969
fukasawa e60969
You give libpng the encoding expected by your system expressed as a 'gamma'
fukasawa e60969
value.  You can also specify a default encoding for the PNG file in
fukasawa e60969
case the required information is missing from the file.  By default libpng
fukasawa e60969
assumes that the PNG data matches your system, to keep this default call:
fukasawa e60969
fukasawa e60969
   png_set_gamma(png_ptr, screen_gamma, output_gamma);
fukasawa e60969
fukasawa e60969
or you can use the fixed point equivalent:
fukasawa e60969
fukasawa e60969
   png_set_gamma_fixed(png_ptr, PNG_FP_1*screen_gamma,
fukasawa e60969
      PNG_FP_1*output_gamma);
fukasawa e60969
fukasawa e60969
If you don't know the gamma for your system it is probably 2.2 - a good
fukasawa e60969
approximation to the IEC standard for display systems (sRGB).  If images are
fukasawa e60969
too contrasty or washed out you got the value wrong - check your system
fukasawa e60969
documentation!
fukasawa e60969
fukasawa e60969
Many systems permit the system gamma to be changed via a lookup table in the
fukasawa e60969
display driver, a few systems, including older Macs, change the response by
fukasawa e60969
default.  As of 1.5.4 three special values are available to handle common
fukasawa e60969
situations:
fukasawa e60969
fukasawa e60969
   PNG_DEFAULT_sRGB: Indicates that the system conforms to the
fukasawa e60969
                     IEC 61966-2-1 standard.  This matches almost
fukasawa e60969
                     all systems.
fukasawa e60969
   PNG_GAMMA_MAC_18: Indicates that the system is an older
fukasawa e60969
                     (pre Mac OS 10.6) Apple Macintosh system with
fukasawa e60969
                     the default settings.
fukasawa e60969
   PNG_GAMMA_LINEAR: Just the fixed point value for 1.0 - indicates
fukasawa e60969
                     that the system expects data with no gamma
fukasawa e60969
                     encoding.
fukasawa e60969
fukasawa e60969
You would use the linear (unencoded) value if you need to process the pixel
fukasawa e60969
values further because this avoids the need to decode and re-encode each
fukasawa e60969
component value whenever arithmetic is performed.  A lot of graphics software
fukasawa e60969
uses linear values for this reason, often with higher precision component values
fukasawa e60969
to preserve overall accuracy.
fukasawa e60969
fukasawa e60969
fukasawa e60969
The output_gamma value expresses how to decode the output values, not how
fukasawa e60969
they are encoded.  The values used correspond to the normal numbers used to
fukasawa e60969
describe the overall gamma of a computer display system; for example 2.2 for
fukasawa e60969
an sRGB conformant system.  The values are scaled by 100000 in the _fixed
fukasawa e60969
version of the API (so 220000 for sRGB.)
fukasawa e60969
fukasawa e60969
The inverse of the value is always used to provide a default for the PNG file
fukasawa e60969
encoding if it has no gAMA chunk and if png_set_gamma() has not been called
fukasawa e60969
to override the PNG gamma information.
fukasawa e60969
fukasawa e60969
When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
fukasawa e60969
opaque pixels however pixels with lower alpha values are not encoded,
fukasawa e60969
regardless of the output gamma setting.
fukasawa e60969
fukasawa e60969
When the standard Porter Duff handling is requested with mode 1 the output
fukasawa e60969
encoding is set to be linear and the output_gamma value is only relevant
fukasawa e60969
as a default for input data that has no gamma information.  The linear output
fukasawa e60969
encoding will be overridden if png_set_gamma() is called - the results may be
fukasawa e60969
highly unexpected!
fukasawa e60969
fukasawa e60969
The following numbers are derived from the sRGB standard and the research
fukasawa e60969
behind it.  sRGB is defined to be approximated by a PNG gAMA chunk value of
fukasawa e60969
0.45455 (1/2.2) for PNG.  The value implicitly includes any viewing
fukasawa e60969
correction required to take account of any differences in the color
fukasawa e60969
environment of the original scene and the intended display environment; the
fukasawa e60969
value expresses how to *decode* the image for display, not how the original
fukasawa e60969
data was *encoded*.
fukasawa e60969
fukasawa e60969
sRGB provides a peg for the PNG standard by defining a viewing environment.
fukasawa e60969
sRGB itself, and earlier TV standards, actually use a more complex transform
fukasawa e60969
(a linear portion then a gamma 2.4 power law) than PNG can express.  (PNG is
fukasawa e60969
limited to simple power laws.)  By saying that an image for direct display on
fukasawa e60969
an sRGB conformant system should be stored with a gAMA chunk value of 45455
fukasawa e60969
(11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
fukasawa e60969
makes it possible to derive values for other display systems and
fukasawa e60969
environments.
fukasawa e60969
fukasawa e60969
The Mac value is deduced from the sRGB based on an assumption that the actual
fukasawa e60969
extra viewing correction used in early Mac display systems was implemented as
fukasawa e60969
a power 1.45 lookup table.
fukasawa e60969
fukasawa e60969
Any system where a programmable lookup table is used or where the behavior of
fukasawa e60969
the final display device characteristics can be changed requires system
fukasawa e60969
specific code to obtain the current characteristic.  However this can be
fukasawa e60969
difficult and most PNG gamma correction only requires an approximate value.
fukasawa e60969
fukasawa e60969
By default, if png_set_alpha_mode() is not called, libpng assumes that all
fukasawa e60969
values are unencoded, linear, values and that the output device also has a
fukasawa e60969
linear characteristic.  This is only very rarely correct - it is invariably
fukasawa e60969
better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
fukasawa e60969
default if you don't know what the right answer is!
fukasawa e60969
fukasawa e60969
The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
fukasawa e60969
10.6) which used a correction table to implement a somewhat lower gamma on an
fukasawa e60969
otherwise sRGB system.
fukasawa e60969
fukasawa e60969
Both these values are reserved (not simple gamma values) in order to allow
fukasawa e60969
more precise correction internally in the future.
fukasawa e60969
fukasawa e60969
NOTE: the values can be passed to either the fixed or floating
fukasawa e60969
point APIs, but the floating point API will also accept floating point
fukasawa e60969
values.
fukasawa e60969
fukasawa e60969
The second thing you may need to tell libpng about is how your system handles
fukasawa e60969
alpha channel information.  Some, but not all, PNG files contain an alpha
fukasawa e60969
channel.  To display these files correctly you need to compose the data onto a
fukasawa e60969
suitable background, as described in the PNG specification.
fukasawa e60969
fukasawa e60969
Libpng only supports composing onto a single color (using png_set_background;
fukasawa e60969
see below).  Otherwise you must do the composition yourself and, in this case,
fukasawa e60969
you may need to call png_set_alpha_mode:
fukasawa e60969
fukasawa e60969
   #if PNG_LIBPNG_VER >= 10504
fukasawa e60969
      png_set_alpha_mode(png_ptr, mode, screen_gamma);
fukasawa e60969
   #else
fukasawa e60969
      png_set_gamma(png_ptr, screen_gamma, 1.0/screen_gamma);
fukasawa e60969
   #endif
fukasawa e60969
fukasawa e60969
The screen_gamma value is the same as the argument to png_set_gamma; however,
fukasawa e60969
how it affects the output depends on the mode.  png_set_alpha_mode() sets the
fukasawa e60969
file gamma default to 1/screen_gamma, so normally you don't need to call
fukasawa e60969
png_set_gamma.  If you need different defaults call png_set_gamma() before
fukasawa e60969
png_set_alpha_mode() - if you call it after it will override the settings made
fukasawa e60969
by png_set_alpha_mode().
fukasawa e60969
fukasawa e60969
The mode is as follows:
fukasawa e60969
fukasawa e60969
    PNG_ALPHA_PNG: The data is encoded according to the PNG
fukasawa e60969
specification.  Red, green and blue, or gray, components are
fukasawa e60969
gamma encoded color values and are not premultiplied by the
fukasawa e60969
alpha value.  The alpha value is a linear measure of the
fukasawa e60969
contribution of the pixel to the corresponding final output pixel.
fukasawa e60969
fukasawa e60969
You should normally use this format if you intend to perform
fukasawa e60969
color correction on the color values; most, maybe all, color
fukasawa e60969
correction software has no handling for the alpha channel and,
fukasawa e60969
anyway, the math to handle pre-multiplied component values is
fukasawa e60969
unnecessarily complex.
fukasawa e60969
fukasawa e60969
Before you do any arithmetic on the component values you need
fukasawa e60969
to remove the gamma encoding and multiply out the alpha
fukasawa e60969
channel.  See the PNG specification for more detail.  It is
fukasawa e60969
important to note that when an image with an alpha channel is
fukasawa e60969
scaled, linear encoded, pre-multiplied component values must
fukasawa e60969
be used!
fukasawa e60969
fukasawa e60969
The remaining modes assume you don't need to do any further color correction or
fukasawa e60969
that if you do, your color correction software knows all about alpha (it
fukasawa e60969
probably doesn't!).  They 'associate' the alpha with the color information by
fukasawa e60969
storing color channel values that have been scaled by the alpha.  The
fukasawa e60969
advantage is that the color channels can be resampled (the image can be
fukasawa e60969
scaled) in this form.  The disadvantage is that normal practice is to store
fukasawa e60969
linear, not (gamma) encoded, values and this requires 16-bit channels for
fukasawa e60969
still images rather than the 8-bit channels that are just about sufficient if
fukasawa e60969
gamma encoding is used.  In addition all non-transparent pixel values,
fukasawa e60969
including completely opaque ones, must be gamma encoded to produce the final
fukasawa e60969
image.  These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
fukasawa e60969
described below (the latter being the two common names for associated alpha
fukasawa e60969
color channels). Note that PNG files always contain non-associated color
fukasawa e60969
channels; png_set_alpha_mode() with one of the modes causes the decoder to
fukasawa e60969
convert the pixels to an associated form before returning them to your
fukasawa e60969
application. 
fukasawa e60969
fukasawa e60969
Since it is not necessary to perform arithmetic on opaque color values so
fukasawa e60969
long as they are not to be resampled and are in the final color space it is
fukasawa e60969
possible to optimize the handling of alpha by storing the opaque pixels in
fukasawa e60969
the PNG format (adjusted for the output color space) while storing partially
fukasawa e60969
opaque pixels in the standard, linear, format.  The accuracy required for
fukasawa e60969
standard alpha composition is relatively low, because the pixels are
fukasawa e60969
isolated, therefore typically the accuracy loss in storing 8-bit linear
fukasawa e60969
values is acceptable.  (This is not true if the alpha channel is used to
fukasawa e60969
simulate transparency over large areas - use 16 bits or the PNG mode in
fukasawa e60969
this case!)  This is the 'OPTIMIZED' mode.  For this mode a pixel is
fukasawa e60969
treated as opaque only if the alpha value is equal to the maximum value.
fukasawa e60969
fukasawa e60969
    PNG_ALPHA_STANDARD:  The data libpng produces is encoded in the
fukasawa e60969
standard way assumed by most correctly written graphics software.
fukasawa e60969
The gamma encoding will be removed by libpng and the
fukasawa e60969
linear component values will be pre-multiplied by the
fukasawa e60969
alpha channel.
fukasawa e60969
fukasawa e60969
With this format the final image must be re-encoded to
fukasawa e60969
match the display gamma before the image is displayed.
fukasawa e60969
If your system doesn't do that, yet still seems to
fukasawa e60969
perform arithmetic on the pixels without decoding them,
fukasawa e60969
it is broken - check out the modes below.
fukasawa e60969
fukasawa e60969
With PNG_ALPHA_STANDARD libpng always produces linear
fukasawa e60969
component values, whatever screen_gamma you supply.  The
fukasawa e60969
screen_gamma value is, however, used as a default for
fukasawa e60969
the file gamma if the PNG file has no gamma information.
fukasawa e60969
fukasawa e60969
If you call png_set_gamma() after png_set_alpha_mode() you
fukasawa e60969
will override the linear encoding.  Instead the
fukasawa e60969
pre-multiplied pixel values will be gamma encoded but
fukasawa e60969
the alpha channel will still be linear.  This may
fukasawa e60969
actually match the requirements of some broken software,
fukasawa e60969
but it is unlikely.
fukasawa e60969
fukasawa e60969
While linear 8-bit data is often used it has
fukasawa e60969
insufficient precision for any image with a reasonable
fukasawa e60969
dynamic range.  To avoid problems, and if your software
fukasawa e60969
supports it, use png_set_expand_16() to force all
fukasawa e60969
components to 16 bits.
fukasawa e60969
fukasawa e60969
    PNG_ALPHA_OPTIMIZED: This mode is the same as PNG_ALPHA_STANDARD
fukasawa e60969
except that completely opaque pixels are gamma encoded according to
fukasawa e60969
the screen_gamma value.  Pixels with alpha less than 1.0
fukasawa e60969
will still have linear components.
fukasawa e60969
fukasawa e60969
Use this format if you have control over your
fukasawa e60969
compositing software and so don't do other arithmetic
fukasawa e60969
(such as scaling) on the data you get from libpng.  Your
fukasawa e60969
compositing software can simply copy opaque pixels to
fukasawa e60969
the output but still has linear values for the
fukasawa e60969
non-opaque pixels.
fukasawa e60969
fukasawa e60969
In normal compositing, where the alpha channel encodes
fukasawa e60969
partial pixel coverage (as opposed to broad area
fukasawa e60969
translucency), the inaccuracies of the 8-bit
fukasawa e60969
representation of non-opaque pixels are irrelevant.
fukasawa e60969
fukasawa e60969
You can also try this format if your software is broken;
fukasawa e60969
it might look better.
fukasawa e60969
fukasawa e60969
    PNG_ALPHA_BROKEN: This is PNG_ALPHA_STANDARD; however, all component
fukasawa e60969
values, including the alpha channel are gamma encoded.  This is
fukasawa e60969
broken because, in practice, no implementation that uses this choice
fukasawa e60969
correctly undoes the encoding before handling alpha composition.  Use this
fukasawa e60969
choice only if other serious errors in the software or hardware you use
fukasawa e60969
mandate it.  In most cases of broken software or hardware the bug in the
fukasawa e60969
final display manifests as a subtle halo around composited parts of the
fukasawa e60969
image.  You may not even perceive this as a halo; the composited part of
fukasawa e60969
the image may simply appear separate from the background, as though it had
fukasawa e60969
been cut out of paper and pasted on afterward.
fukasawa e60969
fukasawa e60969
If you don't have to deal with bugs in software or hardware, or if you can fix
fukasawa e60969
them, there are three recommended ways of using png_set_alpha_mode():
fukasawa e60969
fukasawa e60969
   png_set_alpha_mode(png_ptr, PNG_ALPHA_PNG,
fukasawa e60969
       screen_gamma);
fukasawa e60969
fukasawa e60969
You can do color correction on the result (libpng does not currently
fukasawa e60969
support color correction internally).  When you handle the alpha channel
fukasawa e60969
you need to undo the gamma encoding and multiply out the alpha.
fukasawa e60969
fukasawa e60969
   png_set_alpha_mode(png_ptr, PNG_ALPHA_STANDARD,
fukasawa e60969
       screen_gamma);
fukasawa e60969
   png_set_expand_16(png_ptr);
fukasawa e60969
fukasawa e60969
If you are using the high level interface, don't call png_set_expand_16();
fukasawa e60969
instead pass PNG_TRANSFORM_EXPAND_16 to the interface.
fukasawa e60969
fukasawa e60969
With this mode you can't do color correction, but you can do arithmetic,
fukasawa e60969
including composition and scaling, on the data without further processing.
fukasawa e60969
fukasawa e60969
   png_set_alpha_mode(png_ptr, PNG_ALPHA_OPTIMIZED,
fukasawa e60969
       screen_gamma);
fukasawa e60969
fukasawa e60969
You can avoid the expansion to 16-bit components with this mode, but you
fukasawa e60969
lose the ability to scale the image or perform other linear arithmetic.
fukasawa e60969
All you can do is compose the result onto a matching output.  Since this
fukasawa e60969
mode is libpng-specific you also need to write your own composition
fukasawa e60969
software.
fukasawa e60969
fukasawa e60969
The following are examples of calls to png_set_alpha_mode to achieve the
fukasawa e60969
required overall gamma correction and, where necessary, alpha
fukasawa e60969
premultiplication.
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
fukasawa e60969
fukasawa e60969
This is the default libpng handling of the alpha channel - it is not
fukasawa e60969
pre-multiplied into the color components.  In addition the call states
fukasawa e60969
that the output is for a sRGB system and causes all PNG files without gAMA
fukasawa e60969
chunks to be assumed to be encoded using sRGB.
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
fukasawa e60969
fukasawa e60969
In this case the output is assumed to be something like an sRGB conformant
fukasawa e60969
display preceeded by a power-law lookup table of power 1.45.  This is how
fukasawa e60969
early Mac systems behaved.
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
fukasawa e60969
fukasawa e60969
This is the classic Jim Blinn approach and will work in academic
fukasawa e60969
environments where everything is done by the book.  It has the shortcoming
fukasawa e60969
of assuming that input PNG data with no gamma information is linear - this
fukasawa e60969
is unlikely to be correct unless the PNG files where generated locally.
fukasawa e60969
Most of the time the output precision will be so low as to show
fukasawa e60969
significant banding in dark areas of the image.
fukasawa e60969
fukasawa e60969
    png_set_expand_16(pp);
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
fukasawa e60969
fukasawa e60969
This is a somewhat more realistic Jim Blinn inspired approach.  PNG files
fukasawa e60969
are assumed to have the sRGB encoding if not marked with a gamma value and
fukasawa e60969
the output is always 16 bits per component.  This permits accurate scaling
fukasawa e60969
and processing of the data.  If you know that your input PNG files were
fukasawa e60969
generated locally you might need to replace PNG_DEFAULT_sRGB with the
fukasawa e60969
correct value for your system.
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
fukasawa e60969
fukasawa e60969
If you just need to composite the PNG image onto an existing background
fukasawa e60969
and if you control the code that does this you can use the optimization
fukasawa e60969
setting.  In this case you just copy completely opaque pixels to the
fukasawa e60969
output.  For pixels that are not completely transparent (you just skip
fukasawa e60969
those) you do the composition math using png_composite or png_composite_16
fukasawa e60969
below then encode the resultant 8-bit or 16-bit values to match the output
fukasawa e60969
encoding.
fukasawa e60969
fukasawa e60969
    Other cases
fukasawa e60969
fukasawa e60969
If neither the PNG nor the standard linear encoding work for you because
fukasawa e60969
of the software or hardware you use then you have a big problem.  The PNG
fukasawa e60969
case will probably result in halos around the image.  The linear encoding
fukasawa e60969
will probably result in a washed out, too bright, image (it's actually too
fukasawa e60969
contrasty.)  Try the ALPHA_OPTIMIZED mode above - this will probably
fukasawa e60969
substantially reduce the halos.  Alternatively try:
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
fukasawa e60969
fukasawa e60969
This option will also reduce the halos, but there will be slight dark
fukasawa e60969
halos round the opaque parts of the image where the background is light.
fukasawa e60969
In the OPTIMIZED mode the halos will be light halos where the background
fukasawa e60969
is dark.  Take your pick - the halos are unavoidable unless you can get
fukasawa e60969
your hardware/software fixed!  (The OPTIMIZED approach is slightly
fukasawa e60969
faster.)
fukasawa e60969
fukasawa e60969
When the default gamma of PNG files doesn't match the output gamma.
fukasawa e60969
If you have PNG files with no gamma information png_set_alpha_mode allows
fukasawa e60969
you to provide a default gamma, but it also sets the ouput gamma to the
fukasawa e60969
matching value.  If you know your PNG files have a gamma that doesn't
fukasawa e60969
match the output you can take advantage of the fact that
fukasawa e60969
png_set_alpha_mode always sets the output gamma but only sets the PNG
fukasawa e60969
default if it is not already set:
fukasawa e60969
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
fukasawa e60969
    png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
fukasawa e60969
fukasawa e60969
The first call sets both the default and the output gamma values, the
fukasawa e60969
second call overrides the output gamma without changing the default.  This
fukasawa e60969
is easier than achieving the same effect with png_set_gamma.  You must use
fukasawa e60969
PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
fukasawa e60969
fire if more than one call to png_set_alpha_mode and png_set_background is
fukasawa e60969
made in the same read operation, however multiple calls with PNG_ALPHA_PNG
fukasawa e60969
are ignored.
fukasawa e60969
fukasawa e60969
If you don't need, or can't handle, the alpha channel you can call
fukasawa e60969
png_set_background() to remove it by compositing against a fixed color.  Don't
fukasawa e60969
call png_set_strip_alpha() to do this - it will leave spurious pixel values in
fukasawa e60969
transparent parts of this image.
fukasawa e60969
fukasawa e60969
   png_set_background(png_ptr, &background_color,
fukasawa e60969
       PNG_BACKGROUND_GAMMA_SCREEN, 0, 1);
fukasawa e60969
fukasawa e60969
The background_color is an RGB or grayscale value according to the data format
fukasawa e60969
libpng will produce for you.  Because you don't yet know the format of the PNG
fukasawa e60969
file, if you call png_set_background at this point you must arrange for the
fukasawa e60969
format produced by libpng to always have 8-bit or 16-bit components and then
fukasawa e60969
store the color as an 8-bit or 16-bit color as appropriate.  The color contains
fukasawa e60969
separate gray and RGB component values, so you can let libpng produce gray or
fukasawa e60969
RGB output according to the input format, but low bit depth grayscale images
fukasawa e60969
must always be converted to at least 8-bit format.  (Even though low bit depth
fukasawa e60969
grayscale images can't have an alpha channel they can have a transparent
fukasawa e60969
color!)
fukasawa e60969
fukasawa e60969
You set the transforms you need later, either as flags to the high level
fukasawa e60969
interface or libpng API calls for the low level interface.  For reference the
fukasawa e60969
settings and API calls required are:
fukasawa e60969
fukasawa e60969
8-bit values:
fukasawa e60969
   PNG_TRANSFORM_SCALE_16 | PNG_EXPAND
fukasawa e60969
   png_set_expand(png_ptr); png_set_scale_16(png_ptr);
fukasawa e60969
fukasawa e60969
   If you must get exactly the same inaccurate results
fukasawa e60969
   produced by default in versions prior to libpng-1.5.4,
fukasawa e60969
   use PNG_TRANSFORM_STRIP_16 and png_set_strip_16(png_ptr)
fukasawa e60969
   instead.
fukasawa e60969
fukasawa e60969
16-bit values:
fukasawa e60969
   PNG_TRANSFORM_EXPAND_16
fukasawa e60969
   png_set_expand_16(png_ptr);
fukasawa e60969
fukasawa e60969
In either case palette image data will be expanded to RGB.  If you just want
fukasawa e60969
color data you can add PNG_TRANSFORM_GRAY_TO_RGB or png_set_gray_to_rgb(png_ptr)
fukasawa e60969
to the list.
fukasawa e60969
fukasawa e60969
Calling png_set_background before the PNG file header is read will not work
fukasawa e60969
prior to libpng-1.5.4.  Because the failure may result in unexpected warnings or
fukasawa e60969
errors it is therefore much safer to call png_set_background after the head has
fukasawa e60969
been read.  Unfortunately this means that prior to libpng-1.5.4 it cannot be
fukasawa e60969
used with the high level interface.
fukasawa e60969
fukasawa e60969
.SS The high-level read interface
fukasawa e60969
fukasawa e60969
At this point there are two ways to proceed; through the high-level
fukasawa e60969
read interface, or through a sequence of low-level read operations.
fukasawa e60969
You can use the high-level interface if (a) you are willing to read
fukasawa e60969
the entire image into memory, and (b) the input transformations
fukasawa e60969
you want to do are limited to the following set:
fukasawa e60969
fukasawa e60969
    PNG_TRANSFORM_IDENTITY      No transformation
fukasawa e60969
    PNG_TRANSFORM_SCALE_16      Strip 16-bit samples to
fukasawa e60969
                                8-bit accurately
fukasawa e60969
    PNG_TRANSFORM_STRIP_16      Chop 16-bit samples to
fukasawa e60969
                                8-bit less accurately
fukasawa e60969
    PNG_TRANSFORM_STRIP_ALPHA   Discard the alpha channel
fukasawa e60969
    PNG_TRANSFORM_PACKING       Expand 1, 2 and 4-bit
fukasawa e60969
                                samples to bytes
fukasawa e60969
    PNG_TRANSFORM_PACKSWAP      Change order of packed
fukasawa e60969
                                pixels to LSB first
fukasawa e60969
    PNG_TRANSFORM_EXPAND        Perform set_expand()
fukasawa e60969
    PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
fukasawa e60969
    PNG_TRANSFORM_SHIFT         Normalize pixels to the
fukasawa e60969
                                sBIT depth
fukasawa e60969
    PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
fukasawa e60969
                                to BGRA
fukasawa e60969
    PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
fukasawa e60969
                                to AG
fukasawa e60969
    PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
fukasawa e60969
                                to transparency
fukasawa e60969
    PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
fukasawa e60969
    PNG_TRANSFORM_GRAY_TO_RGB   Expand grayscale samples
fukasawa e60969
                                to RGB (or GA to RGBA)
fukasawa e60969
    PNG_TRANSFORM_EXPAND_16     Expand samples to 16 bits
fukasawa e60969
fukasawa e60969
(This excludes setting a background color, doing gamma transformation,
fukasawa e60969
quantizing, and setting filler.)  If this is the case, simply do this:
fukasawa e60969
fukasawa e60969
    png_read_png(png_ptr, info_ptr, png_transforms, NULL)
fukasawa e60969
fukasawa e60969
where png_transforms is an integer containing the bitwise OR of some
fukasawa e60969
set of transformation flags.  This call is equivalent to png_read_info(),
fukasawa e60969
followed the set of transformations indicated by the transform mask,
fukasawa e60969
then png_read_image(), and finally png_read_end().
fukasawa e60969
fukasawa e60969
(The final parameter of this call is not yet used.  Someday it might point
fukasawa e60969
to transformation parameters required by some future input transform.)
fukasawa e60969
fukasawa e60969
You must use png_transforms and not call any png_set_transform() functions
fukasawa e60969
when you use png_read_png().
fukasawa e60969
fukasawa e60969
After you have called png_read_png(), you can retrieve the image data
fukasawa e60969
with
fukasawa e60969
fukasawa e60969
   row_pointers = png_get_rows(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
where row_pointers is an array of pointers to the pixel data for each row:
fukasawa e60969
fukasawa e60969
   png_bytep row_pointers[height];
fukasawa e60969
fukasawa e60969
If you know your image size and pixel size ahead of time, you can allocate
fukasawa e60969
row_pointers prior to calling png_read_png() with
fukasawa e60969
fukasawa e60969
   if (height > PNG_UINT_32_MAX/(sizeof (png_byte)))
fukasawa e60969
      png_error (png_ptr,
fukasawa e60969
          "Image is too tall to process in memory");
fukasawa e60969
fukasawa e60969
   if (width > PNG_UINT_32_MAX/pixel_size)
fukasawa e60969
      png_error (png_ptr,
fukasawa e60969
          "Image is too wide to process in memory");
fukasawa e60969
fukasawa e60969
   row_pointers = png_malloc(png_ptr,
fukasawa e60969
       height*(sizeof (png_bytep)));
fukasawa e60969
fukasawa e60969
   for (int i=0; i
fukasawa e60969
      row_pointers[i]=NULL;  /* security precaution */
fukasawa e60969
fukasawa e60969
   for (int i=0; i
fukasawa e60969
      row_pointers[i]=png_malloc(png_ptr,
fukasawa e60969
          width*pixel_size);
fukasawa e60969
fukasawa e60969
   png_set_rows(png_ptr, info_ptr, &row_pointers);
fukasawa e60969
fukasawa e60969
Alternatively you could allocate your image in one big block and define
fukasawa e60969
row_pointers[i] to point into the proper places in your block.
fukasawa e60969
fukasawa e60969
If you use png_set_rows(), the application is responsible for freeing
fukasawa e60969
row_pointers (and row_pointers[i], if they were separately allocated).
fukasawa e60969
fukasawa e60969
If you don't allocate row_pointers ahead of time, png_read_png() will
fukasawa e60969
do it, and it'll be free'ed by libpng when you call png_destroy_*().
fukasawa e60969
fukasawa e60969
.SS The low-level read interface
fukasawa e60969
fukasawa e60969
If you are going the low-level route, you are now ready to read all
fukasawa e60969
the file information up to the actual image data.  You do this with a
fukasawa e60969
call to png_read_info().
fukasawa e60969
fukasawa e60969
    png_read_info(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
This will process all chunks up to but not including the image data.
fukasawa e60969
fukasawa e60969
This also copies some of the data from the PNG file into the decode structure
fukasawa e60969
for use in later transformations.  Important information copied in is:
fukasawa e60969
fukasawa e60969
1) The PNG file gamma from the gAMA chunk.  This overwrites the default value
fukasawa e60969
provided by an earlier call to png_set_gamma or png_set_alpha_mode.
fukasawa e60969
fukasawa e60969
2) Prior to libpng-1.5.4 the background color from a bKGd chunk.  This
fukasawa e60969
damages the information provided by an earlier call to png_set_background
fukasawa e60969
resulting in unexpected behavior.  Libpng-1.5.4 no longer does this.
fukasawa e60969
fukasawa e60969
3) The number of significant bits in each component value.  Libpng uses this to
fukasawa e60969
optimize gamma handling by reducing the internal lookup table sizes.
fukasawa e60969
fukasawa e60969
4) The transparent color information from a tRNS chunk.  This can be modified by
fukasawa e60969
a later call to png_set_tRNS.
fukasawa e60969
fukasawa e60969
.SS Querying the info structure
fukasawa e60969
fukasawa e60969
Functions are used to get the information from the info_ptr once it
fukasawa e60969
has been read.  Note that these fields may not be completely filled
fukasawa e60969
in until png_read_end() has read the chunk data following the image.
fukasawa e60969
fukasawa e60969
    png_get_IHDR(png_ptr, info_ptr, &width, &height,
fukasawa e60969
       &bit_depth, &color_type, &interlace_type,
fukasawa e60969
       &compression_type, &filter_method);
fukasawa e60969
fukasawa e60969
    width          - holds the width of the image
fukasawa e60969
                     in pixels (up to 2^31).
fukasawa e60969
fukasawa e60969
    height         - holds the height of the image
fukasawa e60969
                     in pixels (up to 2^31).
fukasawa e60969
fukasawa e60969
    bit_depth      - holds the bit depth of one of the
fukasawa e60969
                     image channels.  (valid values are
fukasawa e60969
                     1, 2, 4, 8, 16 and depend also on
fukasawa e60969
                     the color_type.  See also
fukasawa e60969
                     significant bits (sBIT) below).
fukasawa e60969
fukasawa e60969
    color_type     - describes which color/alpha channels
fukasawa e60969
                         are present.
fukasawa e60969
                     PNG_COLOR_TYPE_GRAY
fukasawa e60969
                        (bit depths 1, 2, 4, 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_GRAY_ALPHA
fukasawa e60969
                        (bit depths 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_PALETTE
fukasawa e60969
                        (bit depths 1, 2, 4, 8)
fukasawa e60969
                     PNG_COLOR_TYPE_RGB
fukasawa e60969
                        (bit_depths 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_RGB_ALPHA
fukasawa e60969
                        (bit_depths 8, 16)
fukasawa e60969
fukasawa e60969
                     PNG_COLOR_MASK_PALETTE
fukasawa e60969
                     PNG_COLOR_MASK_COLOR
fukasawa e60969
                     PNG_COLOR_MASK_ALPHA
fukasawa e60969
fukasawa e60969
    interlace_type - (PNG_INTERLACE_NONE or
fukasawa e60969
                     PNG_INTERLACE_ADAM7)
fukasawa e60969
fukasawa e60969
    compression_type - (must be PNG_COMPRESSION_TYPE_BASE
fukasawa e60969
                     for PNG 1.0)
fukasawa e60969
fukasawa e60969
    filter_method  - (must be PNG_FILTER_TYPE_BASE
fukasawa e60969
                     for PNG 1.0, and can also be
fukasawa e60969
                     PNG_INTRAPIXEL_DIFFERENCING if
fukasawa e60969
                     the PNG datastream is embedded in
fukasawa e60969
                     a MNG-1.0 datastream)
fukasawa e60969
fukasawa e60969
    Any of width, height, color_type, bit_depth,
fukasawa e60969
    interlace_type, compression_type, or filter_method can
fukasawa e60969
    be NULL if you are not interested in their values.
fukasawa e60969
fukasawa e60969
    Note that png_get_IHDR() returns 32-bit data into
fukasawa e60969
    the application's width and height variables.
fukasawa e60969
    This is an unsafe situation if these are not png_uint_32
fukasawa e60969
    variables.  In such situations, the
fukasawa e60969
    png_get_image_width() and png_get_image_height()
fukasawa e60969
    functions described below are safer.
fukasawa e60969
fukasawa e60969
    width            = png_get_image_width(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    height           = png_get_image_height(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    bit_depth        = png_get_bit_depth(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    color_type       = png_get_color_type(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    interlace_type   = png_get_interlace_type(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    compression_type = png_get_compression_type(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    filter_method    = png_get_filter_type(png_ptr,
fukasawa e60969
                         info_ptr);
fukasawa e60969
fukasawa e60969
    channels = png_get_channels(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    channels       - number of channels of info for the
fukasawa e60969
                     color type (valid values are 1 (GRAY,
fukasawa e60969
                     PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
fukasawa e60969
                     4 (RGB_ALPHA or RGB + filler byte))
fukasawa e60969
fukasawa e60969
    rowbytes = png_get_rowbytes(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    rowbytes       - number of bytes needed to hold a row
fukasawa e60969
fukasawa e60969
    signature = png_get_signature(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    signature      - holds the signature read from the
fukasawa e60969
                     file (if any).  The data is kept in
fukasawa e60969
                     the same offset it would be if the
fukasawa e60969
                     whole signature were read (i.e. if an
fukasawa e60969
                     application had already read in 4
fukasawa e60969
                     bytes of signature before starting
fukasawa e60969
                     libpng, the remaining 4 bytes would
fukasawa e60969
                     be in signature[4] through signature[7]
fukasawa e60969
                     (see png_set_sig_bytes())).
fukasawa e60969
fukasawa e60969
These are also important, but their validity depends on whether the chunk
fukasawa e60969
has been read.  The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
fukasawa e60969
png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
fukasawa e60969
data has been read, or zero if it is missing.  The parameters to the
fukasawa e60969
png_get_<chunk> are set directly if they are simple data types, or a
fukasawa e60969
pointer into the info_ptr is returned for any complex types.
fukasawa e60969
fukasawa e60969
The colorspace data from gAMA, cHRM, sRGB, iCCP, and sBIT chunks
fukasawa e60969
is simply returned to give the application information about how the
fukasawa e60969
image was encoded.  Libpng itself only does transformations using the file
fukasawa e60969
gamma when combining semitransparent pixels with the background color, and,
fukasawa e60969
since libpng-1.6.0, when converting between 8-bit sRGB and 16-bit linear pixels
fukasawa e60969
within the simplified API.  Libpng also uses the file gamma when converting
fukasawa e60969
RGB to gray, beginning with libpng-1.0.5, if the application calls
fukasawa e60969
png_set_rgb_to_gray()).
fukasawa e60969
fukasawa e60969
    png_get_PLTE(png_ptr, info_ptr, &palette,
fukasawa e60969
                     &num_palette);
fukasawa e60969
fukasawa e60969
    palette        - the palette for the file
fukasawa e60969
                     (array of png_color)
fukasawa e60969
fukasawa e60969
    num_palette    - number of entries in the palette
fukasawa e60969
fukasawa e60969
    png_get_gAMA(png_ptr, info_ptr, &file_gamma);
fukasawa e60969
    png_get_gAMA_fixed(png_ptr, info_ptr, &int_file_gamma);
fukasawa e60969
fukasawa e60969
    file_gamma     - the gamma at which the file is
fukasawa e60969
                     written (PNG_INFO_gAMA)
fukasawa e60969
fukasawa e60969
    int_file_gamma - 100,000 times the gamma at which the
fukasawa e60969
                     file is written
fukasawa e60969
fukasawa e60969
    png_get_cHRM(png_ptr, info_ptr,  &white_x, &white_y, &red_x,
fukasawa e60969
                     &red_y, &green_x, &green_y, &blue_x, &blue_y)
fukasawa e60969
    png_get_cHRM_XYZ(png_ptr, info_ptr, &red_X, &red_Y, &red_Z,
fukasawa e60969
                     &green_X, &green_Y, &green_Z, &blue_X, &blue_Y,
fukasawa e60969
                     &blue_Z)
fukasawa e60969
    png_get_cHRM_fixed(png_ptr, info_ptr, &int_white_x,
fukasawa e60969
                     &int_white_y, &int_red_x, &int_red_y,
fukasawa e60969
                     &int_green_x, &int_green_y, &int_blue_x,
fukasawa e60969
                     &int_blue_y)
fukasawa e60969
    png_get_cHRM_XYZ_fixed(png_ptr, info_ptr, &int_red_X, &int_red_Y,
fukasawa e60969
                     &int_red_Z, &int_green_X, &int_green_Y,
fukasawa e60969
                     &int_green_Z, &int_blue_X, &int_blue_Y,
fukasawa e60969
                     &int_blue_Z)
fukasawa e60969
fukasawa e60969
    {white,red,green,blue}_{x,y}
fukasawa e60969
                     A color space encoding specified using the
fukasawa e60969
                     chromaticities of the end points and the
fukasawa e60969
                     white point. (PNG_INFO_cHRM)
fukasawa e60969
fukasawa e60969
    {red,green,blue}_{X,Y,Z}
fukasawa e60969
                     A color space encoding specified using the
fukasawa e60969
                     encoding end points - the CIE tristimulus
fukasawa e60969
                     specification of the intended color of the red,
fukasawa e60969
                     green and blue channels in the PNG RGB data.
fukasawa e60969
                     The white point is simply the sum of the three
fukasawa e60969
                     end points. (PNG_INFO_cHRM)
fukasawa e60969
fukasawa e60969
    png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
fukasawa e60969
fukasawa e60969
    srgb_intent -    the rendering intent (PNG_INFO_sRGB)
fukasawa e60969
                     The presence of the sRGB chunk
fukasawa e60969
                     means that the pixel data is in the
fukasawa e60969
                     sRGB color space.  This chunk also
fukasawa e60969
                     implies specific values of gAMA and
fukasawa e60969
                     cHRM.
fukasawa e60969
fukasawa e60969
    png_get_iCCP(png_ptr, info_ptr, &name,
fukasawa e60969
       &compression_type, &profile, &proflen);
fukasawa e60969
fukasawa e60969
    name             - The profile name.
fukasawa e60969
fukasawa e60969
    compression_type - The compression type; always
fukasawa e60969
                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
fukasawa e60969
                       You may give NULL to this argument to
fukasawa e60969
                       ignore it.
fukasawa e60969
fukasawa e60969
    profile          - International Color Consortium color
fukasawa e60969
                       profile data. May contain NULs.
fukasawa e60969
fukasawa e60969
    proflen          - length of profile data in bytes.
fukasawa e60969
fukasawa e60969
    png_get_sBIT(png_ptr, info_ptr, &sig_bit);
fukasawa e60969
fukasawa e60969
    sig_bit        - the number of significant bits for
fukasawa e60969
                     (PNG_INFO_sBIT) each of the gray,
fukasawa e60969
                     red, green, and blue channels,
fukasawa e60969
                     whichever are appropriate for the
fukasawa e60969
                     given color type (png_color_16)
fukasawa e60969
fukasawa e60969
    png_get_tRNS(png_ptr, info_ptr, &trans_alpha,
fukasawa e60969
                     &num_trans, &trans_color);
fukasawa e60969
fukasawa e60969
    trans_alpha    - array of alpha (transparency)
fukasawa e60969
                     entries for palette (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    num_trans      - number of transparent entries
fukasawa e60969
                     (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    trans_color    - graylevel or color sample values of
fukasawa e60969
                     the single transparent color for
fukasawa e60969
                     non-paletted images (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    png_get_hIST(png_ptr, info_ptr, &hist);
fukasawa e60969
                     (PNG_INFO_hIST)
fukasawa e60969
fukasawa e60969
    hist           - histogram of palette (array of
fukasawa e60969
                     png_uint_16)
fukasawa e60969
fukasawa e60969
    png_get_tIME(png_ptr, info_ptr, &mod_time);
fukasawa e60969
fukasawa e60969
    mod_time       - time image was last modified
fukasawa e60969
                    (PNG_VALID_tIME)
fukasawa e60969
fukasawa e60969
    png_get_bKGD(png_ptr, info_ptr, &background);
fukasawa e60969
fukasawa e60969
    background     - background color (of type
fukasawa e60969
                     png_color_16p) (PNG_VALID_bKGD)
fukasawa e60969
                     valid 16-bit red, green and blue
fukasawa e60969
                     values, regardless of color_type
fukasawa e60969
fukasawa e60969
    num_comments   = png_get_text(png_ptr, info_ptr,
fukasawa e60969
                     &text_ptr, &num_text);
fukasawa e60969
fukasawa e60969
    num_comments   - number of comments
fukasawa e60969
fukasawa e60969
    text_ptr       - array of png_text holding image
fukasawa e60969
                     comments
fukasawa e60969
fukasawa e60969
    text_ptr[i].compression - type of compression used
fukasawa e60969
                 on "text" PNG_TEXT_COMPRESSION_NONE
fukasawa e60969
                           PNG_TEXT_COMPRESSION_zTXt
fukasawa e60969
                           PNG_ITXT_COMPRESSION_NONE
fukasawa e60969
                           PNG_ITXT_COMPRESSION_zTXt
fukasawa e60969
fukasawa e60969
    text_ptr[i].key   - keyword for comment.  Must contain
fukasawa e60969
                         1-79 characters.
fukasawa e60969
fukasawa e60969
    text_ptr[i].text  - text comments for current
fukasawa e60969
                         keyword.  Can be empty.
fukasawa e60969
fukasawa e60969
    text_ptr[i].text_length - length of text string,
fukasawa e60969
                 after decompression, 0 for iTXt
fukasawa e60969
fukasawa e60969
    text_ptr[i].itxt_length - length of itxt string,
fukasawa e60969
                 after decompression, 0 for tEXt/zTXt
fukasawa e60969
fukasawa e60969
    text_ptr[i].lang  - language of comment (empty
fukasawa e60969
                         string for unknown).
fukasawa e60969
fukasawa e60969
    text_ptr[i].lang_key  - keyword in UTF-8
fukasawa e60969
                         (empty string for unknown).
fukasawa e60969
fukasawa e60969
    Note that the itxt_length, lang, and lang_key
fukasawa e60969
    members of the text_ptr structure only exist when the
fukasawa e60969
    library is built with iTXt chunk support.  Prior to
fukasawa e60969
    libpng-1.4.0 the library was built by default without
fukasawa e60969
    iTXt support. Also note that when iTXt is supported,
fukasawa e60969
    they contain NULL pointers when the "compression"
fukasawa e60969
    field contains PNG_TEXT_COMPRESSION_NONE or
fukasawa e60969
    PNG_TEXT_COMPRESSION_zTXt.
fukasawa e60969
fukasawa e60969
    num_text       - number of comments (same as
fukasawa e60969
                     num_comments; you can put NULL here
fukasawa e60969
                     to avoid the duplication)
fukasawa e60969
fukasawa e60969
    Note while png_set_text() will accept text, language,
fukasawa e60969
    and translated keywords that can be NULL pointers, the
fukasawa e60969
    structure returned by png_get_text will always contain
fukasawa e60969
    regular zero-terminated C strings.  They might be
fukasawa e60969
    empty strings but they will never be NULL pointers.
fukasawa e60969
fukasawa e60969
    num_spalettes = png_get_sPLT(png_ptr, info_ptr,
fukasawa e60969
       &palette_ptr);
fukasawa e60969
fukasawa e60969
    num_spalettes  - number of sPLT chunks read.
fukasawa e60969
fukasawa e60969
    palette_ptr    - array of palette structures holding
fukasawa e60969
                     contents of one or more sPLT chunks
fukasawa e60969
                     read.
fukasawa e60969
fukasawa e60969
    png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
fukasawa e60969
       &unit_type);
fukasawa e60969
fukasawa e60969
    offset_x       - positive offset from the left edge
fukasawa e60969
                     of the screen (can be negative)
fukasawa e60969
fukasawa e60969
    offset_y       - positive offset from the top edge
fukasawa e60969
                     of the screen (can be negative)
fukasawa e60969
fukasawa e60969
    unit_type      - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
fukasawa e60969
fukasawa e60969
    png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
fukasawa e60969
       &unit_type);
fukasawa e60969
fukasawa e60969
    res_x          - pixels/unit physical resolution in
fukasawa e60969
                     x direction
fukasawa e60969
fukasawa e60969
    res_y          - pixels/unit physical resolution in
fukasawa e60969
                     x direction
fukasawa e60969
fukasawa e60969
    unit_type      - PNG_RESOLUTION_UNKNOWN,
fukasawa e60969
                     PNG_RESOLUTION_METER
fukasawa e60969
fukasawa e60969
    png_get_sCAL(png_ptr, info_ptr, &unit, &width,
fukasawa e60969
       &height)
fukasawa e60969
fukasawa e60969
    unit        - physical scale units (an integer)
fukasawa e60969
fukasawa e60969
    width       - width of a pixel in physical scale units
fukasawa e60969
fukasawa e60969
    height      - height of a pixel in physical scale units
fukasawa e60969
                 (width and height are doubles)
fukasawa e60969
fukasawa e60969
    png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
fukasawa e60969
       &height)
fukasawa e60969
fukasawa e60969
    unit        - physical scale units (an integer)
fukasawa e60969
fukasawa e60969
    width       - width of a pixel in physical scale units
fukasawa e60969
                  (expressed as a string)
fukasawa e60969
fukasawa e60969
    height      - height of a pixel in physical scale units
fukasawa e60969
                 (width and height are strings like "2.54")
fukasawa e60969
fukasawa e60969
    num_unknown_chunks = png_get_unknown_chunks(png_ptr,
fukasawa e60969
       info_ptr, &unknowns)
fukasawa e60969
fukasawa e60969
    unknowns          - array of png_unknown_chunk
fukasawa e60969
                        structures holding unknown chunks
fukasawa e60969
fukasawa e60969
    unknowns[i].name  - name of unknown chunk
fukasawa e60969
fukasawa e60969
    unknowns[i].data  - data of unknown chunk
fukasawa e60969
fukasawa e60969
    unknowns[i].size  - size of unknown chunk's data
fukasawa e60969
fukasawa e60969
    unknowns[i].location - position of chunk in file
fukasawa e60969
fukasawa e60969
    The value of "i" corresponds to the order in which the
fukasawa e60969
    chunks were read from the PNG file or inserted with the
fukasawa e60969
    png_set_unknown_chunks() function.
fukasawa e60969
fukasawa e60969
    The value of "location" is a bitwise "or" of
fukasawa e60969
fukasawa e60969
         PNG_HAVE_IHDR  (0x01)
fukasawa e60969
         PNG_HAVE_PLTE  (0x02)
fukasawa e60969
         PNG_AFTER_IDAT (0x08)
fukasawa e60969
fukasawa e60969
The data from the pHYs chunk can be retrieved in several convenient
fukasawa e60969
forms:
fukasawa e60969
fukasawa e60969
    res_x = png_get_x_pixels_per_meter(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    res_y = png_get_y_pixels_per_meter(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    res_x_and_y = png_get_pixels_per_meter(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    res_x = png_get_x_pixels_per_inch(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    res_y = png_get_y_pixels_per_inch(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    res_x_and_y = png_get_pixels_per_inch(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
fukasawa e60969
       info_ptr)
fukasawa e60969
fukasawa e60969
    Each of these returns 0 [signifying "unknown"] if
fukasawa e60969
       the data is not present or if res_x is 0;
fukasawa e60969
       res_x_and_y is 0 if res_x != res_y
fukasawa e60969
fukasawa e60969
    Note that because of the way the resolutions are
fukasawa e60969
       stored internally, the inch conversions won't
fukasawa e60969
       come out to exactly even number.  For example,
fukasawa e60969
       72 dpi is stored as 0.28346 pixels/meter, and
fukasawa e60969
       when this is retrieved it is 71.9988 dpi, so
fukasawa e60969
       be sure to round the returned value appropriately
fukasawa e60969
       if you want to display a reasonable-looking result.
fukasawa e60969
fukasawa e60969
The data from the oFFs chunk can be retrieved in several convenient
fukasawa e60969
forms:
fukasawa e60969
fukasawa e60969
    x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
    Each of these returns 0 [signifying "unknown" if both
fukasawa e60969
       x and y are 0] if the data is not present or if the
fukasawa e60969
       chunk is present but the unit is the pixel.  The
fukasawa e60969
       remark about inexact inch conversions applies here
fukasawa e60969
       as well, because a value in inches can't always be
fukasawa e60969
       converted to microns and back without some loss
fukasawa e60969
       of precision.
fukasawa e60969
fukasawa e60969
For more information, see the
fukasawa e60969
PNG specification for chunk contents.  Be careful with trusting
fukasawa e60969
rowbytes, as some of the transformations could increase the space
fukasawa e60969
needed to hold a row (expand, filler, gray_to_rgb, etc.).
fukasawa e60969
See png_read_update_info(), below.
fukasawa e60969
fukasawa e60969
A quick word about text_ptr and num_text.  PNG stores comments in
fukasawa e60969
keyword/text pairs, one pair per chunk, with no limit on the number
fukasawa e60969
of text chunks, and a 2^31 byte limit on their size.  While there are
fukasawa e60969
suggested keywords, there is no requirement to restrict the use to these
fukasawa e60969
strings.  It is strongly suggested that keywords and text be sensible
fukasawa e60969
to humans (that's the point), so don't use abbreviations.  Non-printing
fukasawa e60969
symbols are not allowed.  See the PNG specification for more details.
fukasawa e60969
There is also no requirement to have text after the keyword.
fukasawa e60969
fukasawa e60969
Keywords should be limited to 79 Latin-1 characters without leading or
fukasawa e60969
trailing spaces, but non-consecutive spaces are allowed within the
fukasawa e60969
keyword.  It is possible to have the same keyword any number of times.
fukasawa e60969
The text_ptr is an array of png_text structures, each holding a
fukasawa e60969
pointer to a language string, a pointer to a keyword and a pointer to
fukasawa e60969
a text string.  The text string, language code, and translated
fukasawa e60969
keyword may be empty or NULL pointers.  The keyword/text
fukasawa e60969
pairs are put into the array in the order that they are received.
fukasawa e60969
However, some or all of the text chunks may be after the image, so, to
fukasawa e60969
make sure you have read all the text chunks, don't mess with these
fukasawa e60969
until after you read the stuff after the image.  This will be
fukasawa e60969
mentioned again below in the discussion that goes with png_read_end().
fukasawa e60969
fukasawa e60969
.SS Input transformations
fukasawa e60969
fukasawa e60969
After you've read the header information, you can set up the library
fukasawa e60969
to handle any special transformations of the image data.  The various
fukasawa e60969
ways to transform the data will be described in the order that they
fukasawa e60969
should occur.  This is important, as some of these change the color
fukasawa e60969
type and/or bit depth of the data, and some others only work on
fukasawa e60969
certain color types and bit depths.
fukasawa e60969
fukasawa e60969
Transformations you request are ignored if they don't have any meaning for a
fukasawa e60969
particular input data format.  However some transformations can have an effect
fukasawa e60969
as a result of a previous transformation.  If you specify a contradictory set of
fukasawa e60969
transformations, for example both adding and removing the alpha channel, you
fukasawa e60969
cannot predict the final result.
fukasawa e60969
fukasawa e60969
The color used for the transparency values should be supplied in the same
fukasawa e60969
format/depth as the current image data.  It is stored in the same format/depth
fukasawa e60969
as the image data in a tRNS chunk, so this is what libpng expects for this data.
fukasawa e60969
fukasawa e60969
The color used for the background value depends on the need_expand argument as
fukasawa e60969
described below.
fukasawa e60969
fukasawa e60969
Data will be decoded into the supplied row buffers packed into bytes
fukasawa e60969
unless the library has been told to transform it into another format.
fukasawa e60969
For example, 4 bit/pixel paletted or grayscale data will be returned
fukasawa e60969
2 pixels/byte with the leftmost pixel in the high-order bits of the byte,
fukasawa e60969
unless png_set_packing() is called.  8-bit RGB data will be stored
fukasawa e60969
in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
fukasawa e60969
is called to insert filler bytes, either before or after each RGB triplet.
fukasawa e60969
fukasawa e60969
16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
fukasawa e60969
byte of the color value first, unless png_set_scale_16() is called to
fukasawa e60969
transform it to regular RGB RGB triplets, or png_set_filler() or
fukasawa e60969
png_set_add alpha() is called to insert two filler bytes, either before
fukasawa e60969
or after each RRGGBB triplet.  Similarly, 8-bit or 16-bit grayscale data can
fukasawa e60969
be modified with png_set_filler(), png_set_add_alpha(), png_set_strip_16(),
fukasawa e60969
or png_set_scale_16().
fukasawa e60969
fukasawa e60969
The following code transforms grayscale images of less than 8 to 8 bits,
fukasawa e60969
changes paletted images to RGB, and adds a full alpha channel if there is
fukasawa e60969
transparency information in a tRNS chunk.  This is most useful on
fukasawa e60969
grayscale images with bit depths of 2 or 4 or if there is a multiple-image
fukasawa e60969
viewing application that wishes to treat all images in the same way.
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_PALETTE)
fukasawa e60969
        png_set_palette_to_rgb(png_ptr);
fukasawa e60969
fukasawa e60969
    if (png_get_valid(png_ptr, info_ptr,
fukasawa e60969
        PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_GRAY &&
fukasawa e60969
        bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
fukasawa e60969
fukasawa e60969
The first two functions are actually aliases for png_set_expand(), added
fukasawa e60969
in libpng version 1.0.4, with the function names expanded to improve code
fukasawa e60969
readability.  In some future version they may actually do different
fukasawa e60969
things.
fukasawa e60969
fukasawa e60969
As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
fukasawa e60969
added.  It expands the sample depth without changing tRNS to alpha.
fukasawa e60969
fukasawa e60969
As of libpng version 1.5.2, png_set_expand_16() was added.  It behaves as
fukasawa e60969
png_set_expand(); however, the resultant channels have 16 bits rather than 8.
fukasawa e60969
Use this when the output color or gray channels are made linear to avoid fairly
fukasawa e60969
severe accuracy loss.
fukasawa e60969
fukasawa e60969
   if (bit_depth < 16)
fukasawa e60969
      png_set_expand_16(png_ptr);
fukasawa e60969
fukasawa e60969
PNG can have files with 16 bits per channel.  If you only can handle
fukasawa e60969
8 bits per channel, this will strip the pixels down to 8-bit.
fukasawa e60969
fukasawa e60969
    if (bit_depth == 16)
fukasawa e60969
#if PNG_LIBPNG_VER >= 10504
fukasawa e60969
       png_set_scale_16(png_ptr);
fukasawa e60969
#else
fukasawa e60969
       png_set_strip_16(png_ptr);
fukasawa e60969
#endif
fukasawa e60969
fukasawa e60969
(The more accurate "png_set_scale_16()" API became available in libpng version
fukasawa e60969
1.5.4).
fukasawa e60969
fukasawa e60969
If you need to process the alpha channel on the image separately from the image
fukasawa e60969
data (for example if you convert it to a bitmap mask) it is possible to have
fukasawa e60969
libpng strip the channel leaving just RGB or gray data:
fukasawa e60969
fukasawa e60969
    if (color_type & PNG_COLOR_MASK_ALPHA)
fukasawa e60969
       png_set_strip_alpha(png_ptr);
fukasawa e60969
fukasawa e60969
If you strip the alpha channel you need to find some other way of dealing with
fukasawa e60969
the information.  If, instead, you want to convert the image to an opaque
fukasawa e60969
version with no alpha channel use png_set_background; see below.
fukasawa e60969
fukasawa e60969
As of libpng version 1.5.2, almost all useful expansions are supported, the
fukasawa e60969
major ommissions are conversion of grayscale to indexed images (which can be
fukasawa e60969
done trivially in the application) and conversion of indexed to grayscale (which
fukasawa e60969
can be done by a trivial manipulation of the palette.)
fukasawa e60969
fukasawa e60969
In the following table, the 01 means grayscale with depth<8, 31 means
fukasawa e60969
indexed with depth<8, other numerals represent the color type, "T" means
fukasawa e60969
the tRNS chunk is present, A means an alpha channel is present, and O
fukasawa e60969
means tRNS or alpha is present but all pixels in the image are opaque.
fukasawa e60969
fukasawa e60969
  FROM  01  31   0  0T  0O   2  2T  2O   3  3T  3O  4A  4O  6A  6O
fukasawa e60969
   TO
fukasawa e60969
   01    -  [G]  -   -   -   -   -   -   -   -   -   -   -   -   -
fukasawa e60969
   31   [Q]  Q  [Q] [Q] [Q]  Q   Q   Q   Q   Q   Q  [Q] [Q]  Q   Q
fukasawa e60969
    0    1   G   +   .   .   G   G   G   G   G   G   B   B  GB  GB
fukasawa e60969
   0T    lt  Gt  t   +   .   Gt  G   G   Gt  G   G   Bt  Bt GBt GBt
fukasawa e60969
   0O    lt  Gt  t   .   +   Gt  Gt  G   Gt  Gt  G   Bt  Bt GBt GBt
fukasawa e60969
    2    C   P   C   C   C   +   .   .   C   -   -  CB  CB   B   B
fukasawa e60969
   2T    Ct  -   Ct  C   C   t   +   t   -   -   -  CBt CBt  Bt  Bt
fukasawa e60969
   2O    Ct  -   Ct  C   C   t   t   +   -   -   -  CBt CBt  Bt  Bt
fukasawa e60969
    3   [Q]  p  [Q] [Q] [Q]  Q   Q   Q   +   .   .  [Q] [Q]  Q   Q
fukasawa e60969
   3T   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   +   t  [Qt][Qt] Qt  Qt
fukasawa e60969
   3O   [Qt] p  [Qt][Q] [Q]  Qt  Qt  Qt  t   t   +  [Qt][Qt] Qt  Qt
fukasawa e60969
   4A    lA  G   A   T   T   GA  GT  GT  GA  GT  GT  +   BA  G  GBA
fukasawa e60969
   4O    lA GBA  A   T   T   GA  GT  GT  GA  GT  GT  BA  +  GBA  G
fukasawa e60969
   6A    CA  PA  CA  C   C   A   T  tT   PA  P   P   C  CBA  +   BA
fukasawa e60969
   6O    CA PBA  CA  C   C   A  tT   T   PA  P   P  CBA  C   BA  +
fukasawa e60969
fukasawa e60969
Within the matrix,
fukasawa e60969
     "+" identifies entries where 'from' and 'to' are the same.
fukasawa e60969
     "-" means the transformation is not supported.
fukasawa e60969
     "." means nothing is necessary (a tRNS chunk can just be ignored).
fukasawa e60969
     "t" means the transformation is obtained by png_set_tRNS.
fukasawa e60969
     "A" means the transformation is obtained by png_set_add_alpha().
fukasawa e60969
     "X" means the transformation is obtained by png_set_expand().
fukasawa e60969
     "1" means the transformation is obtained by
fukasawa e60969
         png_set_expand_gray_1_2_4_to_8() (and by png_set_expand()
fukasawa e60969
         if there is no transparency in the original or the final
fukasawa e60969
         format).
fukasawa e60969
     "C" means the transformation is obtained by png_set_gray_to_rgb().
fukasawa e60969
     "G" means the transformation is obtained by png_set_rgb_to_gray().
fukasawa e60969
     "P" means the transformation is obtained by
fukasawa e60969
         png_set_expand_palette_to_rgb().
fukasawa e60969
     "p" means the transformation is obtained by png_set_packing().
fukasawa e60969
     "Q" means the transformation is obtained by png_set_quantize().
fukasawa e60969
     "T" means the transformation is obtained by
fukasawa e60969
         png_set_tRNS_to_alpha().
fukasawa e60969
     "B" means the transformation is obtained by
fukasawa e60969
         png_set_background(), or png_strip_alpha().
fukasawa e60969
fukasawa e60969
When an entry has multiple transforms listed all are required to cause the
fukasawa e60969
right overall transformation.  When two transforms are separated by a comma
fukasawa e60969
either will do the job.  When transforms are enclosed in [] the transform should
fukasawa e60969
do the job but this is currently unimplemented - a different format will result
fukasawa e60969
if the suggested transformations are used.
fukasawa e60969
fukasawa e60969
In PNG files, the alpha channel in an image
fukasawa e60969
is the level of opacity.  If you need the alpha channel in an image to
fukasawa e60969
be the level of transparency instead of opacity, you can invert the
fukasawa e60969
alpha channel (or the tRNS chunk data) after it's read, so that 0 is
fukasawa e60969
fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
fukasawa e60969
images) is fully transparent, with
fukasawa e60969
fukasawa e60969
    png_set_invert_alpha(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
fukasawa e60969
they can, resulting in, for example, 8 pixels per byte for 1 bit
fukasawa e60969
files.  This code expands to 1 pixel per byte without changing the
fukasawa e60969
values of the pixels:
fukasawa e60969
fukasawa e60969
    if (bit_depth < 8)
fukasawa e60969
       png_set_packing(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files have possible bit depths of 1, 2, 4, 8, and 16.  All pixels
fukasawa e60969
stored in a PNG image have been "scaled" or "shifted" up to the next
fukasawa e60969
higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
fukasawa e60969
to 8 bits/sample in the range [0, 255]).  However, it is also possible
fukasawa e60969
to convert the PNG pixel data back to the original bit depth of the
fukasawa e60969
image.  This call reduces the pixels back down to the original bit depth:
fukasawa e60969
fukasawa e60969
    png_color_8p sig_bit;
fukasawa e60969
fukasawa e60969
    if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
fukasawa e60969
       png_set_shift(png_ptr, sig_bit);
fukasawa e60969
fukasawa e60969
PNG files store 3-color pixels in red, green, blue order.  This code
fukasawa e60969
changes the storage of the pixels to blue, green, red:
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_RGB ||
fukasawa e60969
        color_type == PNG_COLOR_TYPE_RGB_ALPHA)
fukasawa e60969
       png_set_bgr(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
fukasawa e60969
into 4 or 8 bytes for windowing systems that need them in this format:
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_RGB)
fukasawa e60969
       png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
fukasawa e60969
fukasawa e60969
where "filler" is the 8-bit or 16-bit number to fill with, and the location
fukasawa e60969
is either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
fukasawa e60969
you want the filler before the RGB or after. When filling an 8-bit pixel,
fukasawa e60969
the least significant 8 bits of the number are used, if a 16-bit number is
fukasawa e60969
supplied.  This transformation does not affect images that already have full
fukasawa e60969
alpha channels.  To add an opaque alpha channel, use filler=0xffff and
fukasawa e60969
PNG_FILLER_AFTER which will generate RGBA pixels.
fukasawa e60969
fukasawa e60969
Note that png_set_filler() does not change the color type.  If you want
fukasawa e60969
to do that, you can add a true alpha channel with
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_RGB ||
fukasawa e60969
       color_type == PNG_COLOR_TYPE_GRAY)
fukasawa e60969
       png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
fukasawa e60969
fukasawa e60969
where "filler" contains the alpha value to assign to each pixel.
fukasawa e60969
The png_set_add_alpha() function was added in libpng-1.2.7.
fukasawa e60969
fukasawa e60969
If you are reading an image with an alpha channel, and you need the
fukasawa e60969
data as ARGB instead of the normal PNG format RGBA:
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
fukasawa e60969
       png_set_swap_alpha(png_ptr);
fukasawa e60969
fukasawa e60969
For some uses, you may want a grayscale image to be represented as
fukasawa e60969
RGB.  This code will do that conversion:
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_GRAY ||
fukasawa e60969
        color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
fukasawa e60969
       png_set_gray_to_rgb(png_ptr);
fukasawa e60969
fukasawa e60969
Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
fukasawa e60969
with alpha.
fukasawa e60969
fukasawa e60969
    if (color_type == PNG_COLOR_TYPE_RGB ||
fukasawa e60969
        color_type == PNG_COLOR_TYPE_RGB_ALPHA)
fukasawa e60969
       png_set_rgb_to_gray(png_ptr, error_action,
fukasawa e60969
          double red_weight, double green_weight);
fukasawa e60969
fukasawa e60969
    error_action = 1: silently do the conversion
fukasawa e60969
fukasawa e60969
    error_action = 2: issue a warning if the original
fukasawa e60969
                      image has any pixel where
fukasawa e60969
                      red != green or red != blue
fukasawa e60969
fukasawa e60969
    error_action = 3: issue an error and abort the
fukasawa e60969
                      conversion if the original
fukasawa e60969
                      image has any pixel where
fukasawa e60969
                      red != green or red != blue
fukasawa e60969
fukasawa e60969
    red_weight:       weight of red component
fukasawa e60969
fukasawa e60969
    green_weight:     weight of green component
fukasawa e60969
                      If either weight is negative, default
fukasawa e60969
                      weights are used.
fukasawa e60969
fukasawa e60969
In the corresponding fixed point API the red_weight and green_weight values are
fukasawa e60969
simply scaled by 100,000:
fukasawa e60969
fukasawa e60969
    png_set_rgb_to_gray(png_ptr, error_action,
fukasawa e60969
       png_fixed_point red_weight,
fukasawa e60969
       png_fixed_point green_weight);
fukasawa e60969
fukasawa e60969
If you have set error_action = 1 or 2, you can
fukasawa e60969
later check whether the image really was gray, after processing
fukasawa e60969
the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
fukasawa e60969
It will return a png_byte that is zero if the image was gray or
fukasawa e60969
1 if there were any non-gray pixels.  Background and sBIT data
fukasawa e60969
will be silently converted to grayscale, using the green channel
fukasawa e60969
data for sBIT, regardless of the error_action setting.
fukasawa e60969
fukasawa e60969
The default values come from the PNG file cHRM chunk if present; otherwise, the
fukasawa e60969
defaults correspond to the ITU-R recommendation 709, and also the sRGB color
fukasawa e60969
space, as recommended in the Charles Poynton's Colour FAQ,
fukasawa e60969
Copyright (c) 2006-11-28 Charles Poynton, in section 9:
fukasawa e60969
fukasawa e60969
<http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC9>
fukasawa e60969
fukasawa e60969
    Y = 0.2126 * R + 0.7152 * G + 0.0722 * B
fukasawa e60969
fukasawa e60969
Previous versions of this document, 1998 through 2002, recommended a slightly
fukasawa e60969
different formula:
fukasawa e60969
fukasawa e60969
    Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
fukasawa e60969
fukasawa e60969
Libpng uses an integer approximation:
fukasawa e60969
fukasawa e60969
    Y = (6968 * R + 23434 * G + 2366 * B)/32768
fukasawa e60969
fukasawa e60969
The calculation is done in a linear colorspace, if the image gamma
fukasawa e60969
can be determined.
fukasawa e60969
fukasawa e60969
The png_set_background() function has been described already; it tells libpng to
fukasawa e60969
composite images with alpha or simple transparency against the supplied
fukasawa e60969
background color.  For compatibility with versions of libpng earlier than
fukasawa e60969
libpng-1.5.4 it is recommended that you call the function after reading the file
fukasawa e60969
header, even if you don't want to use the color in a bKGD chunk, if one exists.
fukasawa e60969
fukasawa e60969
If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
fukasawa e60969
you may use this color, or supply another color more suitable for
fukasawa e60969
the current display (e.g., the background color from a web page).  You
fukasawa e60969
need to tell libpng how the color is represented, both the format of the
fukasawa e60969
component values in the color (the number of bits) and the gamma encoding of the
fukasawa e60969
color.  The function takes two arguments, background_gamma_mode and need_expand
fukasawa e60969
to convey this information; however, only two combinations are likely to be
fukasawa e60969
useful:
fukasawa e60969
fukasawa e60969
    png_color_16 my_background;
fukasawa e60969
    png_color_16p image_background;
fukasawa e60969
fukasawa e60969
    if (png_get_bKGD(png_ptr, info_ptr, &image_background))
fukasawa e60969
       png_set_background(png_ptr, image_background,
fukasawa e60969
           PNG_BACKGROUND_GAMMA_FILE, 1/*needs to be expanded*/, 1);
fukasawa e60969
    else
fukasawa e60969
       png_set_background(png_ptr, &my_background,
fukasawa e60969
           PNG_BACKGROUND_GAMMA_SCREEN, 0/*do not expand*/, 1);
fukasawa e60969
fukasawa e60969
The second call was described above - my_background is in the format of the
fukasawa e60969
final, display, output produced by libpng.  Because you now know the format of
fukasawa e60969
the PNG it is possible to avoid the need to choose either 8-bit or 16-bit
fukasawa e60969
output and to retain palette images (the palette colors will be modified
fukasawa e60969
appropriately and the tRNS chunk removed.)  However, if you are doing this,
fukasawa e60969
take great care not to ask for transformations without checking first that
fukasawa e60969
they apply!
fukasawa e60969
fukasawa e60969
In the first call the background color has the original bit depth and color type
fukasawa e60969
of the PNG file.  So, for palette images the color is supplied as a palette
fukasawa e60969
index and for low bit greyscale images the color is a reduced bit value in
fukasawa e60969
image_background->gray.
fukasawa e60969
fukasawa e60969
If you didn't call png_set_gamma() before reading the file header, for example
fukasawa e60969
if you need your code to remain compatible with older versions of libpng prior
fukasawa e60969
to libpng-1.5.4, this is the place to call it.
fukasawa e60969
fukasawa e60969
Do not call it if you called png_set_alpha_mode(); doing so will damage the
fukasawa e60969
settings put in place by png_set_alpha_mode().  (If png_set_alpha_mode() is
fukasawa e60969
supported then you can certainly do png_set_gamma() before reading the PNG
fukasawa e60969
header.)
fukasawa e60969
fukasawa e60969
This API unconditionally sets the screen and file gamma values, so it will
fukasawa e60969
override the value in the PNG file unless it is called before the PNG file
fukasawa e60969
reading starts.  For this reason you must always call it with the PNG file
fukasawa e60969
value when you call it in this position:
fukasawa e60969
fukasawa e60969
   if (png_get_gAMA(png_ptr, info_ptr, &file_gamma))
fukasawa e60969
      png_set_gamma(png_ptr, screen_gamma, file_gamma);
fukasawa e60969
fukasawa e60969
   else
fukasawa e60969
      png_set_gamma(png_ptr, screen_gamma, 0.45455);
fukasawa e60969
fukasawa e60969
If you need to reduce an RGB file to a paletted file, or if a paletted
fukasawa e60969
file has more entries than will fit on your screen, png_set_quantize()
fukasawa e60969
will do that.  Note that this is a simple match quantization that merely
fukasawa e60969
finds the closest color available.  This should work fairly well with
fukasawa e60969
optimized palettes, but fairly badly with linear color cubes.  If you
fukasawa e60969
pass a palette that is larger than maximum_colors, the file will
fukasawa e60969
reduce the number of colors in the palette so it will fit into
fukasawa e60969
maximum_colors.  If there is a histogram, libpng will use it to make
fukasawa e60969
more intelligent choices when reducing the palette.  If there is no
fukasawa e60969
histogram, it may not do as good a job.
fukasawa e60969
fukasawa e60969
   if (color_type & PNG_COLOR_MASK_COLOR)
fukasawa e60969
   {
fukasawa e60969
      if (png_get_valid(png_ptr, info_ptr,
fukasawa e60969
          PNG_INFO_PLTE))
fukasawa e60969
      {
fukasawa e60969
         png_uint_16p histogram = NULL;
fukasawa e60969
fukasawa e60969
         png_get_hIST(png_ptr, info_ptr,
fukasawa e60969
             &histogram);
fukasawa e60969
         png_set_quantize(png_ptr, palette, num_palette,
fukasawa e60969
            max_screen_colors, histogram, 1);
fukasawa e60969
      }
fukasawa e60969
fukasawa e60969
      else
fukasawa e60969
      {
fukasawa e60969
         png_color std_color_cube[MAX_SCREEN_COLORS] =
fukasawa e60969
            { ... colors ... };
fukasawa e60969
fukasawa e60969
         png_set_quantize(png_ptr, std_color_cube,
fukasawa e60969
            MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
fukasawa e60969
            NULL,0);
fukasawa e60969
      }
fukasawa e60969
   }
fukasawa e60969
fukasawa e60969
PNG files describe monochrome as black being zero and white being one.
fukasawa e60969
The following code will reverse this (make black be one and white be
fukasawa e60969
zero):
fukasawa e60969
fukasawa e60969
   if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
fukasawa e60969
      png_set_invert_mono(png_ptr);
fukasawa e60969
fukasawa e60969
This function can also be used to invert grayscale and gray-alpha images:
fukasawa e60969
fukasawa e60969
   if (color_type == PNG_COLOR_TYPE_GRAY ||
fukasawa e60969
       color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
fukasawa e60969
      png_set_invert_mono(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files store 16-bit pixels in network byte order (big-endian,
fukasawa e60969
ie. most significant bits first).  This code changes the storage to the
fukasawa e60969
other way (little-endian, i.e. least significant bits first, the
fukasawa e60969
way PCs store them):
fukasawa e60969
fukasawa e60969
    if (bit_depth == 16)
fukasawa e60969
       png_set_swap(png_ptr);
fukasawa e60969
fukasawa e60969
If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
fukasawa e60969
need to change the order the pixels are packed into bytes, you can use:
fukasawa e60969
fukasawa e60969
    if (bit_depth < 8)
fukasawa e60969
       png_set_packswap(png_ptr);
fukasawa e60969
fukasawa e60969
Finally, you can write your own transformation function if none of
fukasawa e60969
the existing ones meets your needs.  This is done by setting a callback
fukasawa e60969
with
fukasawa e60969
fukasawa e60969
    png_set_read_user_transform_fn(png_ptr,
fukasawa e60969
        read_transform_fn);
fukasawa e60969
fukasawa e60969
You must supply the function
fukasawa e60969
fukasawa e60969
    void read_transform_fn(png_structp png_ptr, png_row_infop
fukasawa e60969
        row_info, png_bytep data)
fukasawa e60969
fukasawa e60969
See pngtest.c for a working example.  Your function will be called
fukasawa e60969
after all of the other transformations have been processed.  Take care with
fukasawa e60969
interlaced images if you do the interlace yourself - the width of the row is the
fukasawa e60969
width in 'row_info', not the overall image width.
fukasawa e60969
fukasawa e60969
If supported, libpng provides two information routines that you can use to find
fukasawa e60969
where you are in processing the image:
fukasawa e60969
fukasawa e60969
   png_get_current_pass_number(png_structp png_ptr);
fukasawa e60969
   png_get_current_row_number(png_structp png_ptr);
fukasawa e60969
fukasawa e60969
Don't try using these outside a transform callback - firstly they are only
fukasawa e60969
supported if user transforms are supported, secondly they may well return
fukasawa e60969
unexpected results unless the row is actually being processed at the moment they
fukasawa e60969
are called.
fukasawa e60969
fukasawa e60969
With interlaced
fukasawa e60969
images the value returned is the row in the input sub-image image.  Use
fukasawa e60969
PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
fukasawa e60969
find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
fukasawa e60969
fukasawa e60969
The discussion of interlace handling above contains more information on how to
fukasawa e60969
use these values.
fukasawa e60969
fukasawa e60969
You can also set up a pointer to a user structure for use by your
fukasawa e60969
callback function, and you can inform libpng that your transform
fukasawa e60969
function will change the number of channels or bit depth with the
fukasawa e60969
function
fukasawa e60969
fukasawa e60969
    png_set_user_transform_info(png_ptr, user_ptr,
fukasawa e60969
        user_depth, user_channels);
fukasawa e60969
fukasawa e60969
The user's application, not libpng, is responsible for allocating and
fukasawa e60969
freeing any memory required for the user structure.
fukasawa e60969
fukasawa e60969
You can retrieve the pointer via the function
fukasawa e60969
png_get_user_transform_ptr().  For example:
fukasawa e60969
fukasawa e60969
    voidp read_user_transform_ptr =
fukasawa e60969
        png_get_user_transform_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
The last thing to handle is interlacing; this is covered in detail below,
fukasawa e60969
but you must call the function here if you want libpng to handle expansion
fukasawa e60969
of the interlaced image.
fukasawa e60969
fukasawa e60969
    number_of_passes = png_set_interlace_handling(png_ptr);
fukasawa e60969
fukasawa e60969
After setting the transformations, libpng can update your png_info
fukasawa e60969
structure to reflect any transformations you've requested with this
fukasawa e60969
call.
fukasawa e60969
fukasawa e60969
    png_read_update_info(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
This is most useful to update the info structure's rowbytes
fukasawa e60969
field so you can use it to allocate your image memory.  This function
fukasawa e60969
will also update your palette with the correct screen_gamma and
fukasawa e60969
background if these have been given with the calls above.  You may
fukasawa e60969
only call png_read_update_info() once with a particular info_ptr.
fukasawa e60969
fukasawa e60969
After you call png_read_update_info(), you can allocate any
fukasawa e60969
memory you need to hold the image.  The row data is simply
fukasawa e60969
raw byte data for all forms of images.  As the actual allocation
fukasawa e60969
varies among applications, no example will be given.  If you
fukasawa e60969
are allocating one large chunk, you will need to build an
fukasawa e60969
array of pointers to each row, as it will be needed for some
fukasawa e60969
of the functions below.
fukasawa e60969
fukasawa e60969
Remember: Before you call png_read_update_info(), the png_get_*()
fukasawa e60969
functions return the values corresponding to the original PNG image.
fukasawa e60969
After you call png_read_update_info the values refer to the image
fukasawa e60969
that libpng will output.  Consequently you must call all the png_set_
fukasawa e60969
functions before you call png_read_update_info().  This is particularly
fukasawa e60969
important for png_set_interlace_handling() - if you are going to call
fukasawa e60969
png_read_update_info() you must call png_set_interlace_handling() before
fukasawa e60969
it unless you want to receive interlaced output.
fukasawa e60969
fukasawa e60969
.SS Reading image data
fukasawa e60969
fukasawa e60969
After you've allocated memory, you can read the image data.
fukasawa e60969
The simplest way to do this is in one function call.  If you are
fukasawa e60969
allocating enough memory to hold the whole image, you can just
fukasawa e60969
call png_read_image() and libpng will read in all the image data
fukasawa e60969
and put it in the memory area supplied.  You will need to pass in
fukasawa e60969
an array of pointers to each row.
fukasawa e60969
fukasawa e60969
This function automatically handles interlacing, so you don't
fukasawa e60969
need to call png_set_interlace_handling() (unless you call
fukasawa e60969
png_read_update_info()) or call this function multiple times, or any
fukasawa e60969
of that other stuff necessary with png_read_rows().
fukasawa e60969
fukasawa e60969
   png_read_image(png_ptr, row_pointers);
fukasawa e60969
fukasawa e60969
where row_pointers is:
fukasawa e60969
fukasawa e60969
   png_bytep row_pointers[height];
fukasawa e60969
fukasawa e60969
You can point to void or char or whatever you use for pixels.
fukasawa e60969
fukasawa e60969
If you don't want to read in the whole image at once, you can
fukasawa e60969
use png_read_rows() instead.  If there is no interlacing (check
fukasawa e60969
interlace_type == PNG_INTERLACE_NONE), this is simple:
fukasawa e60969
fukasawa e60969
    png_read_rows(png_ptr, row_pointers, NULL,
fukasawa e60969
        number_of_rows);
fukasawa e60969
fukasawa e60969
where row_pointers is the same as in the png_read_image() call.
fukasawa e60969
fukasawa e60969
If you are doing this just one row at a time, you can do this with
fukasawa e60969
a single row_pointer instead of an array of row_pointers:
fukasawa e60969
fukasawa e60969
    png_bytep row_pointer = row;
fukasawa e60969
    png_read_row(png_ptr, row_pointer, NULL);
fukasawa e60969
fukasawa e60969
If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
fukasawa e60969
get somewhat harder.  The only current (PNG Specification version 1.2)
fukasawa e60969
interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7);
fukasawa e60969
a somewhat complicated 2D interlace scheme, known as Adam7, that
fukasawa e60969
breaks down an image into seven smaller images of varying size, based
fukasawa e60969
on an 8x8 grid.  This number is defined (from libpng 1.5) as
fukasawa e60969
PNG_INTERLACE_ADAM7_PASSES in png.h
fukasawa e60969
fukasawa e60969
libpng can fill out those images or it can give them to you "as is".
fukasawa e60969
It is almost always better to have libpng handle the interlacing for you.
fukasawa e60969
If you want the images filled out, there are two ways to do that.  The one
fukasawa e60969
mentioned in the PNG specification is to expand each pixel to cover
fukasawa e60969
those pixels that have not been read yet (the "rectangle" method).
fukasawa e60969
This results in a blocky image for the first pass, which gradually
fukasawa e60969
smooths out as more pixels are read.  The other method is the "sparkle"
fukasawa e60969
method, where pixels are drawn only in their final locations, with the
fukasawa e60969
rest of the image remaining whatever colors they were initialized to
fukasawa e60969
before the start of the read.  The first method usually looks better,
fukasawa e60969
but tends to be slower, as there are more pixels to put in the rows.
fukasawa e60969
fukasawa e60969
If, as is likely, you want libpng to expand the images, call this before
fukasawa e60969
calling png_start_read_image() or png_read_update_info():
fukasawa e60969
fukasawa e60969
    if (interlace_type == PNG_INTERLACE_ADAM7)
fukasawa e60969
       number_of_passes
fukasawa e60969
           = png_set_interlace_handling(png_ptr);
fukasawa e60969
fukasawa e60969
This will return the number of passes needed.  Currently, this is seven,
fukasawa e60969
but may change if another interlace type is added.  This function can be
fukasawa e60969
called even if the file is not interlaced, where it will return one pass.
fukasawa e60969
You then need to read the whole image 'number_of_passes' times.  Each time
fukasawa e60969
will distribute the pixels from the current pass to the correct place in
fukasawa e60969
the output image, so you need to supply the same rows to png_read_rows in
fukasawa e60969
each pass.
fukasawa e60969
fukasawa e60969
If you are not going to display the image after each pass, but are
fukasawa e60969
going to wait until the entire image is read in, use the sparkle
fukasawa e60969
effect.  This effect is faster and the end result of either method
fukasawa e60969
is exactly the same.  If you are planning on displaying the image
fukasawa e60969
after each pass, the "rectangle" effect is generally considered the
fukasawa e60969
better looking one.
fukasawa e60969
fukasawa e60969
If you only want the "sparkle" effect, just call png_read_rows() as
fukasawa e60969
normal, with the third parameter NULL.  Make sure you make pass over
fukasawa e60969
the image number_of_passes times, and you don't change the data in the
fukasawa e60969
rows between calls.  You can change the locations of the data, just
fukasawa e60969
not the data.  Each pass only writes the pixels appropriate for that
fukasawa e60969
pass, and assumes the data from previous passes is still valid.
fukasawa e60969
fukasawa e60969
    png_read_rows(png_ptr, row_pointers, NULL,
fukasawa e60969
        number_of_rows);
fukasawa e60969
fukasawa e60969
If you only want the first effect (the rectangles), do the same as
fukasawa e60969
before except pass the row buffer in the third parameter, and leave
fukasawa e60969
the second parameter NULL.
fukasawa e60969
fukasawa e60969
    png_read_rows(png_ptr, NULL, row_pointers,
fukasawa e60969
        number_of_rows);
fukasawa e60969
fukasawa e60969
If you don't want libpng to handle the interlacing details, just call
fukasawa e60969
png_read_rows() PNG_INTERLACE_ADAM7_PASSES times to read in all the images.
fukasawa e60969
Each of the images is a valid image by itself; however, you will almost
fukasawa e60969
certainly need to distribute the pixels from each sub-image to the
fukasawa e60969
correct place.  This is where everything gets very tricky.
fukasawa e60969
fukasawa e60969
If you want to retrieve the separate images you must pass the correct
fukasawa e60969
number of rows to each successive call of png_read_rows().  The calculation
fukasawa e60969
gets pretty complicated for small images, where some sub-images may
fukasawa e60969
not even exist because either their width or height ends up zero.
fukasawa e60969
libpng provides two macros to help you in 1.5 and later versions:
fukasawa e60969
fukasawa e60969
   png_uint_32 width = PNG_PASS_COLS(image_width, pass_number);
fukasawa e60969
   png_uint_32 height = PNG_PASS_ROWS(image_height, pass_number);
fukasawa e60969
fukasawa e60969
Respectively these tell you the width and height of the sub-image
fukasawa e60969
corresponding to the numbered pass.  'pass' is in in the range 0 to 6 -
fukasawa e60969
this can be confusing because the specification refers to the same passes
fukasawa e60969
as 1 to 7!  Be careful, you must check both the width and height before
fukasawa e60969
calling png_read_rows() and not call it for that pass if either is zero.
fukasawa e60969
fukasawa e60969
You can, of course, read each sub-image row by row.  If you want to
fukasawa e60969
produce optimal code to make a pixel-by-pixel transformation of an
fukasawa e60969
interlaced image this is the best approach; read each row of each pass,
fukasawa e60969
transform it, and write it out to a new interlaced image.
fukasawa e60969
fukasawa e60969
If you want to de-interlace the image yourself libpng provides further
fukasawa e60969
macros to help that tell you where to place the pixels in the output image.
fukasawa e60969
Because the interlacing scheme is rectangular - sub-image pixels are always
fukasawa e60969
arranged on a rectangular grid - all you need to know for each pass is the
fukasawa e60969
starting column and row in the output image of the first pixel plus the
fukasawa e60969
spacing between each pixel.  As of libpng 1.5 there are four macros to
fukasawa e60969
retrieve this information:
fukasawa e60969
fukasawa e60969
   png_uint_32 x = PNG_PASS_START_COL(pass);
fukasawa e60969
   png_uint_32 y = PNG_PASS_START_ROW(pass);
fukasawa e60969
   png_uint_32 xStep = 1U << PNG_PASS_COL_SHIFT(pass);
fukasawa e60969
   png_uint_32 yStep = 1U << PNG_PASS_ROW_SHIFT(pass);
fukasawa e60969
fukasawa e60969
These allow you to write the obvious loop:
fukasawa e60969
fukasawa e60969
   png_uint_32 input_y = 0;
fukasawa e60969
   png_uint_32 output_y = PNG_PASS_START_ROW(pass);
fukasawa e60969
fukasawa e60969
   while (output_y < output_image_height)
fukasawa e60969
   {
fukasawa e60969
      png_uint_32 input_x = 0;
fukasawa e60969
      png_uint_32 output_x = PNG_PASS_START_COL(pass);
fukasawa e60969
fukasawa e60969
      while (output_x < output_image_width)
fukasawa e60969
      {
fukasawa e60969
         image[output_y][output_x] =
fukasawa e60969
             subimage[pass][input_y][input_x++];
fukasawa e60969
fukasawa e60969
         output_x += xStep;
fukasawa e60969
      }
fukasawa e60969
fukasawa e60969
      ++input_y;
fukasawa e60969
      output_y += yStep;
fukasawa e60969
   }
fukasawa e60969
fukasawa e60969
Notice that the steps between successive output rows and columns are
fukasawa e60969
returned as shifts.  This is possible because the pixels in the subimages
fukasawa e60969
are always a power of 2 apart - 1, 2, 4 or 8 pixels - in the original
fukasawa e60969
image.  In practice you may need to directly calculate the output coordinate
fukasawa e60969
given an input coordinate.  libpng provides two further macros for this
fukasawa e60969
purpose:
fukasawa e60969
fukasawa e60969
   png_uint_32 output_x = PNG_COL_FROM_PASS_COL(input_x, pass);
fukasawa e60969
   png_uint_32 output_y = PNG_ROW_FROM_PASS_ROW(input_y, pass);
fukasawa e60969
fukasawa e60969
Finally a pair of macros are provided to tell you if a particular image
fukasawa e60969
row or column appears in a given pass:
fukasawa e60969
fukasawa e60969
   int col_in_pass = PNG_COL_IN_INTERLACE_PASS(output_x, pass);
fukasawa e60969
   int row_in_pass = PNG_ROW_IN_INTERLACE_PASS(output_y, pass);
fukasawa e60969
fukasawa e60969
Bear in mind that you will probably also need to check the width and height
fukasawa e60969
of the pass in addition to the above to be sure the pass even exists!
fukasawa e60969
fukasawa e60969
With any luck you are convinced by now that you don't want to do your own
fukasawa e60969
interlace handling.  In reality normally the only good reason for doing this
fukasawa e60969
is if you are processing PNG files on a pixel-by-pixel basis and don't want
fukasawa e60969
to load the whole file into memory when it is interlaced.
fukasawa e60969
fukasawa e60969
libpng includes a test program, pngvalid, that illustrates reading and
fukasawa e60969
writing of interlaced images.  If you can't get interlacing to work in your
fukasawa e60969
code and don't want to leave it to libpng (the recommended approach), see
fukasawa e60969
how pngvalid.c does it.
fukasawa e60969
fukasawa e60969
.SS Finishing a sequential read
fukasawa e60969
fukasawa e60969
After you are finished reading the image through the
fukasawa e60969
low-level interface, you can finish reading the file.
fukasawa e60969
fukasawa e60969
If you want to use a different crc action for handling CRC errors in
fukasawa e60969
chunks after the image data, you can call png_set_crc_action()
fukasawa e60969
again at this point.
fukasawa e60969
fukasawa e60969
If you are interested in comments or time, which may be stored either
fukasawa e60969
before or after the image data, you should pass the separate png_info
fukasawa e60969
struct if you want to keep the comments from before and after the image
fukasawa e60969
separate.
fukasawa e60969
fukasawa e60969
    png_infop end_info = png_create_info_struct(png_ptr);
fukasawa e60969
fukasawa e60969
    if (!end_info)
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
           (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
   png_read_end(png_ptr, end_info);
fukasawa e60969
fukasawa e60969
If you are not interested, you should still call png_read_end()
fukasawa e60969
but you can pass NULL, avoiding the need to create an end_info structure.
fukasawa e60969
If you do this, libpng will not process any chunks after IDAT other than
fukasawa e60969
skipping over them and perhaps (depending on whether you have called
fukasawa e60969
png_set_crc_action) checking their CRCs while looking for the IEND chunk.
fukasawa e60969
fukasawa e60969
   png_read_end(png_ptr, (png_infop)NULL);
fukasawa e60969
fukasawa e60969
If you don't call png_read_end(), then your file pointer will be
fukasawa e60969
left pointing to the first chunk after the last IDAT, which is probably
fukasawa e60969
not what you want if you expect to read something beyond the end of
fukasawa e60969
the PNG datastream.
fukasawa e60969
fukasawa e60969
When you are done, you can free all memory allocated by libpng like this:
fukasawa e60969
fukasawa e60969
   png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
       &end_info);
fukasawa e60969
fukasawa e60969
or, if you didn't create an end_info structure,
fukasawa e60969
fukasawa e60969
   png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
       (png_infopp)NULL);
fukasawa e60969
fukasawa e60969
It is also possible to individually free the info_ptr members that
fukasawa e60969
point to libpng-allocated storage with the following function:
fukasawa e60969
fukasawa e60969
    png_free_data(png_ptr, info_ptr, mask, seq)
fukasawa e60969
fukasawa e60969
    mask - identifies data to be freed, a mask
fukasawa e60969
           containing the bitwise OR of one or
fukasawa e60969
           more of
fukasawa e60969
             PNG_FREE_PLTE, PNG_FREE_TRNS,
fukasawa e60969
             PNG_FREE_HIST, PNG_FREE_ICCP,
fukasawa e60969
             PNG_FREE_PCAL, PNG_FREE_ROWS,
fukasawa e60969
             PNG_FREE_SCAL, PNG_FREE_SPLT,
fukasawa e60969
             PNG_FREE_TEXT, PNG_FREE_UNKN,
fukasawa e60969
           or simply PNG_FREE_ALL
fukasawa e60969
fukasawa e60969
    seq  - sequence number of item to be freed
fukasawa e60969
           (\-1 for all items)
fukasawa e60969
fukasawa e60969
This function may be safely called when the relevant storage has
fukasawa e60969
already been freed, or has not yet been allocated, or was allocated
fukasawa e60969
by the user and not by libpng,  and will in those cases do nothing.
fukasawa e60969
The "seq" parameter is ignored if only one item of the selected data
fukasawa e60969
type, such as PLTE, is allowed.  If "seq" is not \-1, and multiple items
fukasawa e60969
are allowed for the data type identified in the mask, such as text or
fukasawa e60969
sPLT, only the n'th item in the structure is freed, where n is "seq".
fukasawa e60969
fukasawa e60969
The default behavior is only to free data that was allocated internally
fukasawa e60969
by libpng.  This can be changed, so that libpng will not free the data,
fukasawa e60969
or so that it will free data that was allocated by the user with png_malloc()
fukasawa e60969
or png_calloc() and passed in via a png_set_*() function, with
fukasawa e60969
fukasawa e60969
    png_data_freer(png_ptr, info_ptr, freer, mask)
fukasawa e60969
fukasawa e60969
    freer  - one of
fukasawa e60969
               PNG_DESTROY_WILL_FREE_DATA
fukasawa e60969
               PNG_SET_WILL_FREE_DATA
fukasawa e60969
               PNG_USER_WILL_FREE_DATA
fukasawa e60969
fukasawa e60969
    mask   - which data elements are affected
fukasawa e60969
             same choices as in png_free_data()
fukasawa e60969
fukasawa e60969
This function only affects data that has already been allocated.
fukasawa e60969
You can call this function after reading the PNG data but before calling
fukasawa e60969
any png_set_*() functions, to control whether the user or the png_set_*()
fukasawa e60969
function is responsible for freeing any existing data that might be present,
fukasawa e60969
and again after the png_set_*() functions to control whether the user
fukasawa e60969
or png_destroy_*() is supposed to free the data.  When the user assumes
fukasawa e60969
responsibility for libpng-allocated data, the application must use
fukasawa e60969
png_free() to free it, and when the user transfers responsibility to libpng
fukasawa e60969
for data that the user has allocated, the user must have used png_malloc()
fukasawa e60969
or png_calloc() to allocate it.
fukasawa e60969
fukasawa e60969
If you allocated your row_pointers in a single block, as suggested above in
fukasawa e60969
the description of the high level read interface, you must not transfer
fukasawa e60969
responsibility for freeing it to the png_set_rows or png_read_destroy function,
fukasawa e60969
because they would also try to free the individual row_pointers[i].
fukasawa e60969
fukasawa e60969
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
fukasawa e60969
separately, do not transfer responsibility for freeing text_ptr to libpng,
fukasawa e60969
because when libpng fills a png_text structure it combines these members with
fukasawa e60969
the key member, and png_free_data() will free only text_ptr.key.  Similarly,
fukasawa e60969
if you transfer responsibility for free'ing text_ptr from libpng to your
fukasawa e60969
application, your application must not separately free those members.
fukasawa e60969
fukasawa e60969
The png_free_data() function will turn off the "valid" flag for anything
fukasawa e60969
it frees.  If you need to turn the flag off for a chunk that was freed by
fukasawa e60969
your application instead of by libpng, you can use
fukasawa e60969
fukasawa e60969
    png_set_invalid(png_ptr, info_ptr, mask);
fukasawa e60969
fukasawa e60969
    mask - identifies the chunks to be made invalid,
fukasawa e60969
           containing the bitwise OR of one or
fukasawa e60969
           more of
fukasawa e60969
             PNG_INFO_gAMA, PNG_INFO_sBIT,
fukasawa e60969
             PNG_INFO_cHRM, PNG_INFO_PLTE,
fukasawa e60969
             PNG_INFO_tRNS, PNG_INFO_bKGD,
fukasawa e60969
             PNG_INFO_hIST, PNG_INFO_pHYs,
fukasawa e60969
             PNG_INFO_oFFs, PNG_INFO_tIME,
fukasawa e60969
             PNG_INFO_pCAL, PNG_INFO_sRGB,
fukasawa e60969
             PNG_INFO_iCCP, PNG_INFO_sPLT,
fukasawa e60969
             PNG_INFO_sCAL, PNG_INFO_IDAT
fukasawa e60969
fukasawa e60969
For a more compact example of reading a PNG image, see the file example.c.
fukasawa e60969
fukasawa e60969
.SS Reading PNG files progressively
fukasawa e60969
fukasawa e60969
The progressive reader is slightly different from the non-progressive
fukasawa e60969
reader.  Instead of calling png_read_info(), png_read_rows(), and
fukasawa e60969
png_read_end(), you make one call to png_process_data(), which calls
fukasawa e60969
callbacks when it has the info, a row, or the end of the image.  You
fukasawa e60969
set up these callbacks with png_set_progressive_read_fn().  You don't
fukasawa e60969
have to worry about the input/output functions of libpng, as you are
fukasawa e60969
giving the library the data directly in png_process_data().  I will
fukasawa e60969
assume that you have read the section on reading PNG files above,
fukasawa e60969
so I will only highlight the differences (although I will show
fukasawa e60969
all of the code).
fukasawa e60969
fukasawa e60969
png_structp png_ptr;
fukasawa e60969
png_infop info_ptr;
fukasawa e60969
fukasawa e60969
 /*  An example code fragment of how you would
fukasawa e60969
     initialize the progressive reader in your
fukasawa e60969
     application. */
fukasawa e60969
 int
fukasawa e60969
 initialize_png_reader()
fukasawa e60969
 {
fukasawa e60969
    png_ptr = png_create_read_struct
fukasawa e60969
        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
fukasawa e60969
         user_error_fn, user_warning_fn);
fukasawa e60969
fukasawa e60969
    if (!png_ptr)
fukasawa e60969
        return (ERROR);
fukasawa e60969
fukasawa e60969
    info_ptr = png_create_info_struct(png_ptr);
fukasawa e60969
fukasawa e60969
    if (!info_ptr)
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr,
fukasawa e60969
          (png_infopp)NULL, (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    if (setjmp(png_jmpbuf(png_ptr)))
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
          (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    /* This one's new.  You can provide functions
fukasawa e60969
       to be called when the header info is valid,
fukasawa e60969
       when each row is completed, and when the image
fukasawa e60969
       is finished.  If you aren't using all functions,
fukasawa e60969
       you can specify NULL parameters.  Even when all
fukasawa e60969
       three functions are NULL, you need to call
fukasawa e60969
       png_set_progressive_read_fn().  You can use
fukasawa e60969
       any struct as the user_ptr (cast to a void pointer
fukasawa e60969
       for the function call), and retrieve the pointer
fukasawa e60969
       from inside the callbacks using the function
fukasawa e60969
fukasawa e60969
          png_get_progressive_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
       which will return a void pointer, which you have
fukasawa e60969
       to cast appropriately.
fukasawa e60969
     */
fukasawa e60969
    png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
fukasawa e60969
        info_callback, row_callback, end_callback);
fukasawa e60969
fukasawa e60969
    return 0;
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
 /* A code fragment that you call as you receive blocks
fukasawa e60969
   of data */
fukasawa e60969
 int
fukasawa e60969
 process_data(png_bytep buffer, png_uint_32 length)
fukasawa e60969
 {
fukasawa e60969
    if (setjmp(png_jmpbuf(png_ptr)))
fukasawa e60969
    {
fukasawa e60969
       png_destroy_read_struct(&png_ptr, &info_ptr,
fukasawa e60969
           (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    /* This one's new also.  Simply give it a chunk
fukasawa e60969
       of data from the file stream (in order, of
fukasawa e60969
       course).  On machines with segmented memory
fukasawa e60969
       models machines, don't give it any more than
fukasawa e60969
       64K.  The library seems to run fine with sizes
fukasawa e60969
       of 4K. Although you can give it much less if
fukasawa e60969
       necessary (I assume you can give it chunks of
fukasawa e60969
       1 byte, I haven't tried less than 256 bytes
fukasawa e60969
       yet).  When this function returns, you may
fukasawa e60969
       want to display any rows that were generated
fukasawa e60969
       in the row callback if you don't already do
fukasawa e60969
       so there.
fukasawa e60969
     */
fukasawa e60969
    png_process_data(png_ptr, info_ptr, buffer, length);
fukasawa e60969
fukasawa e60969
    /* At this point you can call png_process_data_skip if
fukasawa e60969
       you want to handle data the library will skip yourself;
fukasawa e60969
       it simply returns the number of bytes to skip (and stops
fukasawa e60969
       libpng skipping that number of bytes on the next
fukasawa e60969
       png_process_data call).
fukasawa e60969
    return 0;
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
 /* This function is called (as set by
fukasawa e60969
    png_set_progressive_read_fn() above) when enough data
fukasawa e60969
    has been supplied so all of the header has been
fukasawa e60969
    read.
fukasawa e60969
 */
fukasawa e60969
 void
fukasawa e60969
 info_callback(png_structp png_ptr, png_infop info)
fukasawa e60969
 {
fukasawa e60969
    /* Do any setup here, including setting any of
fukasawa e60969
       the transformations mentioned in the Reading
fukasawa e60969
       PNG files section.  For now, you _must_ call
fukasawa e60969
       either png_start_read_image() or
fukasawa e60969
       png_read_update_info() after all the
fukasawa e60969
       transformations are set (even if you don't set
fukasawa e60969
       any).  You may start getting rows before
fukasawa e60969
       png_process_data() returns, so this is your
fukasawa e60969
       last chance to prepare for that.
fukasawa e60969
fukasawa e60969
       This is where you turn on interlace handling,
fukasawa e60969
       assuming you don't want to do it yourself.
fukasawa e60969
fukasawa e60969
       If you need to you can stop the processing of
fukasawa e60969
       your original input data at this point by calling
fukasawa e60969
       png_process_data_pause.  This returns the number
fukasawa e60969
       of unprocessed bytes from the last png_process_data
fukasawa e60969
       call - it is up to you to ensure that the next call
fukasawa e60969
       sees these bytes again.  If you don't want to bother
fukasawa e60969
       with this you can get libpng to cache the unread
fukasawa e60969
       bytes by setting the 'save' parameter (see png.h) but
fukasawa e60969
       then libpng will have to copy the data internally.
fukasawa e60969
     */
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
 /* This function is called when each row of image
fukasawa e60969
    data is complete */
fukasawa e60969
 void
fukasawa e60969
 row_callback(png_structp png_ptr, png_bytep new_row,
fukasawa e60969
    png_uint_32 row_num, int pass)
fukasawa e60969
 {
fukasawa e60969
    /* If the image is interlaced, and you turned
fukasawa e60969
       on the interlace handler, this function will
fukasawa e60969
       be called for every row in every pass.  Some
fukasawa e60969
       of these rows will not be changed from the
fukasawa e60969
       previous pass.  When the row is not changed,
fukasawa e60969
       the new_row variable will be NULL.  The rows
fukasawa e60969
       and passes are called in order, so you don't
fukasawa e60969
       really need the row_num and pass, but I'm
fukasawa e60969
       supplying them because it may make your life
fukasawa e60969
       easier.
fukasawa e60969
fukasawa e60969
       If you did not turn on interlace handling then
fukasawa e60969
       the callback is called for each row of each
fukasawa e60969
       sub-image when the image is interlaced.  In this
fukasawa e60969
       case 'row_num' is the row in the sub-image, not
fukasawa e60969
       the row in the output image as it is in all other
fukasawa e60969
       cases.
fukasawa e60969
fukasawa e60969
       For the non-NULL rows of interlaced images when
fukasawa e60969
       you have switched on libpng interlace handling,
fukasawa e60969
       you must call png_progressive_combine_row()
fukasawa e60969
       passing in the row and the old row.  You can
fukasawa e60969
       call this function for NULL rows (it will just
fukasawa e60969
       return) and for non-interlaced images (it just
fukasawa e60969
       does the memcpy for you) if it will make the
fukasawa e60969
       code easier.  Thus, you can just do this for
fukasawa e60969
       all cases if you switch on interlace handling;
fukasawa e60969
     */
fukasawa e60969
fukasawa e60969
        png_progressive_combine_row(png_ptr, old_row,
fukasawa e60969
          new_row);
fukasawa e60969
fukasawa e60969
    /* where old_row is what was displayed
fukasawa e60969
       previously for the row.  Note that the first
fukasawa e60969
       pass (pass == 0, really) will completely cover
fukasawa e60969
       the old row, so the rows do not have to be
fukasawa e60969
       initialized.  After the first pass (and only
fukasawa e60969
       for interlaced images), you will have to pass
fukasawa e60969
       the current row, and the function will combine
fukasawa e60969
       the old row and the new row.
fukasawa e60969
fukasawa e60969
       You can also call png_process_data_pause in this
fukasawa e60969
       callback - see above.
fukasawa e60969
    */
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
 void
fukasawa e60969
 end_callback(png_structp png_ptr, png_infop info)
fukasawa e60969
 {
fukasawa e60969
    /* This function is called after the whole image
fukasawa e60969
       has been read, including any chunks after the
fukasawa e60969
       image (up to and including the IEND).  You
fukasawa e60969
       will usually have the same info chunk as you
fukasawa e60969
       had in the header, although some data may have
fukasawa e60969
       been added to the comments and time fields.
fukasawa e60969
fukasawa e60969
       Most people won't do much here, perhaps setting
fukasawa e60969
       a flag that marks the image as finished.
fukasawa e60969
     */
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
fukasawa e60969
fukasawa e60969
.SH IV. Writing
fukasawa e60969
fukasawa e60969
Much of this is very similar to reading.  However, everything of
fukasawa e60969
importance is repeated here, so you won't have to constantly look
fukasawa e60969
back up in the reading section to understand writing.
fukasawa e60969
fukasawa e60969
.SS Setup
fukasawa e60969
fukasawa e60969
You will want to do the I/O initialization before you get into libpng,
fukasawa e60969
so if it doesn't work, you don't have anything to undo. If you are not
fukasawa e60969
using the standard I/O functions, you will need to replace them with
fukasawa e60969
custom writing functions.  See the discussion under Customizing libpng.
fukasawa e60969
fukasawa e60969
    FILE *fp = fopen(file_name, "wb");
fukasawa e60969
fukasawa e60969
    if (!fp)
fukasawa e60969
       return (ERROR);
fukasawa e60969
fukasawa e60969
Next, png_struct and png_info need to be allocated and initialized.
fukasawa e60969
As these can be both relatively large, you may not want to store these
fukasawa e60969
on the stack, unless you have stack space to spare.  Of course, you
fukasawa e60969
will want to check if they return NULL.  If you are also reading,
fukasawa e60969
you won't want to name your read structure and your write structure
fukasawa e60969
both "png_ptr"; you can call them anything you like, such as
fukasawa e60969
"read_ptr" and "write_ptr".  Look at pngtest.c, for example.
fukasawa e60969
fukasawa e60969
    png_structp png_ptr = png_create_write_struct
fukasawa e60969
       (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
fukasawa e60969
        user_error_fn, user_warning_fn);
fukasawa e60969
fukasawa e60969
    if (!png_ptr)
fukasawa e60969
       return (ERROR);
fukasawa e60969
fukasawa e60969
    png_infop info_ptr = png_create_info_struct(png_ptr);
fukasawa e60969
    if (!info_ptr)
fukasawa e60969
    {
fukasawa e60969
       png_destroy_write_struct(&png_ptr,
fukasawa e60969
           (png_infopp)NULL);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
If you want to use your own memory allocation routines,
fukasawa e60969
define PNG_USER_MEM_SUPPORTED and use
fukasawa e60969
png_create_write_struct_2() instead of png_create_write_struct():
fukasawa e60969
fukasawa e60969
    png_structp png_ptr = png_create_write_struct_2
fukasawa e60969
       (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
fukasawa e60969
        user_error_fn, user_warning_fn, (png_voidp)
fukasawa e60969
        user_mem_ptr, user_malloc_fn, user_free_fn);
fukasawa e60969
fukasawa e60969
After you have these structures, you will need to set up the
fukasawa e60969
error handling.  When libpng encounters an error, it expects to
fukasawa e60969
longjmp() back to your routine.  Therefore, you will need to call
fukasawa e60969
setjmp() and pass the png_jmpbuf(png_ptr).  If you
fukasawa e60969
write the file from different routines, you will need to update
fukasawa e60969
the png_jmpbuf(png_ptr) every time you enter a new routine that will
fukasawa e60969
call a png_*() function.  See your documentation of setjmp/longjmp
fukasawa e60969
for your compiler for more information on setjmp/longjmp.  See
fukasawa e60969
the discussion on libpng error handling in the Customizing Libpng
fukasawa e60969
section below for more information on the libpng error handling.
fukasawa e60969
fukasawa e60969
    if (setjmp(png_jmpbuf(png_ptr)))
fukasawa e60969
    {
fukasawa e60969
    png_destroy_write_struct(&png_ptr, &info_ptr);
fukasawa e60969
       fclose(fp);
fukasawa e60969
       return (ERROR);
fukasawa e60969
    }
fukasawa e60969
    ...
fukasawa e60969
    return;
fukasawa e60969
fukasawa e60969
If you would rather avoid the complexity of setjmp/longjmp issues,
fukasawa e60969
you can compile libpng with PNG_NO_SETJMP, in which case
fukasawa e60969
errors will result in a call to PNG_ABORT() which defaults to abort().
fukasawa e60969
fukasawa e60969
You can #define PNG_ABORT() to a function that does something
fukasawa e60969
more useful than abort(), as long as your function does not
fukasawa e60969
return.
fukasawa e60969
fukasawa e60969
Checking for invalid palette index on write was added at libpng
fukasawa e60969
1.5.10.  If a pixel contains an invalid (out-of-range) index libpng issues
fukasawa e60969
a benign error.  This is enabled by default because this condition is an
fukasawa e60969
error according to the PNG specification, Clause 11.3.2, but the error can
fukasawa e60969
be ignored in each png_ptr with
fukasawa e60969
fukasawa e60969
   png_set_check_for_invalid_index(png_ptr, 0);
fukasawa e60969
fukasawa e60969
If the error is ignored, or if png_benign_error() treats it as a warning,
fukasawa e60969
any invalid pixels are written as-is by the encoder, resulting in an
fukasawa e60969
invalid PNG datastream as output.  In this case the application is
fukasawa e60969
responsible for ensuring that the pixel indexes are in range when it writes
fukasawa e60969
a PLTE chunk with fewer entries than the bit depth would allow.
fukasawa e60969
fukasawa e60969
Now you need to set up the output code.  The default for libpng is to
fukasawa e60969
use the C function fwrite().  If you use this, you will need to pass a
fukasawa e60969
valid FILE * in the function png_init_io().  Be sure that the file is
fukasawa e60969
opened in binary mode.  Again, if you wish to handle writing data in
fukasawa e60969
another way, see the discussion on libpng I/O handling in the Customizing
fukasawa e60969
Libpng section below.
fukasawa e60969
fukasawa e60969
    png_init_io(png_ptr, fp);
fukasawa e60969
fukasawa e60969
If you are embedding your PNG into a datastream such as MNG, and don't
fukasawa e60969
want libpng to write the 8-byte signature, or if you have already
fukasawa e60969
written the signature in your application, use
fukasawa e60969
fukasawa e60969
    png_set_sig_bytes(png_ptr, 8);
fukasawa e60969
fukasawa e60969
to inform libpng that it should not write a signature.
fukasawa e60969
fukasawa e60969
.SS Write callbacks
fukasawa e60969
fukasawa e60969
At this point, you can set up a callback function that will be
fukasawa e60969
called after each row has been written, which you can use to control
fukasawa e60969
a progress meter or the like.  It's demonstrated in pngtest.c.
fukasawa e60969
You must supply a function
fukasawa e60969
fukasawa e60969
    void write_row_callback(png_structp png_ptr, png_uint_32 row,
fukasawa e60969
       int pass);
fukasawa e60969
    {
fukasawa e60969
      /* put your code here */
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
(You can give it another name that you like instead of "write_row_callback")
fukasawa e60969
fukasawa e60969
To inform libpng about your function, use
fukasawa e60969
fukasawa e60969
    png_set_write_status_fn(png_ptr, write_row_callback);
fukasawa e60969
fukasawa e60969
When this function is called the row has already been completely processed and
fukasawa e60969
it has also been written out.  The 'row' and 'pass' refer to the next row to be
fukasawa e60969
handled.  For the
fukasawa e60969
non-interlaced case the row that was just handled is simply one less than the
fukasawa e60969
passed in row number, and pass will always be 0.  For the interlaced case the
fukasawa e60969
same applies unless the row value is 0, in which case the row just handled was
fukasawa e60969
the last one from one of the preceding passes.  Because interlacing may skip a
fukasawa e60969
pass you cannot be sure that the preceding pass is just 'pass\-1', if you really
fukasawa e60969
need to know what the last pass is record (row,pass) from the callback and use
fukasawa e60969
the last recorded value each time.
fukasawa e60969
fukasawa e60969
As with the user transform you can find the output row using the
fukasawa e60969
PNG_ROW_FROM_PASS_ROW macro.
fukasawa e60969
fukasawa e60969
You now have the option of modifying how the compression library will
fukasawa e60969
run.  The following functions are mainly for testing, but may be useful
fukasawa e60969
in some cases, like if you need to write PNG files extremely fast and
fukasawa e60969
are willing to give up some compression, or if you want to get the
fukasawa e60969
maximum possible compression at the expense of slower writing.  If you
fukasawa e60969
have no special needs in this area, let the library do what it wants by
fukasawa e60969
not calling this function at all, as it has been tuned to deliver a good
fukasawa e60969
speed/compression ratio. The second parameter to png_set_filter() is
fukasawa e60969
the filter method, for which the only valid values are 0 (as of the
fukasawa e60969
July 1999 PNG specification, version 1.2) or 64 (if you are writing
fukasawa e60969
a PNG datastream that is to be embedded in a MNG datastream).  The third
fukasawa e60969
parameter is a flag that indicates which filter type(s) are to be tested
fukasawa e60969
for each scanline.  See the PNG specification for details on the specific
fukasawa e60969
filter types.
fukasawa e60969
fukasawa e60969
fukasawa e60969
    /* turn on or off filtering, and/or choose
fukasawa e60969
       specific filters.  You can use either a single
fukasawa e60969
       PNG_FILTER_VALUE_NAME or the bitwise OR of one
fukasawa e60969
       or more PNG_FILTER_NAME masks.
fukasawa e60969
     */
fukasawa e60969
    png_set_filter(png_ptr, 0,
fukasawa e60969
       PNG_FILTER_NONE  | PNG_FILTER_VALUE_NONE |
fukasawa e60969
       PNG_FILTER_SUB   | PNG_FILTER_VALUE_SUB  |
fukasawa e60969
       PNG_FILTER_UP    | PNG_FILTER_VALUE_UP   |
fukasawa e60969
       PNG_FILTER_AVG   | PNG_FILTER_VALUE_AVG  |
fukasawa e60969
       PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
fukasawa e60969
       PNG_ALL_FILTERS);
fukasawa e60969
fukasawa e60969
If an application wants to start and stop using particular filters during
fukasawa e60969
compression, it should start out with all of the filters (to ensure that
fukasawa e60969
the previous row of pixels will be stored in case it's needed later),
fukasawa e60969
and then add and remove them after the start of compression.
fukasawa e60969
fukasawa e60969
If you are writing a PNG datastream that is to be embedded in a MNG
fukasawa e60969
datastream, the second parameter can be either 0 or 64.
fukasawa e60969
fukasawa e60969
The png_set_compression_*() functions interface to the zlib compression
fukasawa e60969
library, and should mostly be ignored unless you really know what you are
fukasawa e60969
doing.  The only generally useful call is png_set_compression_level()
fukasawa e60969
which changes how much time zlib spends on trying to compress the image
fukasawa e60969
data.  See the Compression Library (zlib.h and algorithm.txt, distributed
fukasawa e60969
with zlib) for details on the compression levels.
fukasawa e60969
fukasawa e60969
    #include zlib.h
fukasawa e60969
fukasawa e60969
    /* Set the zlib compression level */
fukasawa e60969
    png_set_compression_level(png_ptr,
fukasawa e60969
        Z_BEST_COMPRESSION);
fukasawa e60969
fukasawa e60969
    /* Set other zlib parameters for compressing IDAT */
fukasawa e60969
    png_set_compression_mem_level(png_ptr, 8);
fukasawa e60969
    png_set_compression_strategy(png_ptr,
fukasawa e60969
        Z_DEFAULT_STRATEGY);
fukasawa e60969
    png_set_compression_window_bits(png_ptr, 15);
fukasawa e60969
    png_set_compression_method(png_ptr, 8);
fukasawa e60969
    png_set_compression_buffer_size(png_ptr, 8192)
fukasawa e60969
fukasawa e60969
    /* Set zlib parameters for text compression
fukasawa e60969
     * If you don't call these, the parameters
fukasawa e60969
     * fall back on those defined for IDAT chunks
fukasawa e60969
     */
fukasawa e60969
    png_set_text_compression_mem_level(png_ptr, 8);
fukasawa e60969
    png_set_text_compression_strategy(png_ptr,
fukasawa e60969
        Z_DEFAULT_STRATEGY);
fukasawa e60969
    png_set_text_compression_window_bits(png_ptr, 15);
fukasawa e60969
    png_set_text_compression_method(png_ptr, 8);
fukasawa e60969
fukasawa e60969
.SS Setting the contents of info for output
fukasawa e60969
fukasawa e60969
You now need to fill in the png_info structure with all the data you
fukasawa e60969
wish to write before the actual image.  Note that the only thing you
fukasawa e60969
are allowed to write after the image is the text chunks and the time
fukasawa e60969
chunk (as of PNG Specification 1.2, anyway).  See png_write_end() and
fukasawa e60969
the latest PNG specification for more information on that.  If you
fukasawa e60969
wish to write them before the image, fill them in now, and flag that
fukasawa e60969
data as being valid.  If you want to wait until after the data, don't
fukasawa e60969
fill them until png_write_end().  For all the fields in png_info and
fukasawa e60969
their data types, see png.h.  For explanations of what the fields
fukasawa e60969
contain, see the PNG specification.
fukasawa e60969
fukasawa e60969
Some of the more important parts of the png_info are:
fukasawa e60969
fukasawa e60969
    png_set_IHDR(png_ptr, info_ptr, width, height,
fukasawa e60969
       bit_depth, color_type, interlace_type,
fukasawa e60969
       compression_type, filter_method)
fukasawa e60969
fukasawa e60969
    width          - holds the width of the image
fukasawa e60969
                     in pixels (up to 2^31).
fukasawa e60969
fukasawa e60969
    height         - holds the height of the image
fukasawa e60969
                     in pixels (up to 2^31).
fukasawa e60969
fukasawa e60969
    bit_depth      - holds the bit depth of one of the
fukasawa e60969
                     image channels.
fukasawa e60969
                     (valid values are 1, 2, 4, 8, 16
fukasawa e60969
                     and depend also on the
fukasawa e60969
                     color_type.  See also significant
fukasawa e60969
                     bits (sBIT) below).
fukasawa e60969
fukasawa e60969
    color_type     - describes which color/alpha
fukasawa e60969
                     channels are present.
fukasawa e60969
                     PNG_COLOR_TYPE_GRAY
fukasawa e60969
                        (bit depths 1, 2, 4, 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_GRAY_ALPHA
fukasawa e60969
                        (bit depths 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_PALETTE
fukasawa e60969
                        (bit depths 1, 2, 4, 8)
fukasawa e60969
                     PNG_COLOR_TYPE_RGB
fukasawa e60969
                        (bit_depths 8, 16)
fukasawa e60969
                     PNG_COLOR_TYPE_RGB_ALPHA
fukasawa e60969
                        (bit_depths 8, 16)
fukasawa e60969
fukasawa e60969
                     PNG_COLOR_MASK_PALETTE
fukasawa e60969
                     PNG_COLOR_MASK_COLOR
fukasawa e60969
                     PNG_COLOR_MASK_ALPHA
fukasawa e60969
fukasawa e60969
    interlace_type - PNG_INTERLACE_NONE or
fukasawa e60969
                     PNG_INTERLACE_ADAM7
fukasawa e60969
fukasawa e60969
    compression_type - (must be
fukasawa e60969
                     PNG_COMPRESSION_TYPE_DEFAULT)
fukasawa e60969
fukasawa e60969
    filter_method  - (must be PNG_FILTER_TYPE_DEFAULT
fukasawa e60969
                     or, if you are writing a PNG to
fukasawa e60969
                     be embedded in a MNG datastream,
fukasawa e60969
                     can also be
fukasawa e60969
                     PNG_INTRAPIXEL_DIFFERENCING)
fukasawa e60969
fukasawa e60969
If you call png_set_IHDR(), the call must appear before any of the
fukasawa e60969
other png_set_*() functions, because they might require access to some of
fukasawa e60969
the IHDR settings.  The remaining png_set_*() functions can be called
fukasawa e60969
in any order.
fukasawa e60969
fukasawa e60969
If you wish, you can reset the compression_type, interlace_type, or
fukasawa e60969
filter_method later by calling png_set_IHDR() again; if you do this, the
fukasawa e60969
width, height, bit_depth, and color_type must be the same in each call.
fukasawa e60969
fukasawa e60969
    png_set_PLTE(png_ptr, info_ptr, palette,
fukasawa e60969
       num_palette);
fukasawa e60969
fukasawa e60969
    palette        - the palette for the file
fukasawa e60969
                     (array of png_color)
fukasawa e60969
    num_palette    - number of entries in the palette
fukasawa e60969
fukasawa e60969
fukasawa e60969
    png_set_gAMA(png_ptr, info_ptr, file_gamma);
fukasawa e60969
    png_set_gAMA_fixed(png_ptr, info_ptr, int_file_gamma);
fukasawa e60969
fukasawa e60969
    file_gamma     - the gamma at which the image was
fukasawa e60969
                     created (PNG_INFO_gAMA)
fukasawa e60969
fukasawa e60969
    int_file_gamma - 100,000 times the gamma at which
fukasawa e60969
                     the image was created
fukasawa e60969
fukasawa e60969
    png_set_cHRM(png_ptr, info_ptr,  white_x, white_y, red_x, red_y,
fukasawa e60969
                     green_x, green_y, blue_x, blue_y)
fukasawa e60969
    png_set_cHRM_XYZ(png_ptr, info_ptr, red_X, red_Y, red_Z, green_X,
fukasawa e60969
                     green_Y, green_Z, blue_X, blue_Y, blue_Z)
fukasawa e60969
    png_set_cHRM_fixed(png_ptr, info_ptr, int_white_x, int_white_y,
fukasawa e60969
                     int_red_x, int_red_y, int_green_x, int_green_y,
fukasawa e60969
                     int_blue_x, int_blue_y)
fukasawa e60969
    png_set_cHRM_XYZ_fixed(png_ptr, info_ptr, int_red_X, int_red_Y,
fukasawa e60969
                     int_red_Z, int_green_X, int_green_Y, int_green_Z,
fukasawa e60969
                     int_blue_X, int_blue_Y, int_blue_Z)
fukasawa e60969
fukasawa e60969
    {white,red,green,blue}_{x,y}
fukasawa e60969
                     A color space encoding specified using the chromaticities
fukasawa e60969
                     of the end points and the white point.
fukasawa e60969
fukasawa e60969
    {red,green,blue}_{X,Y,Z}
fukasawa e60969
                     A color space encoding specified using the encoding end
fukasawa e60969
                     points - the CIE tristimulus specification of the intended
fukasawa e60969
                     color of the red, green and blue channels in the PNG RGB
fukasawa e60969
                     data.  The white point is simply the sum of the three end
fukasawa e60969
                     points.
fukasawa e60969
fukasawa e60969
    png_set_sRGB(png_ptr, info_ptr, srgb_intent);
fukasawa e60969
fukasawa e60969
    srgb_intent    - the rendering intent
fukasawa e60969
                     (PNG_INFO_sRGB) The presence of
fukasawa e60969
                     the sRGB chunk means that the pixel
fukasawa e60969
                     data is in the sRGB color space.
fukasawa e60969
                     This chunk also implies specific
fukasawa e60969
                     values of gAMA and cHRM.  Rendering
fukasawa e60969
                     intent is the CSS-1 property that
fukasawa e60969
                     has been defined by the International
fukasawa e60969
                     Color Consortium
fukasawa e60969
                     (http://www.color.org).
fukasawa e60969
                     It can be one of
fukasawa e60969
                     PNG_sRGB_INTENT_SATURATION,
fukasawa e60969
                     PNG_sRGB_INTENT_PERCEPTUAL,
fukasawa e60969
                     PNG_sRGB_INTENT_ABSOLUTE, or
fukasawa e60969
                     PNG_sRGB_INTENT_RELATIVE.
fukasawa e60969
fukasawa e60969
fukasawa e60969
    png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
fukasawa e60969
       srgb_intent);
fukasawa e60969
fukasawa e60969
    srgb_intent    - the rendering intent
fukasawa e60969
                     (PNG_INFO_sRGB) The presence of the
fukasawa e60969
                     sRGB chunk means that the pixel
fukasawa e60969
                     data is in the sRGB color space.
fukasawa e60969
                     This function also causes gAMA and
fukasawa e60969
                     cHRM chunks with the specific values
fukasawa e60969
                     that are consistent with sRGB to be
fukasawa e60969
                     written.
fukasawa e60969
fukasawa e60969
    png_set_iCCP(png_ptr, info_ptr, name, compression_type,
fukasawa e60969
                       profile, proflen);
fukasawa e60969
fukasawa e60969
    name             - The profile name.
fukasawa e60969
fukasawa e60969
    compression_type - The compression type; always
fukasawa e60969
                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
fukasawa e60969
                       You may give NULL to this argument to
fukasawa e60969
                       ignore it.
fukasawa e60969
fukasawa e60969
    profile          - International Color Consortium color
fukasawa e60969
                       profile data. May contain NULs.
fukasawa e60969
fukasawa e60969
    proflen          - length of profile data in bytes.
fukasawa e60969
fukasawa e60969
    png_set_sBIT(png_ptr, info_ptr, sig_bit);
fukasawa e60969
fukasawa e60969
    sig_bit        - the number of significant bits for
fukasawa e60969
                     (PNG_INFO_sBIT) each of the gray, red,
fukasawa e60969
                     green, and blue channels, whichever are
fukasawa e60969
                     appropriate for the given color type
fukasawa e60969
                     (png_color_16)
fukasawa e60969
fukasawa e60969
    png_set_tRNS(png_ptr, info_ptr, trans_alpha,
fukasawa e60969
       num_trans, trans_color);
fukasawa e60969
fukasawa e60969
    trans_alpha    - array of alpha (transparency)
fukasawa e60969
                     entries for palette (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    num_trans      - number of transparent entries
fukasawa e60969
                     (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    trans_color    - graylevel or color sample values
fukasawa e60969
                     (in order red, green, blue) of the
fukasawa e60969
                     single transparent color for
fukasawa e60969
                     non-paletted images (PNG_INFO_tRNS)
fukasawa e60969
fukasawa e60969
    png_set_hIST(png_ptr, info_ptr, hist);
fukasawa e60969
fukasawa e60969
    hist           - histogram of palette (array of
fukasawa e60969
                     png_uint_16) (PNG_INFO_hIST)
fukasawa e60969
fukasawa e60969
    png_set_tIME(png_ptr, info_ptr, mod_time);
fukasawa e60969
fukasawa e60969
    mod_time       - time image was last modified
fukasawa e60969
                     (PNG_VALID_tIME)
fukasawa e60969
fukasawa e60969
    png_set_bKGD(png_ptr, info_ptr, background);
fukasawa e60969
fukasawa e60969
    background     - background color (of type
fukasawa e60969
                     png_color_16p) (PNG_VALID_bKGD)
fukasawa e60969
fukasawa e60969
    png_set_text(png_ptr, info_ptr, text_ptr, num_text);
fukasawa e60969
fukasawa e60969
    text_ptr       - array of png_text holding image
fukasawa e60969
                     comments
fukasawa e60969
fukasawa e60969
    text_ptr[i].compression - type of compression used
fukasawa e60969
                 on "text" PNG_TEXT_COMPRESSION_NONE
fukasawa e60969
                           PNG_TEXT_COMPRESSION_zTXt
fukasawa e60969
                           PNG_ITXT_COMPRESSION_NONE
fukasawa e60969
                           PNG_ITXT_COMPRESSION_zTXt
fukasawa e60969
    text_ptr[i].key   - keyword for comment.  Must contain
fukasawa e60969
                 1-79 characters.
fukasawa e60969
    text_ptr[i].text  - text comments for current
fukasawa e60969
                         keyword.  Can be NULL or empty.
fukasawa e60969
    text_ptr[i].text_length - length of text string,
fukasawa e60969
                 after decompression, 0 for iTXt
fukasawa e60969
    text_ptr[i].itxt_length - length of itxt string,
fukasawa e60969
                 after decompression, 0 for tEXt/zTXt
fukasawa e60969
    text_ptr[i].lang  - language of comment (NULL or
fukasawa e60969
                         empty for unknown).
fukasawa e60969
    text_ptr[i].translated_keyword  - keyword in UTF-8 (NULL
fukasawa e60969
                         or empty for unknown).
fukasawa e60969
fukasawa e60969
    Note that the itxt_length, lang, and lang_key
fukasawa e60969
    members of the text_ptr structure only exist when the
fukasawa e60969
    library is built with iTXt chunk support.  Prior to
fukasawa e60969
    libpng-1.4.0 the library was built by default without
fukasawa e60969
    iTXt support. Also note that when iTXt is supported,
fukasawa e60969
    they contain NULL pointers when the "compression"
fukasawa e60969
    field contains PNG_TEXT_COMPRESSION_NONE or
fukasawa e60969
    PNG_TEXT_COMPRESSION_zTXt.
fukasawa e60969
fukasawa e60969
    num_text       - number of comments
fukasawa e60969
fukasawa e60969
    png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
fukasawa e60969
       num_spalettes);
fukasawa e60969
fukasawa e60969
    palette_ptr    - array of png_sPLT_struct structures
fukasawa e60969
                     to be added to the list of palettes
fukasawa e60969
                     in the info structure.
fukasawa e60969
    num_spalettes  - number of palette structures to be
fukasawa e60969
                     added.
fukasawa e60969
fukasawa e60969
    png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
fukasawa e60969
        unit_type);
fukasawa e60969
fukasawa e60969
    offset_x  - positive offset from the left
fukasawa e60969
                     edge of the screen
fukasawa e60969
fukasawa e60969
    offset_y  - positive offset from the top
fukasawa e60969
                     edge of the screen
fukasawa e60969
fukasawa e60969
    unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
fukasawa e60969
fukasawa e60969
    png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
fukasawa e60969
        unit_type);
fukasawa e60969
fukasawa e60969
    res_x       - pixels/unit physical resolution
fukasawa e60969
                  in x direction
fukasawa e60969
fukasawa e60969
    res_y       - pixels/unit physical resolution
fukasawa e60969
                  in y direction
fukasawa e60969
fukasawa e60969
    unit_type   - PNG_RESOLUTION_UNKNOWN,
fukasawa e60969
                  PNG_RESOLUTION_METER
fukasawa e60969
fukasawa e60969
    png_set_sCAL(png_ptr, info_ptr, unit, width, height)
fukasawa e60969
fukasawa e60969
    unit        - physical scale units (an integer)
fukasawa e60969
fukasawa e60969
    width       - width of a pixel in physical scale units
fukasawa e60969
fukasawa e60969
    height      - height of a pixel in physical scale units
fukasawa e60969
                  (width and height are doubles)
fukasawa e60969
fukasawa e60969
    png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
fukasawa e60969
fukasawa e60969
    unit        - physical scale units (an integer)
fukasawa e60969
fukasawa e60969
    width       - width of a pixel in physical scale units
fukasawa e60969
                  expressed as a string
fukasawa e60969
fukasawa e60969
    height      - height of a pixel in physical scale units
fukasawa e60969
                 (width and height are strings like "2.54")
fukasawa e60969
fukasawa e60969
    png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
fukasawa e60969
       num_unknowns)
fukasawa e60969
fukasawa e60969
    unknowns          - array of png_unknown_chunk
fukasawa e60969
                        structures holding unknown chunks
fukasawa e60969
    unknowns[i].name  - name of unknown chunk
fukasawa e60969
    unknowns[i].data  - data of unknown chunk
fukasawa e60969
    unknowns[i].size  - size of unknown chunk's data
fukasawa e60969
    unknowns[i].location - position to write chunk in file
fukasawa e60969
                           0: do not write chunk
fukasawa e60969
                           PNG_HAVE_IHDR: before PLTE
fukasawa e60969
                           PNG_HAVE_PLTE: before IDAT
fukasawa e60969
                           PNG_AFTER_IDAT: after IDAT
fukasawa e60969
fukasawa e60969
The "location" member is set automatically according to
fukasawa e60969
what part of the output file has already been written.
fukasawa e60969
You can change its value after calling png_set_unknown_chunks()
fukasawa e60969
as demonstrated in pngtest.c.  Within each of the "locations",
fukasawa e60969
the chunks are sequenced according to their position in the
fukasawa e60969
structure (that is, the value of "i", which is the order in which
fukasawa e60969
the chunk was either read from the input file or defined with
fukasawa e60969
png_set_unknown_chunks).
fukasawa e60969
fukasawa e60969
A quick word about text and num_text.  text is an array of png_text
fukasawa e60969
structures.  num_text is the number of valid structures in the array.
fukasawa e60969
Each png_text structure holds a language code, a keyword, a text value,
fukasawa e60969
and a compression type.
fukasawa e60969
fukasawa e60969
The compression types have the same valid numbers as the compression
fukasawa e60969
types of the image data.  Currently, the only valid number is zero.
fukasawa e60969
However, you can store text either compressed or uncompressed, unlike
fukasawa e60969
images, which always have to be compressed.  So if you don't want the
fukasawa e60969
text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
fukasawa e60969
Because tEXt and zTXt chunks don't have a language field, if you
fukasawa e60969
specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
fukasawa e60969
any language code or translated keyword will not be written out.
fukasawa e60969
fukasawa e60969
Until text gets around a few hundred bytes, it is not worth compressing it.
fukasawa e60969
After the text has been written out to the file, the compression type
fukasawa e60969
is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
fukasawa e60969
so that it isn't written out again at the end (in case you are calling
fukasawa e60969
png_write_end() with the same struct).
fukasawa e60969
fukasawa e60969
The keywords that are given in the PNG Specification are:
fukasawa e60969
fukasawa e60969
    Title            Short (one line) title or
fukasawa e60969
                     caption for image
fukasawa e60969
fukasawa e60969
    Author           Name of image's creator
fukasawa e60969
fukasawa e60969
    Description      Description of image (possibly long)
fukasawa e60969
fukasawa e60969
    Copyright        Copyright notice
fukasawa e60969
fukasawa e60969
    Creation Time    Time of original image creation
fukasawa e60969
                     (usually RFC 1123 format, see below)
fukasawa e60969
fukasawa e60969
    Software         Software used to create the image
fukasawa e60969
fukasawa e60969
    Disclaimer       Legal disclaimer
fukasawa e60969
fukasawa e60969
    Warning          Warning of nature of content
fukasawa e60969
fukasawa e60969
    Source           Device used to create the image
fukasawa e60969
fukasawa e60969
    Comment          Miscellaneous comment; conversion
fukasawa e60969
                     from other image format
fukasawa e60969
fukasawa e60969
The keyword-text pairs work like this.  Keywords should be short
fukasawa e60969
simple descriptions of what the comment is about.  Some typical
fukasawa e60969
keywords are found in the PNG specification, as is some recommendations
fukasawa e60969
on keywords.  You can repeat keywords in a file.  You can even write
fukasawa e60969
some text before the image and some after.  For example, you may want
fukasawa e60969
to put a description of the image before the image, but leave the
fukasawa e60969
disclaimer until after, so viewers working over modem connections
fukasawa e60969
don't have to wait for the disclaimer to go over the modem before
fukasawa e60969
they start seeing the image.  Finally, keywords should be full
fukasawa e60969
words, not abbreviations.  Keywords and text are in the ISO 8859-1
fukasawa e60969
(Latin-1) character set (a superset of regular ASCII) and can not
fukasawa e60969
contain NUL characters, and should not contain control or other
fukasawa e60969
unprintable characters.  To make the comments widely readable, stick
fukasawa e60969
with basic ASCII, and avoid machine specific character set extensions
fukasawa e60969
like the IBM-PC character set.  The keyword must be present, but
fukasawa e60969
you can leave off the text string on non-compressed pairs.
fukasawa e60969
Compressed pairs must have a text string, as only the text string
fukasawa e60969
is compressed anyway, so the compression would be meaningless.
fukasawa e60969
fukasawa e60969
PNG supports modification time via the png_time structure.  Two
fukasawa e60969
conversion routines are provided, png_convert_from_time_t() for
fukasawa e60969
time_t and png_convert_from_struct_tm() for struct tm.  The
fukasawa e60969
time_t routine uses gmtime().  You don't have to use either of
fukasawa e60969
these, but if you wish to fill in the png_time structure directly,
fukasawa e60969
you should provide the time in universal time (GMT) if possible
fukasawa e60969
instead of your local time.  Note that the year number is the full
fukasawa e60969
year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
fukasawa e60969
that months start with 1.
fukasawa e60969
fukasawa e60969
If you want to store the time of the original image creation, you should
fukasawa e60969
use a plain tEXt chunk with the "Creation Time" keyword.  This is
fukasawa e60969
necessary because the "creation time" of a PNG image is somewhat vague,
fukasawa e60969
depending on whether you mean the PNG file, the time the image was
fukasawa e60969
created in a non-PNG format, a still photo from which the image was
fukasawa e60969
scanned, or possibly the subject matter itself.  In order to facilitate
fukasawa e60969
machine-readable dates, it is recommended that the "Creation Time"
fukasawa e60969
tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
fukasawa e60969
although this isn't a requirement.  Unlike the tIME chunk, the
fukasawa e60969
"Creation Time" tEXt chunk is not expected to be automatically changed
fukasawa e60969
by the software.  To facilitate the use of RFC 1123 dates, a function
fukasawa e60969
png_convert_to_rfc1123_buffer(buffer, png_timep) is provided to
fukasawa e60969
convert from PNG time to an RFC 1123 format string.  The caller must provide
fukasawa e60969
a writeable buffer of at least 29 bytes.
fukasawa e60969
fukasawa e60969
.SS Writing unknown chunks
fukasawa e60969
fukasawa e60969
You can use the png_set_unknown_chunks function to queue up private chunks
fukasawa e60969
for writing.  You give it a chunk name, location, raw data, and a size.  You
fukasawa e60969
also must use png_set_keep_unknown_chunks() to ensure that libpng will
fukasawa e60969
handle them.  That's all there is to it.  The chunks will be written by the
fukasawa e60969
next following png_write_info_before_PLTE, png_write_info, or png_write_end
fukasawa e60969
function, depending upon the specified location.  Any chunks previously
fukasawa e60969
read into the info structure's unknown-chunk list will also be written out
fukasawa e60969
in a sequence that satisfies the PNG specification's ordering rules.
fukasawa e60969
fukasawa e60969
Here is an example of writing two private chunks, prVt and miNE:
fukasawa e60969
fukasawa e60969
    #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
fukasawa e60969
    /* Set unknown chunk data */
fukasawa e60969
    png_unknown_chunk unk_chunk[2];
fukasawa e60969
    strcpy((char *) unk_chunk[0].name, "prVt";
fukasawa e60969
    unk_chunk[0].data = (unsigned char *) "PRIVATE DATA";
fukasawa e60969
    unk_chunk[0].size = strlen(unk_chunk[0].data)+1;
fukasawa e60969
    unk_chunk[0].location = PNG_HAVE_IHDR;
fukasawa e60969
    strcpy((char *) unk_chunk[1].name, "miNE";
fukasawa e60969
    unk_chunk[1].data = (unsigned char *) "MY CHUNK DATA";
fukasawa e60969
    unk_chunk[1].size = strlen(unk_chunk[0].data)+1;
fukasawa e60969
    unk_chunk[1].location = PNG_AFTER_IDAT;
fukasawa e60969
    png_set_unknown_chunks(write_ptr, write_info_ptr,
fukasawa e60969
        unk_chunk, 2);
fukasawa e60969
    /* Needed because miNE is not safe-to-copy */
fukasawa e60969
    png_set_keep_unknown_chunks(png, PNG_HANDLE_CHUNK_ALWAYS,
fukasawa e60969
       (png_bytep) "miNE", 1);
fukasawa e60969
    # if PNG_LIBPNG_VER < 10600
fukasawa e60969
      /* Deal with unknown chunk location bug in 1.5.x and earlier */
fukasawa e60969
      png_set_unknown_chunk_location(png, info, 0, PNG_HAVE_IHDR);
fukasawa e60969
      png_set_unknown_chunk_location(png, info, 1, PNG_AFTER_IDAT);
fukasawa e60969
    # endif
fukasawa e60969
    # if PNG_LIBPNG_VER < 10500
fukasawa e60969
      /* PNG_AFTER_IDAT writes two copies of the chunk prior to libpng-1.5.0,
fukasawa e60969
       * one before IDAT and another after IDAT, so don't use it; only use
fukasawa e60969
       * PNG_HAVE_IHDR location.  This call resets the location previously
fukasawa e60969
       * set by assignment and png_set_unknown_chunk_location() for chunk 1.
fukasawa e60969
       */
fukasawa e60969
      png_set_unknown_chunk_location(png, info, 1, PNG_HAVE_IHDR);
fukasawa e60969
    # endif
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
.SS The high-level write interface
fukasawa e60969
fukasawa e60969
At this point there are two ways to proceed; through the high-level
fukasawa e60969
write interface, or through a sequence of low-level write operations.
fukasawa e60969
You can use the high-level interface if your image data is present
fukasawa e60969
in the info structure.  All defined output
fukasawa e60969
transformations are permitted, enabled by the following masks.
fukasawa e60969
fukasawa e60969
    PNG_TRANSFORM_IDENTITY      No transformation
fukasawa e60969
    PNG_TRANSFORM_PACKING       Pack 1, 2 and 4-bit samples
fukasawa e60969
    PNG_TRANSFORM_PACKSWAP      Change order of packed
fukasawa e60969
                                pixels to LSB first
fukasawa e60969
    PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
fukasawa e60969
    PNG_TRANSFORM_SHIFT         Normalize pixels to the
fukasawa e60969
                                sBIT depth
fukasawa e60969
    PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
fukasawa e60969
                                to BGRA
fukasawa e60969
    PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
fukasawa e60969
                                to AG
fukasawa e60969
    PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
fukasawa e60969
                                to transparency
fukasawa e60969
    PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
fukasawa e60969
    PNG_TRANSFORM_STRIP_FILLER        Strip out filler
fukasawa e60969
                                      bytes (deprecated).
fukasawa e60969
    PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
fukasawa e60969
                                      filler bytes
fukasawa e60969
    PNG_TRANSFORM_STRIP_FILLER_AFTER  Strip out trailing
fukasawa e60969
                                      filler bytes
fukasawa e60969
fukasawa e60969
If you have valid image data in the info structure (you can use
fukasawa e60969
png_set_rows() to put image data in the info structure), simply do this:
fukasawa e60969
fukasawa e60969
    png_write_png(png_ptr, info_ptr, png_transforms, NULL)
fukasawa e60969
fukasawa e60969
where png_transforms is an integer containing the bitwise OR of some set of
fukasawa e60969
transformation flags.  This call is equivalent to png_write_info(),
fukasawa e60969
followed the set of transformations indicated by the transform mask,
fukasawa e60969
then png_write_image(), and finally png_write_end().
fukasawa e60969
fukasawa e60969
(The final parameter of this call is not yet used.  Someday it might point
fukasawa e60969
to transformation parameters required by some future output transform.)
fukasawa e60969
fukasawa e60969
You must use png_transforms and not call any png_set_transform() functions
fukasawa e60969
when you use png_write_png().
fukasawa e60969
fukasawa e60969
.SS The low-level write interface
fukasawa e60969
fukasawa e60969
If you are going the low-level route instead, you are now ready to
fukasawa e60969
write all the file information up to the actual image data.  You do
fukasawa e60969
this with a call to png_write_info().
fukasawa e60969
fukasawa e60969
    png_write_info(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
Note that there is one transformation you may need to do before
fukasawa e60969
png_write_info().  In PNG files, the alpha channel in an image is the
fukasawa e60969
level of opacity.  If your data is supplied as a level of transparency,
fukasawa e60969
you can invert the alpha channel before you write it, so that 0 is
fukasawa e60969
fully transparent and 255 (in 8-bit or paletted images) or 65535
fukasawa e60969
(in 16-bit images) is fully opaque, with
fukasawa e60969
fukasawa e60969
    png_set_invert_alpha(png_ptr);
fukasawa e60969
fukasawa e60969
This must appear before png_write_info() instead of later with the
fukasawa e60969
other transformations because in the case of paletted images the tRNS
fukasawa e60969
chunk data has to be inverted before the tRNS chunk is written.  If
fukasawa e60969
your image is not a paletted image, the tRNS data (which in such cases
fukasawa e60969
represents a single color to be rendered as transparent) won't need to
fukasawa e60969
be changed, and you can safely do this transformation after your
fukasawa e60969
png_write_info() call.
fukasawa e60969
fukasawa e60969
If you need to write a private chunk that you want to appear before
fukasawa e60969
the PLTE chunk when PLTE is present, you can write the PNG info in
fukasawa e60969
two steps, and insert code to write your own chunk between them:
fukasawa e60969
fukasawa e60969
    png_write_info_before_PLTE(png_ptr, info_ptr);
fukasawa e60969
    png_set_unknown_chunks(png_ptr, info_ptr, ...);
fukasawa e60969
    png_write_info(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
After you've written the file information, you can set up the library
fukasawa e60969
to handle any special transformations of the image data.  The various
fukasawa e60969
ways to transform the data will be described in the order that they
fukasawa e60969
should occur.  This is important, as some of these change the color
fukasawa e60969
type and/or bit depth of the data, and some others only work on
fukasawa e60969
certain color types and bit depths.  Even though each transformation
fukasawa e60969
checks to see if it has data that it can do something with, you should
fukasawa e60969
make sure to only enable a transformation if it will be valid for the
fukasawa e60969
data.  For example, don't swap red and blue on grayscale data.
fukasawa e60969
fukasawa e60969
PNG files store RGB pixels packed into 3 or 6 bytes.  This code tells
fukasawa e60969
the library to strip input data that has 4 or 8 bytes per pixel down
fukasawa e60969
to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
fukasawa e60969
bytes per pixel).
fukasawa e60969
fukasawa e60969
    png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
fukasawa e60969
fukasawa e60969
where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
fukasawa e60969
PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
fukasawa e60969
is stored XRGB or RGBX.
fukasawa e60969
fukasawa e60969
PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
fukasawa e60969
they can, resulting in, for example, 8 pixels per byte for 1 bit files.
fukasawa e60969
If the data is supplied at 1 pixel per byte, use this code, which will
fukasawa e60969
correctly pack the pixels into a single byte:
fukasawa e60969
fukasawa e60969
    png_set_packing(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files reduce possible bit depths to 1, 2, 4, 8, and 16.  If your
fukasawa e60969
data is of another bit depth, you can write an sBIT chunk into the
fukasawa e60969
file so that decoders can recover the original data if desired.
fukasawa e60969
fukasawa e60969
    /* Set the true bit depth of the image data */
fukasawa e60969
    if (color_type & PNG_COLOR_MASK_COLOR)
fukasawa e60969
    {
fukasawa e60969
       sig_bit.red = true_bit_depth;
fukasawa e60969
       sig_bit.green = true_bit_depth;
fukasawa e60969
       sig_bit.blue = true_bit_depth;
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    else
fukasawa e60969
    {
fukasawa e60969
       sig_bit.gray = true_bit_depth;
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    if (color_type & PNG_COLOR_MASK_ALPHA)
fukasawa e60969
    {
fukasawa e60969
       sig_bit.alpha = true_bit_depth;
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    png_set_sBIT(png_ptr, info_ptr, &sig_bit);
fukasawa e60969
fukasawa e60969
If the data is stored in the row buffer in a bit depth other than
fukasawa e60969
one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
fukasawa e60969
this will scale the values to appear to be the correct bit depth as
fukasawa e60969
is required by PNG.
fukasawa e60969
fukasawa e60969
    png_set_shift(png_ptr, &sig_bit);
fukasawa e60969
fukasawa e60969
PNG files store 16-bit pixels in network byte order (big-endian,
fukasawa e60969
ie. most significant bits first).  This code would be used if they are
fukasawa e60969
supplied the other way (little-endian, i.e. least significant bits
fukasawa e60969
first, the way PCs store them):
fukasawa e60969
fukasawa e60969
    if (bit_depth > 8)
fukasawa e60969
       png_set_swap(png_ptr);
fukasawa e60969
fukasawa e60969
If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
fukasawa e60969
need to change the order the pixels are packed into bytes, you can use:
fukasawa e60969
fukasawa e60969
    if (bit_depth < 8)
fukasawa e60969
       png_set_packswap(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files store 3 color pixels in red, green, blue order.  This code
fukasawa e60969
would be used if they are supplied as blue, green, red:
fukasawa e60969
fukasawa e60969
    png_set_bgr(png_ptr);
fukasawa e60969
fukasawa e60969
PNG files describe monochrome as black being zero and white being
fukasawa e60969
one. This code would be used if the pixels are supplied with this reversed
fukasawa e60969
(black being one and white being zero):
fukasawa e60969
fukasawa e60969
    png_set_invert_mono(png_ptr);
fukasawa e60969
fukasawa e60969
Finally, you can write your own transformation function if none of
fukasawa e60969
the existing ones meets your needs.  This is done by setting a callback
fukasawa e60969
with
fukasawa e60969
fukasawa e60969
    png_set_write_user_transform_fn(png_ptr,
fukasawa e60969
       write_transform_fn);
fukasawa e60969
fukasawa e60969
You must supply the function
fukasawa e60969
fukasawa e60969
    void write_transform_fn(png_structp png_ptr, png_row_infop
fukasawa e60969
       row_info, png_bytep data)
fukasawa e60969
fukasawa e60969
See pngtest.c for a working example.  Your function will be called
fukasawa e60969
before any of the other transformations are processed.  If supported
fukasawa e60969
libpng also supplies an information routine that may be called from
fukasawa e60969
your callback:
fukasawa e60969
fukasawa e60969
   png_get_current_row_number(png_ptr);
fukasawa e60969
   png_get_current_pass_number(png_ptr);
fukasawa e60969
fukasawa e60969
This returns the current row passed to the transform.  With interlaced
fukasawa e60969
images the value returned is the row in the input sub-image image.  Use
fukasawa e60969
PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
fukasawa e60969
find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
fukasawa e60969
fukasawa e60969
The discussion of interlace handling above contains more information on how to
fukasawa e60969
use these values.
fukasawa e60969
fukasawa e60969
You can also set up a pointer to a user structure for use by your
fukasawa e60969
callback function.
fukasawa e60969
fukasawa e60969
    png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
fukasawa e60969
fukasawa e60969
The user_channels and user_depth parameters of this function are ignored
fukasawa e60969
when writing; you can set them to zero as shown.
fukasawa e60969
fukasawa e60969
You can retrieve the pointer via the function png_get_user_transform_ptr().
fukasawa e60969
For example:
fukasawa e60969
fukasawa e60969
    voidp write_user_transform_ptr =
fukasawa e60969
       png_get_user_transform_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
It is possible to have libpng flush any pending output, either manually,
fukasawa e60969
or automatically after a certain number of lines have been written.  To
fukasawa e60969
flush the output stream a single time call:
fukasawa e60969
fukasawa e60969
    png_write_flush(png_ptr);
fukasawa e60969
fukasawa e60969
and to have libpng flush the output stream periodically after a certain
fukasawa e60969
number of scanlines have been written, call:
fukasawa e60969
fukasawa e60969
    png_set_flush(png_ptr, nrows);
fukasawa e60969
fukasawa e60969
Note that the distance between rows is from the last time png_write_flush()
fukasawa e60969
was called, or the first row of the image if it has never been called.
fukasawa e60969
So if you write 50 lines, and then png_set_flush 25, it will flush the
fukasawa e60969
output on the next scanline, and every 25 lines thereafter, unless
fukasawa e60969
png_write_flush() is called before 25 more lines have been written.
fukasawa e60969
If nrows is too small (less than about 10 lines for a 640 pixel wide
fukasawa e60969
RGB image) the image compression may decrease noticeably (although this
fukasawa e60969
may be acceptable for real-time applications).  Infrequent flushing will
fukasawa e60969
only degrade the compression performance by a few percent over images
fukasawa e60969
that do not use flushing.
fukasawa e60969
fukasawa e60969
.SS Writing the image data
fukasawa e60969
fukasawa e60969
That's it for the transformations.  Now you can write the image data.
fukasawa e60969
The simplest way to do this is in one function call.  If you have the
fukasawa e60969
whole image in memory, you can just call png_write_image() and libpng
fukasawa e60969
will write the image.  You will need to pass in an array of pointers to
fukasawa e60969
each row.  This function automatically handles interlacing, so you don't
fukasawa e60969
need to call png_set_interlace_handling() or call this function multiple
fukasawa e60969
times, or any of that other stuff necessary with png_write_rows().
fukasawa e60969
fukasawa e60969
    png_write_image(png_ptr, row_pointers);
fukasawa e60969
fukasawa e60969
where row_pointers is:
fukasawa e60969
fukasawa e60969
    png_byte *row_pointers[height];
fukasawa e60969
fukasawa e60969
You can point to void or char or whatever you use for pixels.
fukasawa e60969
fukasawa e60969
If you don't want to write the whole image at once, you can
fukasawa e60969
use png_write_rows() instead.  If the file is not interlaced,
fukasawa e60969
this is simple:
fukasawa e60969
fukasawa e60969
    png_write_rows(png_ptr, row_pointers,
fukasawa e60969
       number_of_rows);
fukasawa e60969
fukasawa e60969
row_pointers is the same as in the png_write_image() call.
fukasawa e60969
fukasawa e60969
If you are just writing one row at a time, you can do this with
fukasawa e60969
a single row_pointer instead of an array of row_pointers:
fukasawa e60969
fukasawa e60969
    png_bytep row_pointer = row;
fukasawa e60969
fukasawa e60969
    png_write_row(png_ptr, row_pointer);
fukasawa e60969
fukasawa e60969
When the file is interlaced, things can get a good deal more complicated.
fukasawa e60969
The only currently (as of the PNG Specification version 1.2, dated July
fukasawa e60969
1999) defined interlacing scheme for PNG files is the "Adam7" interlace
fukasawa e60969
scheme, that breaks down an image into seven smaller images of varying
fukasawa e60969
size.  libpng will build these images for you, or you can do them
fukasawa e60969
yourself.  If you want to build them yourself, see the PNG specification
fukasawa e60969
for details of which pixels to write when.
fukasawa e60969
fukasawa e60969
If you don't want libpng to handle the interlacing details, just
fukasawa e60969
use png_set_interlace_handling() and call png_write_rows() the
fukasawa e60969
correct number of times to write all the sub-images
fukasawa e60969
(png_set_interlace_handling() returns the number of sub-images.)
fukasawa e60969
fukasawa e60969
If you want libpng to build the sub-images, call this before you start
fukasawa e60969
writing any rows:
fukasawa e60969
fukasawa e60969
    number_of_passes = png_set_interlace_handling(png_ptr);
fukasawa e60969
fukasawa e60969
This will return the number of passes needed.  Currently, this is seven,
fukasawa e60969
but may change if another interlace type is added.
fukasawa e60969
fukasawa e60969
Then write the complete image number_of_passes times.
fukasawa e60969
fukasawa e60969
    png_write_rows(png_ptr, row_pointers, number_of_rows);
fukasawa e60969
fukasawa e60969
Think carefully before you write an interlaced image.  Typically code that
fukasawa e60969
reads such images reads all the image data into memory, uncompressed, before
fukasawa e60969
doing any processing.  Only code that can display an image on the fly can
fukasawa e60969
take advantage of the interlacing and even then the image has to be exactly
fukasawa e60969
the correct size for the output device, because scaling an image requires
fukasawa e60969
adjacent pixels and these are not available until all the passes have been
fukasawa e60969
read.
fukasawa e60969
fukasawa e60969
If you do write an interlaced image you will hardly ever need to handle
fukasawa e60969
the interlacing yourself.  Call png_set_interlace_handling() and use the
fukasawa e60969
approach described above.
fukasawa e60969
fukasawa e60969
The only time it is conceivable that you will really need to write an
fukasawa e60969
interlaced image pass-by-pass is when you have read one pass by pass and
fukasawa e60969
made some pixel-by-pixel transformation to it, as described in the read
fukasawa e60969
code above.  In this case use the PNG_PASS_ROWS and PNG_PASS_COLS macros
fukasawa e60969
to determine the size of each sub-image in turn and simply write the rows
fukasawa e60969
you obtained from the read code.
fukasawa e60969
fukasawa e60969
.SS Finishing a sequential write
fukasawa e60969
fukasawa e60969
After you are finished writing the image, you should finish writing
fukasawa e60969
the file.  If you are interested in writing comments or time, you should
fukasawa e60969
pass an appropriately filled png_info pointer.  If you are not interested,
fukasawa e60969
you can pass NULL.
fukasawa e60969
fukasawa e60969
    png_write_end(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
When you are done, you can free all memory used by libpng like this:
fukasawa e60969
fukasawa e60969
    png_destroy_write_struct(&png_ptr, &info_ptr);
fukasawa e60969
fukasawa e60969
It is also possible to individually free the info_ptr members that
fukasawa e60969
point to libpng-allocated storage with the following function:
fukasawa e60969
fukasawa e60969
    png_free_data(png_ptr, info_ptr, mask, seq)
fukasawa e60969
fukasawa e60969
    mask  - identifies data to be freed, a mask
fukasawa e60969
            containing the bitwise OR of one or
fukasawa e60969
            more of
fukasawa e60969
              PNG_FREE_PLTE, PNG_FREE_TRNS,
fukasawa e60969
              PNG_FREE_HIST, PNG_FREE_ICCP,
fukasawa e60969
              PNG_FREE_PCAL, PNG_FREE_ROWS,
fukasawa e60969
              PNG_FREE_SCAL, PNG_FREE_SPLT,
fukasawa e60969
              PNG_FREE_TEXT, PNG_FREE_UNKN,
fukasawa e60969
            or simply PNG_FREE_ALL
fukasawa e60969
fukasawa e60969
    seq   - sequence number of item to be freed
fukasawa e60969
            (\-1 for all items)
fukasawa e60969
fukasawa e60969
This function may be safely called when the relevant storage has
fukasawa e60969
already been freed, or has not yet been allocated, or was allocated
fukasawa e60969
by the user  and not by libpng,  and will in those cases do nothing.
fukasawa e60969
The "seq" parameter is ignored if only one item of the selected data
fukasawa e60969
type, such as PLTE, is allowed.  If "seq" is not \-1, and multiple items
fukasawa e60969
are allowed for the data type identified in the mask, such as text or
fukasawa e60969
sPLT, only the n'th item in the structure is freed, where n is "seq".
fukasawa e60969
fukasawa e60969
If you allocated data such as a palette that you passed in to libpng
fukasawa e60969
with png_set_*, you must not free it until just before the call to
fukasawa e60969
png_destroy_write_struct().
fukasawa e60969
fukasawa e60969
The default behavior is only to free data that was allocated internally
fukasawa e60969
by libpng.  This can be changed, so that libpng will not free the data,
fukasawa e60969
or so that it will free data that was allocated by the user with png_malloc()
fukasawa e60969
or png_calloc() and passed in via a png_set_*() function, with
fukasawa e60969
fukasawa e60969
    png_data_freer(png_ptr, info_ptr, freer, mask)
fukasawa e60969
fukasawa e60969
    freer  - one of
fukasawa e60969
               PNG_DESTROY_WILL_FREE_DATA
fukasawa e60969
               PNG_SET_WILL_FREE_DATA
fukasawa e60969
               PNG_USER_WILL_FREE_DATA
fukasawa e60969
fukasawa e60969
    mask   - which data elements are affected
fukasawa e60969
             same choices as in png_free_data()
fukasawa e60969
fukasawa e60969
For example, to transfer responsibility for some data from a read structure
fukasawa e60969
to a write structure, you could use
fukasawa e60969
fukasawa e60969
    png_data_freer(read_ptr, read_info_ptr,
fukasawa e60969
       PNG_USER_WILL_FREE_DATA,
fukasawa e60969
       PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
fukasawa e60969
fukasawa e60969
    png_data_freer(write_ptr, write_info_ptr,
fukasawa e60969
       PNG_DESTROY_WILL_FREE_DATA,
fukasawa e60969
       PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
fukasawa e60969
fukasawa e60969
thereby briefly reassigning responsibility for freeing to the user but
fukasawa e60969
immediately afterwards reassigning it once more to the write_destroy
fukasawa e60969
function.  Having done this, it would then be safe to destroy the read
fukasawa e60969
structure and continue to use the PLTE, tRNS, and hIST data in the write
fukasawa e60969
structure.
fukasawa e60969
fukasawa e60969
This function only affects data that has already been allocated.
fukasawa e60969
You can call this function before calling after the png_set_*() functions
fukasawa e60969
to control whether the user or png_destroy_*() is supposed to free the data.
fukasawa e60969
When the user assumes responsibility for libpng-allocated data, the
fukasawa e60969
application must use
fukasawa e60969
png_free() to free it, and when the user transfers responsibility to libpng
fukasawa e60969
for data that the user has allocated, the user must have used png_malloc()
fukasawa e60969
or png_calloc() to allocate it.
fukasawa e60969
fukasawa e60969
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
fukasawa e60969
separately, do not transfer responsibility for freeing text_ptr to libpng,
fukasawa e60969
because when libpng fills a png_text structure it combines these members with
fukasawa e60969
the key member, and png_free_data() will free only text_ptr.key.  Similarly,
fukasawa e60969
if you transfer responsibility for free'ing text_ptr from libpng to your
fukasawa e60969
application, your application must not separately free those members.
fukasawa e60969
For a more compact example of writing a PNG image, see the file example.c.
fukasawa e60969
fukasawa e60969
.SH V. Simplified API
fukasawa e60969
fukasawa e60969
The simplified API, which became available in libpng-1.6.0, hides the details
fukasawa e60969
of both libpng and the PNG file format itself.
fukasawa e60969
It allows PNG files to be read into a very limited number of
fukasawa e60969
in-memory bitmap formats or to be written from the same formats.  If these
fukasawa e60969
formats do not accommodate your needs then you can, and should, use the more
fukasawa e60969
sophisticated APIs above - these support a wide variety of in-memory formats
fukasawa e60969
and a wide variety of sophisticated transformations to those formats as well
fukasawa e60969
as a wide variety of APIs to manipulate ancilliary information.
fukasawa e60969
fukasawa e60969
To read a PNG file using the simplified API:
fukasawa e60969
fukasawa e60969
  1) Declare a 'png_image' structure (see below) on the stack, set the
fukasawa e60969
     version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
fukasawa e60969
     (this is REQUIRED, your program may crash if you don't do it.)
fukasawa e60969
fukasawa e60969
  2) Call the appropriate png_image_begin_read... function.
fukasawa e60969
fukasawa e60969
  3) Set the png_image 'format' member to the required sample format.
fukasawa e60969
fukasawa e60969
  4) Allocate a buffer for the image and, if required, the color-map.
fukasawa e60969
fukasawa e60969
  5) Call png_image_finish_read to read the image and, if required, the
fukasawa e60969
     color-map into your buffers.
fukasawa e60969
fukasawa e60969
There are no restrictions on the format of the PNG input itself; all valid
fukasawa e60969
color types, bit depths, and interlace methods are acceptable, and the
fukasawa e60969
input image is transformed as necessary to the requested in-memory format
fukasawa e60969
during the png_image_finish_read() step.  The only caveat is that if you
fukasawa e60969
request a color-mapped image from a PNG that is full-color or makes
fukasawa e60969
complex use of an alpha channel the transformation is extremely lossy and the
fukasawa e60969
result may look terrible.
fukasawa e60969
fukasawa e60969
To write a PNG file using the simplified API:
fukasawa e60969
fukasawa e60969
  1) Declare a 'png_image' structure on the stack and memset()
fukasawa e60969
     it to all zero.
fukasawa e60969
fukasawa e60969
  2) Initialize the members of the structure that describe the
fukasawa e60969
     image, setting the 'format' member to the format of the
fukasawa e60969
     image samples.
fukasawa e60969
fukasawa e60969
  3) Call the appropriate png_image_write... function with a
fukasawa e60969
     pointer to the image and, if necessary, the color-map to write
fukasawa e60969
     the PNG data.
fukasawa e60969
fukasawa e60969
png_image is a structure that describes the in-memory format of an image
fukasawa e60969
when it is being read or defines the in-memory format of an image that you
fukasawa e60969
need to write.  The "png_image" structure contains the following members:
fukasawa e60969
fukasawa e60969
   png_controlp opaque  Initialize to NULL, free with png_image_free
fukasawa e60969
   png_uint_32  version Set to PNG_IMAGE_VERSION
fukasawa e60969
   png_uint_32  width   Image width in pixels (columns)
fukasawa e60969
   png_uint_32  height  Image height in pixels (rows)
fukasawa e60969
   png_uint_32  format  Image format as defined below
fukasawa e60969
   png_uint_32  flags   A bit mask containing informational flags
fukasawa e60969
   png_uint_32  colormap_entries; Number of entries in the color-map
fukasawa e60969
   png_uint_32  warning_or_error;
fukasawa e60969
   char         message[64];
fukasawa e60969
fukasawa e60969
In the event of an error or warning the "warning_or_error"
fukasawa e60969
field will be set to a non-zero value and the 'message' field will contain
fukasawa e60969
a '\0' terminated string with the libpng error or warning message.  If both
fukasawa e60969
warnings and an error were encountered, only the error is recorded.  If there
fukasawa e60969
are multiple warnings, only the first one is recorded.
fukasawa e60969
fukasawa e60969
The upper 30 bits of the "warning_or_error" value are reserved; the low two
fukasawa e60969
bits contain a two bit code such that a value more than 1 indicates a failure
fukasawa e60969
in the API just called:
fukasawa e60969
fukasawa e60969
   0 - no warning or error
fukasawa e60969
   1 - warning
fukasawa e60969
   2 - error
fukasawa e60969
   3 - error preceded by warning
fukasawa e60969
fukasawa e60969
The pixels (samples) of the image have one to four channels whose components
fukasawa e60969
have original values in the range 0 to 1.0:
fukasawa e60969
fukasawa e60969
  1: A single gray or luminance channel (G).
fukasawa e60969
  2: A gray/luminance channel and an alpha channel (GA).
fukasawa e60969
  3: Three red, green, blue color channels (RGB).
fukasawa e60969
  4: Three color channels and an alpha channel (RGBA).
fukasawa e60969
fukasawa e60969
The channels are encoded in one of two ways:
fukasawa e60969
fukasawa e60969
  a) As a small integer, value 0..255, contained in a single byte.  For the
fukasawa e60969
alpha channel the original value is simply value/255.  For the color or
fukasawa e60969
luminance channels the value is encoded according to the sRGB specification
fukasawa e60969
and matches the 8-bit format expected by typical display devices.
fukasawa e60969
fukasawa e60969
The color/gray channels are not scaled (pre-multiplied) by the alpha
fukasawa e60969
channel and are suitable for passing to color management software.
fukasawa e60969
fukasawa e60969
  b) As a value in the range 0..65535, contained in a 2-byte integer, in
fukasawa e60969
the native byte order of the platform on which the application is running.
fukasawa e60969
All channels can be converted to the original value by dividing by 65535; all
fukasawa e60969
channels are linear.  Color channels use the RGB encoding (RGB end-points) of
fukasawa e60969
the sRGB specification.  This encoding is identified by the
fukasawa e60969
PNG_FORMAT_FLAG_LINEAR flag below.
fukasawa e60969
fukasawa e60969
When the simplified API needs to convert between sRGB and linear colorspaces,
fukasawa e60969
the actual sRGB transfer curve defined in the sRGB specification (see the
fukasawa e60969
article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
fukasawa e60969
approximation used elsewhere in libpng.
fukasawa e60969
fukasawa e60969
When an alpha channel is present it is expected to denote pixel coverage
fukasawa e60969
of the color or luminance channels and is returned as an associated alpha
fukasawa e60969
channel: the color/gray channels are scaled (pre-multiplied) by the alpha
fukasawa e60969
value.
fukasawa e60969
fukasawa e60969
The samples are either contained directly in the image data, between 1 and 8
fukasawa e60969
bytes per pixel according to the encoding, or are held in a color-map indexed
fukasawa e60969
by bytes in the image data.  In the case of a color-map the color-map entries
fukasawa e60969
are individual samples, encoded as above, and the image data has one byte per
fukasawa e60969
pixel to select the relevant sample from the color-map.
fukasawa e60969
fukasawa e60969
PNG_FORMAT_*
fukasawa e60969
fukasawa e60969
The #defines to be used in png_image::format.  Each #define identifies a
fukasawa e60969
particular layout of channel data and, if present, alpha values.  There are
fukasawa e60969
separate defines for each of the two component encodings.
fukasawa e60969
fukasawa e60969
A format is built up using single bit flag values.  All combinations are
fukasawa e60969
valid.  Formats can be built up from the flag values or you can use one of
fukasawa e60969
the predefined values below.  When testing formats always use the FORMAT_FLAG
fukasawa e60969
macros to test for individual features - future versions of the library may
fukasawa e60969
add new flags.
fukasawa e60969
fukasawa e60969
When reading or writing color-mapped images the format should be set to the
fukasawa e60969
format of the entries in the color-map then png_image_{read,write}_colormap
fukasawa e60969
called to read or write the color-map and set the format correctly for the
fukasawa e60969
image data.  Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
fukasawa e60969
fukasawa e60969
NOTE: libpng can be built with particular features disabled. If you see
fukasawa e60969
compiler errors because the definition of one of the following flags has been
fukasawa e60969
compiled out it is because libpng does not have the required support.  It is
fukasawa e60969
possible, however, for the libpng configuration to enable the format on just
fukasawa e60969
read or just write; in that case you may see an error at run time.
fukasawa e60969
You can guard against this by checking for the definition of the
fukasawa e60969
appropriate "_SUPPORTED" macro, one of:
fukasawa e60969
fukasawa e60969
   PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
fukasawa e60969
fukasawa e60969
   PNG_FORMAT_FLAG_ALPHA    format with an alpha channel
fukasawa e60969
   PNG_FORMAT_FLAG_COLOR    color format: otherwise grayscale
fukasawa e60969
   PNG_FORMAT_FLAG_LINEAR   2-byte channels else 1-byte
fukasawa e60969
   PNG_FORMAT_FLAG_COLORMAP image data is color-mapped
fukasawa e60969
   PNG_FORMAT_FLAG_BGR      BGR colors, else order is RGB
fukasawa e60969
   PNG_FORMAT_FLAG_AFIRST   alpha channel comes first
fukasawa e60969
fukasawa e60969
Supported formats are as follows.  Future versions of libpng may support more
fukasawa e60969
formats; for compatibility with older versions simply check if the format
fukasawa e60969
macro is defined using #ifdef.  These defines describe the in-memory layout
fukasawa e60969
of the components of the pixels of the image.
fukasawa e60969
fukasawa e60969
First the single byte (sRGB) formats:
fukasawa e60969
fukasawa e60969
   PNG_FORMAT_GRAY
fukasawa e60969
   PNG_FORMAT_GA
fukasawa e60969
   PNG_FORMAT_AG
fukasawa e60969
   PNG_FORMAT_RGB
fukasawa e60969
   PNG_FORMAT_BGR
fukasawa e60969
   PNG_FORMAT_RGBA
fukasawa e60969
   PNG_FORMAT_ARGB
fukasawa e60969
   PNG_FORMAT_BGRA
fukasawa e60969
   PNG_FORMAT_ABGR
fukasawa e60969
fukasawa e60969
Then the linear 2-byte formats.  When naming these "Y" is used to
fukasawa e60969
indicate a luminance (gray) channel.  The component order within the pixel
fukasawa e60969
is always the same - there is no provision for swapping the order of the
fukasawa e60969
components in the linear format.  The components are 16-bit integers in
fukasawa e60969
the native byte order for your platform, and there is no provision for
fukasawa e60969
swapping the bytes to a different endian condition.
fukasawa e60969
fukasawa e60969
   PNG_FORMAT_LINEAR_Y
fukasawa e60969
   PNG_FORMAT_LINEAR_Y_ALPHA
fukasawa e60969
   PNG_FORMAT_LINEAR_RGB
fukasawa e60969
   PNG_FORMAT_LINEAR_RGB_ALPHA
fukasawa e60969
fukasawa e60969
With color-mapped formats the image data is one byte for each pixel. The byte
fukasawa e60969
is an index into the color-map which is formatted as above.  To obtain a
fukasawa e60969
color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
fukasawa e60969
to one of the above definitions, or you can use one of the definitions below.
fukasawa e60969
fukasawa e60969
   PNG_FORMAT_RGB_COLORMAP
fukasawa e60969
   PNG_FORMAT_BGR_COLORMAP
fukasawa e60969
   PNG_FORMAT_RGBA_COLORMAP
fukasawa e60969
   PNG_FORMAT_ARGB_COLORMAP
fukasawa e60969
   PNG_FORMAT_BGRA_COLORMAP
fukasawa e60969
   PNG_FORMAT_ABGR_COLORMAP
fukasawa e60969
fukasawa e60969
PNG_IMAGE macros
fukasawa e60969
fukasawa e60969
These are convenience macros to derive information from a png_image
fukasawa e60969
structure.  The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
fukasawa e60969
actual image sample values - either the entries in the color-map or the
fukasawa e60969
pixels in the image.  The PNG_IMAGE_PIXEL_ macros return corresponding values
fukasawa e60969
for the pixels and will always return 1 for color-mapped formats.  The
fukasawa e60969
remaining macros return information about the rows in the image and the
fukasawa e60969
complete image.
fukasawa e60969
fukasawa e60969
NOTE: All the macros that take a png_image::format parameter are compile time
fukasawa e60969
constants if the format parameter is, itself, a constant.  Therefore these
fukasawa e60969
macros can be used in array declarations and case labels where required.
fukasawa e60969
Similarly the macros are also pre-processor constants (sizeof is not used) so
fukasawa e60969
they can be used in #if tests.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_SAMPLE_CHANNELS(fmt)
fukasawa e60969
    Returns the total number of channels in a given format: 1..4
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)
fukasawa e60969
    Returns the size in bytes of a single component of a pixel or color-map
fukasawa e60969
    entry (as appropriate) in the image: 1 or 2.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_SAMPLE_SIZE(fmt)
fukasawa e60969
    This is the size of the sample data for one sample.  If the image is
fukasawa e60969
    color-mapped it is the size of one color-map entry (and image pixels are
fukasawa e60969
    one byte in size), otherwise it is the size of one image pixel.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)
fukasawa e60969
    The maximum size of the color-map required by the format expressed in a
fukasawa e60969
    count of components.  This can be used to compile-time allocate a
fukasawa e60969
    color-map:
fukasawa e60969
fukasawa e60969
    png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
fukasawa e60969
fukasawa e60969
    png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
fukasawa e60969
fukasawa e60969
    Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
fukasawa e60969
    information from one of the png_image_begin_read_ APIs and dynamically
fukasawa e60969
    allocate the required memory.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_COLORMAP_SIZE(fmt)
fukasawa e60969
   The size of the color-map required by the format; this is the size of the
fukasawa e60969
   color-map buffer passed to the png_image_{read,write}_colormap APIs. It is
fukasawa e60969
   a fixed number determined by the format so can easily be allocated on the
fukasawa e60969
   stack if necessary.
fukasawa e60969
fukasawa e60969
Corresponding information about the pixels
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_PIXEL_CHANNELS(fmt)
fukasawa e60969
   The number of separate channels (components) in a pixel; 1 for a
fukasawa e60969
   color-mapped image.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
fukasawa e60969
   The size, in bytes, of each component in a pixel; 1 for a color-mapped
fukasawa e60969
   image.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_PIXEL_SIZE(fmt)
fukasawa e60969
   The size, in bytes, of a complete pixel; 1 for a color-mapped image.
fukasawa e60969
fukasawa e60969
Information about the whole row, or whole image
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_ROW_STRIDE(image)
fukasawa e60969
   Returns the total number of components in a single row of the image; this
fukasawa e60969
   is the minimum 'row stride', the minimum count of components between each
fukasawa e60969
   row.  For a color-mapped image this is the minimum number of bytes in a
fukasawa e60969
   row.
fukasawa e60969
fukasawa e60969
   If you need the stride measured in bytes, row_stride_bytes is
fukasawa e60969
   PNG_IMAGE_ROW_STRIDE(image) * PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)
fukasawa e60969
   plus any padding bytes that your application might need, for example
fukasawa e60969
   to start the next row on a 4-byte boundary.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_BUFFER_SIZE(image, row_stride)
fukasawa e60969
   Return the size, in bytes, of an image buffer given a png_image and a row
fukasawa e60969
   stride - the number of components to leave space for in each row.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_SIZE(image)
fukasawa e60969
   Return the size, in bytes, of the image in memory given just a png_image;
fukasawa e60969
   the row stride is the minimum stride required for the image.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_COLORMAP_SIZE(image)
fukasawa e60969
   Return the size, in bytes, of the color-map of this image.  If the image
fukasawa e60969
   format is not a color-map format this will return a size sufficient for
fukasawa e60969
   256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
fukasawa e60969
   you don't want to allocate a color-map in this case.
fukasawa e60969
fukasawa e60969
PNG_IMAGE_FLAG_*
fukasawa e60969
fukasawa e60969
Flags containing additional information about the image are held in
fukasawa e60969
the 'flags' field of png_image.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB == 0x01
fukasawa e60969
    This indicates the the RGB values of the in-memory bitmap do not
fukasawa e60969
    correspond to the red, green and blue end-points defined by sRGB.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_FLAG_FAST == 0x02
fukasawa e60969
   On write emphasise speed over compression; the resultant PNG file will be
fukasawa e60969
   larger but will be produced significantly faster, particular for large
fukasawa e60969
   images.  Do not use this option for images which will be distributed, only
fukasawa e60969
   used it when producing intermediate files that will be read back in
fukasawa e60969
   repeatedly.  For a typical 24-bit image the option will double the read
fukasawa e60969
   speed at the cost of increasing the image size by 25%, however for many
fukasawa e60969
   more compressible images the PNG file can be 10 times larger with only a
fukasawa e60969
   slight speed gain.
fukasawa e60969
fukasawa e60969
  PNG_IMAGE_FLAG_16BIT_sRGB == 0x04
fukasawa e60969
    On read if the image is a 16-bit per component image and there is no gAMA
fukasawa e60969
    or sRGB chunk assume that the components are sRGB encoded.  Notice that
fukasawa e60969
    images output by the simplified API always have gamma information; setting
fukasawa e60969
    this flag only affects the interpretation of 16-bit images from an
fukasawa e60969
    external source.  It is recommended that the application expose this flag
fukasawa e60969
    to the user; the user can normally easily recognize the difference between
fukasawa e60969
    linear and sRGB encoding.  This flag has no effect on write - the data
fukasawa e60969
    passed to the write APIs must have the correct encoding (as defined
fukasawa e60969
    above.)
fukasawa e60969
fukasawa e60969
    If the flag is not set (the default) input 16-bit per component data is
fukasawa e60969
    assumed to be linear.
fukasawa e60969
fukasawa e60969
    NOTE: the flag can only be set after the png_image_begin_read_ call,
fukasawa e60969
    because that call initializes the 'flags' field.
fukasawa e60969
fukasawa e60969
READ APIs
fukasawa e60969
fukasawa e60969
   The png_image passed to the read APIs must have been initialized by setting
fukasawa e60969
   the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.)
fukasawa e60969
fukasawa e60969
   int png_image_begin_read_from_file( png_imagep image,
fukasawa e60969
     const char *file_name)
fukasawa e60969
fukasawa e60969
     The named file is opened for read and the image header
fukasawa e60969
     is filled in from the PNG header in the file.
fukasawa e60969
fukasawa e60969
   int png_image_begin_read_from_stdio (png_imagep image,
fukasawa e60969
     FILE* file)
fukasawa e60969
fukasawa e60969
      The PNG header is read from the stdio FILE object.
fukasawa e60969
fukasawa e60969
   int png_image_begin_read_from_memory(png_imagep image,
fukasawa e60969
      png_const_voidp memory, png_size_t size)
fukasawa e60969
fukasawa e60969
      The PNG header is read from the given memory buffer.
fukasawa e60969
fukasawa e60969
   int png_image_finish_read(png_imagep image,
fukasawa e60969
      png_colorp background, void *buffer,
fukasawa e60969
      png_int_32 row_stride, void *colormap));
fukasawa e60969
fukasawa e60969
      Finish reading the image into the supplied buffer and
fukasawa e60969
      clean up the png_image structure.
fukasawa e60969
fukasawa e60969
      row_stride is the step, in png_byte or png_uint_16 units
fukasawa e60969
      as appropriate, between adjacent rows.  A positive stride
fukasawa e60969
      indicates that the top-most row is first in the buffer -
fukasawa e60969
      the normal top-down arrangement.  A negative stride
fukasawa e60969
      indicates that the bottom-most row is first in the buffer.
fukasawa e60969
fukasawa e60969
      background need only be supplied if an alpha channel must
fukasawa e60969
      be removed from a png_byte format and the removal is to be
fukasawa e60969
      done by compositing on a solid color; otherwise it may be
fukasawa e60969
      NULL and any composition will be done directly onto the
fukasawa e60969
      buffer.  The value is an sRGB color to use for the
fukasawa e60969
      background, for grayscale output the green channel is used.
fukasawa e60969
fukasawa e60969
      For linear output removing the alpha channel is always done
fukasawa e60969
      by compositing on black.
fukasawa e60969
fukasawa e60969
   void png_image_free(png_imagep image)
fukasawa e60969
fukasawa e60969
      Free any data allocated by libpng in image->opaque,
fukasawa e60969
      setting the pointer to NULL.  May be called at any time
fukasawa e60969
      after the structure is initialized.
fukasawa e60969
fukasawa e60969
When the simplified API needs to convert between sRGB and linear colorspaces,
fukasawa e60969
the actual sRGB transfer curve defined in the sRGB specification (see the
fukasawa e60969
article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
fukasawa e60969
approximation used elsewhere in libpng.
fukasawa e60969
fukasawa e60969
WRITE APIS
fukasawa e60969
fukasawa e60969
For write you must initialize a png_image structure to describe the image to
fukasawa e60969
be written:
fukasawa e60969
fukasawa e60969
   version: must be set to PNG_IMAGE_VERSION
fukasawa e60969
   opaque: must be initialized to NULL
fukasawa e60969
   width: image width in pixels
fukasawa e60969
   height: image height in rows
fukasawa e60969
   format: the format of the data you wish to write
fukasawa e60969
   flags: set to 0 unless one of the defined flags applies; set
fukasawa e60969
      PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images
fukasawa e60969
      where the RGB values do not correspond to the colors in sRGB.
fukasawa e60969
   colormap_entries: set to the number of entries in the color-map (0 to 256)
fukasawa e60969
fukasawa e60969
   int png_image_write_to_file, (png_imagep image,
fukasawa e60969
      const char *file, int convert_to_8bit, const void *buffer,
fukasawa e60969
      png_int_32 row_stride, const void *colormap));
fukasawa e60969
fukasawa e60969
      Write the image to the named file.
fukasawa e60969
fukasawa e60969
   int png_image_write_to_stdio(png_imagep image, FILE *file,
fukasawa e60969
      int convert_to_8_bit, const void *buffer,
fukasawa e60969
      png_int_32 row_stride, const void *colormap)
fukasawa e60969
fukasawa e60969
      Write the image to the given (FILE*).
fukasawa e60969
fukasawa e60969
With all write APIs if image is in one of the linear formats with
fukasawa e60969
(png_uint_16) data then setting convert_to_8_bit will cause the output to be
fukasawa e60969
a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise
fukasawa e60969
a 16-bit linear encoded PNG file is written.
fukasawa e60969
fukasawa e60969
With all APIs row_stride is handled as in the read APIs - it is the spacing
fukasawa e60969
from one row to the next in component sized units (float) and if negative
fukasawa e60969
indicates a bottom-up row layout in the buffer.  If you pass zero, libpng will
fukasawa e60969
calculate the row_stride for you from the width and number of channels.
fukasawa e60969
fukasawa e60969
Note that the write API does not support interlacing, sub-8-bit pixels,
fukasawa e60969
indexed (paletted) images, or most ancillary chunks.
fukasawa e60969
fukasawa e60969
.SH VI. Modifying/Customizing libpng
fukasawa e60969
fukasawa e60969
There are two issues here.  The first is changing how libpng does
fukasawa e60969
standard things like memory allocation, input/output, and error handling.
fukasawa e60969
The second deals with more complicated things like adding new chunks,
fukasawa e60969
adding new transformations, and generally changing how libpng works.
fukasawa e60969
Both of those are compile-time issues; that is, they are generally
fukasawa e60969
determined at the time the code is written, and there is rarely a need
fukasawa e60969
to provide the user with a means of changing them.
fukasawa e60969
fukasawa e60969
Memory allocation, input/output, and error handling
fukasawa e60969
fukasawa e60969
All of the memory allocation, input/output, and error handling in libpng
fukasawa e60969
goes through callbacks that are user-settable.  The default routines are
fukasawa e60969
in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively.  To change
fukasawa e60969
these functions, call the appropriate png_set_*_fn() function.
fukasawa e60969
fukasawa e60969
Memory allocation is done through the functions png_malloc(), png_calloc(),
fukasawa e60969
and png_free().  The png_malloc() and png_free() functions currently just
fukasawa e60969
call the standard C functions and png_calloc() calls png_malloc() and then
fukasawa e60969
clears the newly allocated memory to zero; note that png_calloc(png_ptr, size)
fukasawa e60969
is not the same as the calloc(number, size) function provided by stdlib.h.
fukasawa e60969
There is limited support for certain systems with segmented memory
fukasawa e60969
architectures and the types of pointers declared by png.h match this; you
fukasawa e60969
will have to use appropriate pointers in your application.  If you prefer
fukasawa e60969
to use a different method of allocating and freeing data, you can use
fukasawa e60969
png_create_read_struct_2() or png_create_write_struct_2() to register your
fukasawa e60969
own functions as described above.  These functions also provide a void
fukasawa e60969
pointer that can be retrieved via
fukasawa e60969
fukasawa e60969
    mem_ptr=png_get_mem_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
Your replacement memory functions must have prototypes as follows:
fukasawa e60969
fukasawa e60969
    png_voidp malloc_fn(png_structp png_ptr,
fukasawa e60969
       png_alloc_size_t size);
fukasawa e60969
fukasawa e60969
    void free_fn(png_structp png_ptr, png_voidp ptr);
fukasawa e60969
fukasawa e60969
Your malloc_fn() must return NULL in case of failure.  The png_malloc()
fukasawa e60969
function will normally call png_error() if it receives a NULL from the
fukasawa e60969
system memory allocator or from your replacement malloc_fn().
fukasawa e60969
fukasawa e60969
Your free_fn() will never be called with a NULL ptr, since libpng's
fukasawa e60969
png_free() checks for NULL before calling free_fn().
fukasawa e60969
fukasawa e60969
Input/Output in libpng is done through png_read() and png_write(),
fukasawa e60969
which currently just call fread() and fwrite().  The FILE * is stored in
fukasawa e60969
png_struct and is initialized via png_init_io().  If you wish to change
fukasawa e60969
the method of I/O, the library supplies callbacks that you can set
fukasawa e60969
through the function png_set_read_fn() and png_set_write_fn() at run
fukasawa e60969
time, instead of calling the png_init_io() function.  These functions
fukasawa e60969
also provide a void pointer that can be retrieved via the function
fukasawa e60969
png_get_io_ptr().  For example:
fukasawa e60969
fukasawa e60969
    png_set_read_fn(png_structp read_ptr,
fukasawa e60969
        voidp read_io_ptr, png_rw_ptr read_data_fn)
fukasawa e60969
fukasawa e60969
    png_set_write_fn(png_structp write_ptr,
fukasawa e60969
        voidp write_io_ptr, png_rw_ptr write_data_fn,
fukasawa e60969
        png_flush_ptr output_flush_fn);
fukasawa e60969
fukasawa e60969
    voidp read_io_ptr = png_get_io_ptr(read_ptr);
fukasawa e60969
    voidp write_io_ptr = png_get_io_ptr(write_ptr);
fukasawa e60969
fukasawa e60969
The replacement I/O functions must have prototypes as follows:
fukasawa e60969
fukasawa e60969
    void user_read_data(png_structp png_ptr,
fukasawa e60969
        png_bytep data, png_size_t length);
fukasawa e60969
fukasawa e60969
    void user_write_data(png_structp png_ptr,
fukasawa e60969
        png_bytep data, png_size_t length);
fukasawa e60969
fukasawa e60969
    void user_flush_data(png_structp png_ptr);
fukasawa e60969
fukasawa e60969
The user_read_data() function is responsible for detecting and
fukasawa e60969
handling end-of-data errors.
fukasawa e60969
fukasawa e60969
Supplying NULL for the read, write, or flush functions sets them back
fukasawa e60969
to using the default C stream functions, which expect the io_ptr to
fukasawa e60969
point to a standard *FILE structure.  It is probably a mistake
fukasawa e60969
to use NULL for one of write_data_fn and output_flush_fn but not both
fukasawa e60969
of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
fukasawa e60969
It is an error to read from a write stream, and vice versa.
fukasawa e60969
fukasawa e60969
Error handling in libpng is done through png_error() and png_warning().
fukasawa e60969
Errors handled through png_error() are fatal, meaning that png_error()
fukasawa e60969
should never return to its caller.  Currently, this is handled via
fukasawa e60969
setjmp() and longjmp() (unless you have compiled libpng with
fukasawa e60969
PNG_NO_SETJMP, in which case it is handled via PNG_ABORT()),
fukasawa e60969
but you could change this to do things like exit() if you should wish,
fukasawa e60969
as long as your function does not return.
fukasawa e60969
fukasawa e60969
On non-fatal errors, png_warning() is called
fukasawa e60969
to print a warning message, and then control returns to the calling code.
fukasawa e60969
By default png_error() and png_warning() print a message on stderr via
fukasawa e60969
fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
fukasawa e60969
(because you don't want the messages) or PNG_NO_STDIO defined (because
fukasawa e60969
fprintf() isn't available).  If you wish to change the behavior of the error
fukasawa e60969
functions, you will need to set up your own message callbacks.  These
fukasawa e60969
functions are normally supplied at the time that the png_struct is created.
fukasawa e60969
It is also possible to redirect errors and warnings to your own replacement
fukasawa e60969
functions after png_create_*_struct() has been called by calling:
fukasawa e60969
fukasawa e60969
    png_set_error_fn(png_structp png_ptr,
fukasawa e60969
        png_voidp error_ptr, png_error_ptr error_fn,
fukasawa e60969
        png_error_ptr warning_fn);
fukasawa e60969
fukasawa e60969
    png_voidp error_ptr = png_get_error_ptr(png_ptr);
fukasawa e60969
fukasawa e60969
If NULL is supplied for either error_fn or warning_fn, then the libpng
fukasawa e60969
default function will be used, calling fprintf() and/or longjmp() if a
fukasawa e60969
problem is encountered.  The replacement error functions should have
fukasawa e60969
parameters as follows:
fukasawa e60969
fukasawa e60969
    void user_error_fn(png_structp png_ptr,
fukasawa e60969
        png_const_charp error_msg);
fukasawa e60969
fukasawa e60969
    void user_warning_fn(png_structp png_ptr,
fukasawa e60969
        png_const_charp warning_msg);
fukasawa e60969
fukasawa e60969
The motivation behind using setjmp() and longjmp() is the C++ throw and
fukasawa e60969
catch exception handling methods.  This makes the code much easier to write,
fukasawa e60969
as there is no need to check every return code of every function call.
fukasawa e60969
However, there are some uncertainties about the status of local variables
fukasawa e60969
after a longjmp, so the user may want to be careful about doing anything
fukasawa e60969
after setjmp returns non-zero besides returning itself.  Consult your
fukasawa e60969
compiler documentation for more details.  For an alternative approach, you
fukasawa e60969
may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net),
fukasawa e60969
which is illustrated in pngvalid.c and in contrib/visupng.
fukasawa e60969
fukasawa e60969
Beginning in libpng-1.4.0, the png_set_benign_errors() API became available.
fukasawa e60969
You can use this to handle certain errors (normally handled as errors)
fukasawa e60969
as warnings.
fukasawa e60969
fukasawa e60969
    png_set_benign_errors (png_ptr, int allowed);
fukasawa e60969
fukasawa e60969
    allowed: 0: treat png_benign_error() as an error.
fukasawa e60969
             1: treat png_benign_error() as a warning.
fukasawa e60969
fukasawa e60969
As of libpng-1.6.0, the default condition is to treat benign errors as
fukasawa e60969
warnings while reading and as errors while writing.
fukasawa e60969
fukasawa e60969
.SS Custom chunks
fukasawa e60969
fukasawa e60969
If you need to read or write custom chunks, you may need to get deeper
fukasawa e60969
into the libpng code.  The library now has mechanisms for storing
fukasawa e60969
and writing chunks of unknown type; you can even declare callbacks
fukasawa e60969
for custom chunks.  However, this may not be good enough if the
fukasawa e60969
library code itself needs to know about interactions between your
fukasawa e60969
chunk and existing `intrinsic' chunks.
fukasawa e60969
fukasawa e60969
If you need to write a new intrinsic chunk, first read the PNG
fukasawa e60969
specification. Acquire a first level of understanding of how it works.
fukasawa e60969
Pay particular attention to the sections that describe chunk names,
fukasawa e60969
and look at how other chunks were designed, so you can do things
fukasawa e60969
similarly.  Second, check out the sections of libpng that read and
fukasawa e60969
write chunks.  Try to find a chunk that is similar to yours and use
fukasawa e60969
it as a template.  More details can be found in the comments inside
fukasawa e60969
the code.  It is best to handle private or unknown chunks in a generic method,
fukasawa e60969
via callback functions, instead of by modifying libpng functions. This
fukasawa e60969
is illustrated in pngtest.c, which uses a callback function to handle a
fukasawa e60969
private "vpAg" chunk and the new "sTER" chunk, which are both unknown to
fukasawa e60969
libpng.
fukasawa e60969
fukasawa e60969
If you wish to write your own transformation for the data, look through
fukasawa e60969
the part of the code that does the transformations, and check out some of
fukasawa e60969
the simpler ones to get an idea of how they work.  Try to find a similar
fukasawa e60969
transformation to the one you want to add and copy off of it.  More details
fukasawa e60969
can be found in the comments inside the code itself.
fukasawa e60969
fukasawa e60969
.SS Configuring for gui/windowing platforms:
fukasawa e60969
fukasawa e60969
You will need to write new error and warning functions that use the GUI
fukasawa e60969
interface, as described previously, and set them to be the error and
fukasawa e60969
warning functions at the time that png_create_*_struct() is called,
fukasawa e60969
in order to have them available during the structure initialization.
fukasawa e60969
They can be changed later via png_set_error_fn().  On some compilers,
fukasawa e60969
you may also have to change the memory allocators (png_malloc, etc.).
fukasawa e60969
fukasawa e60969
.SS Configuring zlib:
fukasawa e60969
fukasawa e60969
There are special functions to configure the compression.  Perhaps the
fukasawa e60969
most useful one changes the compression level, which currently uses
fukasawa e60969
input compression values in the range 0 - 9.  The library normally
fukasawa e60969
uses the default compression level (Z_DEFAULT_COMPRESSION = 6).  Tests
fukasawa e60969
have shown that for a large majority of images, compression values in
fukasawa e60969
the range 3-6 compress nearly as well as higher levels, and do so much
fukasawa e60969
faster.  For online applications it may be desirable to have maximum speed
fukasawa e60969
(Z_BEST_SPEED = 1).  With versions of zlib after v0.99, you can also
fukasawa e60969
specify no compression (Z_NO_COMPRESSION = 0), but this would create
fukasawa e60969
files larger than just storing the raw bitmap.  You can specify the
fukasawa e60969
compression level by calling:
fukasawa e60969
fukasawa e60969
    #include zlib.h
fukasawa e60969
    png_set_compression_level(png_ptr, level);
fukasawa e60969
fukasawa e60969
Another useful one is to reduce the memory level used by the library.
fukasawa e60969
The memory level defaults to 8, but it can be lowered if you are
fukasawa e60969
short on memory (running DOS, for example, where you only have 640K).
fukasawa e60969
Note that the memory level does have an effect on compression; among
fukasawa e60969
other things, lower levels will result in sections of incompressible
fukasawa e60969
data being emitted in smaller stored blocks, with a correspondingly
fukasawa e60969
larger relative overhead of up to 15% in the worst case.
fukasawa e60969
fukasawa e60969
    #include zlib.h
fukasawa e60969
    png_set_compression_mem_level(png_ptr, level);
fukasawa e60969
fukasawa e60969
The other functions are for configuring zlib.  They are not recommended
fukasawa e60969
for normal use and may result in writing an invalid PNG file.  See
fukasawa e60969
zlib.h for more information on what these mean.
fukasawa e60969
fukasawa e60969
    #include zlib.h
fukasawa e60969
    png_set_compression_strategy(png_ptr,
fukasawa e60969
        strategy);
fukasawa e60969
fukasawa e60969
    png_set_compression_window_bits(png_ptr,
fukasawa e60969
        window_bits);
fukasawa e60969
fukasawa e60969
    png_set_compression_method(png_ptr, method);
fukasawa e60969
fukasawa e60969
This controls the size of the IDAT chunks (default 8192):
fukasawa e60969
fukasawa e60969
    png_set_compression_buffer_size(png_ptr, size);
fukasawa e60969
fukasawa e60969
As of libpng version 1.5.4, additional APIs became
fukasawa e60969
available to set these separately for non-IDAT
fukasawa e60969
compressed chunks such as zTXt, iTXt, and iCCP:
fukasawa e60969
fukasawa e60969
    #include zlib.h
fukasawa e60969
    #if PNG_LIBPNG_VER >= 10504
fukasawa e60969
    png_set_text_compression_level(png_ptr, level);
fukasawa e60969
fukasawa e60969
    png_set_text_compression_mem_level(png_ptr, level);
fukasawa e60969
fukasawa e60969
    png_set_text_compression_strategy(png_ptr,
fukasawa e60969
        strategy);
fukasawa e60969
fukasawa e60969
    png_set_text_compression_window_bits(png_ptr,
fukasawa e60969
        window_bits);
fukasawa e60969
fukasawa e60969
    png_set_text_compression_method(png_ptr, method);
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
.SS Controlling row filtering
fukasawa e60969
fukasawa e60969
If you want to control whether libpng uses filtering or not, which
fukasawa e60969
filters are used, and how it goes about picking row filters, you
fukasawa e60969
can call one of these functions.  The selection and configuration
fukasawa e60969
of row filters can have a significant impact on the size and
fukasawa e60969
encoding speed and a somewhat lesser impact on the decoding speed
fukasawa e60969
of an image.  Filtering is enabled by default for RGB and grayscale
fukasawa e60969
images (with and without alpha), but not for paletted images nor
fukasawa e60969
for any images with bit depths less than 8 bits/pixel.
fukasawa e60969
fukasawa e60969
The 'method' parameter sets the main filtering method, which is
fukasawa e60969
currently only '0' in the PNG 1.2 specification.  The 'filters'
fukasawa e60969
parameter sets which filter(s), if any, should be used for each
fukasawa e60969
scanline.  Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS
fukasawa e60969
to turn filtering on and off, respectively.
fukasawa e60969
fukasawa e60969
Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
fukasawa e60969
PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
fukasawa e60969
ORed together with '|' to specify one or more filters to use.
fukasawa e60969
These filters are described in more detail in the PNG specification.
fukasawa e60969
If you intend to change the filter type during the course of writing
fukasawa e60969
the image, you should start with flags set for all of the filters
fukasawa e60969
you intend to use so that libpng can initialize its internal
fukasawa e60969
structures appropriately for all of the filter types.  (Note that this
fukasawa e60969
means the first row must always be adaptively filtered, because libpng
fukasawa e60969
currently does not allocate the filter buffers until png_write_row()
fukasawa e60969
is called for the first time.)
fukasawa e60969
fukasawa e60969
    filters = PNG_FILTER_NONE | PNG_FILTER_SUB
fukasawa e60969
              PNG_FILTER_UP | PNG_FILTER_AVG |
fukasawa e60969
              PNG_FILTER_PAETH | PNG_ALL_FILTERS;
fukasawa e60969
fukasawa e60969
    png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
fukasawa e60969
       filters);
fukasawa e60969
              The second parameter can also be
fukasawa e60969
              PNG_INTRAPIXEL_DIFFERENCING if you are
fukasawa e60969
              writing a PNG to be embedded in a MNG
fukasawa e60969
              datastream.  This parameter must be the
fukasawa e60969
              same as the value of filter_method used
fukasawa e60969
              in png_set_IHDR().
fukasawa e60969
fukasawa e60969
.SS Requesting debug printout
fukasawa e60969
fukasawa e60969
The macro definition PNG_DEBUG can be used to request debugging
fukasawa e60969
printout.  Set it to an integer value in the range 0 to 3.  Higher
fukasawa e60969
numbers result in increasing amounts of debugging information.  The
fukasawa e60969
information is printed to the "stderr" file, unless another file
fukasawa e60969
name is specified in the PNG_DEBUG_FILE macro definition.
fukasawa e60969
fukasawa e60969
When PNG_DEBUG > 0, the following functions (macros) become available:
fukasawa e60969
fukasawa e60969
   png_debug(level, message)
fukasawa e60969
   png_debug1(level, message, p1)
fukasawa e60969
   png_debug2(level, message, p1, p2)
fukasawa e60969
fukasawa e60969
in which "level" is compared to PNG_DEBUG to decide whether to print
fukasawa e60969
the message, "message" is the formatted string to be printed,
fukasawa e60969
and p1 and p2 are parameters that are to be embedded in the string
fukasawa e60969
according to printf-style formatting directives.  For example,
fukasawa e60969
fukasawa e60969
   png_debug1(2, "foo=%d", foo);
fukasawa e60969
fukasawa e60969
is expanded to
fukasawa e60969
fukasawa e60969
   if (PNG_DEBUG > 2)
fukasawa e60969
      fprintf(PNG_DEBUG_FILE, "foo=%d\en", foo);
fukasawa e60969
fukasawa e60969
When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
fukasawa e60969
can still use PNG_DEBUG to control your own debugging:
fukasawa e60969
fukasawa e60969
   #ifdef PNG_DEBUG
fukasawa e60969
       fprintf(stderr, ...
fukasawa e60969
   #endif
fukasawa e60969
fukasawa e60969
When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
fukasawa e60969
having level = 0 will be printed.  There aren't any such statements in
fukasawa e60969
this version of libpng, but if you insert some they will be printed.
fukasawa e60969
fukasawa e60969
.SH VII.  MNG support
fukasawa e60969
fukasawa e60969
The MNG specification (available at http://www.libpng.org/pub/mng) allows
fukasawa e60969
certain extensions to PNG for PNG images that are embedded in MNG datastreams.
fukasawa e60969
Libpng can support some of these extensions.  To enable them, use the
fukasawa e60969
png_permit_mng_features() function:
fukasawa e60969
fukasawa e60969
   feature_set = png_permit_mng_features(png_ptr, mask)
fukasawa e60969
fukasawa e60969
   mask is a png_uint_32 containing the bitwise OR of the
fukasawa e60969
        features you want to enable.  These include
fukasawa e60969
        PNG_FLAG_MNG_EMPTY_PLTE
fukasawa e60969
        PNG_FLAG_MNG_FILTER_64
fukasawa e60969
        PNG_ALL_MNG_FEATURES
fukasawa e60969
fukasawa e60969
   feature_set is a png_uint_32 that is the bitwise AND of
fukasawa e60969
      your mask with the set of MNG features that is
fukasawa e60969
      supported by the version of libpng that you are using.
fukasawa e60969
fukasawa e60969
It is an error to use this function when reading or writing a standalone
fukasawa e60969
PNG file with the PNG 8-byte signature.  The PNG datastream must be wrapped
fukasawa e60969
in a MNG datastream.  As a minimum, it must have the MNG 8-byte signature
fukasawa e60969
and the MHDR and MEND chunks.  Libpng does not provide support for these
fukasawa e60969
or any other MNG chunks; your application must provide its own support for
fukasawa e60969
them.  You may wish to consider using libmng (available at
fukasawa e60969
http://www.libmng.com) instead.
fukasawa e60969
fukasawa e60969
.SH VIII.  Changes to Libpng from version 0.88
fukasawa e60969
fukasawa e60969
It should be noted that versions of libpng later than 0.96 are not
fukasawa e60969
distributed by the original libpng author, Guy Schalnat, nor by
fukasawa e60969
Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
fukasawa e60969
distributed versions 0.89 through 0.96, but rather by another member
fukasawa e60969
of the original PNG Group, Glenn Randers-Pehrson.  Guy and Andreas are
fukasawa e60969
still alive and well, but they have moved on to other things.
fukasawa e60969
fukasawa e60969
The old libpng functions png_read_init(), png_write_init(),
fukasawa e60969
png_info_init(), png_read_destroy(), and png_write_destroy() have been
fukasawa e60969
moved to PNG_INTERNAL in version 0.95 to discourage their use.  These
fukasawa e60969
functions will be removed from libpng version 1.4.0.
fukasawa e60969
fukasawa e60969
The preferred method of creating and initializing the libpng structures is
fukasawa e60969
via the png_create_read_struct(), png_create_write_struct(), and
fukasawa e60969
png_create_info_struct() because they isolate the size of the structures
fukasawa e60969
from the application, allow version error checking, and also allow the
fukasawa e60969
use of custom error handling routines during the initialization, which
fukasawa e60969
the old functions do not.  The functions png_read_destroy() and
fukasawa e60969
png_write_destroy() do not actually free the memory that libpng
fukasawa e60969
allocated for these structs, but just reset the data structures, so they
fukasawa e60969
can be used instead of png_destroy_read_struct() and
fukasawa e60969
png_destroy_write_struct() if you feel there is too much system overhead
fukasawa e60969
allocating and freeing the png_struct for each image read.
fukasawa e60969
fukasawa e60969
Setting the error callbacks via png_set_message_fn() before
fukasawa e60969
png_read_init() as was suggested in libpng-0.88 is no longer supported
fukasawa e60969
because this caused applications that do not use custom error functions
fukasawa e60969
to fail if the png_ptr was not initialized to zero.  It is still possible
fukasawa e60969
to set the error callbacks AFTER png_read_init(), or to change them with
fukasawa e60969
png_set_error_fn(), which is essentially the same function, but with a new
fukasawa e60969
name to force compilation errors with applications that try to use the old
fukasawa e60969
method.
fukasawa e60969
fukasawa e60969
Support for the sCAL, iCCP, iTXt, and sPLT chunks was added at libpng-1.0.6;
fukasawa e60969
however, iTXt support was not enabled by default.
fukasawa e60969
fukasawa e60969
Starting with version 1.0.7, you can find out which version of the library
fukasawa e60969
you are using at run-time:
fukasawa e60969
fukasawa e60969
   png_uint_32 libpng_vn = png_access_version_number();
fukasawa e60969
fukasawa e60969
The number libpng_vn is constructed from the major version, minor
fukasawa e60969
version with leading zero, and release number with leading zero,
fukasawa e60969
(e.g., libpng_vn for version 1.0.7 is 10007).
fukasawa e60969
fukasawa e60969
Note that this function does not take a png_ptr, so you can call it
fukasawa e60969
before you've created one.
fukasawa e60969
fukasawa e60969
You can also check which version of png.h you used when compiling your
fukasawa e60969
application:
fukasawa e60969
fukasawa e60969
   png_uint_32 application_vn = PNG_LIBPNG_VER;
fukasawa e60969
fukasawa e60969
.SH IX.  Changes to Libpng from version 1.0.x to 1.2.x
fukasawa e60969
fukasawa e60969
Support for user memory management was enabled by default.  To
fukasawa e60969
accomplish this, the functions png_create_read_struct_2(),
fukasawa e60969
png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
fukasawa e60969
png_malloc_default(), and png_free_default() were added.
fukasawa e60969
fukasawa e60969
Support for the iTXt chunk has been enabled by default as of
fukasawa e60969
version 1.2.41.
fukasawa e60969
fukasawa e60969
Support for certain MNG features was enabled.
fukasawa e60969
fukasawa e60969
Support for numbered error messages was added.  However, we never got
fukasawa e60969
around to actually numbering the error messages.  The function
fukasawa e60969
png_set_strip_error_numbers() was added (Note: the prototype for this
fukasawa e60969
function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
fukasawa e60969
builds of libpng-1.2.15.  It was restored in libpng-1.2.36).
fukasawa e60969
fukasawa e60969
The png_malloc_warn() function was added at libpng-1.2.3.  This issues
fukasawa e60969
a png_warning and returns NULL instead of aborting when it fails to
fukasawa e60969
acquire the requested memory allocation.
fukasawa e60969
fukasawa e60969
Support for setting user limits on image width and height was enabled
fukasawa e60969
by default.  The functions png_set_user_limits(), png_get_user_width_max(),
fukasawa e60969
and png_get_user_height_max() were added at libpng-1.2.6.
fukasawa e60969
fukasawa e60969
The png_set_add_alpha() function was added at libpng-1.2.7.
fukasawa e60969
fukasawa e60969
The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
fukasawa e60969
Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
fukasawa e60969
tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
fukasawa e60969
deprecated.
fukasawa e60969
fukasawa e60969
A number of macro definitions in support of runtime selection of
fukasawa e60969
assembler code features (especially Intel MMX code support) were
fukasawa e60969
added at libpng-1.2.0:
fukasawa e60969
fukasawa e60969
    PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
fukasawa e60969
    PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_INTERLACE
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_FILTER_SUB
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_FILTER_UP
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_FILTER_AVG
fukasawa e60969
    PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
fukasawa e60969
    PNG_ASM_FLAGS_INITIALIZED
fukasawa e60969
    PNG_MMX_READ_FLAGS
fukasawa e60969
    PNG_MMX_FLAGS
fukasawa e60969
    PNG_MMX_WRITE_FLAGS
fukasawa e60969
    PNG_MMX_FLAGS
fukasawa e60969
fukasawa e60969
We added the following functions in support of runtime
fukasawa e60969
selection of assembler code features:
fukasawa e60969
fukasawa e60969
    png_get_mmx_flagmask()
fukasawa e60969
    png_set_mmx_thresholds()
fukasawa e60969
    png_get_asm_flags()
fukasawa e60969
    png_get_mmx_bitdepth_threshold()
fukasawa e60969
    png_get_mmx_rowbytes_threshold()
fukasawa e60969
    png_set_asm_flags()
fukasawa e60969
fukasawa e60969
We replaced all of these functions with simple stubs in libpng-1.2.20,
fukasawa e60969
when the Intel assembler code was removed due to a licensing issue.
fukasawa e60969
fukasawa e60969
These macros are deprecated:
fukasawa e60969
fukasawa e60969
    PNG_READ_TRANSFORMS_NOT_SUPPORTED
fukasawa e60969
    PNG_PROGRESSIVE_READ_NOT_SUPPORTED
fukasawa e60969
    PNG_NO_SEQUENTIAL_READ_SUPPORTED
fukasawa e60969
    PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
fukasawa e60969
    PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
fukasawa e60969
    PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
fukasawa e60969
fukasawa e60969
They have been replaced, respectively, by:
fukasawa e60969
fukasawa e60969
    PNG_NO_READ_TRANSFORMS
fukasawa e60969
    PNG_NO_PROGRESSIVE_READ
fukasawa e60969
    PNG_NO_SEQUENTIAL_READ
fukasawa e60969
    PNG_NO_WRITE_TRANSFORMS
fukasawa e60969
    PNG_NO_READ_ANCILLARY_CHUNKS
fukasawa e60969
    PNG_NO_WRITE_ANCILLARY_CHUNKS
fukasawa e60969
fukasawa e60969
PNG_MAX_UINT was replaced with PNG_UINT_31_MAX.  It has been
fukasawa e60969
deprecated since libpng-1.0.16 and libpng-1.2.6.
fukasawa e60969
fukasawa e60969
The function
fukasawa e60969
    png_check_sig(sig, num)
fukasawa e60969
was replaced with
fukasawa e60969
    !png_sig_cmp(sig, 0, num)
fukasawa e60969
It has been deprecated since libpng-0.90.
fukasawa e60969
fukasawa e60969
The function
fukasawa e60969
    png_set_gray_1_2_4_to_8()
fukasawa e60969
which also expands tRNS to alpha was replaced with
fukasawa e60969
    png_set_expand_gray_1_2_4_to_8()
fukasawa e60969
which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
fukasawa e60969
fukasawa e60969
.SH X.  Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
fukasawa e60969
fukasawa e60969
Private libpng prototypes and macro definitions were moved from
fukasawa e60969
png.h and pngconf.h into a new pngpriv.h header file.
fukasawa e60969
fukasawa e60969
Functions png_set_benign_errors(), png_benign_error(), and
fukasawa e60969
png_chunk_benign_error() were added.
fukasawa e60969
fukasawa e60969
Support for setting the maximum amount of memory that the application
fukasawa e60969
will allocate for reading chunks was added, as a security measure.
fukasawa e60969
The functions png_set_chunk_cache_max() and png_get_chunk_cache_max()
fukasawa e60969
were added to the library.
fukasawa e60969
fukasawa e60969
We implemented support for I/O states by adding png_ptr member io_state
fukasawa e60969
and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c
fukasawa e60969
fukasawa e60969
We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level
fukasawa e60969
input transforms.
fukasawa e60969
fukasawa e60969
Checking for and reporting of errors in the IHDR chunk is more thorough.
fukasawa e60969
fukasawa e60969
Support for global arrays was removed, to improve thread safety.
fukasawa e60969
fukasawa e60969
Some obsolete/deprecated macros and functions have been removed.
fukasawa e60969
fukasawa e60969
Typecasted NULL definitions such as
fukasawa e60969
   #define png_voidp_NULL            (png_voidp)NULL
fukasawa e60969
were eliminated.  If you used these in your application, just use
fukasawa e60969
NULL instead.
fukasawa e60969
fukasawa e60969
The png_struct and info_struct members "trans" and "trans_values" were
fukasawa e60969
changed to "trans_alpha" and "trans_color", respectively.
fukasawa e60969
fukasawa e60969
The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles
fukasawa e60969
were removed.
fukasawa e60969
fukasawa e60969
The PNG_1_0_X and PNG_1_2_X macros were eliminated.
fukasawa e60969
fukasawa e60969
The PNG_LEGACY_SUPPORTED macro was eliminated.
fukasawa e60969
fukasawa e60969
Many WIN32_WCE #ifdefs were removed.
fukasawa e60969
fukasawa e60969
The functions png_read_init(info_ptr), png_write_init(info_ptr),
fukasawa e60969
png_info_init(info_ptr), png_read_destroy(), and png_write_destroy()
fukasawa e60969
have been removed.  They have been deprecated since libpng-0.95.
fukasawa e60969
fukasawa e60969
The png_permit_empty_plte() was removed. It has been deprecated
fukasawa e60969
since libpng-1.0.9.  Use png_permit_mng_features() instead.
fukasawa e60969
fukasawa e60969
We removed the obsolete stub functions png_get_mmx_flagmask(),
fukasawa e60969
png_set_mmx_thresholds(), png_get_asm_flags(),
fukasawa e60969
png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(),
fukasawa e60969
png_set_asm_flags(), and png_mmx_supported()
fukasawa e60969
fukasawa e60969
We removed the obsolete png_check_sig(), png_memcpy_check(), and
fukasawa e60969
png_memset_check() functions.  Instead use !png_sig_cmp(), memcpy(),
fukasawa e60969
and memset(), respectively.
fukasawa e60969
fukasawa e60969
The function png_set_gray_1_2_4_to_8() was removed. It has been
fukasawa e60969
deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with
fukasawa e60969
png_set_expand_gray_1_2_4_to_8() because the former function also
fukasawa e60969
expanded any tRNS chunk to an alpha channel.
fukasawa e60969
fukasawa e60969
Macros for png_get_uint_16, png_get_uint_32, and png_get_int_32
fukasawa e60969
were added and are used by default instead of the corresponding
fukasawa e60969
functions. Unfortunately,
fukasawa e60969
from libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
fukasawa e60969
function) incorrectly returned a value of type png_uint_32.
fukasawa e60969
fukasawa e60969
We changed the prototype for png_malloc() from
fukasawa e60969
    png_malloc(png_structp png_ptr, png_uint_32 size)
fukasawa e60969
to
fukasawa e60969
    png_malloc(png_structp png_ptr, png_alloc_size_t size)
fukasawa e60969
fukasawa e60969
This also applies to the prototype for the user replacement malloc_fn().
fukasawa e60969
fukasawa e60969
The png_calloc() function was added and is used in place of
fukasawa e60969
of "png_malloc(); memset();" except in the case in png_read_png()
fukasawa e60969
where the array consists of pointers; in this case a "for" loop is used
fukasawa e60969
after the png_malloc() to set the pointers to NULL, to give robust.
fukasawa e60969
behavior in case the application runs out of memory part-way through
fukasawa e60969
the process.
fukasawa e60969
fukasawa e60969
We changed the prototypes of png_get_compression_buffer_size() and
fukasawa e60969
png_set_compression_buffer_size() to work with png_size_t instead of
fukasawa e60969
png_uint_32.
fukasawa e60969
fukasawa e60969
Support for numbered error messages was removed by default, since we
fukasawa e60969
never got around to actually numbering the error messages. The function
fukasawa e60969
png_set_strip_error_numbers() was removed from the library by default.
fukasawa e60969
fukasawa e60969
The png_zalloc() and png_zfree() functions are no longer exported.
fukasawa e60969
The png_zalloc() function no longer zeroes out the memory that it
fukasawa e60969
allocates.  Applications that called png_zalloc(png_ptr, number, size)
fukasawa e60969
can call png_calloc(png_ptr, number*size) instead, and can call
fukasawa e60969
png_free() instead of png_zfree().
fukasawa e60969
fukasawa e60969
Support for dithering was disabled by default in libpng-1.4.0, because
fukasawa e60969
it has not been well tested and doesn't actually "dither".
fukasawa e60969
The code was not
fukasawa e60969
removed, however, and could be enabled by building libpng with
fukasawa e60969
PNG_READ_DITHER_SUPPORTED defined.  In libpng-1.4.2, this support
fukasawa e60969
was re-enabled, but the function was renamed png_set_quantize() to
fukasawa e60969
reflect more accurately what it actually does.  At the same time,
fukasawa e60969
the PNG_DITHER_[RED,GREEN_BLUE]_BITS macros were also renamed to
fukasawa e60969
PNG_QUANTIZE_[RED,GREEN,BLUE]_BITS, and PNG_READ_DITHER_SUPPORTED
fukasawa e60969
was renamed to PNG_READ_QUANTIZE_SUPPORTED.
fukasawa e60969
fukasawa e60969
We removed the trailing '.' from the warning and error messages.
fukasawa e60969
fukasawa e60969
.SH XI.  Changes to Libpng from version 1.4.x to 1.5.x
fukasawa e60969
fukasawa e60969
From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
fukasawa e60969
function) incorrectly returned a value of type png_uint_32.
fukasawa e60969
The incorrect macro was removed from libpng-1.4.5.
fukasawa e60969
fukasawa e60969
Checking for invalid palette index on write was added at libpng
fukasawa e60969
1.5.10.  If a pixel contains an invalid (out-of-range) index libpng issues
fukasawa e60969
a benign error.  This is enabled by default because this condition is an
fukasawa e60969
error according to the PNG specification, Clause 11.3.2, but the error can
fukasawa e60969
be ignored in each png_ptr with
fukasawa e60969
fukasawa e60969
   png_set_check_for_invalid_index(png_ptr, allowed);
fukasawa e60969
fukasawa e60969
      allowed  - one of
fukasawa e60969
                 0: disable benign error (accept the
fukasawa e60969
                    invalid data without warning).
fukasawa e60969
                 1: enable benign error (treat the
fukasawa e60969
                    invalid data as an error or a
fukasawa e60969
                    warning).
fukasawa e60969
fukasawa e60969
If the error is ignored, or if png_benign_error() treats it as a warning,
fukasawa e60969
any invalid pixels are decoded as opaque black by the decoder and written
fukasawa e60969
as-is by the encoder.
fukasawa e60969
fukasawa e60969
Retrieving the maximum palette index found was added at libpng-1.5.15.
fukasawa e60969
This statement must appear after png_read_png() or png_read_image() while
fukasawa e60969
reading, and after png_write_png() or png_write_image() while writing.
fukasawa e60969
fukasawa e60969
   int max_palette = png_get_palette_max(png_ptr, info_ptr);
fukasawa e60969
fukasawa e60969
This will return the maximum palette index found in the image, or "\-1" if
fukasawa e60969
the palette was not checked, or "0" if no palette was found.  Note that this
fukasawa e60969
does not account for any palette index used by ancillary chunks such as the
fukasawa e60969
bKGD chunk; you must check those separately to determine the maximum
fukasawa e60969
palette index actually used.
fukasawa e60969
fukasawa e60969
There are no substantial API changes between the non-deprecated parts of
fukasawa e60969
the 1.4.5 API and the 1.5.0 API; however, the ability to directly access
fukasawa e60969
members of the main libpng control structures, png_struct and png_info,
fukasawa e60969
deprecated in earlier versions of libpng, has been completely removed from
fukasawa e60969
libpng 1.5.
fukasawa e60969
fukasawa e60969
We no longer include zlib.h in png.h.  The include statement has been moved
fukasawa e60969
to pngstruct.h, where it is not accessible by applications. Applications that
fukasawa e60969
need access to information in zlib.h will need to add the '#include "zlib.h"'
fukasawa e60969
directive.  It does not matter whether this is placed prior to or after
fukasawa e60969
the '"#include png.h"' directive.
fukasawa e60969
fukasawa e60969
The png_sprintf(), png_strcpy(), and png_strncpy() macros are no longer used
fukasawa e60969
and were removed.
fukasawa e60969
fukasawa e60969
We moved the png_strlen(), png_memcpy(), png_memset(), and png_memcmp()
fukasawa e60969
macros into a private header file (pngpriv.h) that is not accessible to
fukasawa e60969
applications.
fukasawa e60969
fukasawa e60969
In png_get_iCCP, the type of "profile" was changed from png_charpp
fukasawa e60969
to png_bytepp, and in png_set_iCCP, from png_charp to png_const_bytep.
fukasawa e60969
fukasawa e60969
There are changes of form in png.h, including new and changed macros to
fukasawa e60969
declare parts of the API.  Some API functions with arguments that are
fukasawa e60969
pointers to data not modified within the function have been corrected to
fukasawa e60969
declare these arguments with PNG_CONST.
fukasawa e60969
fukasawa e60969
Much of the internal use of C macros to control the library build has also
fukasawa e60969
changed and some of this is visible in the exported header files, in
fukasawa e60969
particular the use of macros to control data and API elements visible
fukasawa e60969
during application compilation may require significant revision to
fukasawa e60969
application code.  (It is extremely rare for an application to do this.)
fukasawa e60969
fukasawa e60969
Any program that compiled against libpng 1.4 and did not use deprecated
fukasawa e60969
features or access internal library structures should compile and work
fukasawa e60969
against libpng 1.5, except for the change in the prototype for
fukasawa e60969
png_get_iCCP() and png_set_iCCP() API functions mentioned above.
fukasawa e60969
fukasawa e60969
libpng 1.5.0 adds PNG_ PASS macros to help in the reading and writing of
fukasawa e60969
interlaced images.  The macros return the number of rows and columns in
fukasawa e60969
each pass and information that can be used to de-interlace and (if
fukasawa e60969
absolutely necessary) interlace an image.
fukasawa e60969
fukasawa e60969
libpng 1.5.0 adds an API png_longjmp(png_ptr, value).  This API calls
fukasawa e60969
the application-provided png_longjmp_ptr on the internal, but application
fukasawa e60969
initialized, longjmp buffer.  It is provided as a convenience to avoid
fukasawa e60969
the need to use the png_jmpbuf macro, which had the unnecessary side
fukasawa e60969
effect of resetting the internal png_longjmp_ptr value.
fukasawa e60969
fukasawa e60969
libpng 1.5.0 includes a complete fixed point API.  By default this is
fukasawa e60969
present along with the corresponding floating point API.  In general the
fukasawa e60969
fixed point API is faster and smaller than the floating point one because
fukasawa e60969
the PNG file format used fixed point, not floating point.  This applies
fukasawa e60969
even if the library uses floating point in internal calculations.  A new
fukasawa e60969
macro, PNG_FLOATING_ARITHMETIC_SUPPORTED, reveals whether the library
fukasawa e60969
uses floating point arithmetic (the default) or fixed point arithmetic
fukasawa e60969
internally for performance critical calculations such as gamma correction.
fukasawa e60969
In some cases, the gamma calculations may produce slightly different
fukasawa e60969
results.  This has changed the results in png_rgb_to_gray and in alpha
fukasawa e60969
composition (png_set_background for example). This applies even if the
fukasawa e60969
original image was already linear (gamma == 1.0) and, therefore, it is
fukasawa e60969
not necessary to linearize the image.  This is because libpng has *not*
fukasawa e60969
been changed to optimize that case correctly, yet.
fukasawa e60969
fukasawa e60969
Fixed point support for the sCAL chunk comes with an important caveat;
fukasawa e60969
the sCAL specification uses a decimal encoding of floating point values
fukasawa e60969
and the accuracy of PNG fixed point values is insufficient for
fukasawa e60969
representation of these values. Consequently a "string" API
fukasawa e60969
(png_get_sCAL_s and png_set_sCAL_s) is the only reliable way of reading
fukasawa e60969
arbitrary sCAL chunks in the absence of either the floating point API or
fukasawa e60969
internal floating point calculations.  Starting with libpng-1.5.0, both
fukasawa e60969
of these functions are present when PNG_sCAL_SUPPORTED is defined.  Prior
fukasawa e60969
to libpng-1.5.0, their presence also depended upon PNG_FIXED_POINT_SUPPORTED
fukasawa e60969
being defined and PNG_FLOATING_POINT_SUPPORTED not being defined.
fukasawa e60969
fukasawa e60969
Applications no longer need to include the optional distribution header
fukasawa e60969
file pngusr.h or define the corresponding macros during application
fukasawa e60969
build in order to see the correct variant of the libpng API.  From 1.5.0
fukasawa e60969
application code can check for the corresponding _SUPPORTED macro:
fukasawa e60969
fukasawa e60969
#ifdef PNG_INCH_CONVERSIONS_SUPPORTED
fukasawa e60969
   /* code that uses the inch conversion APIs. */
fukasawa e60969
#endif
fukasawa e60969
fukasawa e60969
This macro will only be defined if the inch conversion functions have been
fukasawa e60969
compiled into libpng.  The full set of macros, and whether or not support
fukasawa e60969
has been compiled in, are available in the header file pnglibconf.h.
fukasawa e60969
This header file is specific to the libpng build.  Notice that prior to
fukasawa e60969
1.5.0 the _SUPPORTED macros would always have the default definition unless
fukasawa e60969
reset by pngusr.h or by explicit settings on the compiler command line.
fukasawa e60969
These settings may produce compiler warnings or errors in 1.5.0 because
fukasawa e60969
of macro redefinition.
fukasawa e60969
fukasawa e60969
Applications can now choose whether to use these macros or to call the
fukasawa e60969
corresponding function by defining PNG_USE_READ_MACROS or
fukasawa e60969
PNG_NO_USE_READ_MACROS before including png.h.  Notice that this is
fukasawa e60969
only supported from 1.5.0; defining PNG_NO_USE_READ_MACROS prior to 1.5.0
fukasawa e60969
will lead to a link failure.
fukasawa e60969
fukasawa e60969
Prior to libpng-1.5.4, the zlib compressor used the same set of parameters
fukasawa e60969
when compressing the IDAT data and textual data such as zTXt and iCCP.
fukasawa e60969
In libpng-1.5.4 we reinitialized the zlib stream for each type of data.
fukasawa e60969
We added five png_set_text_*() functions for setting the parameters to
fukasawa e60969
use with textual data.
fukasawa e60969
fukasawa e60969
Prior to libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
fukasawa e60969
option was off by default, and slightly inaccurate scaling occurred.
fukasawa e60969
This option can no longer be turned off, and the choice of accurate
fukasawa e60969
or inaccurate 16-to-8 scaling is by using the new png_set_scale_16_to_8()
fukasawa e60969
API for accurate scaling or the old png_set_strip_16_to_8() API for simple
fukasawa e60969
chopping.  In libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
fukasawa e60969
macro became PNG_READ_SCALE_16_TO_8_SUPPORTED, and the PNG_READ_16_TO_8
fukasawa e60969
macro became PNG_READ_STRIP_16_TO_8_SUPPORTED, to enable the two
fukasawa e60969
png_set_*_16_to_8() functions separately.
fukasawa e60969
fukasawa e60969
Prior to libpng-1.5.4, the png_set_user_limits() function could only be
fukasawa e60969
used to reduce the width and height limits from the value of
fukasawa e60969
PNG_USER_WIDTH_MAX and PNG_USER_HEIGHT_MAX, although this document said
fukasawa e60969
that it could be used to override them.  Now this function will reduce or
fukasawa e60969
increase the limits.
fukasawa e60969
fukasawa e60969
Starting in libpng-1.5.10, the user limits can be set en masse with the
fukasawa e60969
configuration option PNG_SAFE_LIMITS_SUPPORTED.  If this option is enabled,
fukasawa e60969
a set of "safe" limits is applied in pngpriv.h.  These can be overridden by
fukasawa e60969
application calls to png_set_user_limits(), png_set_user_chunk_cache_max(),
fukasawa e60969
and/or png_set_user_malloc_max() that increase or decrease the limits.  Also,
fukasawa e60969
in libpng-1.5.10 the default width and height limits were increased
fukasawa e60969
from 1,000,000 to 0x7fffffff (i.e., made unlimited).  Therefore, the
fukasawa e60969
limits are now
fukasawa e60969
                               default      safe
fukasawa e60969
   png_user_width_max        0x7fffffff    1,000,000
fukasawa e60969
   png_user_height_max       0x7fffffff    1,000,000
fukasawa e60969
   png_user_chunk_cache_max  0 (unlimited)   128
fukasawa e60969
   png_user_chunk_malloc_max 0 (unlimited) 8,000,000
fukasawa e60969
fukasawa e60969
The png_set_option() function (and the "options" member of the png struct) was
fukasawa e60969
added to libpng-1.5.15, with option PNG_ARM_NEON.
fukasawa e60969
fukasawa e60969
The library now supports a complete fixed point implementation and can
fukasawa e60969
thus be used on systems that have no floating point support or very
fukasawa e60969
limited or slow support.  Previously gamma correction, an essential part
fukasawa e60969
of complete PNG support, required reasonably fast floating point.
fukasawa e60969
fukasawa e60969
As part of this the choice of internal implementation has been made
fukasawa e60969
independent of the choice of fixed versus floating point APIs and all the
fukasawa e60969
missing fixed point APIs have been implemented.
fukasawa e60969
fukasawa e60969
The exact mechanism used to control attributes of API functions has
fukasawa e60969
changed, as described in the INSTALL file.
fukasawa e60969
fukasawa e60969
A new test program, pngvalid, is provided in addition to pngtest.
fukasawa e60969
pngvalid validates the arithmetic accuracy of the gamma correction
fukasawa e60969
calculations and includes a number of validations of the file format.
fukasawa e60969
A subset of the full range of tests is run when "make check" is done
fukasawa e60969
(in the 'configure' build.)  pngvalid also allows total allocated memory
fukasawa e60969
usage to be evaluated and performs additional memory overwrite validation.
fukasawa e60969
fukasawa e60969
Many changes to individual feature macros have been made. The following
fukasawa e60969
are the changes most likely to be noticed by library builders who
fukasawa e60969
configure libpng:
fukasawa e60969
fukasawa e60969
1) All feature macros now have consistent naming:
fukasawa e60969
fukasawa e60969
#define PNG_NO_feature turns the feature off
fukasawa e60969
#define PNG_feature_SUPPORTED turns the feature on
fukasawa e60969
fukasawa e60969
pnglibconf.h contains one line for each feature macro which is either:
fukasawa e60969
fukasawa e60969
#define PNG_feature_SUPPORTED
fukasawa e60969
fukasawa e60969
if the feature is supported or:
fukasawa e60969
fukasawa e60969
/*#undef PNG_feature_SUPPORTED*/
fukasawa e60969
fukasawa e60969
if it is not.  Library code consistently checks for the 'SUPPORTED' macro.
fukasawa e60969
It does not, and libpng applications should not, check for the 'NO' macro
fukasawa e60969
which will not normally be defined even if the feature is not supported.
fukasawa e60969
The 'NO' macros are only used internally for setting or not setting the
fukasawa e60969
corresponding 'SUPPORTED' macros.
fukasawa e60969
fukasawa e60969
Compatibility with the old names is provided as follows:
fukasawa e60969
fukasawa e60969
PNG_INCH_CONVERSIONS turns on PNG_INCH_CONVERSIONS_SUPPORTED
fukasawa e60969
fukasawa e60969
And the following definitions disable the corresponding feature:
fukasawa e60969
fukasawa e60969
PNG_SETJMP_NOT_SUPPORTED disables SETJMP
fukasawa e60969
PNG_READ_TRANSFORMS_NOT_SUPPORTED disables READ_TRANSFORMS
fukasawa e60969
PNG_NO_READ_COMPOSITED_NODIV disables READ_COMPOSITE_NODIV
fukasawa e60969
PNG_WRITE_TRANSFORMS_NOT_SUPPORTED disables WRITE_TRANSFORMS
fukasawa e60969
PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED disables READ_ANCILLARY_CHUNKS
fukasawa e60969
PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED disables WRITE_ANCILLARY_CHUNKS
fukasawa e60969
fukasawa e60969
Library builders should remove use of the above, inconsistent, names.
fukasawa e60969
fukasawa e60969
2) Warning and error message formatting was previously conditional on
fukasawa e60969
the STDIO feature. The library has been changed to use the
fukasawa e60969
CONSOLE_IO feature instead. This means that if CONSOLE_IO is disabled
fukasawa e60969
the library no longer uses the printf(3) functions, even though the
fukasawa e60969
default read/write implementations use (FILE) style stdio.h functions.
fukasawa e60969
fukasawa e60969
3) Three feature macros now control the fixed/floating point decisions:
fukasawa e60969
fukasawa e60969
PNG_FLOATING_POINT_SUPPORTED enables the floating point APIs
fukasawa e60969
fukasawa e60969
PNG_FIXED_POINT_SUPPORTED enables the fixed point APIs; however, in
fukasawa e60969
practice these are normally required internally anyway (because the PNG
fukasawa e60969
file format is fixed point), therefore in most cases PNG_NO_FIXED_POINT
fukasawa e60969
merely stops the function from being exported.
fukasawa e60969
fukasawa e60969
PNG_FLOATING_ARITHMETIC_SUPPORTED chooses between the internal floating
fukasawa e60969
point implementation or the fixed point one.  Typically the fixed point
fukasawa e60969
implementation is larger and slower than the floating point implementation
fukasawa e60969
on a system that supports floating point; however, it may be faster on a
fukasawa e60969
system which lacks floating point hardware and therefore uses a software
fukasawa e60969
emulation.
fukasawa e60969
fukasawa e60969
4) Added PNG_{READ,WRITE}_INT_FUNCTIONS_SUPPORTED.  This allows the
fukasawa e60969
functions to read and write ints to be disabled independently of
fukasawa e60969
PNG_USE_READ_MACROS, which allows libpng to be built with the functions
fukasawa e60969
even though the default is to use the macros - this allows applications
fukasawa e60969
to choose at app buildtime whether or not to use macros (previously
fukasawa e60969
impossible because the functions weren't in the default build.)
fukasawa e60969
fukasawa e60969
.SH XII.  Changes to Libpng from version 1.5.x to 1.6.x
fukasawa e60969
fukasawa e60969
A "simplified API" has been added (see documentation in png.h and a simple
fukasawa e60969
example in contrib/examples/pngtopng.c).  The new publicly visible API
fukasawa e60969
includes the following:
fukasawa e60969
fukasawa e60969
   macros:
fukasawa e60969
     PNG_FORMAT_*
fukasawa e60969
     PNG_IMAGE_*
fukasawa e60969
   structures:
fukasawa e60969
     png_control
fukasawa e60969
     png_image
fukasawa e60969
   read functions
fukasawa e60969
     png_image_begin_read_from_file()
fukasawa e60969
     png_image_begin_read_from_stdio()
fukasawa e60969
     png_image_begin_read_from_memory()
fukasawa e60969
     png_image_finish_read()
fukasawa e60969
     png_image_free()
fukasawa e60969
   write functions
fukasawa e60969
     png_image_write_to_file()
fukasawa e60969
     png_image_write_to_stdio()
fukasawa e60969
fukasawa e60969
Starting with libpng-1.6.0, you can configure libpng to prefix all exported
fukasawa e60969
symbols, using the PNG_PREFIX macro.
fukasawa e60969
fukasawa e60969
We no longer include string.h in png.h.  The include statement has been moved
fukasawa e60969
to pngpriv.h, where it is not accessible by applications.  Applications that
fukasawa e60969
need access to information in string.h must add an '#include <string.h>'
fukasawa e60969
directive.  It does not matter whether this is placed prior to or after
fukasawa e60969
the '#include "png.h"' directive.
fukasawa e60969
fukasawa e60969
The following API are now DEPRECATED:
fukasawa e60969
   png_info_init_3()
fukasawa e60969
   png_convert_to_rfc1123() which has been replaced
fukasawa e60969
     with png_convert_to_rfc1123_buffer()
fukasawa e60969
   png_malloc_default()
fukasawa e60969
   png_free_default()
fukasawa e60969
   png_reset_zstream()
fukasawa e60969
fukasawa e60969
The following have been removed:
fukasawa e60969
   png_get_io_chunk_name(), which has been replaced
fukasawa e60969
     with png_get_io_chunk_type().  The new
fukasawa e60969
     function returns a 32-bit integer instead of
fukasawa e60969
     a string.
fukasawa e60969
   The png_sizeof(), png_strlen(), png_memcpy(), png_memcmp(), and
fukasawa e60969
     png_memset() macros are no longer used in the libpng sources and
fukasawa e60969
     have been removed.  These had already been made invisible to applications
fukasawa e60969
     (i.e., defined in the private pngpriv.h header file) since libpng-1.5.0.
fukasawa e60969
fukasawa e60969
The signatures of many exported functions were changed, such that
fukasawa e60969
   png_structp became png_structrp or png_const_structrp
fukasawa e60969
   png_infop became png_inforp or png_const_inforp
fukasawa e60969
where "rp" indicates a "restricted pointer".
fukasawa e60969
fukasawa e60969
Dropped support for 16-bit platforms. The support for FAR/far types has
fukasawa e60969
been eliminated and the definition of png_alloc_size_t is now controlled
fukasawa e60969
by a flag so that 'small size_t' systems can select it if necessary.
fukasawa e60969
fukasawa e60969
Error detection in some chunks has improved; in particular the iCCP chunk
fukasawa e60969
reader now does pretty complete validation of the basic format.  Some bad
fukasawa e60969
profiles that were previously accepted are now accepted with a warning or
fukasawa e60969
rejected, depending upon the png_set_benign_errors() setting, in particular
fukasawa e60969
the very old broken Microsoft/HP 3144-byte sRGB profile.  Starting with
fukasawa e60969
libpng-1.6.11, recognizing and checking sRGB profiles can be avoided by
fukasawa e60969
means of
fukasawa e60969
fukasawa e60969
    #if defined(PNG_SKIP_sRGB_CHECK_PROFILE) && \
fukasawa e60969
        defined(PNG_SET_OPTION_SUPPORTED)
fukasawa e60969
       png_set_option(png_ptr, PNG_SKIP_sRGB_CHECK_PROFILE,
fukasawa e60969
           PNG_OPTION_ON);
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
It's not a good idea to do this if you are using the "simplified API",
fukasawa e60969
which needs to be able to recognize sRGB profiles conveyed via the iCCP
fukasawa e60969
chunk.
fukasawa e60969
fukasawa e60969
The PNG spec requirement that only grayscale profiles may appear in images
fukasawa e60969
with color type 0 or 4 and that even if the image only contains gray pixels,
fukasawa e60969
only RGB profiles may appear in images with color type 2, 3, or 6, is now
fukasawa e60969
enforced.  The sRGB chunk is allowed to appear in images with any color type
fukasawa e60969
and is interpreted by libpng to convey a one-tracer-curve gray profile or a
fukasawa e60969
three-tracer-curve RGB profile as appropriate.
fukasawa e60969
fukasawa e60969
Libpng 1.5.x erroneously used /MD for Debug DLL builds; if you used the debug
fukasawa e60969
builds in your app and you changed your app to use /MD you will need to
fukasawa e60969
change it back to /MDd for libpng 1.6.x.
fukasawa e60969
fukasawa e60969
Prior to libpng-1.6.0 a warning would be issued if the iTXt chunk contained
fukasawa e60969
an empty language field or an empty translated keyword.  Both of these
fukasawa e60969
are allowed by the PNG specification, so these warnings are no longer issued.
fukasawa e60969
fukasawa e60969
The library now issues an error if the application attempts to set a
fukasawa e60969
transform after it calls png_read_update_info() or if it attempts to call
fukasawa e60969
both png_read_update_info() and png_start_read_image() or to call either
fukasawa e60969
of them more than once.
fukasawa e60969
fukasawa e60969
The default condition for benign_errors is now to treat benign errors as
fukasawa e60969
warnings while reading and as errors while writing.
fukasawa e60969
fukasawa e60969
The library now issues a warning if both background processing and RGB to
fukasawa e60969
gray are used when gamma correction happens. As with previous versions of
fukasawa e60969
the library the results are numerically very incorrect in this case.
fukasawa e60969
fukasawa e60969
There are some minor arithmetic changes in some transforms such as
fukasawa e60969
png_set_background(), that might be detected by certain regression tests.
fukasawa e60969
fukasawa e60969
Unknown chunk handling has been improved internally, without any API change.
fukasawa e60969
This adds more correct option control of the unknown handling, corrects
fukasawa e60969
a pre-existing bug where the per-chunk 'keep' setting is ignored, and makes
fukasawa e60969
it possible to skip IDAT chunks in the sequential reader.
fukasawa e60969
fukasawa e60969
The machine-generated configure files are no longer included in branches
fukasawa e60969
libpng16 and later of the GIT repository.  They continue to be included
fukasawa e60969
in the tarball releases, however.
fukasawa e60969
fukasawa e60969
Libpng-1.6.0 through 1.6.2 used the CMF bytes at the beginning of the IDAT
fukasawa e60969
stream to set the size of the sliding window for reading instead of using the
fukasawa e60969
default 32-kbyte sliding window size.  It was discovered that there are
fukasawa e60969
hundreds of PNG files in the wild that have incorrect CMF bytes that caused
fukasawa e60969
zlib to issue the "invalid distance too far back" error and reject the file.
fukasawa e60969
Libpng-1.6.3 and later calculate their own safe CMF from the image dimensions,
fukasawa e60969
provide a way to revert to the libpng-1.5.x behavior (ignoring the CMF bytes
fukasawa e60969
and using a 32-kbyte sliding window), by using
fukasawa e60969
fukasawa e60969
    png_set_option(png_ptr, PNG_MAXIMUM_INFLATE_WINDOW,
fukasawa e60969
        PNG_OPTION_ON);
fukasawa e60969
fukasawa e60969
and provide a tool (contrib/tools/pngfix) for rewriting a PNG file while
fukasawa e60969
optimizing the CMF bytes in its IDAT chunk correctly.
fukasawa e60969
fukasawa e60969
Libpng-1.6.0 and libpng-1.6.1 wrote uncompressed iTXt chunks with the wrong
fukasawa e60969
length, which resulted in PNG files that cannot be read beyond the bad iTXt
fukasawa e60969
chunk.  This error was fixed in libpng-1.6.3, and a tool (called
fukasawa e60969
contrib/tools/png-fix-itxt) has been added to the libpng distribution.
fukasawa e60969
fukasawa e60969
Starting with libpng-1.6.17, the PNG_SAFE_LIMITS macro was eliminated
fukasawa e60969
and safe limits are used by default (users who need larger limits
fukasawa e60969
can still override them at compile time or run time, as described above).
fukasawa e60969
fukasawa e60969
The new limits are
fukasawa e60969
                                default   spec limit
fukasawa e60969
   png_user_width_max         1,000,000  2,147,483,647
fukasawa e60969
   png_user_height_max        1,000,000  2,147,483,647
fukasawa e60969
   png_user_chunk_cache_max         128  unlimited
fukasawa e60969
   png_user_chunk_malloc_max  8,000,000  unlimited
fukasawa e60969
fukasawa e60969
Starting with libpng-1.6.18, a PNG_RELEASE_BUILD macro was added, which allows
fukasawa e60969
library builders to control compilation for an installed system (a release build).
fukasawa e60969
It can be set for testing debug or beta builds to ensure that they will compile
fukasawa e60969
when the build type is switched to RC or STABLE. In essence this overrides the
fukasawa e60969
PNG_LIBPNG_BUILD_BASE_TYPE definition which is not directly user controllable.
fukasawa e60969
fukasawa e60969
Starting with libpng-1.6.19, attempting to set an over-length PLTE chunk
fukasawa e60969
is an error. Previously this requirement of the PNG specification was not
fukasawa e60969
enforced, and the palette was always limited to 256 entries. An over-length
fukasawa e60969
PLTE chunk found in an input PNG is silently truncated.
fukasawa e60969
fukasawa e60969
.SH XIII.  Detecting libpng
fukasawa e60969
fukasawa e60969
The png_get_io_ptr() function has been present since libpng-0.88, has never
fukasawa e60969
changed, and is unaffected by conditional compilation macros.  It is the
fukasawa e60969
best choice for use in configure scripts for detecting the presence of any
fukasawa e60969
libpng version since 0.88.  In an autoconf "configure.in" you could use
fukasawa e60969
fukasawa e60969
    AC_CHECK_LIB(png, png_get_io_ptr, ...
fukasawa e60969
fukasawa e60969
.SH XV. Source code repository
fukasawa e60969
fukasawa e60969
Since about February 2009, version 1.2.34, libpng has been under "git" source
fukasawa e60969
control.  The git repository was built from old libpng-x.y.z.tar.gz files
fukasawa e60969
going back to version 0.70.  You can access the git repository (read only)
fukasawa e60969
at
fukasawa e60969
fukasawa e60969
    git://git.code.sf.net/p/libpng/code
fukasawa e60969
fukasawa e60969
or you can browse it with a web browser by selecting the "code" button at
fukasawa e60969
fukasawa e60969
    https://sourceforge.net/projects/libpng
fukasawa e60969
fukasawa e60969
Patches can be sent to glennrp at users.sourceforge.net or to
fukasawa e60969
png-mng-implement at lists.sourceforge.net or you can upload them to
fukasawa e60969
the libpng bug tracker at
fukasawa e60969
fukasawa e60969
    http://libpng.sourceforge.net
fukasawa e60969
fukasawa e60969
We also accept patches built from the tar or zip distributions, and
fukasawa e60969
simple verbal discriptions of bug fixes, reported either to the
fukasawa e60969
SourceForge bug tracker, to the png-mng-implement at lists.sf.net
fukasawa e60969
mailing list, or directly to glennrp.
fukasawa e60969
fukasawa e60969
.SH XV. Coding style
fukasawa e60969
fukasawa e60969
Our coding style is similar to the "Allman" style
fukasawa e60969
(See http://en.wikipedia.org/wiki/Indent_style#Allman_style), with curly
fukasawa e60969
braces on separate lines:
fukasawa e60969
fukasawa e60969
    if (condition)
fukasawa e60969
    {
fukasawa e60969
       action;
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
    else if (another condition)
fukasawa e60969
    {
fukasawa e60969
       another action;
fukasawa e60969
    }
fukasawa e60969
fukasawa e60969
The braces can be omitted from simple one-line actions:
fukasawa e60969
fukasawa e60969
    if (condition)
fukasawa e60969
       return (0);
fukasawa e60969
fukasawa e60969
We use 3-space indentation, except for continued statements which
fukasawa e60969
are usually indented the same as the first line of the statement
fukasawa e60969
plus four more spaces.
fukasawa e60969
fukasawa e60969
For macro definitions we use 2-space indentation, always leaving the "#"
fukasawa e60969
in the first column.
fukasawa e60969
fukasawa e60969
    #ifndef PNG_NO_FEATURE
fukasawa e60969
    #  ifndef PNG_FEATURE_SUPPORTED
fukasawa e60969
    #    define PNG_FEATURE_SUPPORTED
fukasawa e60969
    #  endif
fukasawa e60969
    #endif
fukasawa e60969
fukasawa e60969
Comments appear with the leading "/*" at the same indentation as
fukasawa e60969
the statement that follows the comment:
fukasawa e60969
fukasawa e60969
    /* Single-line comment */
fukasawa e60969
    statement;
fukasawa e60969
fukasawa e60969
    /* This is a multiple-line
fukasawa e60969
     * comment.
fukasawa e60969
     */
fukasawa e60969
    statement;
fukasawa e60969
fukasawa e60969
Very short comments can be placed after the end of the statement
fukasawa e60969
to which they pertain:
fukasawa e60969
fukasawa e60969
    statement;    /* comment */
fukasawa e60969
fukasawa e60969
We don't use C++ style ("//") comments. We have, however,
fukasawa e60969
used them in the past in some now-abandoned MMX assembler
fukasawa e60969
code.
fukasawa e60969
fukasawa e60969
Functions and their curly braces are not indented, and
fukasawa e60969
exported functions are marked with PNGAPI:
fukasawa e60969
fukasawa e60969
 /* This is a public function that is visible to
fukasawa e60969
  * application programmers. It does thus-and-so.
fukasawa e60969
  */
fukasawa e60969
 void PNGAPI
fukasawa e60969
 png_exported_function(png_ptr, png_info, foo)
fukasawa e60969
 {
fukasawa e60969
    body;
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
The return type and decorations are placed on a separate line
fukasawa e60969
ahead of the function name, as illustrated above.
fukasawa e60969
fukasawa e60969
The prototypes for all exported functions appear in png.h,
fukasawa e60969
above the comment that says
fukasawa e60969
fukasawa e60969
    /* Maintainer: Put new public prototypes here ... */
fukasawa e60969
fukasawa e60969
We mark all non-exported functions with "/* PRIVATE */"":
fukasawa e60969
fukasawa e60969
 void /* PRIVATE */
fukasawa e60969
 png_non_exported_function(png_ptr, png_info, foo)
fukasawa e60969
 {
fukasawa e60969
    body;
fukasawa e60969
 }
fukasawa e60969
fukasawa e60969
The prototypes for non-exported functions (except for those in
fukasawa e60969
pngtest) appear in pngpriv.h above the comment that says
fukasawa e60969
fukasawa e60969
  /* Maintainer: Put new private prototypes here ^ */
fukasawa e60969
fukasawa e60969
To avoid polluting the global namespace, the names of all exported
fukasawa e60969
functions and variables begin with "png_", and all publicly visible C
fukasawa e60969
preprocessor macros begin with "PNG".  We request that applications that
fukasawa e60969
use libpng *not* begin any of their own symbols with either of these strings.
fukasawa e60969
fukasawa e60969
We put a space after the "sizeof" operator and we omit the
fukasawa e60969
optional parentheses around its argument when the argument
fukasawa e60969
is an expression, not a type name, and we always enclose the
fukasawa e60969
sizeof operator, with its argument, in parentheses:
fukasawa e60969
fukasawa e60969
  (sizeof (png_uint_32))
fukasawa e60969
  (sizeof array)
fukasawa e60969
fukasawa e60969
Prior to libpng-1.6.0 we used a "png_sizeof()" macro, formatted as
fukasawa e60969
though it were a function.
fukasawa e60969
fukasawa e60969
Control keywords if, for, while, and switch are always followed by a space
fukasawa e60969
to distinguish them from function calls, which have no trailing space. 
fukasawa e60969
fukasawa e60969
We put a space after each comma and after each semicolon
fukasawa e60969
in "for" statements, and we put spaces before and after each
fukasawa e60969
C binary operator and after "for" or "while", and before
fukasawa e60969
"?".  We don't put a space between a typecast and the expression
fukasawa e60969
being cast, nor do we put one between a function name and the
fukasawa e60969
left parenthesis that follows it:
fukasawa e60969
fukasawa e60969
    for (i = 2; i > 0; \-\-i)
fukasawa e60969
       y[i] = a(x) + (int)b;
fukasawa e60969
fukasawa e60969
We prefer #ifdef and #ifndef to #if defined() and #if !defined()
fukasawa e60969
when there is only one macro being tested.  We always use parentheses
fukasawa e60969
with "defined".
fukasawa e60969
fukasawa e60969
We express integer constants that are used as bit masks in hex format,
fukasawa e60969
with an even number of lower-case hex digits, and to make them unsigned
fukasawa e60969
(e.g., 0x00U, 0xffU, 0x0100U) and long if they are greater than 0x7fff
fukasawa e60969
(e.g., 0xffffUL).
fukasawa e60969
fukasawa e60969
We prefer to use underscores rather than camelCase in names, except
fukasawa e60969
for a few type names that we inherit from zlib.h.
fukasawa e60969
fukasawa e60969
We prefer "if (something != 0)" and "if (something == 0)"
fukasawa e60969
over "if (something)" and if "(!something)", respectively.
fukasawa e60969
fukasawa e60969
We do not use the TAB character for indentation in the C sources.
fukasawa e60969
fukasawa e60969
Lines do not exceed 80 characters.
fukasawa e60969
fukasawa e60969
Other rules can be inferred by inspecting the libpng source.
fukasawa e60969
fukasawa e60969
.SH XVI. Y2K Compliance in libpng
fukasawa e60969
fukasawa e60969
Since the PNG Development group is an ad-hoc body, we can't make
fukasawa e60969
an official declaration.
fukasawa e60969
fukasawa e60969
This is your unofficial assurance that libpng from version 0.71 and
fukasawa e60969
upward through 1.6.21 are Y2K compliant.  It is my belief that earlier
fukasawa e60969
versions were also Y2K compliant.
fukasawa e60969
fukasawa e60969
Libpng only has two year fields.  One is a 2-byte unsigned integer
fukasawa e60969
that will hold years up to 65535.  The other, which is deprecated,
fukasawa e60969
holds the date in text format, and will hold years up to 9999.
fukasawa e60969
fukasawa e60969
The integer is
fukasawa e60969
    "png_uint_16 year" in png_time_struct.
fukasawa e60969
fukasawa e60969
The string is
fukasawa e60969
    "char time_buffer[29]" in png_struct.  This is no longer used
fukasawa e60969
in libpng-1.6.x and will be removed from libpng-1.7.0.
fukasawa e60969
fukasawa e60969
There are seven time-related functions:
fukasawa e60969
fukasawa e60969
    png_convert_to_rfc_1123_buffer() in png.c
fukasawa e60969
      (formerly png_convert_to_rfc_1152() in error, and
fukasawa e60969
      also formerly png_convert_to_rfc_1123())
fukasawa e60969
    png_convert_from_struct_tm() in pngwrite.c, called
fukasawa e60969
      in pngwrite.c
fukasawa e60969
    png_convert_from_time_t() in pngwrite.c
fukasawa e60969
    png_get_tIME() in pngget.c
fukasawa e60969
    png_handle_tIME() in pngrutil.c, called in pngread.c
fukasawa e60969
    png_set_tIME() in pngset.c
fukasawa e60969
    png_write_tIME() in pngwutil.c, called in pngwrite.c
fukasawa e60969
fukasawa e60969
All appear to handle dates properly in a Y2K environment.  The
fukasawa e60969
png_convert_from_time_t() function calls gmtime() to convert from system
fukasawa e60969
clock time, which returns (year - 1900), which we properly convert to
fukasawa e60969
the full 4-digit year.  There is a possibility that applications using
fukasawa e60969
libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
fukasawa e60969
function, or that they are incorrectly passing only a 2-digit year
fukasawa e60969
instead of "year - 1900" into the png_convert_from_struct_tm() function,
fukasawa e60969
but this is not under our control.  The libpng documentation has always
fukasawa e60969
stated that it works with 4-digit years, and the APIs have been
fukasawa e60969
documented as such.
fukasawa e60969
fukasawa e60969
The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
fukasawa e60969
integer to hold the year, and can hold years as large as 65535.
fukasawa e60969
fukasawa e60969
zlib, upon which libpng depends, is also Y2K compliant.  It contains
fukasawa e60969
no date-related code.
fukasawa e60969
fukasawa e60969
fukasawa e60969
   Glenn Randers-Pehrson
fukasawa e60969
   libpng maintainer
fukasawa e60969
   PNG Development Group
fukasawa e60969
fukasawa e60969
.SH NOTE
fukasawa e60969
fukasawa e60969
Note about libpng version numbers:
fukasawa e60969
fukasawa e60969
Due to various miscommunications, unforeseen code incompatibilities
fukasawa e60969
and occasional factors outside the authors' control, version numbering
fukasawa e60969
on the library has not always been consistent and straightforward.
fukasawa e60969
The following table summarizes matters since version 0.89c, which was
fukasawa e60969
the first widely used release:
fukasawa e60969
fukasawa e60969
 source             png.h  png.h  shared-lib
fukasawa e60969
 version            string   int  version
fukasawa e60969
 -------            ------  ----- ----------
fukasawa e60969
 0.89c "1.0 beta 3"     0.89      89  1.0.89
fukasawa e60969
 0.90  "1.0 beta 4"     0.90      90  0.90  [should have been 2.0.90]
fukasawa e60969
 0.95  "1.0 beta 5"     0.95      95  0.95  [should have been 2.0.95]
fukasawa e60969
 0.96  "1.0 beta 6"     0.96      96  0.96  [should have been 2.0.96]
fukasawa e60969
 0.97b "1.00.97 beta 7" 1.00.97   97  1.0.1 [should have been 2.0.97]
fukasawa e60969
 0.97c                  0.97      97  2.0.97
fukasawa e60969
 0.98                   0.98      98  2.0.98
fukasawa e60969
 0.99                   0.99      98  2.0.99
fukasawa e60969
 0.99a-m                0.99      99  2.0.99
fukasawa e60969
 1.00                   1.00     100  2.1.0 [100 should be 10000]
fukasawa e60969
 1.0.0      (from here on, the   100  2.1.0 [100 should be 10000]
fukasawa e60969
 1.0.1       png.h string is   10001  2.1.0
fukasawa e60969
 1.0.1a-e    identical to the  10002  from here on, the shared library
fukasawa e60969
 1.0.2       source version)   10002  is 2.V where V is the source code
fukasawa e60969
 1.0.2a-b                      10003  version, except as noted.
fukasawa e60969
 1.0.3                         10003
fukasawa e60969
 1.0.3a-d                      10004
fukasawa e60969
 1.0.4                         10004
fukasawa e60969
 1.0.4a-f                      10005
fukasawa e60969
 1.0.5 (+ 2 patches)           10005
fukasawa e60969
 1.0.5a-d                      10006
fukasawa e60969
 1.0.5e-r                      10100 (not source compatible)
fukasawa e60969
 1.0.5s-v                      10006 (not binary compatible)
fukasawa e60969
 1.0.6 (+ 3 patches)           10006 (still binary incompatible)
fukasawa e60969
 1.0.6d-f                      10007 (still binary incompatible)
fukasawa e60969
 1.0.6g                        10007
fukasawa e60969
 1.0.6h                        10007  10.6h (testing xy.z so-numbering)
fukasawa e60969
 1.0.6i                        10007  10.6i
fukasawa e60969
 1.0.6j                        10007  2.1.0.6j (incompatible with 1.0.0)
fukasawa e60969
 1.0.7beta11-14        DLLNUM  10007  2.1.0.7beta11-14 (binary compatible)
fukasawa e60969
 1.0.7beta15-18           1    10007  2.1.0.7beta15-18 (binary compatible)
fukasawa e60969
 1.0.7rc1-2               1    10007  2.1.0.7rc1-2 (binary compatible)
fukasawa e60969
 1.0.7                    1    10007  (still compatible)
fukasawa e60969
 ...
fukasawa e60969
 1.0.19                  10    10019  10.so.0.19[.0]
fukasawa e60969
 ...
fukasawa e60969
 1.2.53                  13    10253  12.so.0.53[.0]
fukasawa e60969
 ...
fukasawa e60969
 1.5.23                  15    10523  15.so.15.23[.0]
fukasawa e60969
 ...
fukasawa e60969
 1.6.21                  16    10621  16.so.16.21[.0]
fukasawa e60969
fukasawa e60969
Henceforth the source version will match the shared-library minor
fukasawa e60969
and patch numbers; the shared-library major version number will be
fukasawa e60969
used for changes in backward compatibility, as it is intended.  The
fukasawa e60969
PNG_PNGLIB_VER macro, which is not used within libpng but is available
fukasawa e60969
for applications, is an unsigned integer of the form xyyzz corresponding
fukasawa e60969
to the source version x.y.z (leading zeros in y and z).  Beta versions
fukasawa e60969
were given the previous public release number plus a letter, until
fukasawa e60969
version 1.0.6j; from then on they were given the upcoming public
fukasawa e60969
release number plus "betaNN" or "rcNN".
fukasawa e60969
fukasawa e60969
.SH "SEE ALSO"
fukasawa e60969
.IR libpngpf(3) ", " png(5)
fukasawa e60969
.LP
fukasawa e60969
.IR libpng :
fukasawa e60969
.IP
fukasawa e60969
http://libpng.sourceforge.net (follow the [DOWNLOAD] link)
fukasawa e60969
http://www.libpng.org/pub/png
fukasawa e60969
fukasawa e60969
.LP
fukasawa e60969
.IR zlib :
fukasawa e60969
.IP
fukasawa e60969
(generally) at the same location as
fukasawa e60969
.I libpng
fukasawa e60969
or at
fukasawa e60969
.br
fukasawa e60969
ftp://ftp.info-zip.org/pub/infozip/zlib
fukasawa e60969
fukasawa e60969
.LP
fukasawa e60969
.IR PNG specification: RFC 2083
fukasawa e60969
.IP
fukasawa e60969
(generally) at the same location as
fukasawa e60969
.I libpng
fukasawa e60969
or at
fukasawa e60969
.br
fukasawa e60969
ftp://ftp.rfc-editor.org:/in-notes/rfc2083.txt
fukasawa e60969
.br
fukasawa e60969
or (as a W3C Recommendation) at
fukasawa e60969
.br
fukasawa e60969
http://www.w3.org/TR/REC-png.html
fukasawa e60969
fukasawa e60969
.LP
fukasawa e60969
In the case of any inconsistency between the PNG specification
fukasawa e60969
and this library, the specification takes precedence.
fukasawa e60969
fukasawa e60969
.SH AUTHORS
fukasawa e60969
This man page: Glenn Randers-Pehrson
fukasawa e60969
<glennrp at users.sourceforge.net>
fukasawa e60969
fukasawa e60969
The contributing authors would like to thank all those who helped
fukasawa e60969
with testing, bug fixes, and patience.  This wouldn't have been
fukasawa e60969
possible without all of you.
fukasawa e60969
fukasawa e60969
Thanks to Frank J. T. Wojcik for helping with the documentation.
fukasawa e60969
fukasawa e60969
Libpng version 1.6.21 - January 15, 2016:
fukasawa e60969
Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
fukasawa e60969
Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
fukasawa e60969
fukasawa e60969
Supported by the PNG development group
fukasawa e60969
.br
fukasawa e60969
png-mng-implement at lists.sf.net
fukasawa e60969
(subscription required; visit
fukasawa e60969
png-mng-implement at lists.sourceforge.net (subscription required; visit
fukasawa e60969
https://lists.sourceforge.net/lists/listinfo/png-mng-implement
fukasawa e60969
to subscribe).
fukasawa e60969
fukasawa e60969
.SH NOTICES:
fukasawa e60969
fukasawa e60969
This copy of the libpng notices is provided for your convenience.  In case of
fukasawa e60969
any discrepancy between this copy and the notices in the file png.h that is
fukasawa e60969
included in the libpng distribution, the latter shall prevail.
fukasawa e60969
fukasawa e60969
COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
fukasawa e60969
fukasawa e60969
If you modify libpng you may insert additional notices immediately following
fukasawa e60969
this sentence.
fukasawa e60969
fukasawa e60969
This code is released under the libpng license.
fukasawa e60969
fukasawa e60969
libpng versions 1.0.7, July 1, 2000, through 1.6.21, January 15, 2016, are
fukasawa e60969
Copyright (c) 2000-2002, 2004, 2006-2016 Glenn Randers-Pehrson, are
fukasawa e60969
derived from libpng-1.0.6, and are distributed according to the same
fukasawa e60969
disclaimer and license as libpng-1.0.6 with the following individuals
fukasawa e60969
added to the list of Contributing Authors:
fukasawa e60969
fukasawa e60969
   Simon-Pierre Cadieux
fukasawa e60969
   Eric S. Raymond
fukasawa e60969
   Mans Rullgard
fukasawa e60969
   Cosmin Truta
fukasawa e60969
   Gilles Vollant
fukasawa e60969
   James Yu
fukasawa e60969
fukasawa e60969
and with the following additions to the disclaimer:
fukasawa e60969
fukasawa e60969
   There is no warranty against interference with your enjoyment of the
fukasawa e60969
   library or against infringement.  There is no warranty that our
fukasawa e60969
   efforts or the library will fulfill any of your particular purposes
fukasawa e60969
   or needs.  This library is provided with all faults, and the entire
fukasawa e60969
   risk of satisfactory quality, performance, accuracy, and effort is with
fukasawa e60969
   the user.
fukasawa e60969
fukasawa e60969
libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
fukasawa e60969
Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from
fukasawa e60969
libpng-0.96, and are distributed according to the same disclaimer and
fukasawa e60969
license as libpng-0.96, with the following individuals added to the list
fukasawa e60969
of Contributing Authors:
fukasawa e60969
fukasawa e60969
   Tom Lane
fukasawa e60969
   Glenn Randers-Pehrson
fukasawa e60969
   Willem van Schaik
fukasawa e60969
fukasawa e60969
libpng versions 0.89, June 1996, through 0.96, May 1997, are
fukasawa e60969
Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,
fukasawa e60969
and are distributed according to the same disclaimer and license as
fukasawa e60969
libpng-0.88, with the following individuals added to the list of
fukasawa e60969
Contributing Authors:
fukasawa e60969
fukasawa e60969
   John Bowler
fukasawa e60969
   Kevin Bracey
fukasawa e60969
   Sam Bushell
fukasawa e60969
   Magnus Holmgren
fukasawa e60969
   Greg Roelofs
fukasawa e60969
   Tom Tanner
fukasawa e60969
fukasawa e60969
libpng versions 0.5, May 1995, through 0.88, January 1996, are
fukasawa e60969
Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
fukasawa e60969
fukasawa e60969
For the purposes of this copyright and license, "Contributing Authors"
fukasawa e60969
is defined as the following set of individuals:
fukasawa e60969
fukasawa e60969
   Andreas Dilger
fukasawa e60969
   Dave Martindale
fukasawa e60969
   Guy Eric Schalnat
fukasawa e60969
   Paul Schmidt
fukasawa e60969
   Tim Wegner
fukasawa e60969
fukasawa e60969
The PNG Reference Library is supplied "AS IS".  The Contributing Authors
fukasawa e60969
and Group 42, Inc. disclaim all warranties, expressed or implied,
fukasawa e60969
including, without limitation, the warranties of merchantability and of
fukasawa e60969
fitness for any purpose.  The Contributing Authors and Group 42, Inc.
fukasawa e60969
assume no liability for direct, indirect, incidental, special, exemplary,
fukasawa e60969
or consequential damages, which may result from the use of the PNG
fukasawa e60969
Reference Library, even if advised of the possibility of such damage.
fukasawa e60969
fukasawa e60969
Permission is hereby granted to use, copy, modify, and distribute this
fukasawa e60969
source code, or portions hereof, for any purpose, without fee, subject
fukasawa e60969
to the following restrictions:
fukasawa e60969
fukasawa e60969
  1. The origin of this source code must not be misrepresented.
fukasawa e60969
fukasawa e60969
  2. Altered versions must be plainly marked as such and must not
fukasawa e60969
     be misrepresented as being the original source.
fukasawa e60969
fukasawa e60969
  3. This Copyright notice may not be removed or altered from any
fukasawa e60969
     source or altered source distribution.
fukasawa e60969
fukasawa e60969
The Contributing Authors and Group 42, Inc. specifically permit, without
fukasawa e60969
fee, and encourage the use of this source code as a component to
fukasawa e60969
supporting the PNG file format in commercial products.  If you use this
fukasawa e60969
source code in a product, acknowledgment is not required but would be
fukasawa e60969
appreciated.
fukasawa e60969
fukasawa e60969
END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.
fukasawa e60969
fukasawa e60969
A "png_get_copyright" function is available, for convenient use in "about"
fukasawa e60969
boxes and the like:
fukasawa e60969
fukasawa e60969
   printf("%s", png_get_copyright(NULL));
fukasawa e60969
fukasawa e60969
Also, the PNG logo (in PNG format, of course) is supplied in the
fukasawa e60969
files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
fukasawa e60969
fukasawa e60969
Libpng is OSI Certified Open Source Software.  OSI Certified Open Source is
fukasawa e60969
a certification mark of the Open Source Initiative. OSI has not addressed
fukasawa e60969
the additional disclaimers inserted at version 1.0.7.
fukasawa e60969
fukasawa e60969
Glenn Randers-Pehrson
fukasawa e60969
glennrp at users.sourceforge.net
fukasawa e60969
January 15, 2016
fukasawa e60969
fukasawa e60969
.\" end of man page
fukasawa e60969