Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(37)

Side by Side Diff: third_party/libpng/libpng.3

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

Powered by Google App Engine
This is Rietveld 408576698