blob: e251007977fdb1c9358fdb1fda7ef6f0ce7e3e1c [file] [log] [blame]
Chris Craikb50c2172013-07-29 15:28:30 -07001
The Android Open Source Project893912b2009-03-03 19:30:05 -08002/* png.h - header file for PNG reference library
3 *
Chris Craikb50c2172013-07-29 15:28:30 -07004 * libpng version 1.6.3 - July 18, 2013
5 * Copyright (c) 1998-2013 Glenn Randers-Pehrson
The Android Open Source Project893912b2009-03-03 19:30:05 -08006 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8 *
Patrick Scotta0bb96c2009-07-22 11:50:02 -04009 * This code is released under the libpng license (See LICENSE, below)
10 *
The Android Open Source Project893912b2009-03-03 19:30:05 -080011 * Authors and maintainers:
Chris Craikb50c2172013-07-29 15:28:30 -070012 * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
13 * libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger
14 * libpng versions 0.97, January 1998, through 1.6.3 - July 18, 2013: Glenn
15 * See also "Contributing Authors", below.
The Android Open Source Project893912b2009-03-03 19:30:05 -080016 *
17 * Note about libpng version numbers:
18 *
Chris Craikb50c2172013-07-29 15:28:30 -070019 * Due to various miscommunications, unforeseen code incompatibilities
20 * and occasional factors outside the authors' control, version numbering
21 * on the library has not always been consistent and straightforward.
22 * The following table summarizes matters since version 0.89c, which was
23 * the first widely used release:
The Android Open Source Project893912b2009-03-03 19:30:05 -080024 *
25 * source png.h png.h shared-lib
26 * version string int version
27 * ------- ------ ----- ----------
28 * 0.89c "1.0 beta 3" 0.89 89 1.0.89
29 * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
30 * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
31 * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
32 * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
33 * 0.97c 0.97 97 2.0.97
34 * 0.98 0.98 98 2.0.98
35 * 0.99 0.99 98 2.0.99
36 * 0.99a-m 0.99 99 2.0.99
37 * 1.00 1.00 100 2.1.0 [100 should be 10000]
38 * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
39 * 1.0.1 png.h string is 10001 2.1.0
40 * 1.0.1a-e identical to the 10002 from here on, the shared library
41 * 1.0.2 source version) 10002 is 2.V where V is the source code
42 * 1.0.2a-b 10003 version, except as noted.
43 * 1.0.3 10003
44 * 1.0.3a-d 10004
45 * 1.0.4 10004
46 * 1.0.4a-f 10005
47 * 1.0.5 (+ 2 patches) 10005
48 * 1.0.5a-d 10006
49 * 1.0.5e-r 10100 (not source compatible)
50 * 1.0.5s-v 10006 (not binary compatible)
51 * 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
52 * 1.0.6d-f 10007 (still binary incompatible)
53 * 1.0.6g 10007
54 * 1.0.6h 10007 10.6h (testing xy.z so-numbering)
55 * 1.0.6i 10007 10.6i
56 * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
57 * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
58 * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
59 * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
60 * 1.0.7 1 10007 (still compatible)
61 * 1.0.8beta1-4 1 10008 2.1.0.8beta1-4
62 * 1.0.8rc1 1 10008 2.1.0.8rc1
63 * 1.0.8 1 10008 2.1.0.8
64 * 1.0.9beta1-6 1 10009 2.1.0.9beta1-6
65 * 1.0.9rc1 1 10009 2.1.0.9rc1
66 * 1.0.9beta7-10 1 10009 2.1.0.9beta7-10
67 * 1.0.9rc2 1 10009 2.1.0.9rc2
68 * 1.0.9 1 10009 2.1.0.9
69 * 1.0.10beta1 1 10010 2.1.0.10beta1
70 * 1.0.10rc1 1 10010 2.1.0.10rc1
71 * 1.0.10 1 10010 2.1.0.10
72 * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3
73 * 1.0.11rc1 1 10011 2.1.0.11rc1
74 * 1.0.11 1 10011 2.1.0.11
75 * 1.0.12beta1-2 2 10012 2.1.0.12beta1-2
76 * 1.0.12rc1 2 10012 2.1.0.12rc1
77 * 1.0.12 2 10012 2.1.0.12
78 * 1.1.0a-f - 10100 2.1.1.0a-f (branch abandoned)
79 * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2
80 * 1.2.0beta3-5 3 10200 3.1.2.0beta3-5
81 * 1.2.0rc1 3 10200 3.1.2.0rc1
82 * 1.2.0 3 10200 3.1.2.0
83 * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4
84 * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2
85 * 1.2.1 3 10201 3.1.2.1
86 * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6
87 * 1.0.13beta1 10 10013 10.so.0.1.0.13beta1
88 * 1.0.13rc1 10 10013 10.so.0.1.0.13rc1
89 * 1.2.2rc1 12 10202 12.so.0.1.2.2rc1
90 * 1.0.13 10 10013 10.so.0.1.0.13
91 * 1.2.2 12 10202 12.so.0.1.2.2
92 * 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6
93 * 1.2.3 12 10203 12.so.0.1.2.3
94 * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3
95 * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1
96 * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1
97 * 1.0.14 10 10014 10.so.0.1.0.14
98 * 1.2.4 13 10204 12.so.0.1.2.4
99 * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2
100 * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3
101 * 1.2.5rc1-3 13 10205 12.so.0.1.2.5rc1-3
102 * 1.0.15 10 10015 10.so.0.1.0.15
103 * 1.2.5 13 10205 12.so.0.1.2.5
104 * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4
105 * 1.0.16 10 10016 10.so.0.1.0.16
106 * 1.2.6 13 10206 12.so.0.1.2.6
107 * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2
Chris Craikb50c2172013-07-29 15:28:30 -0700108 * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1
The Android Open Source Project893912b2009-03-03 19:30:05 -0800109 * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1
Chris Craikb50c2172013-07-29 15:28:30 -0700110 * 1.0.17 10 10017 12.so.0.1.0.17
The Android Open Source Project893912b2009-03-03 19:30:05 -0800111 * 1.2.7 13 10207 12.so.0.1.2.7
112 * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5
Chris Craikb50c2172013-07-29 15:28:30 -0700113 * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5
The Android Open Source Project893912b2009-03-03 19:30:05 -0800114 * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5
Chris Craikb50c2172013-07-29 15:28:30 -0700115 * 1.0.18 10 10018 12.so.0.1.0.18
The Android Open Source Project893912b2009-03-03 19:30:05 -0800116 * 1.2.8 13 10208 12.so.0.1.2.8
117 * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3
118 * 1.2.9beta4-11 13 10209 12.so.0.9[.0]
119 * 1.2.9rc1 13 10209 12.so.0.9[.0]
120 * 1.2.9 13 10209 12.so.0.9[.0]
Chris Craikb50c2172013-07-29 15:28:30 -0700121 * 1.2.10beta1-7 13 10210 12.so.0.10[.0]
122 * 1.2.10rc1-2 13 10210 12.so.0.10[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800123 * 1.2.10 13 10210 12.so.0.10[.0]
Chris Craikb50c2172013-07-29 15:28:30 -0700124 * 1.4.0beta1-5 14 10400 14.so.0.0[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800125 * 1.2.11beta1-4 13 10211 12.so.0.11[.0]
Chris Craikb50c2172013-07-29 15:28:30 -0700126 * 1.4.0beta7-8 14 10400 14.so.0.0[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800127 * 1.2.11 13 10211 12.so.0.11[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800128 * 1.2.12 13 10212 12.so.0.12[.0]
Chris Craikb50c2172013-07-29 15:28:30 -0700129 * 1.4.0beta9-14 14 10400 14.so.0.0[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800130 * 1.2.13 13 10213 12.so.0.13[.0]
Chris Craikb50c2172013-07-29 15:28:30 -0700131 * 1.4.0beta15-36 14 10400 14.so.0.0[.0]
132 * 1.4.0beta37-87 14 10400 14.so.14.0[.0]
133 * 1.4.0rc01 14 10400 14.so.14.0[.0]
134 * 1.4.0beta88-109 14 10400 14.so.14.0[.0]
135 * 1.4.0rc02-08 14 10400 14.so.14.0[.0]
136 * 1.4.0 14 10400 14.so.14.0[.0]
137 * 1.4.1beta01-03 14 10401 14.so.14.1[.0]
138 * 1.4.1rc01 14 10401 14.so.14.1[.0]
139 * 1.4.1beta04-12 14 10401 14.so.14.1[.0]
140 * 1.4.1 14 10401 14.so.14.1[.0]
141 * 1.4.2 14 10402 14.so.14.2[.0]
142 * 1.4.3 14 10403 14.so.14.3[.0]
143 * 1.4.4 14 10404 14.so.14.4[.0]
144 * 1.5.0beta01-58 15 10500 15.so.15.0[.0]
145 * 1.5.0rc01-07 15 10500 15.so.15.0[.0]
146 * 1.5.0 15 10500 15.so.15.0[.0]
147 * 1.5.1beta01-11 15 10501 15.so.15.1[.0]
148 * 1.5.1rc01-02 15 10501 15.so.15.1[.0]
149 * 1.5.1 15 10501 15.so.15.1[.0]
150 * 1.5.2beta01-03 15 10502 15.so.15.2[.0]
151 * 1.5.2rc01-03 15 10502 15.so.15.2[.0]
152 * 1.5.2 15 10502 15.so.15.2[.0]
153 * 1.5.3beta01-10 15 10503 15.so.15.3[.0]
154 * 1.5.3rc01-02 15 10503 15.so.15.3[.0]
155 * 1.5.3beta11 15 10503 15.so.15.3[.0]
156 * 1.5.3 [omitted]
157 * 1.5.4beta01-08 15 10504 15.so.15.4[.0]
158 * 1.5.4rc01 15 10504 15.so.15.4[.0]
159 * 1.5.4 15 10504 15.so.15.4[.0]
160 * 1.5.5beta01-08 15 10505 15.so.15.5[.0]
161 * 1.5.5rc01 15 10505 15.so.15.5[.0]
162 * 1.5.5 15 10505 15.so.15.5[.0]
163 * 1.5.6beta01-07 15 10506 15.so.15.6[.0]
164 * 1.5.6rc01-03 15 10506 15.so.15.6[.0]
165 * 1.5.6 15 10506 15.so.15.6[.0]
166 * 1.5.7beta01-05 15 10507 15.so.15.7[.0]
167 * 1.5.7rc01-03 15 10507 15.so.15.7[.0]
168 * 1.5.7 15 10507 15.so.15.7[.0]
169 * 1.6.0beta01-40 16 10600 16.so.16.0[.0]
170 * 1.6.0rc01-08 16 10600 16.so.16.0[.0]
171 * 1.6.0 16 10600 16.so.16.0[.0]
172 * 1.6.1beta01-09 16 10601 16.so.16.1[.0]
173 * 1.6.1rc01 16 10601 16.so.16.1[.0]
174 * 1.6.1 16 10601 16.so.16.1[.0]
175 * 1.6.2beta01 16 10602 16.so.16.2[.0]
176 * 1.6.2rc01-06 16 10602 16.so.16.2[.0]
177 * 1.6.2 16 10602 16.so.16.2[.0]
178 * 1.6.3beta01-11 16 10603 16.so.16.3[.0]
179 * 1.6.3rc01 16 10603 16.so.16.3[.0]
180 * 1.6.3 16 10603 16.so.16.3[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800181 *
Chris Craikb50c2172013-07-29 15:28:30 -0700182 * Henceforth the source version will match the shared-library major
183 * and minor numbers; the shared-library major version number will be
184 * used for changes in backward compatibility, as it is intended. The
185 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
186 * for applications, is an unsigned integer of the form xyyzz corresponding
187 * to the source version x.y.z (leading zeros in y and z). Beta versions
188 * were given the previous public release number plus a letter, until
189 * version 1.0.6j; from then on they were given the upcoming public
190 * release number plus "betaNN" or "rcNN".
The Android Open Source Project893912b2009-03-03 19:30:05 -0800191 *
Chris Craikb50c2172013-07-29 15:28:30 -0700192 * Binary incompatibility exists only when applications make direct access
193 * to the info_ptr or png_ptr members through png.h, and the compiled
194 * application is loaded with a different version of the library.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800195 *
Chris Craikb50c2172013-07-29 15:28:30 -0700196 * DLLNUM will change each time there are forward or backward changes
197 * in binary compatibility (e.g., when a new feature is added).
The Android Open Source Project893912b2009-03-03 19:30:05 -0800198 *
Chris Craikb50c2172013-07-29 15:28:30 -0700199 * See libpng-manual.txt or libpng.3 for more information. The PNG
200 * specification is available as a W3C Recommendation and as an ISO
201 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
The Android Open Source Project893912b2009-03-03 19:30:05 -0800202 */
203
204/*
205 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
206 *
207 * If you modify libpng you may insert additional notices immediately following
208 * this sentence.
209 *
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400210 * This code is released under the libpng license.
211 *
Chris Craikb50c2172013-07-29 15:28:30 -0700212 * libpng versions 1.2.6, August 15, 2004, through 1.6.3, July 18, 2013, are
213 * Copyright (c) 2004, 2006-2013 Glenn Randers-Pehrson, and are
The Android Open Source Project893912b2009-03-03 19:30:05 -0800214 * distributed according to the same disclaimer and license as libpng-1.2.5
215 * with the following individual added to the list of Contributing Authors:
216 *
217 * Cosmin Truta
218 *
219 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
220 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
221 * distributed according to the same disclaimer and license as libpng-1.0.6
222 * with the following individuals added to the list of Contributing Authors:
223 *
224 * Simon-Pierre Cadieux
225 * Eric S. Raymond
226 * Gilles Vollant
227 *
228 * and with the following additions to the disclaimer:
229 *
230 * There is no warranty against interference with your enjoyment of the
231 * library or against infringement. There is no warranty that our
232 * efforts or the library will fulfill any of your particular purposes
233 * or needs. This library is provided with all faults, and the entire
234 * risk of satisfactory quality, performance, accuracy, and effort is with
235 * the user.
236 *
237 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
238 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
239 * distributed according to the same disclaimer and license as libpng-0.96,
240 * with the following individuals added to the list of Contributing Authors:
241 *
242 * Tom Lane
243 * Glenn Randers-Pehrson
244 * Willem van Schaik
245 *
246 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
247 * Copyright (c) 1996, 1997 Andreas Dilger
248 * Distributed according to the same disclaimer and license as libpng-0.88,
249 * with the following individuals added to the list of Contributing Authors:
250 *
251 * John Bowler
252 * Kevin Bracey
253 * Sam Bushell
254 * Magnus Holmgren
255 * Greg Roelofs
256 * Tom Tanner
257 *
258 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
259 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
260 *
261 * For the purposes of this copyright and license, "Contributing Authors"
262 * is defined as the following set of individuals:
263 *
264 * Andreas Dilger
265 * Dave Martindale
266 * Guy Eric Schalnat
267 * Paul Schmidt
268 * Tim Wegner
269 *
270 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
271 * and Group 42, Inc. disclaim all warranties, expressed or implied,
272 * including, without limitation, the warranties of merchantability and of
273 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
274 * assume no liability for direct, indirect, incidental, special, exemplary,
275 * or consequential damages, which may result from the use of the PNG
276 * Reference Library, even if advised of the possibility of such damage.
277 *
278 * Permission is hereby granted to use, copy, modify, and distribute this
279 * source code, or portions hereof, for any purpose, without fee, subject
280 * to the following restrictions:
281 *
Chris Craikb50c2172013-07-29 15:28:30 -0700282 * 1. The origin of this source code must not be misrepresented.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800283 *
Chris Craikb50c2172013-07-29 15:28:30 -0700284 * 2. Altered versions must be plainly marked as such and must not
285 * be misrepresented as being the original source.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800286 *
Chris Craikb50c2172013-07-29 15:28:30 -0700287 * 3. This Copyright notice may not be removed or altered from
288 * any source or altered source distribution.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800289 *
290 * The Contributing Authors and Group 42, Inc. specifically permit, without
291 * fee, and encourage the use of this source code as a component to
292 * supporting the PNG file format in commercial products. If you use this
293 * source code in a product, acknowledgment is not required but would be
294 * appreciated.
295 */
296
297/*
298 * A "png_get_copyright" function is available, for convenient use in "about"
299 * boxes and the like:
300 *
Chris Craikb50c2172013-07-29 15:28:30 -0700301 * printf("%s", png_get_copyright(NULL));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800302 *
303 * Also, the PNG logo (in PNG format, of course) is supplied in the
304 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
305 */
306
307/*
308 * Libpng is OSI Certified Open Source Software. OSI Certified is a
309 * certification mark of the Open Source Initiative.
310 */
311
312/*
313 * The contributing authors would like to thank all those who helped
314 * with testing, bug fixes, and patience. This wouldn't have been
315 * possible without all of you.
316 *
317 * Thanks to Frank J. T. Wojcik for helping with the documentation.
318 */
319
320/*
321 * Y2K compliance in libpng:
322 * =========================
323 *
Chris Craikb50c2172013-07-29 15:28:30 -0700324 * July 18, 2013
The Android Open Source Project893912b2009-03-03 19:30:05 -0800325 *
326 * Since the PNG Development group is an ad-hoc body, we can't make
327 * an official declaration.
328 *
329 * This is your unofficial assurance that libpng from version 0.71 and
Chris Craikb50c2172013-07-29 15:28:30 -0700330 * upward through 1.6.3 are Y2K compliant. It is my belief that
331 * earlier versions were also Y2K compliant.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800332 *
Chris Craikb50c2172013-07-29 15:28:30 -0700333 * Libpng only has two year fields. One is a 2-byte unsigned integer
334 * that will hold years up to 65535. The other, which is deprecated,
335 * holds the date in text format, and will hold years up to 9999.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800336 *
337 * The integer is
338 * "png_uint_16 year" in png_time_struct.
339 *
Chris Craikb50c2172013-07-29 15:28:30 -0700340 * The string is
341 * "char time_buffer[29]" in png_struct. This is no longer used
342 * in libpng-1.6.x and will be removed from libpng-1.7.0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800343 *
344 * There are seven time-related functions:
Chris Craikb50c2172013-07-29 15:28:30 -0700345 * png.c: png_convert_to_rfc_1123_buffer() in png.c
346 * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
347 * png_convert_to_rfc_1152() in error prior to libpng-0.98)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800348 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
349 * png_convert_from_time_t() in pngwrite.c
350 * png_get_tIME() in pngget.c
351 * png_handle_tIME() in pngrutil.c, called in pngread.c
352 * png_set_tIME() in pngset.c
353 * png_write_tIME() in pngwutil.c, called in pngwrite.c
354 *
355 * All handle dates properly in a Y2K environment. The
356 * png_convert_from_time_t() function calls gmtime() to convert from system
357 * clock time, which returns (year - 1900), which we properly convert to
Chris Craikb50c2172013-07-29 15:28:30 -0700358 * the full 4-digit year. There is a possibility that libpng applications
359 * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
The Android Open Source Project893912b2009-03-03 19:30:05 -0800360 * function, or that they are incorrectly passing only a 2-digit year
361 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
362 * but this is not under our control. The libpng documentation has always
363 * stated that it works with 4-digit years, and the APIs have been
364 * documented as such.
365 *
366 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
367 * integer to hold the year, and can hold years as large as 65535.
368 *
369 * zlib, upon which libpng depends, is also Y2K compliant. It contains
370 * no date-related code.
371 *
372 * Glenn Randers-Pehrson
373 * libpng maintainer
374 * PNG Development Group
375 */
376
377#ifndef PNG_H
378#define PNG_H
379
Chris Craikb50c2172013-07-29 15:28:30 -0700380/* This is not the place to learn how to use libpng. The file libpng-manual.txt
The Android Open Source Project893912b2009-03-03 19:30:05 -0800381 * describes how to use libpng, and the file example.c summarizes it
382 * with some code on which to build. This file is useful for looking
383 * at the actual function definitions and structure components.
Chris Craikb50c2172013-07-29 15:28:30 -0700384 *
385 * If you just need to read a PNG file and don't want to read the documentation
386 * skip to the end of this file and read the section entitled 'simplified API'.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800387 */
388
389/* Version information for png.h - this should match the version in png.c */
Chris Craikb50c2172013-07-29 15:28:30 -0700390#define PNG_LIBPNG_VER_STRING "1.6.3"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800391#define PNG_HEADER_VERSION_STRING \
Chris Craikb50c2172013-07-29 15:28:30 -0700392 " libpng version 1.6.3 - July 18, 2013\n"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800393
Chris Craikb50c2172013-07-29 15:28:30 -0700394#define PNG_LIBPNG_VER_SONUM 16
395#define PNG_LIBPNG_VER_DLLNUM 16
The Android Open Source Project893912b2009-03-03 19:30:05 -0800396
397/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
398#define PNG_LIBPNG_VER_MAJOR 1
Chris Craikb50c2172013-07-29 15:28:30 -0700399#define PNG_LIBPNG_VER_MINOR 6
400#define PNG_LIBPNG_VER_RELEASE 3
401
The Android Open Source Project893912b2009-03-03 19:30:05 -0800402/* This should match the numeric part of the final component of
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400403 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
404 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800405
406#define PNG_LIBPNG_VER_BUILD 0
407
408/* Release Status */
409#define PNG_LIBPNG_BUILD_ALPHA 1
410#define PNG_LIBPNG_BUILD_BETA 2
411#define PNG_LIBPNG_BUILD_RC 3
412#define PNG_LIBPNG_BUILD_STABLE 4
413#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400414
The Android Open Source Project893912b2009-03-03 19:30:05 -0800415/* Release-Specific Flags */
416#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
417 PNG_LIBPNG_BUILD_STABLE only */
418#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
419 PNG_LIBPNG_BUILD_SPECIAL */
420#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
421 PNG_LIBPNG_BUILD_PRIVATE */
422
423#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE
424
425/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
426 * We must not include leading zeros.
427 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
428 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400429 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
430 */
Chris Craikb50c2172013-07-29 15:28:30 -0700431#define PNG_LIBPNG_VER 10603 /* 1.6.3 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800432
Chris Craikb50c2172013-07-29 15:28:30 -0700433/* Library configuration: these options cannot be changed after
434 * the library has been built.
435 */
436#ifndef PNGLCONF_H
437 /* If pnglibconf.h is missing, you can
438 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
439 */
440# include "pnglibconf.h"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800441#endif
442
Chris Craikb50c2172013-07-29 15:28:30 -0700443#ifndef PNG_VERSION_INFO_ONLY
444 /* Machine specific configuration. */
445# include "pngconf.h"
446#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800447
448/*
Chris Craikb50c2172013-07-29 15:28:30 -0700449 * Added at libpng-1.2.8
450 *
451 * Ref MSDN: Private as priority over Special
The Android Open Source Project893912b2009-03-03 19:30:05 -0800452 * VS_FF_PRIVATEBUILD File *was not* built using standard release
453 * procedures. If this value is given, the StringFileInfo block must
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400454 * contain a PrivateBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800455 *
456 * VS_FF_SPECIALBUILD File *was* built by the original company using
457 * standard release procedures but is a variation of the standard
458 * file of the same version number. If this value is given, the
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400459 * StringFileInfo block must contain a SpecialBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800460 */
461
Chris Craikb50c2172013-07-29 15:28:30 -0700462#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800463# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700464 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800465#else
Patrick Scott5f6bd842010-06-28 16:55:16 -0400466# ifdef PNG_LIBPNG_SPECIALBUILD
The Android Open Source Project893912b2009-03-03 19:30:05 -0800467# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700468 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800469# else
470# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
471# endif
472#endif
473
474#ifndef PNG_VERSION_INFO_ONLY
475
476/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
477#ifdef __cplusplus
478extern "C" {
479#endif /* __cplusplus */
480
The Android Open Source Project893912b2009-03-03 19:30:05 -0800481/* Version information for C files, stored in png.c. This had better match
482 * the version above.
483 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800484#define png_libpng_ver png_get_header_ver(NULL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800485
Chris Craikb50c2172013-07-29 15:28:30 -0700486/* This file is arranged in several sections:
487 *
488 * 1. Any configuration options that can be specified by for the application
489 * code when it is built. (Build time configuration is in pnglibconf.h)
490 * 2. Type definitions (base types are defined in pngconf.h), structure
491 * definitions.
492 * 3. Exported library functions.
493 * 4. Simplified API.
494 *
495 * The library source code has additional files (principally pngpriv.h) that
496 * allow configuration of the library.
497 */
498/* Section 1: run time configuration
499 * See pnglibconf.h for build time configuration
500 *
501 * Run time configuration allows the application to choose between
502 * implementations of certain arithmetic APIs. The default is set
503 * at build time and recorded in pnglibconf.h, but it is safe to
504 * override these (and only these) settings. Note that this won't
505 * change what the library does, only application code, and the
506 * settings can (and probably should) be made on a per-file basis
507 * by setting the #defines before including png.h
508 *
509 * Use macros to read integers from PNG data or use the exported
510 * functions?
511 * PNG_USE_READ_MACROS: use the macros (see below) Note that
512 * the macros evaluate their argument multiple times.
513 * PNG_NO_USE_READ_MACROS: call the relevant library function.
514 *
515 * Use the alternative algorithm for compositing alpha samples that
516 * does not use division?
517 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
518 * algorithm.
519 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
520 *
521 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
522 * false?
523 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
524 * APIs to png_warning.
525 * Otherwise the calls are mapped to png_error.
526 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800527
Chris Craikb50c2172013-07-29 15:28:30 -0700528/* Section 2: type definitions, including structures and compile time
529 * constants.
530 * See pngconf.h for base types that vary by machine/system
531 */
532
533/* This triggers a compiler error in png.c, if png.c and png.h
534 * do not agree upon the version number.
535 */
536typedef char* png_libpng_version_1_6_3;
537
538/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
539 *
540 * png_struct is the cache of information used while reading or writing a single
541 * PNG file. One of these is always required, although the simplified API
542 * (below) hides the creation and destruction of it.
543 */
544typedef struct png_struct_def png_struct;
545typedef const png_struct * png_const_structp;
546typedef png_struct * png_structp;
547typedef png_struct * * png_structpp;
548
549/* png_info contains information read from or to be written to a PNG file. One
550 * or more of these must exist while reading or creating a PNG file. The
551 * information is not used by libpng during read but is used to control what
552 * gets written when a PNG file is created. "png_get_" function calls read
553 * information during read and "png_set_" functions calls write information
554 * when creating a PNG.
555 * been moved into a separate header file that is not accessible to
556 * applications. Read libpng-manual.txt or libpng.3 for more info.
557 */
558typedef struct png_info_def png_info;
559typedef png_info * png_infop;
560typedef const png_info * png_const_infop;
561typedef png_info * * png_infopp;
562
563/* Types with names ending 'p' are pointer types. The corresponding types with
564 * names ending 'rp' are identical pointer types except that the pointer is
565 * marked 'restrict', which means that it is the only pointer to the object
566 * passed to the function. Applications should not use the 'restrict' types;
567 * it is always valid to pass 'p' to a pointer with a function argument of the
568 * corresponding 'rp' type. Different compilers have different rules with
569 * regard to type matching in the presence of 'restrict'. For backward
570 * compatibility libpng callbacks never have 'restrict' in their parameters and,
571 * consequentially, writing portable application code is extremely difficult if
572 * an attempt is made to use 'restrict'.
573 */
574typedef png_struct * PNG_RESTRICT png_structrp;
575typedef const png_struct * PNG_RESTRICT png_const_structrp;
576typedef png_info * PNG_RESTRICT png_inforp;
577typedef const png_info * PNG_RESTRICT png_const_inforp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800578
579/* Three color definitions. The order of the red, green, and blue, (and the
580 * exact size) is not important, although the size of the fields need to
581 * be png_byte or png_uint_16 (as defined below).
582 */
583typedef struct png_color_struct
584{
585 png_byte red;
586 png_byte green;
587 png_byte blue;
588} png_color;
Chris Craikb50c2172013-07-29 15:28:30 -0700589typedef png_color * png_colorp;
590typedef const png_color * png_const_colorp;
591typedef png_color * * png_colorpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800592
593typedef struct png_color_16_struct
594{
595 png_byte index; /* used for palette files */
596 png_uint_16 red; /* for use in red green blue files */
597 png_uint_16 green;
598 png_uint_16 blue;
599 png_uint_16 gray; /* for use in grayscale files */
600} png_color_16;
Chris Craikb50c2172013-07-29 15:28:30 -0700601typedef png_color_16 * png_color_16p;
602typedef const png_color_16 * png_const_color_16p;
603typedef png_color_16 * * png_color_16pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800604
605typedef struct png_color_8_struct
606{
607 png_byte red; /* for use in red green blue files */
608 png_byte green;
609 png_byte blue;
610 png_byte gray; /* for use in grayscale files */
611 png_byte alpha; /* for alpha channel files */
612} png_color_8;
Chris Craikb50c2172013-07-29 15:28:30 -0700613typedef png_color_8 * png_color_8p;
614typedef const png_color_8 * png_const_color_8p;
615typedef png_color_8 * * png_color_8pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800616
617/*
618 * The following two structures are used for the in-core representation
619 * of sPLT chunks.
620 */
621typedef struct png_sPLT_entry_struct
622{
623 png_uint_16 red;
624 png_uint_16 green;
625 png_uint_16 blue;
626 png_uint_16 alpha;
627 png_uint_16 frequency;
628} png_sPLT_entry;
Chris Craikb50c2172013-07-29 15:28:30 -0700629typedef png_sPLT_entry * png_sPLT_entryp;
630typedef const png_sPLT_entry * png_const_sPLT_entryp;
631typedef png_sPLT_entry * * png_sPLT_entrypp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800632
633/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
634 * occupy the LSB of their respective members, and the MSB of each member
635 * is zero-filled. The frequency member always occupies the full 16 bits.
636 */
637
638typedef struct png_sPLT_struct
639{
640 png_charp name; /* palette name */
641 png_byte depth; /* depth of palette samples */
642 png_sPLT_entryp entries; /* palette entries */
643 png_int_32 nentries; /* number of palette entries */
644} png_sPLT_t;
Chris Craikb50c2172013-07-29 15:28:30 -0700645typedef png_sPLT_t * png_sPLT_tp;
646typedef const png_sPLT_t * png_const_sPLT_tp;
647typedef png_sPLT_t * * png_sPLT_tpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800648
649#ifdef PNG_TEXT_SUPPORTED
650/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
651 * and whether that contents is compressed or not. The "key" field
Chris Craikb50c2172013-07-29 15:28:30 -0700652 * points to a regular zero-terminated C string. The "text" fields can be a
653 * regular C string, an empty string, or a NULL pointer.
654 * However, the structure returned by png_get_text() will always contain
655 * the "text" field as a regular zero-terminated C string (possibly
656 * empty), never a NULL pointer, so it can be safely used in printf() and
657 * other string-handling functions. Note that the "itxt_length", "lang", and
658 * "lang_key" members of the structure only exist when the library is built
659 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
660 * default without iTXt support. Also note that when iTXt *is* supported,
661 * the "lang" and "lang_key" fields contain NULL pointers when the
662 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
663 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
664 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
665 * which is always 0 or 1, or its "compression method" which is always 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800666 */
667typedef struct png_text_struct
668{
669 int compression; /* compression value:
670 -1: tEXt, none
671 0: zTXt, deflate
672 1: iTXt, none
673 2: iTXt, deflate */
674 png_charp key; /* keyword, 1-79 character description of "text" */
675 png_charp text; /* comment, may be an empty string (ie "")
676 or a NULL pointer */
677 png_size_t text_length; /* length of the text string */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800678 png_size_t itxt_length; /* length of the itxt string */
679 png_charp lang; /* language code, 0-79 characters
680 or a NULL pointer */
681 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
682 chars or a NULL pointer */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800683} png_text;
Chris Craikb50c2172013-07-29 15:28:30 -0700684typedef png_text * png_textp;
685typedef const png_text * png_const_textp;
686typedef png_text * * png_textpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800687#endif
688
689/* Supported compression types for text in PNG files (tEXt, and zTXt).
Chris Craikb50c2172013-07-29 15:28:30 -0700690 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800691#define PNG_TEXT_COMPRESSION_NONE_WR -3
692#define PNG_TEXT_COMPRESSION_zTXt_WR -2
693#define PNG_TEXT_COMPRESSION_NONE -1
694#define PNG_TEXT_COMPRESSION_zTXt 0
695#define PNG_ITXT_COMPRESSION_NONE 1
696#define PNG_ITXT_COMPRESSION_zTXt 2
697#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
698
699/* png_time is a way to hold the time in an machine independent way.
700 * Two conversions are provided, both from time_t and struct tm. There
701 * is no portable way to convert to either of these structures, as far
702 * as I know. If you know of a portable way, send it to me. As a side
703 * note - PNG has always been Year 2000 compliant!
704 */
705typedef struct png_time_struct
706{
707 png_uint_16 year; /* full year, as in, 1995 */
708 png_byte month; /* month of year, 1 - 12 */
709 png_byte day; /* day of month, 1 - 31 */
710 png_byte hour; /* hour of day, 0 - 23 */
711 png_byte minute; /* minute of hour, 0 - 59 */
712 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
713} png_time;
Chris Craikb50c2172013-07-29 15:28:30 -0700714typedef png_time * png_timep;
715typedef const png_time * png_const_timep;
716typedef png_time * * png_timepp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800717
Chris Craikb50c2172013-07-29 15:28:30 -0700718#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -0800719/* png_unknown_chunk is a structure to hold queued chunks for which there is
720 * no specific support. The idea is that we can use this to queue
721 * up private chunks for output even though the library doesn't actually
722 * know about their semantics.
Chris Craikb50c2172013-07-29 15:28:30 -0700723 *
724 * The data in the structure is set by libpng on read and used on write.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800725 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800726typedef struct png_unknown_chunk_t
727{
Chris Craikb50c2172013-07-29 15:28:30 -0700728 png_byte name[5]; /* Textual chunk name with '\0' terminator */
729 png_byte *data; /* Data, should not be modified on read! */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800730 png_size_t size;
731
Chris Craikb50c2172013-07-29 15:28:30 -0700732 /* On write 'location' must be set using the flag values listed below.
733 * Notice that on read it is set by libpng however the values stored have
734 * more bits set than are listed below. Always treat the value as a
735 * bitmask. On write set only one bit - setting multiple bits may cause the
736 * chunk to be written in multiple places.
737 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800738 png_byte location; /* mode of operation at read time */
739}
740png_unknown_chunk;
Chris Craikb50c2172013-07-29 15:28:30 -0700741
742typedef png_unknown_chunk * png_unknown_chunkp;
743typedef const png_unknown_chunk * png_const_unknown_chunkp;
744typedef png_unknown_chunk * * png_unknown_chunkpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800745#endif
746
Chris Craikb50c2172013-07-29 15:28:30 -0700747/* Flag values for the unknown chunk location byte. */
748#define PNG_HAVE_IHDR 0x01
749#define PNG_HAVE_PLTE 0x02
750#define PNG_AFTER_IDAT 0x08
The Android Open Source Project893912b2009-03-03 19:30:05 -0800751
752/* Maximum positive integer used in PNG is (2^31)-1 */
753#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
754#define PNG_UINT_32_MAX ((png_uint_32)(-1))
755#define PNG_SIZE_MAX ((png_size_t)(-1))
Chris Craikb50c2172013-07-29 15:28:30 -0700756
757/* These are constants for fixed point values encoded in the
758 * PNG specification manner (x100000)
759 */
760#define PNG_FP_1 100000
761#define PNG_FP_HALF 50000
762#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
763#define PNG_FP_MIN (-PNG_FP_MAX)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800764
765/* These describe the color_type field in png_info. */
766/* color type masks */
767#define PNG_COLOR_MASK_PALETTE 1
768#define PNG_COLOR_MASK_COLOR 2
769#define PNG_COLOR_MASK_ALPHA 4
770
771/* color types. Note that not all combinations are legal */
772#define PNG_COLOR_TYPE_GRAY 0
773#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
774#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
775#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
776#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
777/* aliases */
778#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
779#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
780
781/* This is for compression type. PNG 1.0-1.2 only define the single type. */
782#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
783#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
784
785/* This is for filter type. PNG 1.0-1.2 only define the single type. */
786#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
787#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
788#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
789
790/* These are for the interlacing type. These values should NOT be changed. */
791#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
792#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
793#define PNG_INTERLACE_LAST 2 /* Not a valid value */
794
795/* These are for the oFFs chunk. These values should NOT be changed. */
796#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
797#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
798#define PNG_OFFSET_LAST 2 /* Not a valid value */
799
800/* These are for the pCAL chunk. These values should NOT be changed. */
801#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
802#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
803#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
804#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
805#define PNG_EQUATION_LAST 4 /* Not a valid value */
806
807/* These are for the sCAL chunk. These values should NOT be changed. */
808#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
809#define PNG_SCALE_METER 1 /* meters per pixel */
810#define PNG_SCALE_RADIAN 2 /* radians per pixel */
811#define PNG_SCALE_LAST 3 /* Not a valid value */
812
813/* These are for the pHYs chunk. These values should NOT be changed. */
814#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
815#define PNG_RESOLUTION_METER 1 /* pixels/meter */
816#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
817
818/* These are for the sRGB chunk. These values should NOT be changed. */
819#define PNG_sRGB_INTENT_PERCEPTUAL 0
820#define PNG_sRGB_INTENT_RELATIVE 1
821#define PNG_sRGB_INTENT_SATURATION 2
822#define PNG_sRGB_INTENT_ABSOLUTE 3
823#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
824
825/* This is for text chunks */
826#define PNG_KEYWORD_MAX_LENGTH 79
827
828/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
829#define PNG_MAX_PALETTE_LENGTH 256
830
831/* These determine if an ancillary chunk's data has been successfully read
832 * from the PNG header, or if the application has filled in the corresponding
833 * data in the info_struct to be written into the output file. The values
834 * of the PNG_INFO_<chunk> defines should NOT be changed.
835 */
836#define PNG_INFO_gAMA 0x0001
837#define PNG_INFO_sBIT 0x0002
838#define PNG_INFO_cHRM 0x0004
839#define PNG_INFO_PLTE 0x0008
840#define PNG_INFO_tRNS 0x0010
841#define PNG_INFO_bKGD 0x0020
842#define PNG_INFO_hIST 0x0040
843#define PNG_INFO_pHYs 0x0080
844#define PNG_INFO_oFFs 0x0100
845#define PNG_INFO_tIME 0x0200
846#define PNG_INFO_pCAL 0x0400
847#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
848#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
849#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
850#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Chris Craikb50c2172013-07-29 15:28:30 -0700851#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800852
853/* This is used for the transformation routines, as some of them
854 * change these values for the row. It also should enable using
855 * the routines for other purposes.
856 */
857typedef struct png_row_info_struct
858{
Chris Craikb50c2172013-07-29 15:28:30 -0700859 png_uint_32 width; /* width of row */
860 png_size_t rowbytes; /* number of bytes in row */
861 png_byte color_type; /* color type of row */
862 png_byte bit_depth; /* bit depth of row */
863 png_byte channels; /* number of channels (1, 2, 3, or 4) */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800864 png_byte pixel_depth; /* bits per pixel (depth * channels) */
865} png_row_info;
866
Chris Craikb50c2172013-07-29 15:28:30 -0700867typedef png_row_info * png_row_infop;
868typedef png_row_info * * png_row_infopp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800869
870/* These are the function types for the I/O functions and for the functions
871 * that allow the user to override the default I/O functions with his or her
872 * own. The png_error_ptr type should match that of user-supplied warning
873 * and error functions, while the png_rw_ptr type should match that of the
Chris Craikb50c2172013-07-29 15:28:30 -0700874 * user read/write data functions. Note that the 'write' function must not
875 * modify the buffer it is passed. The 'read' function, on the other hand, is
876 * expected to return the read data in the buffer.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800877 */
Chris Craikb50c2172013-07-29 15:28:30 -0700878typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
879typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
880typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
881typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
882 int));
883typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
884 int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800885
John Reck90bf0d22013-08-14 10:37:42 -0700886#ifdef PNG_INDEX_SUPPORTED
887typedef PNG_CALLBACK(void, *png_seek_ptr, (png_structp, png_uint_32));
888#endif
889
The Android Open Source Project893912b2009-03-03 19:30:05 -0800890#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700891typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
892typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
893
894/* The following callback receives png_uint_32 row_number, int pass for the
895 * png_bytep data of the row. When transforming an interlaced image the
896 * row number is the row number within the sub-image of the interlace pass, so
897 * the value will increase to the height of the sub-image (not the full image)
898 * then reset to 0 for the next pass.
899 *
900 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
901 * find the output pixel (x,y) given an interlaced sub-image pixel
902 * (row,col,pass). (See below for these macros.)
903 */
904typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
905 png_uint_32, int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800906#endif
907
908#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Chris Craikb50c2172013-07-29 15:28:30 -0700909 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
910typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
911 png_bytep));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800912#endif
913
Patrick Scott5f6bd842010-06-28 16:55:16 -0400914#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700915typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
916 png_unknown_chunkp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800917#endif
Patrick Scott5f6bd842010-06-28 16:55:16 -0400918#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700919/* not used anywhere */
920/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
921#endif
922
923#ifdef PNG_SETJMP_SUPPORTED
924/* This must match the function definition in <setjmp.h>, and the application
925 * must include this before png.h to obtain the definition of jmp_buf. The
926 * function is required to be PNG_NORETURN, but this is not checked. If the
927 * function does return the application will crash via an abort() or similar
928 * system level call.
929 *
930 * If you get a warning here while building the library you may need to make
931 * changes to ensure that pnglibconf.h records the calling convention used by
932 * your compiler. This may be very difficult - try using a different compiler
933 * to build the library!
934 */
935PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800936#endif
937
938/* Transform masks for the high-level interface */
939#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
940#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
941#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
942#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
943#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
944#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
945#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
946#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
947#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
948#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
949#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
950#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Chris Craikb50c2172013-07-29 15:28:30 -0700951#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
The Android Open Source Project4215dd12009-03-09 11:52:12 -0700952/* Added to libpng-1.2.34 */
Chris Craikb50c2172013-07-29 15:28:30 -0700953#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
954#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
955/* Added to libpng-1.4.0 */
Patrick Scott5f6bd842010-06-28 16:55:16 -0400956#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Chris Craikb50c2172013-07-29 15:28:30 -0700957/* Added to libpng-1.5.4 */
958#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
959#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800960
961/* Flags for MNG supported features */
962#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
963#define PNG_FLAG_MNG_FILTER_64 0x04
964#define PNG_ALL_MNG_FEATURES 0x05
965
Chris Craikb50c2172013-07-29 15:28:30 -0700966/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
967 * this allowed the zlib default functions to be used on Windows
968 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
969 * ignores the first argument) should be completely compatible with the
970 * following.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800971 */
Chris Craikb50c2172013-07-29 15:28:30 -0700972typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
973 png_alloc_size_t));
974typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800975
Chris Craikb50c2172013-07-29 15:28:30 -0700976/* Section 3: exported functions
977 * Here are the function definitions most commonly used. This is not
978 * the place to find out how to use libpng. See libpng-manual.txt for the
The Android Open Source Project893912b2009-03-03 19:30:05 -0800979 * full explanation, see example.c for the summary. This just provides
980 * a simple one line description of the use of each function.
Chris Craikb50c2172013-07-29 15:28:30 -0700981 *
982 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
983 * pngconf.h and in the *.dfn files in the scripts directory.
984 *
985 * PNG_EXPORT(ordinal, type, name, (args));
986 *
987 * ordinal: ordinal that is used while building
988 * *.def files. The ordinal value is only
989 * relevant when preprocessing png.h with
990 * the *.dfn files for building symbol table
991 * entries, and are removed by pngconf.h.
992 * type: return type of the function
993 * name: function name
994 * args: function arguments, with types
995 *
996 * When we wish to append attributes to a function prototype we use
997 * the PNG_EXPORTA() macro instead.
998 *
999 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
1000 *
1001 * ordinal, type, name, and args: same as in PNG_EXPORT().
1002 * attributes: function attributes
The Android Open Source Project893912b2009-03-03 19:30:05 -08001003 */
1004
1005/* Returns the version number of the library */
Chris Craikb50c2172013-07-29 15:28:30 -07001006PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001007
1008/* Tell lib we have already handled the first <num_bytes> magic bytes.
1009 * Handling more than 8 bytes from the beginning of the file is an error.
1010 */
Chris Craikb50c2172013-07-29 15:28:30 -07001011PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001012
1013/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
1014 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
1015 * signature, and non-zero otherwise. Having num_to_check == 0 or
1016 * start > 7 will always fail (ie return non-zero).
1017 */
Chris Craikb50c2172013-07-29 15:28:30 -07001018PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
1019 png_size_t num_to_check));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001020
1021/* Simple signature checking function. This is the same as calling
1022 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
1023 */
Chris Craikb50c2172013-07-29 15:28:30 -07001024#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001025
1026/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Chris Craikb50c2172013-07-29 15:28:30 -07001027PNG_EXPORTA(4, png_structp, png_create_read_struct,
1028 (png_const_charp user_png_ver, png_voidp error_ptr,
1029 png_error_ptr error_fn, png_error_ptr warn_fn),
1030 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001031
1032/* Allocate and initialize png_ptr struct for writing, and any other memory */
Chris Craikb50c2172013-07-29 15:28:30 -07001033PNG_EXPORTA(5, png_structp, png_create_write_struct,
1034 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1035 png_error_ptr warn_fn),
1036 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001037
Chris Craikb50c2172013-07-29 15:28:30 -07001038PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
1039 (png_const_structrp png_ptr));
1040
1041PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
1042 png_size_t size));
1043
1044/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
1045 * match up.
1046 */
1047#ifdef PNG_SETJMP_SUPPORTED
1048/* This function returns the jmp_buf built in to *png_ptr. It must be
1049 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
1050 * unless the default error function is overridden in which case NULL is
1051 * acceptable. The size of the jmp_buf is checked against the actual size
1052 * allocated by the library - the call will return NULL on a mismatch
1053 * indicating an ABI mismatch.
1054 */
1055PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
1056 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
1057# define png_jmpbuf(png_ptr) \
1058 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
1059#else
1060# define png_jmpbuf(png_ptr) \
1061 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001062#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001063/* This function should be used by libpng applications in place of
1064 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1065 * will use it; otherwise it will call PNG_ABORT(). This function was
1066 * added in libpng-1.5.0.
1067 */
1068PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
1069 PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001070
Chris Craikb50c2172013-07-29 15:28:30 -07001071#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001072/* Reset the compression stream */
Chris Craikb50c2172013-07-29 15:28:30 -07001073PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
1074#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08001075
1076/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
1077#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001078PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1079 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1080 png_error_ptr warn_fn,
1081 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1082 PNG_ALLOCATED);
1083PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1084 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1085 png_error_ptr warn_fn,
1086 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1087 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001088#endif
1089
Chris Craikb50c2172013-07-29 15:28:30 -07001090/* Write the PNG file signature. */
1091PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
1092
The Android Open Source Project893912b2009-03-03 19:30:05 -08001093/* Write a PNG chunk - size, type, (optional) data, CRC. */
Chris Craikb50c2172013-07-29 15:28:30 -07001094PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
1095 chunk_name, png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001096
1097/* Write the start of a PNG chunk - length and chunk name. */
Chris Craikb50c2172013-07-29 15:28:30 -07001098PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
1099 png_const_bytep chunk_name, png_uint_32 length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001100
1101/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Chris Craikb50c2172013-07-29 15:28:30 -07001102PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
1103 png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001104
1105/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Chris Craikb50c2172013-07-29 15:28:30 -07001106PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001107
1108/* Allocate and initialize the info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001109PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
1110 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001111
Chris Craikb50c2172013-07-29 15:28:30 -07001112/* DEPRECATED: this function allowed init structures to be created using the
1113 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1114 * the API will be removed in the future.
1115 */
1116PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1117 png_size_t png_info_struct_size), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001118
1119/* Writes all the PNG information before the image. */
Chris Craikb50c2172013-07-29 15:28:30 -07001120PNG_EXPORT(20, void, png_write_info_before_PLTE,
1121 (png_structrp png_ptr, png_const_inforp info_ptr));
1122PNG_EXPORT(21, void, png_write_info,
1123 (png_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001124
Patrick Scott5f6bd842010-06-28 16:55:16 -04001125#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001126/* Read the information before the actual image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001127PNG_EXPORT(22, void, png_read_info,
1128 (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001129#endif
1130
Patrick Scott5f6bd842010-06-28 16:55:16 -04001131#ifdef PNG_TIME_RFC1123_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001132 /* Convert to a US string format: there is no localization support in this
1133 * routine. The original implementation used a 29 character buffer in
1134 * png_struct, this will be removed in future versions.
1135 */
1136#if PNG_LIBPNG_VER < 10700
1137/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
1138PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
1139 png_const_timep ptime),PNG_DEPRECATED);
1140#endif
1141PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
1142 png_const_timep ptime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001143#endif
1144
Patrick Scott5f6bd842010-06-28 16:55:16 -04001145#ifdef PNG_CONVERT_tIME_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001146/* Convert from a struct tm to png_time */
Chris Craikb50c2172013-07-29 15:28:30 -07001147PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1148 const struct tm * ttime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001149
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001150/* Convert from time_t to png_time. Uses gmtime() */
Chris Craikb50c2172013-07-29 15:28:30 -07001151PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
Patrick Scott5f6bd842010-06-28 16:55:16 -04001152#endif /* PNG_CONVERT_tIME_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001153
Patrick Scott5f6bd842010-06-28 16:55:16 -04001154#ifdef PNG_READ_EXPAND_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001155/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Chris Craikb50c2172013-07-29 15:28:30 -07001156PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1157PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1158PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1159PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001160#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001161
1162#ifdef PNG_READ_EXPAND_16_SUPPORTED
1163/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1164 * of a tRNS chunk if present.
1165 */
1166PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001167#endif
1168
1169#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1170/* Use blue, green, red order for pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07001171PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001172#endif
1173
Patrick Scott5f6bd842010-06-28 16:55:16 -04001174#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001175/* Expand the grayscale to 24-bit RGB if necessary. */
Chris Craikb50c2172013-07-29 15:28:30 -07001176PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001177#endif
1178
Patrick Scott5f6bd842010-06-28 16:55:16 -04001179#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001180/* Reduce RGB to grayscale. */
Chris Craikb50c2172013-07-29 15:28:30 -07001181#define PNG_ERROR_ACTION_NONE 1
1182#define PNG_ERROR_ACTION_WARN 2
1183#define PNG_ERROR_ACTION_ERROR 3
1184#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1185
1186PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
1187 int error_action, double red, double green))
1188PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
1189 int error_action, png_fixed_point red, png_fixed_point green))
1190
1191PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
1192 png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001193#endif
1194
Chris Craikb50c2172013-07-29 15:28:30 -07001195#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1196PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1197 png_colorp palette));
1198#endif
1199
1200#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1201/* How the alpha channel is interpreted - this affects how the color channels of
1202 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
1203 * file, is present.
1204 *
1205 * This has no effect on the way pixels are written into a PNG output
1206 * datastream. The color samples in a PNG datastream are never premultiplied
1207 * with the alpha samples.
1208 *
1209 * The default is to return data according to the PNG specification: the alpha
1210 * channel is a linear measure of the contribution of the pixel to the
1211 * corresponding composited pixel. The gamma encoded color channels must be
1212 * scaled according to the contribution and to do this it is necessary to undo
1213 * the encoding, scale the color values, perform the composition and reencode
1214 * the values. This is the 'PNG' mode.
1215 *
1216 * The alternative is to 'associate' the alpha with the color information by
1217 * storing color channel values that have been scaled by the alpha. The
1218 * advantage is that the color channels can be resampled (the image can be
1219 * scaled) in this form. The disadvantage is that normal practice is to store
1220 * linear, not (gamma) encoded, values and this requires 16-bit channels for
1221 * still images rather than the 8-bit channels that are just about sufficient if
1222 * gamma encoding is used. In addition all non-transparent pixel values,
1223 * including completely opaque ones, must be gamma encoded to produce the final
1224 * image. This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
1225 * latter being the two common names for associated alpha color channels.)
1226 *
1227 * Since it is not necessary to perform arithmetic on opaque color values so
1228 * long as they are not to be resampled and are in the final color space it is
1229 * possible to optimize the handling of alpha by storing the opaque pixels in
1230 * the PNG format (adjusted for the output color space) while storing partially
1231 * opaque pixels in the standard, linear, format. The accuracy required for
1232 * standard alpha composition is relatively low, because the pixels are
1233 * isolated, therefore typically the accuracy loss in storing 8-bit linear
1234 * values is acceptable. (This is not true if the alpha channel is used to
1235 * simulate transparency over large areas - use 16 bits or the PNG mode in
1236 * this case!) This is the 'OPTIMIZED' mode. For this mode a pixel is
1237 * treated as opaque only if the alpha value is equal to the maximum value.
1238 *
1239 * The final choice is to gamma encode the alpha channel as well. This is
1240 * broken because, in practice, no implementation that uses this choice
1241 * correctly undoes the encoding before handling alpha composition. Use this
1242 * choice only if other serious errors in the software or hardware you use
1243 * mandate it; the typical serious error is for dark halos to appear around
1244 * opaque areas of the composited PNG image because of arithmetic overflow.
1245 *
1246 * The API function png_set_alpha_mode specifies which of these choices to use
1247 * with an enumerated 'mode' value and the gamma of the required output:
1248 */
1249#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1250#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1251#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1252#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1253#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1254#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1255
1256PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
1257 double output_gamma))
1258PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
1259 int mode, png_fixed_point output_gamma))
1260#endif
1261
1262#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1263/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1264 * how to decode the output values, not how they are encoded. The values used
1265 * correspond to the normal numbers used to describe the overall gamma of a
1266 * computer display system; for example 2.2 for an sRGB conformant system. The
1267 * values are scaled by 100000 in the _fixed version of the API (so 220000 for
1268 * sRGB.)
1269 *
1270 * The inverse of the value is always used to provide a default for the PNG file
1271 * encoding if it has no gAMA chunk and if png_set_gamma() has not been called
1272 * to override the PNG gamma information.
1273 *
1274 * When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
1275 * opaque pixels however pixels with lower alpha values are not encoded,
1276 * regardless of the output gamma setting.
1277 *
1278 * When the standard Porter Duff handling is requested with mode 1 the output
1279 * encoding is set to be linear and the output_gamma value is only relevant
1280 * as a default for input data that has no gamma information. The linear output
1281 * encoding will be overridden if png_set_gamma() is called - the results may be
1282 * highly unexpected!
1283 *
1284 * The following numbers are derived from the sRGB standard and the research
1285 * behind it. sRGB is defined to be approximated by a PNG gAMA chunk value of
1286 * 0.45455 (1/2.2) for PNG. The value implicitly includes any viewing
1287 * correction required to take account of any differences in the color
1288 * environment of the original scene and the intended display environment; the
1289 * value expresses how to *decode* the image for display, not how the original
1290 * data was *encoded*.
1291 *
1292 * sRGB provides a peg for the PNG standard by defining a viewing environment.
1293 * sRGB itself, and earlier TV standards, actually use a more complex transform
1294 * (a linear portion then a gamma 2.4 power law) than PNG can express. (PNG is
1295 * limited to simple power laws.) By saying that an image for direct display on
1296 * an sRGB conformant system should be stored with a gAMA chunk value of 45455
1297 * (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
1298 * makes it possible to derive values for other display systems and
1299 * environments.
1300 *
1301 * The Mac value is deduced from the sRGB based on an assumption that the actual
1302 * extra viewing correction used in early Mac display systems was implemented as
1303 * a power 1.45 lookup table.
1304 *
1305 * Any system where a programmable lookup table is used or where the behavior of
1306 * the final display device characteristics can be changed requires system
1307 * specific code to obtain the current characteristic. However this can be
1308 * difficult and most PNG gamma correction only requires an approximate value.
1309 *
1310 * By default, if png_set_alpha_mode() is not called, libpng assumes that all
1311 * values are unencoded, linear, values and that the output device also has a
1312 * linear characteristic. This is only very rarely correct - it is invariably
1313 * better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
1314 * default if you don't know what the right answer is!
1315 *
1316 * The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
1317 * 10.6) which used a correction table to implement a somewhat lower gamma on an
1318 * otherwise sRGB system.
1319 *
1320 * Both these values are reserved (not simple gamma values) in order to allow
1321 * more precise correction internally in the future.
1322 *
1323 * NOTE: the following values can be passed to either the fixed or floating
1324 * point APIs, but the floating point API will also accept floating point
1325 * values.
1326 */
1327#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1328#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
1329#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
1330#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1331#endif
1332
1333/* The following are examples of calls to png_set_alpha_mode to achieve the
1334 * required overall gamma correction and, where necessary, alpha
1335 * premultiplication.
1336 *
1337 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1338 * This is the default libpng handling of the alpha channel - it is not
1339 * pre-multiplied into the color components. In addition the call states
1340 * that the output is for a sRGB system and causes all PNG files without gAMA
1341 * chunks to be assumed to be encoded using sRGB.
1342 *
1343 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1344 * In this case the output is assumed to be something like an sRGB conformant
1345 * display preceeded by a power-law lookup table of power 1.45. This is how
1346 * early Mac systems behaved.
1347 *
1348 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1349 * This is the classic Jim Blinn approach and will work in academic
1350 * environments where everything is done by the book. It has the shortcoming
1351 * of assuming that input PNG data with no gamma information is linear - this
1352 * is unlikely to be correct unless the PNG files where generated locally.
1353 * Most of the time the output precision will be so low as to show
1354 * significant banding in dark areas of the image.
1355 *
1356 * png_set_expand_16(pp);
1357 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1358 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1359 * are assumed to have the sRGB encoding if not marked with a gamma value and
1360 * the output is always 16 bits per component. This permits accurate scaling
1361 * and processing of the data. If you know that your input PNG files were
1362 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1363 * correct value for your system.
1364 *
1365 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1366 * If you just need to composite the PNG image onto an existing background
1367 * and if you control the code that does this you can use the optimization
1368 * setting. In this case you just copy completely opaque pixels to the
1369 * output. For pixels that are not completely transparent (you just skip
1370 * those) you do the composition math using png_composite or png_composite_16
1371 * below then encode the resultant 8-bit or 16-bit values to match the output
1372 * encoding.
1373 *
1374 * Other cases
1375 * If neither the PNG nor the standard linear encoding work for you because
1376 * of the software or hardware you use then you have a big problem. The PNG
1377 * case will probably result in halos around the image. The linear encoding
1378 * will probably result in a washed out, too bright, image (it's actually too
1379 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1380 * substantially reduce the halos. Alternatively try:
1381 *
1382 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1383 * This option will also reduce the halos, but there will be slight dark
1384 * halos round the opaque parts of the image where the background is light.
1385 * In the OPTIMIZED mode the halos will be light halos where the background
1386 * is dark. Take your pick - the halos are unavoidable unless you can get
1387 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1388 * faster.)
1389 *
1390 * When the default gamma of PNG files doesn't match the output gamma.
1391 * If you have PNG files with no gamma information png_set_alpha_mode allows
1392 * you to provide a default gamma, but it also sets the ouput gamma to the
1393 * matching value. If you know your PNG files have a gamma that doesn't
1394 * match the output you can take advantage of the fact that
1395 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1396 * default if it is not already set:
1397 *
1398 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1399 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1400 * The first call sets both the default and the output gamma values, the
1401 * second call overrides the output gamma without changing the default. This
1402 * is easier than achieving the same effect with png_set_gamma. You must use
1403 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1404 * fire if more than one call to png_set_alpha_mode and png_set_background is
1405 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1406 * are ignored.
1407 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001408
Patrick Scott5f6bd842010-06-28 16:55:16 -04001409#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001410PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001411#endif
1412
1413#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1414 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001415PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001416#endif
1417
1418#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1419 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001420PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001421#endif
1422
1423#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1424/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001425PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
1426 int flags));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001427/* The values of the PNG_FILLER_ defines should NOT be changed */
Chris Craikb50c2172013-07-29 15:28:30 -07001428# define PNG_FILLER_BEFORE 0
1429# define PNG_FILLER_AFTER 1
The Android Open Source Project893912b2009-03-03 19:30:05 -08001430/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001431PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
1432 png_uint_32 filler, int flags));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001433#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
1434
1435#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1436/* Swap bytes in 16-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001437PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001438#endif
1439
1440#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1441/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001442PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001443#endif
1444
Chris Craikb50c2172013-07-29 15:28:30 -07001445#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1446 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001447/* Swap packing order of pixels in bytes. */
Chris Craikb50c2172013-07-29 15:28:30 -07001448PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001449#endif
1450
1451#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
1452/* Converts files to legal bit depths. */
Chris Craikb50c2172013-07-29 15:28:30 -07001453PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
1454 true_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001455#endif
1456
1457#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1458 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001459/* Have the code handle the interlacing. Returns the number of passes.
1460 * MUST be called before png_read_update_info or png_start_read_image,
1461 * otherwise it will not have the desired effect. Note that it is still
1462 * necessary to call png_read_row or png_read_rows png_get_image_height
1463 * times for each pass.
1464*/
1465PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001466#endif
1467
1468#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1469/* Invert monochrome files */
Chris Craikb50c2172013-07-29 15:28:30 -07001470PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001471#endif
1472
Patrick Scott5f6bd842010-06-28 16:55:16 -04001473#ifdef PNG_READ_BACKGROUND_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001474/* Handle alpha and tRNS by replacing with a background color. Prior to
1475 * libpng-1.5.4 this API must not be called before the PNG file header has been
1476 * read. Doing so will result in unexpected behavior and possible warnings or
1477 * errors if the PNG file contains a bKGD chunk.
1478 */
1479PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
1480 png_const_color_16p background_color, int background_gamma_code,
1481 int need_expand, double background_gamma))
1482PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
1483 png_const_color_16p background_color, int background_gamma_code,
1484 int need_expand, png_fixed_point background_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001485#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001486#ifdef PNG_READ_BACKGROUND_SUPPORTED
1487# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1488# define PNG_BACKGROUND_GAMMA_SCREEN 1
1489# define PNG_BACKGROUND_GAMMA_FILE 2
1490# define PNG_BACKGROUND_GAMMA_UNIQUE 3
The Android Open Source Project893912b2009-03-03 19:30:05 -08001491#endif
1492
Chris Craikb50c2172013-07-29 15:28:30 -07001493#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1494/* Scale a 16-bit depth file down to 8-bit, accurately. */
1495PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
1496#endif
1497
1498#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1499#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001500/* Strip the second byte of information from a 16-bit depth file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001501PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001502#endif
1503
Chris Craikb50c2172013-07-29 15:28:30 -07001504#ifdef PNG_READ_QUANTIZE_SUPPORTED
1505/* Turn on quantizing, and reduce the palette to the number of colors
1506 * available.
1507 */
1508PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1509 png_colorp palette, int num_palette, int maximum_colors,
1510 png_const_uint_16p histogram, int full_quantize));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001511#endif
1512
Patrick Scott5f6bd842010-06-28 16:55:16 -04001513#ifdef PNG_READ_GAMMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001514/* The threshold on gamma processing is configurable but hard-wired into the
1515 * library. The following is the floating point variant.
1516 */
1517#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001518
Chris Craikb50c2172013-07-29 15:28:30 -07001519/* Handle gamma correction. Screen_gamma=(display_exponent).
1520 * NOTE: this API simply sets the screen and file gamma values. It will
1521 * therefore override the value for gamma in a PNG file if it is called after
1522 * the file header has been read - use with care - call before reading the PNG
1523 * file for best results!
1524 *
1525 * These routines accept the same gamma values as png_set_alpha_mode (described
1526 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1527 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1528 * is the inverse of a 'screen gamma' value.
1529 */
1530PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
1531 double screen_gamma, double override_file_gamma))
1532PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
1533 png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001534#endif
1535
Patrick Scott5f6bd842010-06-28 16:55:16 -04001536#ifdef PNG_WRITE_FLUSH_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001537/* Set how many lines between output flushes - 0 for no flushing */
Chris Craikb50c2172013-07-29 15:28:30 -07001538PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001539/* Flush the current PNG output buffer */
Chris Craikb50c2172013-07-29 15:28:30 -07001540PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001541#endif
1542
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001543/* Optional update palette with requested transformations */
Chris Craikb50c2172013-07-29 15:28:30 -07001544PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001545
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001546/* Optional call to update the users info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001547PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1548 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001549
Chris Craikb50c2172013-07-29 15:28:30 -07001550#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001551/* Read one or more rows of image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001552PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
1553 png_bytepp display_row, png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001554#endif
1555
Chris Craikb50c2172013-07-29 15:28:30 -07001556#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001557/* Read a row of data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001558PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
1559 png_bytep display_row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001560#endif
1561
Chris Craikb50c2172013-07-29 15:28:30 -07001562#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001563/* Read the whole image into memory at once. */
Chris Craikb50c2172013-07-29 15:28:30 -07001564PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001565#endif
1566
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001567/* Write a row of image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001568PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1569 png_const_bytep row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001570
Chris Craikb50c2172013-07-29 15:28:30 -07001571/* Write a few rows of image data: (*row) is not written; however, the type
1572 * is declared as writeable to maintain compatibility with previous versions
1573 * of libpng and to allow the 'display_row' array from read_rows to be passed
1574 * unchanged to write_rows.
1575 */
1576PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
1577 png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001578
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001579/* Write the image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001580PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001581
Chris Craikb50c2172013-07-29 15:28:30 -07001582/* Write the end of the PNG file. */
1583PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1584 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001585
Chris Craikb50c2172013-07-29 15:28:30 -07001586#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001587/* Read the end of the PNG file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001588PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001589#endif
1590
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001591/* Free any memory associated with the png_info_struct */
Chris Craikb50c2172013-07-29 15:28:30 -07001592PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
1593 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001594
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001595/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001596PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1597 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001598
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001599/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001600PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1601 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001602
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001603/* Set the libpng method of handling chunk CRC errors */
Chris Craikb50c2172013-07-29 15:28:30 -07001604PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
1605 int ancil_action));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001606
Chris Craikb50c2172013-07-29 15:28:30 -07001607/* Values for png_set_crc_action() say how to handle CRC errors in
The Android Open Source Project893912b2009-03-03 19:30:05 -08001608 * ancillary and critical chunks, and whether to use the data contained
1609 * therein. Note that it is impossible to "discard" data in a critical
1610 * chunk. For versions prior to 0.90, the action was always error/quit,
1611 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1612 * chunks is warn/discard. These values should NOT be changed.
1613 *
1614 * value action:critical action:ancillary
1615 */
1616#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1617#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1618#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1619#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1620#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1621#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1622
1623/* These functions give the user control over the scan-line filtering in
1624 * libpng and the compression methods used by zlib. These functions are
1625 * mainly useful for testing, as the defaults should work with most users.
1626 * Those users who are tight on memory or want faster performance at the
1627 * expense of compression can modify them. See the compression library
1628 * header file (zlib.h) for an explination of the compression functions.
1629 */
1630
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001631/* Set the filtering method(s) used by libpng. Currently, the only valid
The Android Open Source Project893912b2009-03-03 19:30:05 -08001632 * value for "method" is 0.
1633 */
Chris Craikb50c2172013-07-29 15:28:30 -07001634PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
1635 int filters));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001636
1637/* Flags for png_set_filter() to say which filters to use. The flags
1638 * are chosen so that they don't conflict with real filter types
1639 * below, in case they are supplied instead of the #defined constants.
1640 * These values should NOT be changed.
1641 */
1642#define PNG_NO_FILTERS 0x00
1643#define PNG_FILTER_NONE 0x08
1644#define PNG_FILTER_SUB 0x10
1645#define PNG_FILTER_UP 0x20
1646#define PNG_FILTER_AVG 0x40
1647#define PNG_FILTER_PAETH 0x80
1648#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1649 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1650
1651/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1652 * These defines should NOT be changed.
1653 */
1654#define PNG_FILTER_VALUE_NONE 0
1655#define PNG_FILTER_VALUE_SUB 1
1656#define PNG_FILTER_VALUE_UP 2
1657#define PNG_FILTER_VALUE_AVG 3
1658#define PNG_FILTER_VALUE_PAETH 4
1659#define PNG_FILTER_VALUE_LAST 5
1660
Chris Craikb50c2172013-07-29 15:28:30 -07001661#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001662/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1663 * defines, either the default (minimum-sum-of-absolute-differences), or
1664 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1665 *
1666 * Weights are factors >= 1.0, indicating how important it is to keep the
1667 * filter type consistent between rows. Larger numbers mean the current
1668 * filter is that many times as likely to be the same as the "num_weights"
1669 * previous filters. This is cumulative for each previous row with a weight.
1670 * There needs to be "num_weights" values in "filter_weights", or it can be
1671 * NULL if the weights aren't being specified. Weights have no influence on
1672 * the selection of the first row filter. Well chosen weights can (in theory)
1673 * improve the compression for a given image.
1674 *
1675 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1676 * filter type. Higher costs indicate more decoding expense, and are
1677 * therefore less likely to be selected over a filter with lower computational
1678 * costs. There needs to be a value in "filter_costs" for each valid filter
1679 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1680 * setting the costs. Costs try to improve the speed of decompression without
1681 * unduly increasing the compressed image size.
1682 *
1683 * A negative weight or cost indicates the default value is to be used, and
1684 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1685 * The default values for both weights and costs are currently 1.0, but may
1686 * change if good general weighting/cost heuristics can be found. If both
1687 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1688 * to the UNWEIGHTED method, but with added encoding time/computation.
1689 */
Chris Craikb50c2172013-07-29 15:28:30 -07001690PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
1691 int heuristic_method, int num_weights, png_const_doublep filter_weights,
1692 png_const_doublep filter_costs))
1693PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1694 (png_structrp png_ptr, int heuristic_method, int num_weights,
1695 png_const_fixed_point_p filter_weights,
1696 png_const_fixed_point_p filter_costs))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001697#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1698
1699/* Heuristic used for row filter selection. These defines should NOT be
1700 * changed.
1701 */
1702#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1703#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1704#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1705#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1706
Chris Craikb50c2172013-07-29 15:28:30 -07001707#ifdef PNG_WRITE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001708/* Set the library compression level. Currently, valid values range from
1709 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1710 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1711 * shown that zlib compression levels 3-6 usually perform as well as level 9
1712 * for PNG images, and do considerably fewer caclulations. In the future,
1713 * these values may not correspond directly to the zlib compression levels.
1714 */
Chris Craikb50c2172013-07-29 15:28:30 -07001715PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
1716 int level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001717
Chris Craikb50c2172013-07-29 15:28:30 -07001718PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
1719 int mem_level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001720
Chris Craikb50c2172013-07-29 15:28:30 -07001721PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
1722 int strategy));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001723
Chris Craikb50c2172013-07-29 15:28:30 -07001724/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1725 * smaller value of window_bits if it can do so safely.
1726 */
1727PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
1728 int window_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001729
Chris Craikb50c2172013-07-29 15:28:30 -07001730PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
1731 int method));
1732#endif
1733
1734#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1735/* Also set zlib parameters for compressing non-IDAT chunks */
1736PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
1737 int level));
1738
1739PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
1740 int mem_level));
1741
1742PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
1743 int strategy));
1744
1745/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1746 * smaller value of window_bits if it can do so safely.
1747 */
1748PNG_EXPORT(225, void, png_set_text_compression_window_bits,
1749 (png_structrp png_ptr, int window_bits));
1750
1751PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
1752 int method));
1753#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001754
1755/* These next functions are called for input/output, memory, and error
1756 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
1757 * and call standard C I/O routines such as fread(), fwrite(), and
1758 * fprintf(). These functions can be made to use other I/O routines
1759 * at run time for those applications that need to handle I/O in a
Chris Craikb50c2172013-07-29 15:28:30 -07001760 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
The Android Open Source Project893912b2009-03-03 19:30:05 -08001761 * more information.
1762 */
1763
Patrick Scott5f6bd842010-06-28 16:55:16 -04001764#ifdef PNG_STDIO_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001765/* Initialize the input/output for the PNG file to the default functions. */
Chris Craikb50c2172013-07-29 15:28:30 -07001766PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001767#endif
1768
1769/* Replace the (error and abort), and warning functions with user
1770 * supplied functions. If no messages are to be printed you must still
1771 * write and use replacement functions. The replacement error_fn should
1772 * still do a longjmp to the last setjmp location if you are using this
1773 * method of error handling. If error_fn or warning_fn is NULL, the
1774 * default function will be used.
1775 */
1776
Chris Craikb50c2172013-07-29 15:28:30 -07001777PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
1778 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001779
1780/* Return the user pointer associated with the error functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001781PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001782
1783/* Replace the default data output functions with a user supplied one(s).
1784 * If buffered output is not used, then output_flush_fn can be set to NULL.
1785 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1786 * output_flush_fn will be ignored (and thus can be NULL).
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001787 * It is probably a mistake to use NULL for output_flush_fn if
1788 * write_data_fn is not also NULL unless you have built libpng with
1789 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1790 * default flush function, which uses the standard *FILE structure, will
1791 * be used.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001792 */
Chris Craikb50c2172013-07-29 15:28:30 -07001793PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
1794 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001795
1796/* Replace the default data input function with a user supplied one. */
Chris Craikb50c2172013-07-29 15:28:30 -07001797PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
1798 png_rw_ptr read_data_fn));
Joseph Wen4ce0ee12010-08-20 10:42:22 +08001799
The Android Open Source Project893912b2009-03-03 19:30:05 -08001800/* Return the user pointer associated with the I/O functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001801PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001802
Chris Craikb50c2172013-07-29 15:28:30 -07001803PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
1804 png_read_status_ptr read_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001805
Chris Craikb50c2172013-07-29 15:28:30 -07001806PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
1807 png_write_status_ptr write_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001808
1809#ifdef PNG_USER_MEM_SUPPORTED
1810/* Replace the default memory allocation functions with user supplied one(s). */
Chris Craikb50c2172013-07-29 15:28:30 -07001811PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
1812 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001813/* Return the user pointer associated with the memory functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001814PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001815#endif
1816
Chris Craikb50c2172013-07-29 15:28:30 -07001817#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1818PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
1819 png_user_transform_ptr read_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001820#endif
1821
Chris Craikb50c2172013-07-29 15:28:30 -07001822#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1823PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
1824 png_user_transform_ptr write_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001825#endif
1826
Chris Craikb50c2172013-07-29 15:28:30 -07001827#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1828PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
1829 png_voidp user_transform_ptr, int user_transform_depth,
1830 int user_transform_channels));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001831/* Return the user pointer associated with the user transform functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001832PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1833 (png_const_structrp png_ptr));
1834#endif
1835
1836#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1837/* Return information about the row currently being processed. Note that these
1838 * APIs do not fail but will return unexpected results if called outside a user
1839 * transform callback. Also note that when transforming an interlaced image the
1840 * row number is the row number within the sub-image of the interlace pass, so
1841 * the value will increase to the height of the sub-image (not the full image)
1842 * then reset to 0 for the next pass.
1843 *
1844 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1845 * find the output pixel (x,y) given an interlaced sub-image pixel
1846 * (row,col,pass). (See below for these macros.)
1847 */
1848PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1849PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
1850#endif
1851
1852#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1853/* This callback is called only for *unknown* chunks. If
1854 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1855 * chunks to be treated as unknown, however in this case the callback must do
1856 * any processing required by the chunk (e.g. by calling the appropriate
1857 * png_set_ APIs.)
1858 *
1859 * There is no write support - on write, by default, all the chunks in the
1860 * 'unknown' list are written in the specified position.
1861 *
1862 * The integer return from the callback function is interpreted thus:
1863 *
1864 * negative: An error occured, png_chunk_error will be called.
1865 * zero: The chunk was not handled, the chunk will be saved. A critical
1866 * chunk will cause an error at this point unless it is to be saved.
1867 * positive: The chunk was handled, libpng will ignore/discard it.
1868 *
1869 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
1870 * how this behavior will change in libpng 1.7
1871 */
1872PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
1873 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001874#endif
1875
1876#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001877PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001878#endif
1879
1880#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1881/* Sets the function callbacks for the push reader, and a pointer to a
1882 * user-defined structure available to the callback functions.
1883 */
Chris Craikb50c2172013-07-29 15:28:30 -07001884PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
1885 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1886 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001887
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001888/* Returns the user pointer associated with the push read functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001889PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1890 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001891
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001892/* Function to be called when data becomes available */
Chris Craikb50c2172013-07-29 15:28:30 -07001893PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1894 png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001895
Chris Craikb50c2172013-07-29 15:28:30 -07001896/* A function which may be called *only* within png_process_data to stop the
1897 * processing of any more data. The function returns the number of bytes
1898 * remaining, excluding any that libpng has cached internally. A subsequent
1899 * call to png_process_data must supply these bytes again. If the argument
1900 * 'save' is set to true the routine will first save all the pending data and
1901 * will always return 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001902 */
Chris Craikb50c2172013-07-29 15:28:30 -07001903PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
1904
1905/* A function which may be called *only* outside (after) a call to
1906 * png_process_data. It returns the number of bytes of data to skip in the
1907 * input. Normally it will return 0, but if it returns a non-zero value the
1908 * application must skip than number of bytes of input data and pass the
1909 * following data to the next call to png_process_data.
1910 */
1911PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
1912
1913#ifdef PNG_READ_INTERLACING_SUPPORTED
1914/* Function that combines rows. 'new_row' is a flag that should come from
1915 * the callback and be non-NULL if anything needs to be done; the library
1916 * stores its own version of the new data internally and ignores the passed
1917 * in value.
1918 */
1919PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
1920 png_bytep old_row, png_const_bytep new_row));
1921#endif /* PNG_READ_INTERLACING_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001922#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
1923
Chris Craikb50c2172013-07-29 15:28:30 -07001924PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
1925 png_alloc_size_t size), PNG_ALLOCATED);
1926/* Added at libpng version 1.4.0 */
1927PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
1928 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001929
The Android Open Source Project893912b2009-03-03 19:30:05 -08001930/* Added at libpng version 1.2.4 */
Chris Craikb50c2172013-07-29 15:28:30 -07001931PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
1932 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001933
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001934/* Frees a pointer allocated by png_malloc() */
Chris Craikb50c2172013-07-29 15:28:30 -07001935PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001936
1937/* Free data that was allocated internally */
Chris Craikb50c2172013-07-29 15:28:30 -07001938PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1939 png_inforp info_ptr, png_uint_32 free_me, int num));
1940
The Android Open Source Project893912b2009-03-03 19:30:05 -08001941/* Reassign responsibility for freeing existing data, whether allocated
Chris Craikb50c2172013-07-29 15:28:30 -07001942 * by libpng or by the application; this works on the png_info structure passed
1943 * in, it does not change the state for other png_info structures.
1944 *
1945 * It is unlikely that this function works correctly as of 1.6.0 and using it
1946 * may result either in memory leaks or double free of allocated data.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001947 */
Chris Craikb50c2172013-07-29 15:28:30 -07001948PNG_EXPORTA(99, void, png_data_freer, (png_const_structrp png_ptr,
1949 png_inforp info_ptr, int freer, png_uint_32 mask), PNG_DEPRECATED);
1950
John Reck90bf0d22013-08-14 10:37:42 -07001951#ifdef PNG_INDEX_SUPPORTED
1952/* Build image index for partial image decoding. */
1953PNG_EXPORT(300, void, png_build_index, (png_structp png_ptr));
1954PNG_EXPORT(301, void, png_configure_decoder,
1955 (png_structp png_ptr, int *row_offset, int pass));
1956/* Set the data seek function with a user supplied one.
1957 * REQUIRED by partial image decode.
1958 */
1959PNG_EXPORT(302, void, png_set_seek_fn, (png_structp png_ptr,
1960 png_seek_ptr seek_data_fn));
1961/* Update the decoder status to the given pass */
1962PNG_EXPORT(303, void, png_set_interlaced_pass, (png_structp png_ptr, int pass));
1963#endif
1964
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001965/* Assignments for png_data_freer */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001966#define PNG_DESTROY_WILL_FREE_DATA 1
1967#define PNG_SET_WILL_FREE_DATA 1
1968#define PNG_USER_WILL_FREE_DATA 2
1969/* Flags for png_ptr->free_me and info_ptr->free_me */
1970#define PNG_FREE_HIST 0x0008
1971#define PNG_FREE_ICCP 0x0010
1972#define PNG_FREE_SPLT 0x0020
1973#define PNG_FREE_ROWS 0x0040
1974#define PNG_FREE_PCAL 0x0080
1975#define PNG_FREE_SCAL 0x0100
Chris Craikb50c2172013-07-29 15:28:30 -07001976#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1977# define PNG_FREE_UNKN 0x0200
1978#endif
1979/* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001980#define PNG_FREE_PLTE 0x1000
1981#define PNG_FREE_TRNS 0x2000
1982#define PNG_FREE_TEXT 0x4000
1983#define PNG_FREE_ALL 0x7fff
1984#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1985
1986#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001987PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
1988 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
1989PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
1990 png_voidp ptr), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001991#endif
1992
Chris Craikb50c2172013-07-29 15:28:30 -07001993#ifdef PNG_ERROR_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001994/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07001995PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
1996 png_const_charp error_message), PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001997
1998/* The same, but the chunk name is prepended to the error string. */
Chris Craikb50c2172013-07-29 15:28:30 -07001999PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
2000 png_const_charp error_message), PNG_NORETURN);
2001
The Android Open Source Project893912b2009-03-03 19:30:05 -08002002#else
2003/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07002004PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08002005#endif
2006
Chris Craikb50c2172013-07-29 15:28:30 -07002007#ifdef PNG_WARNINGS_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002008/* Non-fatal error in libpng. Can continue, but may have a problem. */
Chris Craikb50c2172013-07-29 15:28:30 -07002009PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
2010 png_const_charp warning_message));
2011
2012/* Non-fatal error in libpng, chunk name is prepended to message. */
2013PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
2014 png_const_charp warning_message));
2015#endif
2016
2017#ifdef PNG_BENIGN_ERRORS_SUPPORTED
2018/* Benign error in libpng. Can continue, but may have a problem.
2019 * User can choose whether to handle as a fatal error or as a warning. */
2020PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
2021 png_const_charp warning_message));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002022
2023#ifdef PNG_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002024/* Same, chunk name is prepended to message (only during read) */
2025PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
2026 png_const_charp warning_message));
2027#endif
2028
2029PNG_EXPORT(109, void, png_set_benign_errors,
2030 (png_structrp png_ptr, int allowed));
2031#else
2032# ifdef PNG_ALLOW_BENIGN_ERRORS
2033# define png_benign_error png_warning
2034# define png_chunk_benign_error png_chunk_warning
2035# else
2036# define png_benign_error png_error
2037# define png_chunk_benign_error png_chunk_error
2038# endif
2039#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002040
2041/* The png_set_<chunk> functions are for storing values in the png_info_struct.
2042 * Similarly, the png_get_<chunk> calls are used to read values from the
2043 * png_info_struct, either storing the parameters in the passed variables, or
2044 * setting pointers into the png_info_struct where the data is stored. The
2045 * png_get_<chunk> functions return a non-zero value if the data was available
2046 * in info_ptr, or return zero and do not change any of the parameters if the
2047 * data was not available.
2048 *
2049 * These functions should be used instead of directly accessing png_info
2050 * to avoid problems with future changes in the size and internal layout of
2051 * png_info_struct.
2052 */
2053/* Returns "flag" if chunk data is valid in info_ptr. */
Chris Craikb50c2172013-07-29 15:28:30 -07002054PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
2055 png_const_inforp info_ptr, png_uint_32 flag));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002056
2057/* Returns number of bytes needed to hold a transformed row. */
Chris Craikb50c2172013-07-29 15:28:30 -07002058PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
2059 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002060
Patrick Scott5f6bd842010-06-28 16:55:16 -04002061#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002062/* Returns row_pointers, which is an array of pointers to scanlines that was
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002063 * returned from png_read_png().
2064 */
Chris Craikb50c2172013-07-29 15:28:30 -07002065PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
2066 png_const_inforp info_ptr));
2067
The Android Open Source Project893912b2009-03-03 19:30:05 -08002068/* Set row_pointers, which is an array of pointers to scanlines for use
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002069 * by png_write_png().
2070 */
Chris Craikb50c2172013-07-29 15:28:30 -07002071PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
2072 png_inforp info_ptr, png_bytepp row_pointers));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002073#endif
2074
2075/* Returns number of color channels in image. */
Chris Craikb50c2172013-07-29 15:28:30 -07002076PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
2077 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002078
2079#ifdef PNG_EASY_ACCESS_SUPPORTED
2080/* Returns image width in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07002081PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
2082 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002083
2084/* Returns image height in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07002085PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
2086 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002087
2088/* Returns image bit_depth. */
Chris Craikb50c2172013-07-29 15:28:30 -07002089PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
2090 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002091
2092/* Returns image color_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002093PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
2094 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002095
2096/* Returns image filter_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002097PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
2098 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002099
2100/* Returns image interlace_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002101PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
2102 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002103
2104/* Returns image compression_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002105PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
2106 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002107
2108/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002109PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
2110 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2111PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
2112 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2113PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
2114 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002115
2116/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002117PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
2118 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2119PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
2120 (png_const_structrp png_ptr, png_const_inforp info_ptr))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002121
2122/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002123PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2124 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2125PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2126 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2127PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
2128 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2129PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
2130 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002131
2132#endif /* PNG_EASY_ACCESS_SUPPORTED */
2133
Chris Craikb50c2172013-07-29 15:28:30 -07002134#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002135/* Returns pointer to signature string read from PNG header */
Chris Craikb50c2172013-07-29 15:28:30 -07002136PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
2137 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002138#endif
2139
Patrick Scott5f6bd842010-06-28 16:55:16 -04002140#ifdef PNG_bKGD_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002141PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
2142 png_inforp info_ptr, png_color_16p *background));
2143#endif
2144
2145#ifdef PNG_bKGD_SUPPORTED
2146PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
2147 png_inforp info_ptr, png_const_color_16p background));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002148#endif
2149
Patrick Scott5f6bd842010-06-28 16:55:16 -04002150#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002151PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
2152 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
2153 double *red_y, double *green_x, double *green_y, double *blue_x,
2154 double *blue_y))
2155PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
2156 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
2157 double *green_X, double *green_Y, double *green_Z, double *blue_X,
2158 double *blue_Y, double *blue_Z))
2159PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
2160 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2161 png_fixed_point *int_white_x, png_fixed_point *int_white_y,
2162 png_fixed_point *int_red_x, png_fixed_point *int_red_y,
2163 png_fixed_point *int_green_x, png_fixed_point *int_green_y,
2164 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
2165PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
2166 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2167 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
2168 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
2169 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
2170 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
2171 png_fixed_point *int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002172#endif
2173
Patrick Scott5f6bd842010-06-28 16:55:16 -04002174#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002175PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
2176 png_inforp info_ptr,
2177 double white_x, double white_y, double red_x, double red_y, double green_x,
2178 double green_y, double blue_x, double blue_y))
2179PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
2180 png_inforp info_ptr, double red_X, double red_Y, double red_Z,
2181 double green_X, double green_Y, double green_Z, double blue_X,
2182 double blue_Y, double blue_Z))
2183PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
2184 png_inforp info_ptr, png_fixed_point int_white_x,
2185 png_fixed_point int_white_y, png_fixed_point int_red_x,
2186 png_fixed_point int_red_y, png_fixed_point int_green_x,
2187 png_fixed_point int_green_y, png_fixed_point int_blue_x,
2188 png_fixed_point int_blue_y))
2189PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
2190 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
2191 png_fixed_point int_red_Z, png_fixed_point int_green_X,
2192 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2193 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
2194 png_fixed_point int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002195#endif
2196
Patrick Scott5f6bd842010-06-28 16:55:16 -04002197#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002198PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
2199 png_const_inforp info_ptr, double *file_gamma))
2200PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2201 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2202 png_fixed_point *int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002203#endif
2204
Patrick Scott5f6bd842010-06-28 16:55:16 -04002205#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002206PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
2207 png_inforp info_ptr, double file_gamma))
2208PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
2209 png_inforp info_ptr, png_fixed_point int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002210#endif
2211
Patrick Scott5f6bd842010-06-28 16:55:16 -04002212#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002213PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
2214 png_inforp info_ptr, png_uint_16p *hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002215#endif
2216
Patrick Scott5f6bd842010-06-28 16:55:16 -04002217#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002218PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2219 png_inforp info_ptr, png_const_uint_16p hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002220#endif
2221
Chris Craikb50c2172013-07-29 15:28:30 -07002222PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
2223 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
2224 int *bit_depth, int *color_type, int *interlace_method,
2225 int *compression_method, int *filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002226
Chris Craikb50c2172013-07-29 15:28:30 -07002227PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2228 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2229 int color_type, int interlace_method, int compression_method,
2230 int filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002231
Patrick Scott5f6bd842010-06-28 16:55:16 -04002232#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002233PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2234 png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
The Android Open Source Project893912b2009-03-03 19:30:05 -08002235 int *unit_type));
2236#endif
2237
Patrick Scott5f6bd842010-06-28 16:55:16 -04002238#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002239PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2240 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2241 int unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002242#endif
2243
Patrick Scott5f6bd842010-06-28 16:55:16 -04002244#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002245PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
2246 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
2247 png_int_32 *X1, int *type, int *nparams, png_charp *units,
2248 png_charpp *params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002249#endif
2250
Patrick Scott5f6bd842010-06-28 16:55:16 -04002251#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002252PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2253 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2254 int type, int nparams, png_const_charp units, png_charpp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002255#endif
2256
Patrick Scott5f6bd842010-06-28 16:55:16 -04002257#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002258PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2259 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2260 int *unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002261#endif
2262
Patrick Scott5f6bd842010-06-28 16:55:16 -04002263#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002264PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2265 png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002266#endif
2267
Chris Craikb50c2172013-07-29 15:28:30 -07002268PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
2269 png_inforp info_ptr, png_colorp *palette, int *num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002270
Chris Craikb50c2172013-07-29 15:28:30 -07002271PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2272 png_inforp info_ptr, png_const_colorp palette, int num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002273
Patrick Scott5f6bd842010-06-28 16:55:16 -04002274#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002275PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2276 png_inforp info_ptr, png_color_8p *sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002277#endif
2278
Patrick Scott5f6bd842010-06-28 16:55:16 -04002279#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002280PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2281 png_inforp info_ptr, png_const_color_8p sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002282#endif
2283
Patrick Scott5f6bd842010-06-28 16:55:16 -04002284#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002285PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2286 png_const_inforp info_ptr, int *file_srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002287#endif
2288
Patrick Scott5f6bd842010-06-28 16:55:16 -04002289#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002290PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2291 png_inforp info_ptr, int srgb_intent));
2292PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
2293 png_inforp info_ptr, int srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002294#endif
2295
Patrick Scott5f6bd842010-06-28 16:55:16 -04002296#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002297PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
2298 png_inforp info_ptr, png_charpp name, int *compression_type,
2299 png_bytepp profile, png_uint_32 *proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002300#endif
2301
Patrick Scott5f6bd842010-06-28 16:55:16 -04002302#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002303PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2304 png_inforp info_ptr, png_const_charp name, int compression_type,
2305 png_const_bytep profile, png_uint_32 proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002306#endif
2307
Patrick Scott5f6bd842010-06-28 16:55:16 -04002308#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002309PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2310 png_inforp info_ptr, png_sPLT_tpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002311#endif
2312
Patrick Scott5f6bd842010-06-28 16:55:16 -04002313#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002314PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2315 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002316#endif
2317
Patrick Scott5f6bd842010-06-28 16:55:16 -04002318#ifdef PNG_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002319/* png_get_text also returns the number of text chunks in *num_text */
Chris Craikb50c2172013-07-29 15:28:30 -07002320PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2321 png_inforp info_ptr, png_textp *text_ptr, int *num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002322#endif
2323
Chris Craikb50c2172013-07-29 15:28:30 -07002324/* Note while png_set_text() will accept a structure whose text,
2325 * language, and translated keywords are NULL pointers, the structure
2326 * returned by png_get_text will always contain regular
2327 * zero-terminated C strings. They might be empty strings but
2328 * they will never be NULL pointers.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002329 */
2330
Patrick Scott5f6bd842010-06-28 16:55:16 -04002331#ifdef PNG_TEXT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002332PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2333 png_inforp info_ptr, png_const_textp text_ptr, int num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002334#endif
2335
Patrick Scott5f6bd842010-06-28 16:55:16 -04002336#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002337PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2338 png_inforp info_ptr, png_timep *mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002339#endif
2340
Patrick Scott5f6bd842010-06-28 16:55:16 -04002341#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002342PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2343 png_inforp info_ptr, png_const_timep mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002344#endif
2345
Patrick Scott5f6bd842010-06-28 16:55:16 -04002346#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002347PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2348 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
2349 png_color_16p *trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002350#endif
2351
Patrick Scott5f6bd842010-06-28 16:55:16 -04002352#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002353PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2354 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
2355 png_const_color_16p trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002356#endif
2357
Patrick Scott5f6bd842010-06-28 16:55:16 -04002358#ifdef PNG_sCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002359PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
2360 png_const_inforp info_ptr, int *unit, double *width, double *height))
2361#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2362 defined(PNG_FLOATING_POINT_SUPPORTED)
2363/* NOTE: this API is currently implemented using floating point arithmetic,
2364 * consequently it can only be used on systems with floating point support.
2365 * In any case the range of values supported by png_fixed_point is small and it
2366 * is highly recommended that png_get_sCAL_s be used instead.
2367 */
2368PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2369 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2370 png_fixed_point *width, png_fixed_point *height))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002371#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002372PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2373 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2374 png_charpp swidth, png_charpp sheight));
2375
2376PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
2377 png_inforp info_ptr, int unit, double width, double height))
2378PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
2379 png_inforp info_ptr, int unit, png_fixed_point width,
2380 png_fixed_point height))
2381PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2382 png_inforp info_ptr, int unit,
2383 png_const_charp swidth, png_const_charp sheight));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002384#endif /* PNG_sCAL_SUPPORTED */
2385
Chris Craikb50c2172013-07-29 15:28:30 -07002386#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2387/* Provide the default handling for all unknown chunks or, optionally, for
2388 * specific unknown chunks.
2389 *
2390 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2391 * ignored and the default was used, the per-chunk setting only had an effect on
2392 * write. If you wish to have chunk-specific handling on read in code that must
2393 * work on earlier versions you must use a user chunk callback to specify the
2394 * desired handling (keep or discard.)
2395 *
2396 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2397 * parameter is interpreted as follows:
2398 *
2399 * READ:
2400 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2401 * Known chunks: do normal libpng processing, do not keep the chunk (but
2402 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2403 * Unknown chunks: for a specific chunk use the global default, when used
2404 * as the default discard the chunk data.
2405 * PNG_HANDLE_CHUNK_NEVER:
2406 * Discard the chunk data.
2407 * PNG_HANDLE_CHUNK_IF_SAFE:
2408 * Keep the chunk data if the chunk is not critical else raise a chunk
2409 * error.
2410 * PNG_HANDLE_CHUNK_ALWAYS:
2411 * Keep the chunk data.
2412 *
2413 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2414 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2415 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2416 * it simply resets the behavior to the libpng default.
2417 *
2418 * INTERACTION WTIH USER CHUNK CALLBACKS:
2419 * The per-chunk handling is always used when there is a png_user_chunk_ptr
2420 * callback and the callback returns 0; the chunk is then always stored *unless*
2421 * it is critical and the per-chunk setting is other than ALWAYS. Notice that
2422 * the global default is *not* used in this case. (In effect the per-chunk
2423 * value is incremented to at least IF_SAFE.)
2424 *
2425 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2426 * per-chunk defaults will be honored. If you want to preserve the current
2427 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2428 * as the default - if you don't do this libpng 1.6 will issue a warning.
2429 *
2430 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2431 * earlier simply return '1' (handled).
2432 *
2433 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2434 * If this is *not* set known chunks will always be handled by libpng and
2435 * will never be stored in the unknown chunk list. Known chunks listed to
2436 * png_set_keep_unknown_chunks will have no effect. If it is set then known
2437 * chunks listed with a keep other than AS_DEFAULT will *never* be processed
2438 * by libpng, in addition critical chunks must either be processed by the
2439 * callback or saved.
2440 *
2441 * The IHDR and IEND chunks must not be listed. Because this turns off the
2442 * default handling for chunks that would otherwise be recognized the
2443 * behavior of libpng transformations may well become incorrect!
2444 *
2445 * WRITE:
2446 * When writing chunks the options only apply to the chunks specified by
2447 * png_set_unknown_chunks (below), libpng will *always* write known chunks
2448 * required by png_set_ calls and will always write the core critical chunks
2449 * (as required for PLTE).
2450 *
2451 * Each chunk in the png_set_unknown_chunks list is looked up in the
2452 * png_set_keep_unknown_chunks list to find the keep setting, this is then
2453 * interpreted as follows:
2454 *
2455 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2456 * Write safe-to-copy chunks and write other chunks if the global
2457 * default is set to _ALWAYS, otherwise don't write this chunk.
2458 * PNG_HANDLE_CHUNK_NEVER:
2459 * Do not write the chunk.
2460 * PNG_HANDLE_CHUNK_IF_SAFE:
2461 * Write the chunk if it is safe-to-copy, otherwise do not write it.
2462 * PNG_HANDLE_CHUNK_ALWAYS:
2463 * Write the chunk.
2464 *
2465 * Note that the default behavior is effectively the opposite of the read case -
2466 * in read unknown chunks are not stored by default, in write they are written
2467 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2468 * - on write the safe-to-copy bit is checked, on read the critical bit is
2469 * checked and on read if the chunk is critical an error will be raised.
2470 *
2471 * num_chunks:
2472 * ===========
2473 * If num_chunks is positive, then the "keep" parameter specifies the manner
2474 * for handling only those chunks appearing in the chunk_list array,
2475 * otherwise the chunk list array is ignored.
2476 *
2477 * If num_chunks is 0 the "keep" parameter specifies the default behavior for
2478 * unknown chunks, as described above.
2479 *
2480 * If num_chunks is negative, then the "keep" parameter specifies the manner
2481 * for handling all unknown chunks plus all chunks recognized by libpng
2482 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2483 * be processed by libpng.
2484 */
2485PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
2486 int keep, png_const_bytep chunk_list, int num_chunks));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002487
Chris Craikb50c2172013-07-29 15:28:30 -07002488/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2489 * the result is therefore true (non-zero) if special handling is required,
2490 * false for the default handling.
2491 */
2492PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
2493 png_const_bytep chunk_name));
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002494#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002495
2496#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
2497PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
2498 png_inforp info_ptr, png_const_unknown_chunkp unknowns,
2499 int num_unknowns));
2500 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2501 * unknowns to the location currently stored in the png_struct. This is
2502 * invariably the wrong value on write. To fix this call the following API
2503 * for each chunk in the list with the correct location. If you know your
2504 * code won't be compiled on earlier versions you can rely on
2505 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2506 * the correct thing.
2507 */
2508
2509PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2510 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
2511
2512PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
2513 png_inforp info_ptr, png_unknown_chunkpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002514#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002515
2516/* Png_free_data() will turn off the "valid" flag for anything it frees.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002517 * If you need to turn it off for a chunk that your application has freed,
2518 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2519 */
Chris Craikb50c2172013-07-29 15:28:30 -07002520PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2521 png_inforp info_ptr, int mask));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002522
Patrick Scott5f6bd842010-06-28 16:55:16 -04002523#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002524/* The "params" pointer is currently not used and is for future expansion. */
Chris Craikb50c2172013-07-29 15:28:30 -07002525PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
2526 int transforms, png_voidp params));
2527PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
2528 int transforms, png_voidp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002529#endif
2530
Chris Craikb50c2172013-07-29 15:28:30 -07002531PNG_EXPORT(180, png_const_charp, png_get_copyright,
2532 (png_const_structrp png_ptr));
2533PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2534 (png_const_structrp png_ptr));
2535PNG_EXPORT(182, png_const_charp, png_get_header_version,
2536 (png_const_structrp png_ptr));
2537PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2538 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002539
2540#ifdef PNG_MNG_FEATURES_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002541PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
2542 png_uint_32 mng_features_permitted));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002543#endif
2544
2545/* For use in png_set_keep_unknown, added to version 1.2.6 */
2546#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2547#define PNG_HANDLE_CHUNK_NEVER 1
2548#define PNG_HANDLE_CHUNK_IF_SAFE 2
2549#define PNG_HANDLE_CHUNK_ALWAYS 3
Chris Craikb50c2172013-07-29 15:28:30 -07002550#define PNG_HANDLE_CHUNK_LAST 4
The Android Open Source Project893912b2009-03-03 19:30:05 -08002551
2552/* Strip the prepended error numbers ("#nnn ") from error and warning
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002553 * messages before passing them to the error or warning handler.
2554 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002555#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002556PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
2557 png_uint_32 strip_mode));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002558#endif
2559
Chris Craikb50c2172013-07-29 15:28:30 -07002560/* Added in libpng-1.2.6 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002561#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002562PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
2563 png_uint_32 user_width_max, png_uint_32 user_height_max));
2564PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2565 (png_const_structrp png_ptr));
2566PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2567 (png_const_structrp png_ptr));
2568/* Added in libpng-1.4.0 */
2569PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
2570 png_uint_32 user_chunk_cache_max));
2571PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2572 (png_const_structrp png_ptr));
2573/* Added in libpng-1.4.1 */
2574PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
2575 png_alloc_size_t user_chunk_cache_max));
2576PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2577 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002578#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002579
2580#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2581PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2582 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2583
2584PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2585 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2586
2587PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2588 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2589
2590PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2591 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2592#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2593PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2594 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2595#endif
2596
2597PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
2598 png_const_inforp info_ptr))
2599#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2600PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2601 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2602#endif
2603
2604# ifdef PNG_pHYs_SUPPORTED
2605PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2606 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2607 int *unit_type));
2608# endif /* PNG_pHYs_SUPPORTED */
2609#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
2610
2611/* Added in libpng-1.4.0 */
2612#ifdef PNG_IO_STATE_SUPPORTED
2613PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
2614
2615/* Removed from libpng 1.6; use png_get_io_chunk_type. */
2616PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
2617 PNG_DEPRECATED)
2618
2619PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2620 (png_const_structrp png_ptr));
2621
2622/* The flags returned by png_get_io_state() are the following: */
2623# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2624# define PNG_IO_READING 0x0001 /* currently reading */
2625# define PNG_IO_WRITING 0x0002 /* currently writing */
2626# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2627# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2628# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2629# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2630# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2631# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
2632#endif /* ?PNG_IO_STATE_SUPPORTED */
2633
2634/* Interlace support. The following macros are always defined so that if
2635 * libpng interlace handling is turned off the macros may be used to handle
2636 * interlaced images within the application.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002637 */
Chris Craikb50c2172013-07-29 15:28:30 -07002638#define PNG_INTERLACE_ADAM7_PASSES 7
2639
2640/* Two macros to return the first row and first column of the original,
2641 * full, image which appears in a given pass. 'pass' is in the range 0
2642 * to 6 and the result is in the range 0 to 7.
2643 */
2644#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2645#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2646
2647/* A macro to return the offset between pixels in the output row for a pair of
2648 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2649 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2650 * COL_OFFSET is from one column to the next, within a row.
2651 */
2652#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2653#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2654
2655/* Two macros to help evaluate the number of rows or columns in each
2656 * pass. This is expressed as a shift - effectively log2 of the number or
2657 * rows or columns in each 8x8 tile of the original image.
2658 */
2659#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2660#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2661
2662/* Hence two macros to determine the number of rows or columns in a given
2663 * pass of an image given its height or width. In fact these macros may
2664 * return non-zero even though the sub-image is empty, because the other
2665 * dimension may be empty for a small image.
2666 */
2667#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2668 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2669#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2670 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2671
2672/* For the reader row callbacks (both progressive and sequential) it is
2673 * necessary to find the row in the output image given a row in an interlaced
2674 * image, so two more macros:
2675 */
2676#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2677 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2678#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2679 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2680
2681/* Two macros which return a boolean (0 or 1) saying whether the given row
2682 * or column is in a particular pass. These use a common utility macro that
2683 * returns a mask for a given pass - the offset 'off' selects the row or
2684 * column version. The mask has the appropriate bit set for each column in
2685 * the tile.
2686 */
2687#define PNG_PASS_MASK(pass,off) ( \
2688 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2689 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2690
2691#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2692 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2693#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2694 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002695
2696#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2697/* With these routines we avoid an integer divide, which will be slower on
2698 * most machines. However, it does take more operations than the corresponding
2699 * divide method, so it may be slower on a few RISC systems. There are two
2700 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2701 *
2702 * Note that the rounding factors are NOT supposed to be the same! 128 and
2703 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2704 * standard method.
2705 *
2706 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2707 */
2708
Chris Craikb50c2172013-07-29 15:28:30 -07002709 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002710
Chris Craikb50c2172013-07-29 15:28:30 -07002711# define png_composite(composite, fg, alpha, bg) \
2712 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2713 * (png_uint_16)(alpha) \
2714 + (png_uint_16)(bg)*(png_uint_16)(255 \
2715 - (png_uint_16)(alpha)) + 128); \
The Android Open Source Project893912b2009-03-03 19:30:05 -08002716 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2717
Chris Craikb50c2172013-07-29 15:28:30 -07002718# define png_composite_16(composite, fg, alpha, bg) \
2719 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2720 * (png_uint_32)(alpha) \
2721 + (png_uint_32)(bg)*(65535 \
2722 - (png_uint_32)(alpha)) + 32768); \
The Android Open Source Project893912b2009-03-03 19:30:05 -08002723 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2724
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002725#else /* Standard method using integer division */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002726
Chris Craikb50c2172013-07-29 15:28:30 -07002727# define png_composite(composite, fg, alpha, bg) \
2728 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
2729 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2730 127) / 255)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002731
2732# define png_composite_16(composite, fg, alpha, bg) \
2733 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
Chris Craikb50c2172013-07-29 15:28:30 -07002734 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2735 32767) / 65535)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002736#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2737
Chris Craikb50c2172013-07-29 15:28:30 -07002738#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2739PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2740PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2741PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2742#endif
2743
2744PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
2745 png_const_bytep buf));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002746/* No png_get_int_16 -- may be added if there's a real need for it. */
2747
Chris Craikb50c2172013-07-29 15:28:30 -07002748/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2749#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2750PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2751#endif
2752#ifdef PNG_SAVE_INT_32_SUPPORTED
2753PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2754#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002755
2756/* Place a 16-bit number into a buffer in PNG byte order.
2757 * The parameter is declared unsigned int, not png_uint_16,
2758 * just to avoid potential problems on pre-ANSI C compilers.
2759 */
Chris Craikb50c2172013-07-29 15:28:30 -07002760#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2761PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002762/* No png_save_int_16 -- may be added if there's a real need for it. */
Chris Craikb50c2172013-07-29 15:28:30 -07002763#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002764
Chris Craikb50c2172013-07-29 15:28:30 -07002765#ifdef PNG_USE_READ_MACROS
2766/* Inline macros to do direct reads of bytes from the input buffer.
2767 * The png_get_int_32() routine assumes we are using two's complement
2768 * format for negative values, which is almost certainly true.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002769 */
Chris Craikb50c2172013-07-29 15:28:30 -07002770# define PNG_get_uint_32(buf) \
2771 (((png_uint_32)(*(buf)) << 24) + \
2772 ((png_uint_32)(*((buf) + 1)) << 16) + \
2773 ((png_uint_32)(*((buf) + 2)) << 8) + \
2774 ((png_uint_32)(*((buf) + 3))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002775
Chris Craikb50c2172013-07-29 15:28:30 -07002776 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2777 * function) incorrectly returned a value of type png_uint_32.
2778 */
2779# define PNG_get_uint_16(buf) \
2780 ((png_uint_16) \
2781 (((unsigned int)(*(buf)) << 8) + \
2782 ((unsigned int)(*((buf) + 1)))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002783
Chris Craikb50c2172013-07-29 15:28:30 -07002784# define PNG_get_int_32(buf) \
2785 ((png_int_32)((*(buf) & 0x80) \
2786 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2787 : (png_int_32)png_get_uint_32(buf)))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002788
Chris Craikb50c2172013-07-29 15:28:30 -07002789 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2790 * but defining a macro name prefixed with PNG_PREFIX.
2791 */
2792# ifndef PNG_PREFIX
2793# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2794# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2795# define png_get_int_32(buf) PNG_get_int_32(buf)
2796# endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002797#else
Chris Craikb50c2172013-07-29 15:28:30 -07002798# ifdef PNG_PREFIX
2799 /* No macros; revert to the (redefined) function */
2800# define PNG_get_uint_32 (png_get_uint_32)
2801# define PNG_get_uint_16 (png_get_uint_16)
2802# define PNG_get_int_32 (png_get_int_32)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002803# endif
2804#endif
2805
Chris Craikb50c2172013-07-29 15:28:30 -07002806/*******************************************************************************
2807 * SIMPLIFIED API
2808 *******************************************************************************
2809 *
2810 * Please read the documentation in libpng-manual.txt (TODO: write said
2811 * documentation) if you don't understand what follows.
2812 *
2813 * The simplified API hides the details of both libpng and the PNG file format
2814 * itself. It allows PNG files to be read into a very limited number of
2815 * in-memory bitmap formats or to be written from the same formats. If these
2816 * formats do not accomodate your needs then you can, and should, use the more
2817 * sophisticated APIs above - these support a wide variety of in-memory formats
2818 * and a wide variety of sophisticated transformations to those formats as well
2819 * as a wide variety of APIs to manipulate ancillary information.
2820 *
2821 * To read a PNG file using the simplified API:
2822 *
2823 * 1) Declare a 'png_image' structure (see below) on the stack and set the
2824 * version field to PNG_IMAGE_VERSION.
2825 * 2) Call the appropriate png_image_begin_read... function.
2826 * 3) Set the png_image 'format' member to the required sample format.
2827 * 4) Allocate a buffer for the image and, if required, the color-map.
2828 * 5) Call png_image_finish_read to read the image and, if required, the
2829 * color-map into your buffers.
2830 *
2831 * There are no restrictions on the format of the PNG input itself; all valid
2832 * color types, bit depths, and interlace methods are acceptable, and the
2833 * input image is transformed as necessary to the requested in-memory format
2834 * during the png_image_finish_read() step. The only caveat is that if you
2835 * request a color-mapped image from a PNG that is full-color or makes
2836 * complex use of an alpha channel the transformation is extremely lossy and the
2837 * result may look terrible.
2838 *
2839 * To write a PNG file using the simplified API:
2840 *
2841 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2842 * 2) Initialize the members of the structure that describe the image, setting
2843 * the 'format' member to the format of the image samples.
2844 * 3) Call the appropriate png_image_write... function with a pointer to the
2845 * image and, if necessary, the color-map to write the PNG data.
2846 *
2847 * png_image is a structure that describes the in-memory format of an image
2848 * when it is being read or defines the in-memory format of an image that you
2849 * need to write:
2850 */
2851#define PNG_IMAGE_VERSION 1
The Android Open Source Project893912b2009-03-03 19:30:05 -08002852
Chris Craikb50c2172013-07-29 15:28:30 -07002853typedef struct png_control *png_controlp;
2854typedef struct
2855{
2856 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2857 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2858 png_uint_32 width; /* Image width in pixels (columns) */
2859 png_uint_32 height; /* Image height in pixels (rows) */
2860 png_uint_32 format; /* Image format as defined below */
2861 png_uint_32 flags; /* A bit mask containing informational flags */
2862 png_uint_32 colormap_entries;
2863 /* Number of entries in the color-map */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002864
Chris Craikb50c2172013-07-29 15:28:30 -07002865 /* In the event of an error or warning the following field will be set to a
2866 * non-zero value and the 'message' field will contain a '\0' terminated
2867 * string with the libpng error or warning message. If both warnings and
2868 * an error were encountered, only the error is recorded. If there
2869 * are multiple warnings, only the first one is recorded.
2870 *
2871 * The upper 30 bits of this value are reserved, the low two bits contain
2872 * a value as follows:
2873 */
2874# define PNG_IMAGE_WARNING 1
2875# define PNG_IMAGE_ERROR 2
2876 /*
2877 * The result is a two bit code such that a value more than 1 indicates
2878 * a failure in the API just called:
2879 *
2880 * 0 - no warning or error
2881 * 1 - warning
2882 * 2 - error
2883 * 3 - error preceded by warning
2884 */
2885# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002886
Chris Craikb50c2172013-07-29 15:28:30 -07002887 png_uint_32 warning_or_error;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002888
Chris Craikb50c2172013-07-29 15:28:30 -07002889 char message[64];
2890} png_image, *png_imagep;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002891
Chris Craikb50c2172013-07-29 15:28:30 -07002892/* The samples of the image have one to four channels whose components have
2893 * original values in the range 0 to 1.0:
2894 *
2895 * 1: A single gray or luminance channel (G).
2896 * 2: A gray/luminance channel and an alpha channel (GA).
2897 * 3: Three red, green, blue color channels (RGB).
2898 * 4: Three color channels and an alpha channel (RGBA).
2899 *
2900 * The components are encoded in one of two ways:
2901 *
2902 * a) As a small integer, value 0..255, contained in a single byte. For the
2903 * alpha channel the original value is simply value/255. For the color or
2904 * luminance channels the value is encoded according to the sRGB specification
2905 * and matches the 8-bit format expected by typical display devices.
2906 *
2907 * The color/gray channels are not scaled (pre-multiplied) by the alpha
2908 * channel and are suitable for passing to color management software.
2909 *
2910 * b) As a value in the range 0..65535, contained in a 2-byte integer. All
2911 * channels can be converted to the original value by dividing by 65535; all
2912 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2913 * the sRGB specification. This encoding is identified by the
2914 * PNG_FORMAT_FLAG_LINEAR flag below.
2915 *
2916 * When the simplified API needs to convert between sRGB and linear colorspaces,
2917 * the actual sRGB transfer curve defined in the sRGB specification (see the
2918 * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2919 * approximation used elsewhere in libpng.
2920 *
2921 * When an alpha channel is present it is expected to denote pixel coverage
2922 * of the color or luminance channels and is returned as an associated alpha
2923 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2924 * value.
2925 *
2926 * The samples are either contained directly in the image data, between 1 and 8
2927 * bytes per pixel according to the encoding, or are held in a color-map indexed
2928 * by bytes in the image data. In the case of a color-map the color-map entries
2929 * are individual samples, encoded as above, and the image data has one byte per
2930 * pixel to select the relevant sample from the color-map.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002931 */
2932
Chris Craikb50c2172013-07-29 15:28:30 -07002933/* PNG_FORMAT_*
2934 *
2935 * #defines to be used in png_image::format. Each #define identifies a
2936 * particular layout of sample data and, if present, alpha values. There are
2937 * separate defines for each of the two component encodings.
2938 *
2939 * A format is built up using single bit flag values. All combinations are
2940 * valid. Formats can be built up from the flag values or you can use one of
2941 * the predefined values below. When testing formats always use the FORMAT_FLAG
2942 * macros to test for individual features - future versions of the library may
2943 * add new flags.
2944 *
2945 * When reading or writing color-mapped images the format should be set to the
2946 * format of the entries in the color-map then png_image_{read,write}_colormap
2947 * called to read or write the color-map and set the format correctly for the
2948 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
2949 *
2950 * NOTE: libpng can be built with particular features disabled, if you see
2951 * compiler errors because the definition of one of the following flags has been
2952 * compiled out it is because libpng does not have the required support. It is
2953 * possible, however, for the libpng configuration to enable the format on just
2954 * read or just write; in that case you may see an error at run time. You can
2955 * guard against this by checking for the definition of the appropriate
2956 * "_SUPPORTED" macro, one of:
2957 *
2958 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2959 */
2960#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2961#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
2962#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */
2963#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002964
Chris Craikb50c2172013-07-29 15:28:30 -07002965#ifdef PNG_FORMAT_BGR_SUPPORTED
2966# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002967#endif
2968
Chris Craikb50c2172013-07-29 15:28:30 -07002969#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2970# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002971#endif
2972
Chris Craikb50c2172013-07-29 15:28:30 -07002973/* Commonly used formats have predefined macros.
2974 *
2975 * First the single byte (sRGB) formats:
2976 */
2977#define PNG_FORMAT_GRAY 0
2978#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
2979#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2980#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2981#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2982#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2983#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2984#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2985#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2986
2987/* Then the linear 2-byte formats. When naming these "Y" is used to
2988 * indicate a luminance (gray) channel.
2989 */
2990#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2991#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2992#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2993#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2994 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2995
2996/* With color-mapped formats the image data is one byte for each pixel, the byte
2997 * is an index into the color-map which is formatted as above. To obtain a
2998 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2999 * to one of the above definitions, or you can use one of the definitions below.
3000 */
3001#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
3002#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
3003#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
3004#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
3005#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
3006#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
3007
3008/* PNG_IMAGE macros
3009 *
3010 * These are convenience macros to derive information from a png_image
3011 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
3012 * actual image sample values - either the entries in the color-map or the
3013 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
3014 * for the pixels and will always return 1 for color-mapped formats. The
3015 * remaining macros return information about the rows in the image and the
3016 * complete image.
3017 *
3018 * NOTE: All the macros that take a png_image::format parameter are compile time
3019 * constants if the format parameter is, itself, a constant. Therefore these
3020 * macros can be used in array declarations and case labels where required.
3021 * Similarly the macros are also pre-processor constants (sizeof is not used) so
3022 * they can be used in #if tests.
3023 *
3024 * First the information about the samples.
3025 */
3026#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
3027 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
3028 /* Return the total number of channels in a given format: 1..4 */
3029
3030#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
3031 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
3032 /* Return the size in bytes of a single component of a pixel or color-map
3033 * entry (as appropriate) in the image: 1 or 2.
3034 */
3035
3036#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
3037 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
3038 /* This is the size of the sample data for one sample. If the image is
3039 * color-mapped it is the size of one color-map entry (and image pixels are
3040 * one byte in size), otherwise it is the size of one image pixel.
3041 */
3042
3043#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
3044 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
3045 /* The maximum size of the color-map required by the format expressed in a
3046 * count of components. This can be used to compile-time allocate a
3047 * color-map:
3048 *
3049 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
3050 *
3051 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
3052 *
3053 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
3054 * information from one of the png_image_begin_read_ APIs and dynamically
3055 * allocate the required memory.
3056 */
3057
3058/* Corresponding information about the pixels */
3059#define PNG_IMAGE_PIXEL_(test,fmt)\
3060 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
3061
3062#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
3063 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
3064 /* The number of separate channels (components) in a pixel; 1 for a
3065 * color-mapped image.
3066 */
3067
3068#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
3069 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
3070 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
3071 * image.
3072 */
3073
3074#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
3075 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
3076
3077/* Information about the whole row, or whole image */
3078#define PNG_IMAGE_ROW_STRIDE(image)\
3079 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
3080 /* Return the total number of components in a single row of the image; this
3081 * is the minimum 'row stride', the minimum count of components between each
3082 * row. For a color-mapped image this is the minimum number of bytes in a
3083 * row.
3084 */
3085
3086#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
3087 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
3088 /* Return the size, in bytes, of an image buffer given a png_image and a row
3089 * stride - the number of components to leave space for in each row.
3090 */
3091
3092#define PNG_IMAGE_SIZE(image)\
3093 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
3094 /* Return the size, in bytes, of the image in memory given just a png_image;
3095 * the row stride is the minimum stride required for the image.
3096 */
3097
3098#define PNG_IMAGE_COLORMAP_SIZE(image)\
3099 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
3100 /* Return the size, in bytes, of the color-map of this image. If the image
3101 * format is not a color-map format this will return a size sufficient for
3102 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
3103 * you don't want to allocate a color-map in this case.
3104 */
3105
3106/* PNG_IMAGE_FLAG_*
3107 *
3108 * Flags containing additional information about the image are held in the
3109 * 'flags' field of png_image.
3110 */
3111#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
3112 /* This indicates the the RGB values of the in-memory bitmap do not
3113 * correspond to the red, green and blue end-points defined by sRGB.
3114 */
3115
3116#define PNG_IMAGE_FLAG_FAST 0x02
3117 /* On write emphasise speed over compression; the resultant PNG file will be
3118 * larger but will be produced significantly faster, particular for large
3119 * images. Do not use this option for images which will be distributed, only
3120 * used it when producing intermediate files that will be read back in
3121 * repeatedly. For a typical 24-bit image the option will double the read
3122 * speed at the cost of increasing the image size by 25%, however for many
3123 * more compressible images the PNG file can be 10 times larger with only a
3124 * slight speed gain.
3125 */
3126
3127#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
3128 /* On read if the image is a 16-bit per component image and there is no gAMA
3129 * or sRGB chunk assume that the components are sRGB encoded. Notice that
3130 * images output by the simplified API always have gamma information; setting
3131 * this flag only affects the interpretation of 16-bit images from an
3132 * external source. It is recommended that the application expose this flag
3133 * to the user; the user can normally easily recognize the difference between
3134 * linear and sRGB encoding. This flag has no effect on write - the data
3135 * passed to the write APIs must have the correct encoding (as defined
3136 * above.)
3137 *
3138 * If the flag is not set (the default) input 16-bit per component data is
3139 * assumed to be linear.
3140 *
3141 * NOTE: the flag can only be set after the png_image_begin_read_ call,
3142 * because that call initializes the 'flags' field.
3143 */
3144
3145#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
3146/* READ APIs
3147 * ---------
3148 *
3149 * The png_image passed to the read APIs must have been initialized by setting
3150 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
3151 */
3152#ifdef PNG_STDIO_SUPPORTED
3153PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
3154 const char *file_name));
3155 /* The named file is opened for read and the image header is filled in
3156 * from the PNG header in the file.
3157 */
3158
3159PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
3160 FILE* file));
3161 /* The PNG header is read from the stdio FILE object. */
3162#endif /* PNG_STDIO_SUPPORTED */
3163
3164PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
3165 png_const_voidp memory, png_size_t size));
3166 /* The PNG header is read from the given memory buffer. */
3167
3168PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
3169 png_const_colorp background, void *buffer, png_int_32 row_stride,
3170 void *colormap));
3171 /* Finish reading the image into the supplied buffer and clean up the
3172 * png_image structure.
3173 *
3174 * row_stride is the step, in byte or 2-byte units as appropriate,
3175 * between adjacent rows. A positive stride indicates that the top-most row
3176 * is first in the buffer - the normal top-down arrangement. A negative
3177 * stride indicates that the bottom-most row is first in the buffer.
3178 *
3179 * background need only be supplied if an alpha channel must be removed from
3180 * a png_byte format and the removal is to be done by compositing on a solid
3181 * color; otherwise it may be NULL and any composition will be done directly
3182 * onto the buffer. The value is an sRGB color to use for the background,
3183 * for grayscale output the green channel is used.
3184 *
3185 * background must be supplied when an alpha channel must be removed from a
3186 * single byte color-mapped output format, in other words if:
3187 *
3188 * 1) The original format from png_image_begin_read_from_* had
3189 * PNG_FORMAT_FLAG_ALPHA set.
3190 * 2) The format set by the application does not.
3191 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3192 * PNG_FORMAT_FLAG_LINEAR *not* set.
3193 *
3194 * For linear output removing the alpha channel is always done by compositing
3195 * on black and background is ignored.
3196 *
3197 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3198 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3199 * image->colormap_entries will be updated to the actual number of entries
3200 * written to the colormap; this may be less than the original value.
3201 */
3202
3203PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3204 /* Free any data allocated by libpng in image->opaque, setting the pointer to
3205 * NULL. May be called at any time after the structure is initialized.
3206 */
3207#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */
3208
3209#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
3210#ifdef PNG_STDIO_SUPPORTED
3211/* WRITE APIS
3212 * ----------
3213 * For write you must initialize a png_image structure to describe the image to
3214 * be written. To do this use memset to set the whole structure to 0 then
3215 * initialize fields describing your image.
3216 *
3217 * version: must be set to PNG_IMAGE_VERSION
3218 * opaque: must be initialized to NULL
3219 * width: image width in pixels
3220 * height: image height in rows
3221 * format: the format of the data (image and color-map) you wish to write
3222 * flags: set to 0 unless one of the defined flags applies; set
3223 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3224 * values do not correspond to the colors in sRGB.
3225 * colormap_entries: set to the number of entries in the color-map (0 to 256)
3226 */
3227PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3228 const char *file, int convert_to_8bit, const void *buffer,
3229 png_int_32 row_stride, const void *colormap));
3230 /* Write the image to the named file. */
3231
3232PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
3233 int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3234 const void *colormap));
3235 /* Write the image to the given (FILE*). */
3236
3237/* With both write APIs if image is in one of the linear formats with 16-bit
3238 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3239 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3240 * encoded PNG file is written.
3241 *
3242 * With color-mapped data formats the colormap parameter point to a color-map
3243 * with at least image->colormap_entries encoded in the specified format. If
3244 * the format is linear the written PNG color-map will be converted to sRGB
3245 * regardless of the convert_to_8_bit flag.
3246 *
3247 * With all APIs row_stride is handled as in the read APIs - it is the spacing
3248 * from one row to the next in component sized units (1 or 2 bytes) and if
3249 * negative indicates a bottom-up row layout in the buffer.
3250 *
3251 * Note that the write API does not support interlacing or sub-8-bit pixels.
3252 */
3253#endif /* PNG_STDIO_SUPPORTED */
3254#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
3255/*******************************************************************************
3256 * END OF SIMPLIFIED API
3257 ******************************************************************************/
3258
3259#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
3260PNG_EXPORT(242, void, png_set_check_for_invalid_index,
3261 (png_structrp png_ptr, int allowed));
3262# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
3263PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
3264 png_const_infop info_ptr));
3265# endif
3266#endif /* CHECK_FOR_INVALID_INDEX */
3267
3268/*******************************************************************************
3269 * IMPLEMENTATION OPTIONS
3270 *******************************************************************************
3271 *
3272 * Support for arbitrary implementation-specific optimizations. The API allows
3273 * particular options to be turned on or off. 'Option' is the number of the
3274 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3275 * by the PNG_OPTION_ defines below.
3276 *
3277 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
3278 * are detected at run time, however sometimes it may be impossible
3279 * to do this in user mode, in which case it is necessary to discover
3280 * the capabilities in an OS specific way. Such capabilities are
3281 * listed here when libpng has support for them and must be turned
3282 * ON by the application if present.
3283 *
3284 * SOFTWARE: sometimes software optimizations actually result in performance
3285 * decrease on some architectures or systems, or with some sets of
3286 * PNG images. 'Software' options allow such optimizations to be
3287 * selected at run time.
3288 */
3289#ifdef PNG_SET_OPTION_SUPPORTED
3290#ifdef PNG_ARM_NEON_API_SUPPORTED
3291# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3292#endif
3293#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3294#define PNG_OPTION_NEXT 4 /* Next option - numbers must be even */
3295
3296/* Return values: NOTE: there are four values and 'off' is *not* zero */
3297#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3298#define PNG_OPTION_INVALID 1 /* Option number out of range */
3299#define PNG_OPTION_OFF 2
3300#define PNG_OPTION_ON 3
3301
3302PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3303 int onoff));
The Android Open Source Project893912b2009-03-03 19:30:05 -08003304#endif
3305
Chris Craikb50c2172013-07-29 15:28:30 -07003306/*******************************************************************************
3307 * END OF HARDWARE OPTIONS
3308 ******************************************************************************/
3309
3310/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
3311 * defs, scripts/pnglibconf.h, and scripts/pnglibconf.h.prebuilt
3312 */
3313
3314/* The last ordinal number (this is the *last* one already used; the next
3315 * one to use is one more than this.) Maintainer, remember to add an entry to
3316 * scripts/symbols.def as well.
3317 */
3318#ifdef PNG_EXPORT_LAST_ORDINAL
3319 PNG_EXPORT_LAST_ORDINAL(244);
The Android Open Source Project893912b2009-03-03 19:30:05 -08003320#endif
3321
The Android Open Source Project893912b2009-03-03 19:30:05 -08003322#ifdef __cplusplus
3323}
3324#endif
3325
3326#endif /* PNG_VERSION_INFO_ONLY */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04003327/* Do not put anything past this line */
The Android Open Source Project893912b2009-03-03 19:30:05 -08003328#endif /* PNG_H */