blob: 16d3299aaa5284ed7b7fb79392794bd2b11f202e [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 *
Sireesh Tripurarib478e662014-05-09 15:15:10 +05304 * libpng version 1.6.10 - March 6, 2014
5 * Copyright (c) 1998-2014 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
Sireesh Tripurarib478e662014-05-09 15:15:10 +053014 * libpng versions 0.97, January 1998, through 1.6.10 - March 6, 2014: Glenn
Chris Craikb50c2172013-07-29 15:28:30 -070015 * 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]
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530181 * 1.6.4beta01-02 16 10604 16.so.16.4[.0]
182 * 1.6.4rc01 16 10604 16.so.16.4[.0]
183 * 1.6.4 16 10604 16.so.16.4[.0]
184 * 1.6.5 16 10605 16.so.16.5[.0]
185 * 1.6.6 16 10606 16.so.16.6[.0]
186 * 1.6.7beta01-04 16 10607 16.so.16.7[.0]
187 * 1.6.7rc01-03 16 10607 16.so.16.7[.0]
188 * 1.6.7 16 10607 16.so.16.7[.0]
189 * 1.6.8beta01-02 16 10608 16.so.16.8[.0]
190 * 1.6.8rc01-02 16 10608 16.so.16.8[.0]
191 * 1.6.8 16 10608 16.so.16.8[.0]
192 * 1.6.9beta01-04 16 10609 16.so.16.9[.0]
193 * 1.6.9rc01-02 16 10609 16.so.16.9[.0]
194 * 1.6.9 16 10609 16.so.16.9[.0]
195 * 1.6.10beta01-03 16 10610 16.so.16.10[.0]
196 * 1.6.10betarc01-04 16 10610 16.so.16.10[.0]
197 * 1.6.10beta 16 10610 16.so.16.10[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800198 *
Chris Craikb50c2172013-07-29 15:28:30 -0700199 * Henceforth the source version will match the shared-library major
200 * and minor numbers; the shared-library major version number will be
201 * used for changes in backward compatibility, as it is intended. The
202 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
203 * for applications, is an unsigned integer of the form xyyzz corresponding
204 * to the source version x.y.z (leading zeros in y and z). Beta versions
205 * were given the previous public release number plus a letter, until
206 * version 1.0.6j; from then on they were given the upcoming public
207 * release number plus "betaNN" or "rcNN".
The Android Open Source Project893912b2009-03-03 19:30:05 -0800208 *
Chris Craikb50c2172013-07-29 15:28:30 -0700209 * Binary incompatibility exists only when applications make direct access
210 * to the info_ptr or png_ptr members through png.h, and the compiled
211 * application is loaded with a different version of the library.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800212 *
Chris Craikb50c2172013-07-29 15:28:30 -0700213 * DLLNUM will change each time there are forward or backward changes
214 * in binary compatibility (e.g., when a new feature is added).
The Android Open Source Project893912b2009-03-03 19:30:05 -0800215 *
Chris Craikb50c2172013-07-29 15:28:30 -0700216 * See libpng-manual.txt or libpng.3 for more information. The PNG
217 * specification is available as a W3C Recommendation and as an ISO
218 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
The Android Open Source Project893912b2009-03-03 19:30:05 -0800219 */
220
221/*
222 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
223 *
224 * If you modify libpng you may insert additional notices immediately following
225 * this sentence.
226 *
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400227 * This code is released under the libpng license.
228 *
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530229 * libpng versions 1.2.6, August 15, 2004, through 1.6.10, March 6, 2014, are
Chris Craikb50c2172013-07-29 15:28:30 -0700230 * Copyright (c) 2004, 2006-2013 Glenn Randers-Pehrson, and are
The Android Open Source Project893912b2009-03-03 19:30:05 -0800231 * distributed according to the same disclaimer and license as libpng-1.2.5
232 * with the following individual added to the list of Contributing Authors:
233 *
234 * Cosmin Truta
235 *
236 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
237 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
238 * distributed according to the same disclaimer and license as libpng-1.0.6
239 * with the following individuals added to the list of Contributing Authors:
240 *
241 * Simon-Pierre Cadieux
242 * Eric S. Raymond
243 * Gilles Vollant
244 *
245 * and with the following additions to the disclaimer:
246 *
247 * There is no warranty against interference with your enjoyment of the
248 * library or against infringement. There is no warranty that our
249 * efforts or the library will fulfill any of your particular purposes
250 * or needs. This library is provided with all faults, and the entire
251 * risk of satisfactory quality, performance, accuracy, and effort is with
252 * the user.
253 *
254 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
255 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
256 * distributed according to the same disclaimer and license as libpng-0.96,
257 * with the following individuals added to the list of Contributing Authors:
258 *
259 * Tom Lane
260 * Glenn Randers-Pehrson
261 * Willem van Schaik
262 *
263 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
264 * Copyright (c) 1996, 1997 Andreas Dilger
265 * Distributed according to the same disclaimer and license as libpng-0.88,
266 * with the following individuals added to the list of Contributing Authors:
267 *
268 * John Bowler
269 * Kevin Bracey
270 * Sam Bushell
271 * Magnus Holmgren
272 * Greg Roelofs
273 * Tom Tanner
274 *
275 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
276 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
277 *
278 * For the purposes of this copyright and license, "Contributing Authors"
279 * is defined as the following set of individuals:
280 *
281 * Andreas Dilger
282 * Dave Martindale
283 * Guy Eric Schalnat
284 * Paul Schmidt
285 * Tim Wegner
286 *
287 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
288 * and Group 42, Inc. disclaim all warranties, expressed or implied,
289 * including, without limitation, the warranties of merchantability and of
290 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
291 * assume no liability for direct, indirect, incidental, special, exemplary,
292 * or consequential damages, which may result from the use of the PNG
293 * Reference Library, even if advised of the possibility of such damage.
294 *
295 * Permission is hereby granted to use, copy, modify, and distribute this
296 * source code, or portions hereof, for any purpose, without fee, subject
297 * to the following restrictions:
298 *
Chris Craikb50c2172013-07-29 15:28:30 -0700299 * 1. The origin of this source code must not be misrepresented.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800300 *
Chris Craikb50c2172013-07-29 15:28:30 -0700301 * 2. Altered versions must be plainly marked as such and must not
302 * be misrepresented as being the original source.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800303 *
Chris Craikb50c2172013-07-29 15:28:30 -0700304 * 3. This Copyright notice may not be removed or altered from
305 * any source or altered source distribution.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800306 *
307 * The Contributing Authors and Group 42, Inc. specifically permit, without
308 * fee, and encourage the use of this source code as a component to
309 * supporting the PNG file format in commercial products. If you use this
310 * source code in a product, acknowledgment is not required but would be
311 * appreciated.
312 */
313
314/*
315 * A "png_get_copyright" function is available, for convenient use in "about"
316 * boxes and the like:
317 *
Chris Craikb50c2172013-07-29 15:28:30 -0700318 * printf("%s", png_get_copyright(NULL));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800319 *
320 * Also, the PNG logo (in PNG format, of course) is supplied in the
321 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
322 */
323
324/*
325 * Libpng is OSI Certified Open Source Software. OSI Certified is a
326 * certification mark of the Open Source Initiative.
327 */
328
329/*
330 * The contributing authors would like to thank all those who helped
331 * with testing, bug fixes, and patience. This wouldn't have been
332 * possible without all of you.
333 *
334 * Thanks to Frank J. T. Wojcik for helping with the documentation.
335 */
336
337/*
338 * Y2K compliance in libpng:
339 * =========================
340 *
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530341 * March 6, 2014
The Android Open Source Project893912b2009-03-03 19:30:05 -0800342 *
343 * Since the PNG Development group is an ad-hoc body, we can't make
344 * an official declaration.
345 *
346 * This is your unofficial assurance that libpng from version 0.71 and
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530347 * upward through 1.6.10 are Y2K compliant. It is my belief that
Chris Craikb50c2172013-07-29 15:28:30 -0700348 * earlier versions were also Y2K compliant.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800349 *
Chris Craikb50c2172013-07-29 15:28:30 -0700350 * Libpng only has two year fields. One is a 2-byte unsigned integer
351 * that will hold years up to 65535. The other, which is deprecated,
352 * holds the date in text format, and will hold years up to 9999.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800353 *
354 * The integer is
355 * "png_uint_16 year" in png_time_struct.
356 *
Chris Craikb50c2172013-07-29 15:28:30 -0700357 * The string is
358 * "char time_buffer[29]" in png_struct. This is no longer used
359 * in libpng-1.6.x and will be removed from libpng-1.7.0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800360 *
361 * There are seven time-related functions:
Chris Craikb50c2172013-07-29 15:28:30 -0700362 * png.c: png_convert_to_rfc_1123_buffer() in png.c
363 * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
364 * png_convert_to_rfc_1152() in error prior to libpng-0.98)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800365 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
366 * png_convert_from_time_t() in pngwrite.c
367 * png_get_tIME() in pngget.c
368 * png_handle_tIME() in pngrutil.c, called in pngread.c
369 * png_set_tIME() in pngset.c
370 * png_write_tIME() in pngwutil.c, called in pngwrite.c
371 *
372 * All handle dates properly in a Y2K environment. The
373 * png_convert_from_time_t() function calls gmtime() to convert from system
374 * clock time, which returns (year - 1900), which we properly convert to
Chris Craikb50c2172013-07-29 15:28:30 -0700375 * the full 4-digit year. There is a possibility that libpng applications
376 * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
The Android Open Source Project893912b2009-03-03 19:30:05 -0800377 * function, or that they are incorrectly passing only a 2-digit year
378 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
379 * but this is not under our control. The libpng documentation has always
380 * stated that it works with 4-digit years, and the APIs have been
381 * documented as such.
382 *
383 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
384 * integer to hold the year, and can hold years as large as 65535.
385 *
386 * zlib, upon which libpng depends, is also Y2K compliant. It contains
387 * no date-related code.
388 *
389 * Glenn Randers-Pehrson
390 * libpng maintainer
391 * PNG Development Group
392 */
393
394#ifndef PNG_H
395#define PNG_H
396
Chris Craikb50c2172013-07-29 15:28:30 -0700397/* 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 -0800398 * describes how to use libpng, and the file example.c summarizes it
399 * with some code on which to build. This file is useful for looking
400 * at the actual function definitions and structure components.
Chris Craikb50c2172013-07-29 15:28:30 -0700401 *
402 * If you just need to read a PNG file and don't want to read the documentation
403 * skip to the end of this file and read the section entitled 'simplified API'.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800404 */
405
406/* Version information for png.h - this should match the version in png.c */
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530407#define PNG_LIBPNG_VER_STRING "1.6.10"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800408#define PNG_HEADER_VERSION_STRING \
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530409 " libpng version 1.6.10 - March 6, 2014\n"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800410
Chris Craikb50c2172013-07-29 15:28:30 -0700411#define PNG_LIBPNG_VER_SONUM 16
412#define PNG_LIBPNG_VER_DLLNUM 16
The Android Open Source Project893912b2009-03-03 19:30:05 -0800413
414/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
415#define PNG_LIBPNG_VER_MAJOR 1
Chris Craikb50c2172013-07-29 15:28:30 -0700416#define PNG_LIBPNG_VER_MINOR 6
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530417#define PNG_LIBPNG_VER_RELEASE 10
Chris Craikb50c2172013-07-29 15:28:30 -0700418
The Android Open Source Project893912b2009-03-03 19:30:05 -0800419/* This should match the numeric part of the final component of
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400420 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
421 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800422
423#define PNG_LIBPNG_VER_BUILD 0
424
425/* Release Status */
426#define PNG_LIBPNG_BUILD_ALPHA 1
427#define PNG_LIBPNG_BUILD_BETA 2
428#define PNG_LIBPNG_BUILD_RC 3
429#define PNG_LIBPNG_BUILD_STABLE 4
430#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400431
The Android Open Source Project893912b2009-03-03 19:30:05 -0800432/* Release-Specific Flags */
433#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
434 PNG_LIBPNG_BUILD_STABLE only */
435#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
436 PNG_LIBPNG_BUILD_SPECIAL */
437#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
438 PNG_LIBPNG_BUILD_PRIVATE */
439
440#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE
441
442/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
443 * We must not include leading zeros.
444 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
445 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400446 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
447 */
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530448#define PNG_LIBPNG_VER 10610 /* 1.6.10 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800449
Chris Craikb50c2172013-07-29 15:28:30 -0700450/* Library configuration: these options cannot be changed after
451 * the library has been built.
452 */
453#ifndef PNGLCONF_H
454 /* If pnglibconf.h is missing, you can
455 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
456 */
457# include "pnglibconf.h"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800458#endif
459
Chris Craikb50c2172013-07-29 15:28:30 -0700460#ifndef PNG_VERSION_INFO_ONLY
461 /* Machine specific configuration. */
462# include "pngconf.h"
463#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800464
465/*
Chris Craikb50c2172013-07-29 15:28:30 -0700466 * Added at libpng-1.2.8
467 *
468 * Ref MSDN: Private as priority over Special
The Android Open Source Project893912b2009-03-03 19:30:05 -0800469 * VS_FF_PRIVATEBUILD File *was not* built using standard release
470 * procedures. If this value is given, the StringFileInfo block must
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400471 * contain a PrivateBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800472 *
473 * VS_FF_SPECIALBUILD File *was* built by the original company using
474 * standard release procedures but is a variation of the standard
475 * file of the same version number. If this value is given, the
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400476 * StringFileInfo block must contain a SpecialBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800477 */
478
Chris Craikb50c2172013-07-29 15:28:30 -0700479#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800480# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700481 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800482#else
Patrick Scott5f6bd842010-06-28 16:55:16 -0400483# ifdef PNG_LIBPNG_SPECIALBUILD
The Android Open Source Project893912b2009-03-03 19:30:05 -0800484# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700485 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800486# else
487# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
488# endif
489#endif
490
491#ifndef PNG_VERSION_INFO_ONLY
492
493/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
494#ifdef __cplusplus
495extern "C" {
496#endif /* __cplusplus */
497
The Android Open Source Project893912b2009-03-03 19:30:05 -0800498/* Version information for C files, stored in png.c. This had better match
499 * the version above.
500 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800501#define png_libpng_ver png_get_header_ver(NULL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800502
Chris Craikb50c2172013-07-29 15:28:30 -0700503/* This file is arranged in several sections:
504 *
505 * 1. Any configuration options that can be specified by for the application
506 * code when it is built. (Build time configuration is in pnglibconf.h)
507 * 2. Type definitions (base types are defined in pngconf.h), structure
508 * definitions.
509 * 3. Exported library functions.
510 * 4. Simplified API.
511 *
512 * The library source code has additional files (principally pngpriv.h) that
513 * allow configuration of the library.
514 */
515/* Section 1: run time configuration
516 * See pnglibconf.h for build time configuration
517 *
518 * Run time configuration allows the application to choose between
519 * implementations of certain arithmetic APIs. The default is set
520 * at build time and recorded in pnglibconf.h, but it is safe to
521 * override these (and only these) settings. Note that this won't
522 * change what the library does, only application code, and the
523 * settings can (and probably should) be made on a per-file basis
524 * by setting the #defines before including png.h
525 *
526 * Use macros to read integers from PNG data or use the exported
527 * functions?
528 * PNG_USE_READ_MACROS: use the macros (see below) Note that
529 * the macros evaluate their argument multiple times.
530 * PNG_NO_USE_READ_MACROS: call the relevant library function.
531 *
532 * Use the alternative algorithm for compositing alpha samples that
533 * does not use division?
534 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
535 * algorithm.
536 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
537 *
538 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
539 * false?
540 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
541 * APIs to png_warning.
542 * Otherwise the calls are mapped to png_error.
543 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800544
Chris Craikb50c2172013-07-29 15:28:30 -0700545/* Section 2: type definitions, including structures and compile time
546 * constants.
547 * See pngconf.h for base types that vary by machine/system
548 */
549
550/* This triggers a compiler error in png.c, if png.c and png.h
551 * do not agree upon the version number.
552 */
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530553typedef char* png_libpng_version_1_6_10;
Chris Craikb50c2172013-07-29 15:28:30 -0700554
555/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
556 *
557 * png_struct is the cache of information used while reading or writing a single
558 * PNG file. One of these is always required, although the simplified API
559 * (below) hides the creation and destruction of it.
560 */
561typedef struct png_struct_def png_struct;
562typedef const png_struct * png_const_structp;
563typedef png_struct * png_structp;
564typedef png_struct * * png_structpp;
565
566/* png_info contains information read from or to be written to a PNG file. One
567 * or more of these must exist while reading or creating a PNG file. The
568 * information is not used by libpng during read but is used to control what
569 * gets written when a PNG file is created. "png_get_" function calls read
570 * information during read and "png_set_" functions calls write information
571 * when creating a PNG.
572 * been moved into a separate header file that is not accessible to
573 * applications. Read libpng-manual.txt or libpng.3 for more info.
574 */
575typedef struct png_info_def png_info;
576typedef png_info * png_infop;
577typedef const png_info * png_const_infop;
578typedef png_info * * png_infopp;
579
580/* Types with names ending 'p' are pointer types. The corresponding types with
581 * names ending 'rp' are identical pointer types except that the pointer is
582 * marked 'restrict', which means that it is the only pointer to the object
583 * passed to the function. Applications should not use the 'restrict' types;
584 * it is always valid to pass 'p' to a pointer with a function argument of the
585 * corresponding 'rp' type. Different compilers have different rules with
586 * regard to type matching in the presence of 'restrict'. For backward
587 * compatibility libpng callbacks never have 'restrict' in their parameters and,
588 * consequentially, writing portable application code is extremely difficult if
589 * an attempt is made to use 'restrict'.
590 */
591typedef png_struct * PNG_RESTRICT png_structrp;
592typedef const png_struct * PNG_RESTRICT png_const_structrp;
593typedef png_info * PNG_RESTRICT png_inforp;
594typedef const png_info * PNG_RESTRICT png_const_inforp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800595
596/* Three color definitions. The order of the red, green, and blue, (and the
597 * exact size) is not important, although the size of the fields need to
598 * be png_byte or png_uint_16 (as defined below).
599 */
600typedef struct png_color_struct
601{
602 png_byte red;
603 png_byte green;
604 png_byte blue;
605} png_color;
Chris Craikb50c2172013-07-29 15:28:30 -0700606typedef png_color * png_colorp;
607typedef const png_color * png_const_colorp;
608typedef png_color * * png_colorpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800609
610typedef struct png_color_16_struct
611{
612 png_byte index; /* used for palette files */
613 png_uint_16 red; /* for use in red green blue files */
614 png_uint_16 green;
615 png_uint_16 blue;
616 png_uint_16 gray; /* for use in grayscale files */
617} png_color_16;
Chris Craikb50c2172013-07-29 15:28:30 -0700618typedef png_color_16 * png_color_16p;
619typedef const png_color_16 * png_const_color_16p;
620typedef png_color_16 * * png_color_16pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800621
622typedef struct png_color_8_struct
623{
624 png_byte red; /* for use in red green blue files */
625 png_byte green;
626 png_byte blue;
627 png_byte gray; /* for use in grayscale files */
628 png_byte alpha; /* for alpha channel files */
629} png_color_8;
Chris Craikb50c2172013-07-29 15:28:30 -0700630typedef png_color_8 * png_color_8p;
631typedef const png_color_8 * png_const_color_8p;
632typedef png_color_8 * * png_color_8pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800633
634/*
635 * The following two structures are used for the in-core representation
636 * of sPLT chunks.
637 */
638typedef struct png_sPLT_entry_struct
639{
640 png_uint_16 red;
641 png_uint_16 green;
642 png_uint_16 blue;
643 png_uint_16 alpha;
644 png_uint_16 frequency;
645} png_sPLT_entry;
Chris Craikb50c2172013-07-29 15:28:30 -0700646typedef png_sPLT_entry * png_sPLT_entryp;
647typedef const png_sPLT_entry * png_const_sPLT_entryp;
648typedef png_sPLT_entry * * png_sPLT_entrypp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800649
650/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
651 * occupy the LSB of their respective members, and the MSB of each member
652 * is zero-filled. The frequency member always occupies the full 16 bits.
653 */
654
655typedef struct png_sPLT_struct
656{
657 png_charp name; /* palette name */
658 png_byte depth; /* depth of palette samples */
659 png_sPLT_entryp entries; /* palette entries */
660 png_int_32 nentries; /* number of palette entries */
661} png_sPLT_t;
Chris Craikb50c2172013-07-29 15:28:30 -0700662typedef png_sPLT_t * png_sPLT_tp;
663typedef const png_sPLT_t * png_const_sPLT_tp;
664typedef png_sPLT_t * * png_sPLT_tpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800665
666#ifdef PNG_TEXT_SUPPORTED
667/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
668 * and whether that contents is compressed or not. The "key" field
Chris Craikb50c2172013-07-29 15:28:30 -0700669 * points to a regular zero-terminated C string. The "text" fields can be a
670 * regular C string, an empty string, or a NULL pointer.
671 * However, the structure returned by png_get_text() will always contain
672 * the "text" field as a regular zero-terminated C string (possibly
673 * empty), never a NULL pointer, so it can be safely used in printf() and
674 * other string-handling functions. Note that the "itxt_length", "lang", and
675 * "lang_key" members of the structure only exist when the library is built
676 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
677 * default without iTXt support. Also note that when iTXt *is* supported,
678 * the "lang" and "lang_key" fields contain NULL pointers when the
679 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
680 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
681 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
682 * which is always 0 or 1, or its "compression method" which is always 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800683 */
684typedef struct png_text_struct
685{
686 int compression; /* compression value:
687 -1: tEXt, none
688 0: zTXt, deflate
689 1: iTXt, none
690 2: iTXt, deflate */
691 png_charp key; /* keyword, 1-79 character description of "text" */
692 png_charp text; /* comment, may be an empty string (ie "")
693 or a NULL pointer */
694 png_size_t text_length; /* length of the text string */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800695 png_size_t itxt_length; /* length of the itxt string */
696 png_charp lang; /* language code, 0-79 characters
697 or a NULL pointer */
698 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
699 chars or a NULL pointer */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800700} png_text;
Chris Craikb50c2172013-07-29 15:28:30 -0700701typedef png_text * png_textp;
702typedef const png_text * png_const_textp;
703typedef png_text * * png_textpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800704#endif
705
706/* Supported compression types for text in PNG files (tEXt, and zTXt).
Chris Craikb50c2172013-07-29 15:28:30 -0700707 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800708#define PNG_TEXT_COMPRESSION_NONE_WR -3
709#define PNG_TEXT_COMPRESSION_zTXt_WR -2
710#define PNG_TEXT_COMPRESSION_NONE -1
711#define PNG_TEXT_COMPRESSION_zTXt 0
712#define PNG_ITXT_COMPRESSION_NONE 1
713#define PNG_ITXT_COMPRESSION_zTXt 2
714#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
715
716/* png_time is a way to hold the time in an machine independent way.
717 * Two conversions are provided, both from time_t and struct tm. There
718 * is no portable way to convert to either of these structures, as far
719 * as I know. If you know of a portable way, send it to me. As a side
720 * note - PNG has always been Year 2000 compliant!
721 */
722typedef struct png_time_struct
723{
724 png_uint_16 year; /* full year, as in, 1995 */
725 png_byte month; /* month of year, 1 - 12 */
726 png_byte day; /* day of month, 1 - 31 */
727 png_byte hour; /* hour of day, 0 - 23 */
728 png_byte minute; /* minute of hour, 0 - 59 */
729 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
730} png_time;
Chris Craikb50c2172013-07-29 15:28:30 -0700731typedef png_time * png_timep;
732typedef const png_time * png_const_timep;
733typedef png_time * * png_timepp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800734
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530735#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\
736 defined(PNG_USER_CHUNKS_SUPPORTED)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800737/* png_unknown_chunk is a structure to hold queued chunks for which there is
738 * no specific support. The idea is that we can use this to queue
739 * up private chunks for output even though the library doesn't actually
740 * know about their semantics.
Chris Craikb50c2172013-07-29 15:28:30 -0700741 *
742 * 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 -0800743 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800744typedef struct png_unknown_chunk_t
745{
Chris Craikb50c2172013-07-29 15:28:30 -0700746 png_byte name[5]; /* Textual chunk name with '\0' terminator */
747 png_byte *data; /* Data, should not be modified on read! */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800748 png_size_t size;
749
Chris Craikb50c2172013-07-29 15:28:30 -0700750 /* On write 'location' must be set using the flag values listed below.
751 * Notice that on read it is set by libpng however the values stored have
752 * more bits set than are listed below. Always treat the value as a
753 * bitmask. On write set only one bit - setting multiple bits may cause the
754 * chunk to be written in multiple places.
755 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800756 png_byte location; /* mode of operation at read time */
757}
758png_unknown_chunk;
Chris Craikb50c2172013-07-29 15:28:30 -0700759
760typedef png_unknown_chunk * png_unknown_chunkp;
761typedef const png_unknown_chunk * png_const_unknown_chunkp;
762typedef png_unknown_chunk * * png_unknown_chunkpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800763#endif
764
Chris Craikb50c2172013-07-29 15:28:30 -0700765/* Flag values for the unknown chunk location byte. */
766#define PNG_HAVE_IHDR 0x01
767#define PNG_HAVE_PLTE 0x02
768#define PNG_AFTER_IDAT 0x08
The Android Open Source Project893912b2009-03-03 19:30:05 -0800769
770/* Maximum positive integer used in PNG is (2^31)-1 */
771#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
772#define PNG_UINT_32_MAX ((png_uint_32)(-1))
773#define PNG_SIZE_MAX ((png_size_t)(-1))
Chris Craikb50c2172013-07-29 15:28:30 -0700774
775/* These are constants for fixed point values encoded in the
776 * PNG specification manner (x100000)
777 */
778#define PNG_FP_1 100000
779#define PNG_FP_HALF 50000
780#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
781#define PNG_FP_MIN (-PNG_FP_MAX)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800782
783/* These describe the color_type field in png_info. */
784/* color type masks */
785#define PNG_COLOR_MASK_PALETTE 1
786#define PNG_COLOR_MASK_COLOR 2
787#define PNG_COLOR_MASK_ALPHA 4
788
789/* color types. Note that not all combinations are legal */
790#define PNG_COLOR_TYPE_GRAY 0
791#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
792#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
793#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
794#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
795/* aliases */
796#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
797#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
798
799/* This is for compression type. PNG 1.0-1.2 only define the single type. */
800#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
801#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
802
803/* This is for filter type. PNG 1.0-1.2 only define the single type. */
804#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
805#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
806#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
807
808/* These are for the interlacing type. These values should NOT be changed. */
809#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
810#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
811#define PNG_INTERLACE_LAST 2 /* Not a valid value */
812
813/* These are for the oFFs chunk. These values should NOT be changed. */
814#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
815#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
816#define PNG_OFFSET_LAST 2 /* Not a valid value */
817
818/* These are for the pCAL chunk. These values should NOT be changed. */
819#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
820#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
821#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
822#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
823#define PNG_EQUATION_LAST 4 /* Not a valid value */
824
825/* These are for the sCAL chunk. These values should NOT be changed. */
826#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
827#define PNG_SCALE_METER 1 /* meters per pixel */
828#define PNG_SCALE_RADIAN 2 /* radians per pixel */
829#define PNG_SCALE_LAST 3 /* Not a valid value */
830
831/* These are for the pHYs chunk. These values should NOT be changed. */
832#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
833#define PNG_RESOLUTION_METER 1 /* pixels/meter */
834#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
835
836/* These are for the sRGB chunk. These values should NOT be changed. */
837#define PNG_sRGB_INTENT_PERCEPTUAL 0
838#define PNG_sRGB_INTENT_RELATIVE 1
839#define PNG_sRGB_INTENT_SATURATION 2
840#define PNG_sRGB_INTENT_ABSOLUTE 3
841#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
842
843/* This is for text chunks */
844#define PNG_KEYWORD_MAX_LENGTH 79
845
846/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
847#define PNG_MAX_PALETTE_LENGTH 256
848
849/* These determine if an ancillary chunk's data has been successfully read
850 * from the PNG header, or if the application has filled in the corresponding
851 * data in the info_struct to be written into the output file. The values
852 * of the PNG_INFO_<chunk> defines should NOT be changed.
853 */
854#define PNG_INFO_gAMA 0x0001
855#define PNG_INFO_sBIT 0x0002
856#define PNG_INFO_cHRM 0x0004
857#define PNG_INFO_PLTE 0x0008
858#define PNG_INFO_tRNS 0x0010
859#define PNG_INFO_bKGD 0x0020
860#define PNG_INFO_hIST 0x0040
861#define PNG_INFO_pHYs 0x0080
862#define PNG_INFO_oFFs 0x0100
863#define PNG_INFO_tIME 0x0200
864#define PNG_INFO_pCAL 0x0400
865#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
866#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
867#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
868#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Chris Craikb50c2172013-07-29 15:28:30 -0700869#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800870
871/* This is used for the transformation routines, as some of them
872 * change these values for the row. It also should enable using
873 * the routines for other purposes.
874 */
875typedef struct png_row_info_struct
876{
Chris Craikb50c2172013-07-29 15:28:30 -0700877 png_uint_32 width; /* width of row */
878 png_size_t rowbytes; /* number of bytes in row */
879 png_byte color_type; /* color type of row */
880 png_byte bit_depth; /* bit depth of row */
881 png_byte channels; /* number of channels (1, 2, 3, or 4) */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800882 png_byte pixel_depth; /* bits per pixel (depth * channels) */
883} png_row_info;
884
Chris Craikb50c2172013-07-29 15:28:30 -0700885typedef png_row_info * png_row_infop;
886typedef png_row_info * * png_row_infopp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800887
888/* These are the function types for the I/O functions and for the functions
889 * that allow the user to override the default I/O functions with his or her
890 * own. The png_error_ptr type should match that of user-supplied warning
891 * and error functions, while the png_rw_ptr type should match that of the
Chris Craikb50c2172013-07-29 15:28:30 -0700892 * user read/write data functions. Note that the 'write' function must not
893 * modify the buffer it is passed. The 'read' function, on the other hand, is
894 * expected to return the read data in the buffer.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800895 */
Chris Craikb50c2172013-07-29 15:28:30 -0700896typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
897typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
898typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
899typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
900 int));
901typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
902 int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800903
904#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700905typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
906typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
907
908/* The following callback receives png_uint_32 row_number, int pass for the
909 * png_bytep data of the row. When transforming an interlaced image the
910 * row number is the row number within the sub-image of the interlace pass, so
911 * the value will increase to the height of the sub-image (not the full image)
912 * then reset to 0 for the next pass.
913 *
914 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
915 * find the output pixel (x,y) given an interlaced sub-image pixel
916 * (row,col,pass). (See below for these macros.)
917 */
918typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
919 png_uint_32, int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800920#endif
921
922#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Chris Craikb50c2172013-07-29 15:28:30 -0700923 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
924typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
925 png_bytep));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800926#endif
927
Patrick Scott5f6bd842010-06-28 16:55:16 -0400928#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700929typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
930 png_unknown_chunkp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800931#endif
Patrick Scott5f6bd842010-06-28 16:55:16 -0400932#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700933/* not used anywhere */
934/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
935#endif
936
937#ifdef PNG_SETJMP_SUPPORTED
938/* This must match the function definition in <setjmp.h>, and the application
939 * must include this before png.h to obtain the definition of jmp_buf. The
940 * function is required to be PNG_NORETURN, but this is not checked. If the
941 * function does return the application will crash via an abort() or similar
942 * system level call.
943 *
944 * If you get a warning here while building the library you may need to make
945 * changes to ensure that pnglibconf.h records the calling convention used by
946 * your compiler. This may be very difficult - try using a different compiler
947 * to build the library!
948 */
949PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800950#endif
951
952/* Transform masks for the high-level interface */
953#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
954#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
955#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
956#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
957#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
958#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
959#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
960#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
961#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
962#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
963#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
964#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Chris Craikb50c2172013-07-29 15:28:30 -0700965#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
The Android Open Source Project4215dd12009-03-09 11:52:12 -0700966/* Added to libpng-1.2.34 */
Chris Craikb50c2172013-07-29 15:28:30 -0700967#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
968#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
969/* Added to libpng-1.4.0 */
Patrick Scott5f6bd842010-06-28 16:55:16 -0400970#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Chris Craikb50c2172013-07-29 15:28:30 -0700971/* Added to libpng-1.5.4 */
972#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
973#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800974
975/* Flags for MNG supported features */
976#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
977#define PNG_FLAG_MNG_FILTER_64 0x04
978#define PNG_ALL_MNG_FEATURES 0x05
979
Chris Craikb50c2172013-07-29 15:28:30 -0700980/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
981 * this allowed the zlib default functions to be used on Windows
982 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
983 * ignores the first argument) should be completely compatible with the
984 * following.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800985 */
Chris Craikb50c2172013-07-29 15:28:30 -0700986typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
987 png_alloc_size_t));
988typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800989
Chris Craikb50c2172013-07-29 15:28:30 -0700990/* Section 3: exported functions
991 * Here are the function definitions most commonly used. This is not
992 * 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 -0800993 * full explanation, see example.c for the summary. This just provides
994 * a simple one line description of the use of each function.
Chris Craikb50c2172013-07-29 15:28:30 -0700995 *
996 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
997 * pngconf.h and in the *.dfn files in the scripts directory.
998 *
999 * PNG_EXPORT(ordinal, type, name, (args));
1000 *
1001 * ordinal: ordinal that is used while building
1002 * *.def files. The ordinal value is only
1003 * relevant when preprocessing png.h with
1004 * the *.dfn files for building symbol table
1005 * entries, and are removed by pngconf.h.
1006 * type: return type of the function
1007 * name: function name
1008 * args: function arguments, with types
1009 *
1010 * When we wish to append attributes to a function prototype we use
1011 * the PNG_EXPORTA() macro instead.
1012 *
1013 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
1014 *
1015 * ordinal, type, name, and args: same as in PNG_EXPORT().
1016 * attributes: function attributes
The Android Open Source Project893912b2009-03-03 19:30:05 -08001017 */
1018
1019/* Returns the version number of the library */
Chris Craikb50c2172013-07-29 15:28:30 -07001020PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001021
1022/* Tell lib we have already handled the first <num_bytes> magic bytes.
1023 * Handling more than 8 bytes from the beginning of the file is an error.
1024 */
Chris Craikb50c2172013-07-29 15:28:30 -07001025PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001026
1027/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
1028 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
1029 * signature, and non-zero otherwise. Having num_to_check == 0 or
1030 * start > 7 will always fail (ie return non-zero).
1031 */
Chris Craikb50c2172013-07-29 15:28:30 -07001032PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
1033 png_size_t num_to_check));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001034
1035/* Simple signature checking function. This is the same as calling
1036 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
1037 */
Chris Craikb50c2172013-07-29 15:28:30 -07001038#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001039
1040/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Chris Craikb50c2172013-07-29 15:28:30 -07001041PNG_EXPORTA(4, png_structp, png_create_read_struct,
1042 (png_const_charp user_png_ver, png_voidp error_ptr,
1043 png_error_ptr error_fn, png_error_ptr warn_fn),
1044 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001045
1046/* Allocate and initialize png_ptr struct for writing, and any other memory */
Chris Craikb50c2172013-07-29 15:28:30 -07001047PNG_EXPORTA(5, png_structp, png_create_write_struct,
1048 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1049 png_error_ptr warn_fn),
1050 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001051
Chris Craikb50c2172013-07-29 15:28:30 -07001052PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
1053 (png_const_structrp png_ptr));
1054
1055PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
1056 png_size_t size));
1057
1058/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
1059 * match up.
1060 */
1061#ifdef PNG_SETJMP_SUPPORTED
1062/* This function returns the jmp_buf built in to *png_ptr. It must be
1063 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
1064 * unless the default error function is overridden in which case NULL is
1065 * acceptable. The size of the jmp_buf is checked against the actual size
1066 * allocated by the library - the call will return NULL on a mismatch
1067 * indicating an ABI mismatch.
1068 */
1069PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
1070 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
1071# define png_jmpbuf(png_ptr) \
1072 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
1073#else
1074# define png_jmpbuf(png_ptr) \
1075 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001076#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001077/* This function should be used by libpng applications in place of
1078 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1079 * will use it; otherwise it will call PNG_ABORT(). This function was
1080 * added in libpng-1.5.0.
1081 */
1082PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
1083 PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001084
Chris Craikb50c2172013-07-29 15:28:30 -07001085#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001086/* Reset the compression stream */
Chris Craikb50c2172013-07-29 15:28:30 -07001087PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
1088#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08001089
1090/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
1091#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001092PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1093 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1094 png_error_ptr warn_fn,
1095 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1096 PNG_ALLOCATED);
1097PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1098 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1099 png_error_ptr warn_fn,
1100 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1101 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001102#endif
1103
Chris Craikb50c2172013-07-29 15:28:30 -07001104/* Write the PNG file signature. */
1105PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
1106
The Android Open Source Project893912b2009-03-03 19:30:05 -08001107/* Write a PNG chunk - size, type, (optional) data, CRC. */
Chris Craikb50c2172013-07-29 15:28:30 -07001108PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
1109 chunk_name, png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001110
1111/* Write the start of a PNG chunk - length and chunk name. */
Chris Craikb50c2172013-07-29 15:28:30 -07001112PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
1113 png_const_bytep chunk_name, png_uint_32 length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001114
1115/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Chris Craikb50c2172013-07-29 15:28:30 -07001116PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
1117 png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001118
1119/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Chris Craikb50c2172013-07-29 15:28:30 -07001120PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001121
1122/* Allocate and initialize the info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001123PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
1124 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001125
Chris Craikb50c2172013-07-29 15:28:30 -07001126/* DEPRECATED: this function allowed init structures to be created using the
1127 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1128 * the API will be removed in the future.
1129 */
1130PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1131 png_size_t png_info_struct_size), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001132
1133/* Writes all the PNG information before the image. */
Chris Craikb50c2172013-07-29 15:28:30 -07001134PNG_EXPORT(20, void, png_write_info_before_PLTE,
1135 (png_structrp png_ptr, png_const_inforp info_ptr));
1136PNG_EXPORT(21, void, png_write_info,
1137 (png_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001138
Patrick Scott5f6bd842010-06-28 16:55:16 -04001139#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001140/* Read the information before the actual image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001141PNG_EXPORT(22, void, png_read_info,
1142 (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001143#endif
1144
Patrick Scott5f6bd842010-06-28 16:55:16 -04001145#ifdef PNG_TIME_RFC1123_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001146 /* Convert to a US string format: there is no localization support in this
1147 * routine. The original implementation used a 29 character buffer in
1148 * png_struct, this will be removed in future versions.
1149 */
1150#if PNG_LIBPNG_VER < 10700
1151/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
1152PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
1153 png_const_timep ptime),PNG_DEPRECATED);
1154#endif
1155PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
1156 png_const_timep ptime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001157#endif
1158
Patrick Scott5f6bd842010-06-28 16:55:16 -04001159#ifdef PNG_CONVERT_tIME_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001160/* Convert from a struct tm to png_time */
Chris Craikb50c2172013-07-29 15:28:30 -07001161PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1162 const struct tm * ttime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001163
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001164/* Convert from time_t to png_time. Uses gmtime() */
Chris Craikb50c2172013-07-29 15:28:30 -07001165PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
Patrick Scott5f6bd842010-06-28 16:55:16 -04001166#endif /* PNG_CONVERT_tIME_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001167
Patrick Scott5f6bd842010-06-28 16:55:16 -04001168#ifdef PNG_READ_EXPAND_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001169/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Chris Craikb50c2172013-07-29 15:28:30 -07001170PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1171PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1172PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1173PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001174#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001175
1176#ifdef PNG_READ_EXPAND_16_SUPPORTED
1177/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1178 * of a tRNS chunk if present.
1179 */
1180PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001181#endif
1182
1183#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1184/* Use blue, green, red order for pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07001185PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001186#endif
1187
Patrick Scott5f6bd842010-06-28 16:55:16 -04001188#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001189/* Expand the grayscale to 24-bit RGB if necessary. */
Chris Craikb50c2172013-07-29 15:28:30 -07001190PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001191#endif
1192
Patrick Scott5f6bd842010-06-28 16:55:16 -04001193#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001194/* Reduce RGB to grayscale. */
Chris Craikb50c2172013-07-29 15:28:30 -07001195#define PNG_ERROR_ACTION_NONE 1
1196#define PNG_ERROR_ACTION_WARN 2
1197#define PNG_ERROR_ACTION_ERROR 3
1198#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1199
1200PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
1201 int error_action, double red, double green))
1202PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
1203 int error_action, png_fixed_point red, png_fixed_point green))
1204
1205PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
1206 png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001207#endif
1208
Chris Craikb50c2172013-07-29 15:28:30 -07001209#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1210PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1211 png_colorp palette));
1212#endif
1213
1214#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301215/* How the alpha channel is interpreted - this affects how the color channels
1216 * of a PNG file are returned to the calling application when an alpha channel,
1217 * or a tRNS chunk in a palette file, is present.
Chris Craikb50c2172013-07-29 15:28:30 -07001218 *
1219 * This has no effect on the way pixels are written into a PNG output
1220 * datastream. The color samples in a PNG datastream are never premultiplied
1221 * with the alpha samples.
1222 *
1223 * The default is to return data according to the PNG specification: the alpha
1224 * channel is a linear measure of the contribution of the pixel to the
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301225 * corresponding composited pixel, and the color channels are unassociated
1226 * (not premultiplied). The gamma encoded color channels must be scaled
1227 * according to the contribution and to do this it is necessary to undo
Chris Craikb50c2172013-07-29 15:28:30 -07001228 * the encoding, scale the color values, perform the composition and reencode
1229 * the values. This is the 'PNG' mode.
1230 *
1231 * The alternative is to 'associate' the alpha with the color information by
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301232 * storing color channel values that have been scaled by the alpha.
1233 * image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
1234 * (the latter being the two common names for associated alpha color channels).
Chris Craikb50c2172013-07-29 15:28:30 -07001235 *
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301236 * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha
1237 * value is equal to the maximum value.
Chris Craikb50c2172013-07-29 15:28:30 -07001238 *
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
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301264 * how to decode the output values, not how they are encoded.
Chris Craikb50c2172013-07-29 15:28:30 -07001265 */
1266#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1267#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
1268#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
1269#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1270#endif
1271
1272/* The following are examples of calls to png_set_alpha_mode to achieve the
1273 * required overall gamma correction and, where necessary, alpha
1274 * premultiplication.
1275 *
1276 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1277 * This is the default libpng handling of the alpha channel - it is not
1278 * pre-multiplied into the color components. In addition the call states
1279 * that the output is for a sRGB system and causes all PNG files without gAMA
1280 * chunks to be assumed to be encoded using sRGB.
1281 *
1282 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1283 * In this case the output is assumed to be something like an sRGB conformant
1284 * display preceeded by a power-law lookup table of power 1.45. This is how
1285 * early Mac systems behaved.
1286 *
1287 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1288 * This is the classic Jim Blinn approach and will work in academic
1289 * environments where everything is done by the book. It has the shortcoming
1290 * of assuming that input PNG data with no gamma information is linear - this
1291 * is unlikely to be correct unless the PNG files where generated locally.
1292 * Most of the time the output precision will be so low as to show
1293 * significant banding in dark areas of the image.
1294 *
1295 * png_set_expand_16(pp);
1296 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1297 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1298 * are assumed to have the sRGB encoding if not marked with a gamma value and
1299 * the output is always 16 bits per component. This permits accurate scaling
1300 * and processing of the data. If you know that your input PNG files were
1301 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1302 * correct value for your system.
1303 *
1304 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1305 * If you just need to composite the PNG image onto an existing background
1306 * and if you control the code that does this you can use the optimization
1307 * setting. In this case you just copy completely opaque pixels to the
1308 * output. For pixels that are not completely transparent (you just skip
1309 * those) you do the composition math using png_composite or png_composite_16
1310 * below then encode the resultant 8-bit or 16-bit values to match the output
1311 * encoding.
1312 *
1313 * Other cases
1314 * If neither the PNG nor the standard linear encoding work for you because
1315 * of the software or hardware you use then you have a big problem. The PNG
1316 * case will probably result in halos around the image. The linear encoding
1317 * will probably result in a washed out, too bright, image (it's actually too
1318 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1319 * substantially reduce the halos. Alternatively try:
1320 *
1321 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1322 * This option will also reduce the halos, but there will be slight dark
1323 * halos round the opaque parts of the image where the background is light.
1324 * In the OPTIMIZED mode the halos will be light halos where the background
1325 * is dark. Take your pick - the halos are unavoidable unless you can get
1326 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1327 * faster.)
1328 *
1329 * When the default gamma of PNG files doesn't match the output gamma.
1330 * If you have PNG files with no gamma information png_set_alpha_mode allows
1331 * you to provide a default gamma, but it also sets the ouput gamma to the
1332 * matching value. If you know your PNG files have a gamma that doesn't
1333 * match the output you can take advantage of the fact that
1334 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1335 * default if it is not already set:
1336 *
1337 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1338 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1339 * The first call sets both the default and the output gamma values, the
1340 * second call overrides the output gamma without changing the default. This
1341 * is easier than achieving the same effect with png_set_gamma. You must use
1342 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1343 * fire if more than one call to png_set_alpha_mode and png_set_background is
1344 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1345 * are ignored.
1346 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001347
Patrick Scott5f6bd842010-06-28 16:55:16 -04001348#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001349PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001350#endif
1351
1352#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1353 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001354PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001355#endif
1356
1357#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1358 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001359PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001360#endif
1361
1362#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1363/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001364PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
1365 int flags));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001366/* The values of the PNG_FILLER_ defines should NOT be changed */
Chris Craikb50c2172013-07-29 15:28:30 -07001367# define PNG_FILLER_BEFORE 0
1368# define PNG_FILLER_AFTER 1
The Android Open Source Project893912b2009-03-03 19:30:05 -08001369/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001370PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
1371 png_uint_32 filler, int flags));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001372#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
1373
1374#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1375/* Swap bytes in 16-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001376PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001377#endif
1378
1379#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1380/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001381PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001382#endif
1383
Chris Craikb50c2172013-07-29 15:28:30 -07001384#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1385 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001386/* Swap packing order of pixels in bytes. */
Chris Craikb50c2172013-07-29 15:28:30 -07001387PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001388#endif
1389
1390#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
1391/* Converts files to legal bit depths. */
Chris Craikb50c2172013-07-29 15:28:30 -07001392PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
1393 true_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001394#endif
1395
1396#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1397 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001398/* Have the code handle the interlacing. Returns the number of passes.
1399 * MUST be called before png_read_update_info or png_start_read_image,
1400 * otherwise it will not have the desired effect. Note that it is still
1401 * necessary to call png_read_row or png_read_rows png_get_image_height
1402 * times for each pass.
1403*/
1404PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001405#endif
1406
1407#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1408/* Invert monochrome files */
Chris Craikb50c2172013-07-29 15:28:30 -07001409PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001410#endif
1411
Patrick Scott5f6bd842010-06-28 16:55:16 -04001412#ifdef PNG_READ_BACKGROUND_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001413/* Handle alpha and tRNS by replacing with a background color. Prior to
1414 * libpng-1.5.4 this API must not be called before the PNG file header has been
1415 * read. Doing so will result in unexpected behavior and possible warnings or
1416 * errors if the PNG file contains a bKGD chunk.
1417 */
1418PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
1419 png_const_color_16p background_color, int background_gamma_code,
1420 int need_expand, double background_gamma))
1421PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
1422 png_const_color_16p background_color, int background_gamma_code,
1423 int need_expand, png_fixed_point background_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001424#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001425#ifdef PNG_READ_BACKGROUND_SUPPORTED
1426# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1427# define PNG_BACKGROUND_GAMMA_SCREEN 1
1428# define PNG_BACKGROUND_GAMMA_FILE 2
1429# define PNG_BACKGROUND_GAMMA_UNIQUE 3
The Android Open Source Project893912b2009-03-03 19:30:05 -08001430#endif
1431
Chris Craikb50c2172013-07-29 15:28:30 -07001432#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1433/* Scale a 16-bit depth file down to 8-bit, accurately. */
1434PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
1435#endif
1436
1437#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1438#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001439/* Strip the second byte of information from a 16-bit depth file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001440PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001441#endif
1442
Chris Craikb50c2172013-07-29 15:28:30 -07001443#ifdef PNG_READ_QUANTIZE_SUPPORTED
1444/* Turn on quantizing, and reduce the palette to the number of colors
1445 * available.
1446 */
1447PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1448 png_colorp palette, int num_palette, int maximum_colors,
1449 png_const_uint_16p histogram, int full_quantize));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001450#endif
1451
Patrick Scott5f6bd842010-06-28 16:55:16 -04001452#ifdef PNG_READ_GAMMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001453/* The threshold on gamma processing is configurable but hard-wired into the
1454 * library. The following is the floating point variant.
1455 */
1456#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001457
Chris Craikb50c2172013-07-29 15:28:30 -07001458/* Handle gamma correction. Screen_gamma=(display_exponent).
1459 * NOTE: this API simply sets the screen and file gamma values. It will
1460 * therefore override the value for gamma in a PNG file if it is called after
1461 * the file header has been read - use with care - call before reading the PNG
1462 * file for best results!
1463 *
1464 * These routines accept the same gamma values as png_set_alpha_mode (described
1465 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1466 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1467 * is the inverse of a 'screen gamma' value.
1468 */
1469PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
1470 double screen_gamma, double override_file_gamma))
1471PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
1472 png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001473#endif
1474
Patrick Scott5f6bd842010-06-28 16:55:16 -04001475#ifdef PNG_WRITE_FLUSH_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001476/* Set how many lines between output flushes - 0 for no flushing */
Chris Craikb50c2172013-07-29 15:28:30 -07001477PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001478/* Flush the current PNG output buffer */
Chris Craikb50c2172013-07-29 15:28:30 -07001479PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001480#endif
1481
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001482/* Optional update palette with requested transformations */
Chris Craikb50c2172013-07-29 15:28:30 -07001483PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001484
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001485/* Optional call to update the users info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001486PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1487 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001488
Chris Craikb50c2172013-07-29 15:28:30 -07001489#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001490/* Read one or more rows of image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001491PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
1492 png_bytepp display_row, png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001493#endif
1494
Chris Craikb50c2172013-07-29 15:28:30 -07001495#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001496/* Read a row of data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001497PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
1498 png_bytep display_row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001499#endif
1500
Chris Craikb50c2172013-07-29 15:28:30 -07001501#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001502/* Read the whole image into memory at once. */
Chris Craikb50c2172013-07-29 15:28:30 -07001503PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001504#endif
1505
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001506/* Write a row of image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001507PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1508 png_const_bytep row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001509
Chris Craikb50c2172013-07-29 15:28:30 -07001510/* Write a few rows of image data: (*row) is not written; however, the type
1511 * is declared as writeable to maintain compatibility with previous versions
1512 * of libpng and to allow the 'display_row' array from read_rows to be passed
1513 * unchanged to write_rows.
1514 */
1515PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
1516 png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001517
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001518/* Write the image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001519PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001520
Chris Craikb50c2172013-07-29 15:28:30 -07001521/* Write the end of the PNG file. */
1522PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1523 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001524
Chris Craikb50c2172013-07-29 15:28:30 -07001525#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001526/* Read the end of the PNG file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001527PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001528#endif
1529
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001530/* Free any memory associated with the png_info_struct */
Chris Craikb50c2172013-07-29 15:28:30 -07001531PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
1532 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001533
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001534/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001535PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1536 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001537
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001538/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001539PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1540 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001541
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001542/* Set the libpng method of handling chunk CRC errors */
Chris Craikb50c2172013-07-29 15:28:30 -07001543PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
1544 int ancil_action));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001545
Chris Craikb50c2172013-07-29 15:28:30 -07001546/* Values for png_set_crc_action() say how to handle CRC errors in
The Android Open Source Project893912b2009-03-03 19:30:05 -08001547 * ancillary and critical chunks, and whether to use the data contained
1548 * therein. Note that it is impossible to "discard" data in a critical
1549 * chunk. For versions prior to 0.90, the action was always error/quit,
1550 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1551 * chunks is warn/discard. These values should NOT be changed.
1552 *
1553 * value action:critical action:ancillary
1554 */
1555#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1556#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1557#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1558#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1559#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1560#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1561
1562/* These functions give the user control over the scan-line filtering in
1563 * libpng and the compression methods used by zlib. These functions are
1564 * mainly useful for testing, as the defaults should work with most users.
1565 * Those users who are tight on memory or want faster performance at the
1566 * expense of compression can modify them. See the compression library
1567 * header file (zlib.h) for an explination of the compression functions.
1568 */
1569
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001570/* Set the filtering method(s) used by libpng. Currently, the only valid
The Android Open Source Project893912b2009-03-03 19:30:05 -08001571 * value for "method" is 0.
1572 */
Chris Craikb50c2172013-07-29 15:28:30 -07001573PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
1574 int filters));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001575
1576/* Flags for png_set_filter() to say which filters to use. The flags
1577 * are chosen so that they don't conflict with real filter types
1578 * below, in case they are supplied instead of the #defined constants.
1579 * These values should NOT be changed.
1580 */
1581#define PNG_NO_FILTERS 0x00
1582#define PNG_FILTER_NONE 0x08
1583#define PNG_FILTER_SUB 0x10
1584#define PNG_FILTER_UP 0x20
1585#define PNG_FILTER_AVG 0x40
1586#define PNG_FILTER_PAETH 0x80
1587#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1588 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1589
1590/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1591 * These defines should NOT be changed.
1592 */
1593#define PNG_FILTER_VALUE_NONE 0
1594#define PNG_FILTER_VALUE_SUB 1
1595#define PNG_FILTER_VALUE_UP 2
1596#define PNG_FILTER_VALUE_AVG 3
1597#define PNG_FILTER_VALUE_PAETH 4
1598#define PNG_FILTER_VALUE_LAST 5
1599
Chris Craikb50c2172013-07-29 15:28:30 -07001600#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001601/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1602 * defines, either the default (minimum-sum-of-absolute-differences), or
1603 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1604 *
1605 * Weights are factors >= 1.0, indicating how important it is to keep the
1606 * filter type consistent between rows. Larger numbers mean the current
1607 * filter is that many times as likely to be the same as the "num_weights"
1608 * previous filters. This is cumulative for each previous row with a weight.
1609 * There needs to be "num_weights" values in "filter_weights", or it can be
1610 * NULL if the weights aren't being specified. Weights have no influence on
1611 * the selection of the first row filter. Well chosen weights can (in theory)
1612 * improve the compression for a given image.
1613 *
1614 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1615 * filter type. Higher costs indicate more decoding expense, and are
1616 * therefore less likely to be selected over a filter with lower computational
1617 * costs. There needs to be a value in "filter_costs" for each valid filter
1618 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1619 * setting the costs. Costs try to improve the speed of decompression without
1620 * unduly increasing the compressed image size.
1621 *
1622 * A negative weight or cost indicates the default value is to be used, and
1623 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1624 * The default values for both weights and costs are currently 1.0, but may
1625 * change if good general weighting/cost heuristics can be found. If both
1626 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1627 * to the UNWEIGHTED method, but with added encoding time/computation.
1628 */
Chris Craikb50c2172013-07-29 15:28:30 -07001629PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
1630 int heuristic_method, int num_weights, png_const_doublep filter_weights,
1631 png_const_doublep filter_costs))
1632PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1633 (png_structrp png_ptr, int heuristic_method, int num_weights,
1634 png_const_fixed_point_p filter_weights,
1635 png_const_fixed_point_p filter_costs))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001636#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1637
1638/* Heuristic used for row filter selection. These defines should NOT be
1639 * changed.
1640 */
1641#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1642#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1643#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1644#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1645
Chris Craikb50c2172013-07-29 15:28:30 -07001646#ifdef PNG_WRITE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001647/* Set the library compression level. Currently, valid values range from
1648 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1649 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1650 * shown that zlib compression levels 3-6 usually perform as well as level 9
1651 * for PNG images, and do considerably fewer caclulations. In the future,
1652 * these values may not correspond directly to the zlib compression levels.
1653 */
Chris Craikb50c2172013-07-29 15:28:30 -07001654PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
1655 int level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001656
Chris Craikb50c2172013-07-29 15:28:30 -07001657PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
1658 int mem_level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001659
Chris Craikb50c2172013-07-29 15:28:30 -07001660PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
1661 int strategy));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001662
Chris Craikb50c2172013-07-29 15:28:30 -07001663/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1664 * smaller value of window_bits if it can do so safely.
1665 */
1666PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
1667 int window_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001668
Chris Craikb50c2172013-07-29 15:28:30 -07001669PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
1670 int method));
1671#endif
1672
1673#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1674/* Also set zlib parameters for compressing non-IDAT chunks */
1675PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
1676 int level));
1677
1678PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
1679 int mem_level));
1680
1681PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
1682 int strategy));
1683
1684/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1685 * smaller value of window_bits if it can do so safely.
1686 */
1687PNG_EXPORT(225, void, png_set_text_compression_window_bits,
1688 (png_structrp png_ptr, int window_bits));
1689
1690PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
1691 int method));
1692#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001693
1694/* These next functions are called for input/output, memory, and error
1695 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
1696 * and call standard C I/O routines such as fread(), fwrite(), and
1697 * fprintf(). These functions can be made to use other I/O routines
1698 * at run time for those applications that need to handle I/O in a
Chris Craikb50c2172013-07-29 15:28:30 -07001699 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
The Android Open Source Project893912b2009-03-03 19:30:05 -08001700 * more information.
1701 */
1702
Patrick Scott5f6bd842010-06-28 16:55:16 -04001703#ifdef PNG_STDIO_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001704/* Initialize the input/output for the PNG file to the default functions. */
Chris Craikb50c2172013-07-29 15:28:30 -07001705PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001706#endif
1707
1708/* Replace the (error and abort), and warning functions with user
1709 * supplied functions. If no messages are to be printed you must still
1710 * write and use replacement functions. The replacement error_fn should
1711 * still do a longjmp to the last setjmp location if you are using this
1712 * method of error handling. If error_fn or warning_fn is NULL, the
1713 * default function will be used.
1714 */
1715
Chris Craikb50c2172013-07-29 15:28:30 -07001716PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
1717 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001718
1719/* Return the user pointer associated with the error functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001720PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001721
1722/* Replace the default data output functions with a user supplied one(s).
1723 * If buffered output is not used, then output_flush_fn can be set to NULL.
1724 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1725 * output_flush_fn will be ignored (and thus can be NULL).
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001726 * It is probably a mistake to use NULL for output_flush_fn if
1727 * write_data_fn is not also NULL unless you have built libpng with
1728 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1729 * default flush function, which uses the standard *FILE structure, will
1730 * be used.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001731 */
Chris Craikb50c2172013-07-29 15:28:30 -07001732PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
1733 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001734
1735/* Replace the default data input function with a user supplied one. */
Chris Craikb50c2172013-07-29 15:28:30 -07001736PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
1737 png_rw_ptr read_data_fn));
Joseph Wen4ce0ee12010-08-20 10:42:22 +08001738
The Android Open Source Project893912b2009-03-03 19:30:05 -08001739/* Return the user pointer associated with the I/O functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001740PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001741
Chris Craikb50c2172013-07-29 15:28:30 -07001742PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
1743 png_read_status_ptr read_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001744
Chris Craikb50c2172013-07-29 15:28:30 -07001745PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
1746 png_write_status_ptr write_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001747
1748#ifdef PNG_USER_MEM_SUPPORTED
1749/* Replace the default memory allocation functions with user supplied one(s). */
Chris Craikb50c2172013-07-29 15:28:30 -07001750PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
1751 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001752/* Return the user pointer associated with the memory functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001753PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001754#endif
1755
Chris Craikb50c2172013-07-29 15:28:30 -07001756#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1757PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
1758 png_user_transform_ptr read_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001759#endif
1760
Chris Craikb50c2172013-07-29 15:28:30 -07001761#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1762PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
1763 png_user_transform_ptr write_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001764#endif
1765
Chris Craikb50c2172013-07-29 15:28:30 -07001766#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1767PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
1768 png_voidp user_transform_ptr, int user_transform_depth,
1769 int user_transform_channels));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001770/* Return the user pointer associated with the user transform functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001771PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1772 (png_const_structrp png_ptr));
1773#endif
1774
1775#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1776/* Return information about the row currently being processed. Note that these
1777 * APIs do not fail but will return unexpected results if called outside a user
1778 * transform callback. Also note that when transforming an interlaced image the
1779 * row number is the row number within the sub-image of the interlace pass, so
1780 * the value will increase to the height of the sub-image (not the full image)
1781 * then reset to 0 for the next pass.
1782 *
1783 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1784 * find the output pixel (x,y) given an interlaced sub-image pixel
1785 * (row,col,pass). (See below for these macros.)
1786 */
1787PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1788PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
1789#endif
1790
1791#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1792/* This callback is called only for *unknown* chunks. If
1793 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1794 * chunks to be treated as unknown, however in this case the callback must do
1795 * any processing required by the chunk (e.g. by calling the appropriate
1796 * png_set_ APIs.)
1797 *
1798 * There is no write support - on write, by default, all the chunks in the
1799 * 'unknown' list are written in the specified position.
1800 *
1801 * The integer return from the callback function is interpreted thus:
1802 *
1803 * negative: An error occured, png_chunk_error will be called.
1804 * zero: The chunk was not handled, the chunk will be saved. A critical
1805 * chunk will cause an error at this point unless it is to be saved.
1806 * positive: The chunk was handled, libpng will ignore/discard it.
1807 *
1808 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
1809 * how this behavior will change in libpng 1.7
1810 */
1811PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
1812 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001813#endif
1814
1815#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001816PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001817#endif
1818
1819#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1820/* Sets the function callbacks for the push reader, and a pointer to a
1821 * user-defined structure available to the callback functions.
1822 */
Chris Craikb50c2172013-07-29 15:28:30 -07001823PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
1824 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1825 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001826
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001827/* Returns the user pointer associated with the push read functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001828PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1829 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001830
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001831/* Function to be called when data becomes available */
Chris Craikb50c2172013-07-29 15:28:30 -07001832PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1833 png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001834
Chris Craikb50c2172013-07-29 15:28:30 -07001835/* A function which may be called *only* within png_process_data to stop the
1836 * processing of any more data. The function returns the number of bytes
1837 * remaining, excluding any that libpng has cached internally. A subsequent
1838 * call to png_process_data must supply these bytes again. If the argument
1839 * 'save' is set to true the routine will first save all the pending data and
1840 * will always return 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001841 */
Chris Craikb50c2172013-07-29 15:28:30 -07001842PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
1843
1844/* A function which may be called *only* outside (after) a call to
1845 * png_process_data. It returns the number of bytes of data to skip in the
1846 * input. Normally it will return 0, but if it returns a non-zero value the
1847 * application must skip than number of bytes of input data and pass the
1848 * following data to the next call to png_process_data.
1849 */
1850PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
1851
1852#ifdef PNG_READ_INTERLACING_SUPPORTED
1853/* Function that combines rows. 'new_row' is a flag that should come from
1854 * the callback and be non-NULL if anything needs to be done; the library
1855 * stores its own version of the new data internally and ignores the passed
1856 * in value.
1857 */
1858PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
1859 png_bytep old_row, png_const_bytep new_row));
1860#endif /* PNG_READ_INTERLACING_SUPPORTED */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001861#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
1862
Chris Craikb50c2172013-07-29 15:28:30 -07001863PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
1864 png_alloc_size_t size), PNG_ALLOCATED);
1865/* Added at libpng version 1.4.0 */
1866PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
1867 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001868
The Android Open Source Project893912b2009-03-03 19:30:05 -08001869/* Added at libpng version 1.2.4 */
Chris Craikb50c2172013-07-29 15:28:30 -07001870PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
1871 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001872
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001873/* Frees a pointer allocated by png_malloc() */
Chris Craikb50c2172013-07-29 15:28:30 -07001874PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001875
1876/* Free data that was allocated internally */
Chris Craikb50c2172013-07-29 15:28:30 -07001877PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1878 png_inforp info_ptr, png_uint_32 free_me, int num));
1879
The Android Open Source Project893912b2009-03-03 19:30:05 -08001880/* Reassign responsibility for freeing existing data, whether allocated
Chris Craikb50c2172013-07-29 15:28:30 -07001881 * by libpng or by the application; this works on the png_info structure passed
1882 * in, it does not change the state for other png_info structures.
1883 *
1884 * It is unlikely that this function works correctly as of 1.6.0 and using it
1885 * may result either in memory leaks or double free of allocated data.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001886 */
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301887PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,
1888 png_inforp info_ptr, int freer, png_uint_32 mask));
John Reck90bf0d22013-08-14 10:37:42 -07001889
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001890/* Assignments for png_data_freer */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001891#define PNG_DESTROY_WILL_FREE_DATA 1
1892#define PNG_SET_WILL_FREE_DATA 1
1893#define PNG_USER_WILL_FREE_DATA 2
1894/* Flags for png_ptr->free_me and info_ptr->free_me */
1895#define PNG_FREE_HIST 0x0008
1896#define PNG_FREE_ICCP 0x0010
1897#define PNG_FREE_SPLT 0x0020
1898#define PNG_FREE_ROWS 0x0040
1899#define PNG_FREE_PCAL 0x0080
1900#define PNG_FREE_SCAL 0x0100
Chris Craikb50c2172013-07-29 15:28:30 -07001901#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1902# define PNG_FREE_UNKN 0x0200
1903#endif
1904/* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001905#define PNG_FREE_PLTE 0x1000
1906#define PNG_FREE_TRNS 0x2000
1907#define PNG_FREE_TEXT 0x4000
1908#define PNG_FREE_ALL 0x7fff
1909#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1910
1911#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001912PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
1913 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
1914PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
1915 png_voidp ptr), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001916#endif
1917
Chris Craikb50c2172013-07-29 15:28:30 -07001918#ifdef PNG_ERROR_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001919/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07001920PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
1921 png_const_charp error_message), PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001922
1923/* The same, but the chunk name is prepended to the error string. */
Chris Craikb50c2172013-07-29 15:28:30 -07001924PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
1925 png_const_charp error_message), PNG_NORETURN);
1926
The Android Open Source Project893912b2009-03-03 19:30:05 -08001927#else
1928/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07001929PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301930# define png_error(s1,s2) png_err(s1)
1931# define png_chunk_error(s1,s2) png_err(s1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001932#endif
1933
Chris Craikb50c2172013-07-29 15:28:30 -07001934#ifdef PNG_WARNINGS_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001935/* Non-fatal error in libpng. Can continue, but may have a problem. */
Chris Craikb50c2172013-07-29 15:28:30 -07001936PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
1937 png_const_charp warning_message));
1938
1939/* Non-fatal error in libpng, chunk name is prepended to message. */
1940PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
1941 png_const_charp warning_message));
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301942#else
1943# define png_warning(s1,s2) ((void)(s1))
1944# define png_chunk_warning(s1,s2) ((void)(s1))
Chris Craikb50c2172013-07-29 15:28:30 -07001945#endif
1946
1947#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1948/* Benign error in libpng. Can continue, but may have a problem.
1949 * User can choose whether to handle as a fatal error or as a warning. */
1950PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
1951 png_const_charp warning_message));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001952
1953#ifdef PNG_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001954/* Same, chunk name is prepended to message (only during read) */
1955PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
1956 png_const_charp warning_message));
1957#endif
1958
1959PNG_EXPORT(109, void, png_set_benign_errors,
1960 (png_structrp png_ptr, int allowed));
1961#else
1962# ifdef PNG_ALLOW_BENIGN_ERRORS
1963# define png_benign_error png_warning
1964# define png_chunk_benign_error png_chunk_warning
1965# else
1966# define png_benign_error png_error
1967# define png_chunk_benign_error png_chunk_error
1968# endif
1969#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08001970
1971/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1972 * Similarly, the png_get_<chunk> calls are used to read values from the
1973 * png_info_struct, either storing the parameters in the passed variables, or
1974 * setting pointers into the png_info_struct where the data is stored. The
1975 * png_get_<chunk> functions return a non-zero value if the data was available
1976 * in info_ptr, or return zero and do not change any of the parameters if the
1977 * data was not available.
1978 *
1979 * These functions should be used instead of directly accessing png_info
1980 * to avoid problems with future changes in the size and internal layout of
1981 * png_info_struct.
1982 */
1983/* Returns "flag" if chunk data is valid in info_ptr. */
Chris Craikb50c2172013-07-29 15:28:30 -07001984PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
1985 png_const_inforp info_ptr, png_uint_32 flag));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001986
1987/* Returns number of bytes needed to hold a transformed row. */
Chris Craikb50c2172013-07-29 15:28:30 -07001988PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
1989 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001990
Patrick Scott5f6bd842010-06-28 16:55:16 -04001991#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001992/* Returns row_pointers, which is an array of pointers to scanlines that was
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001993 * returned from png_read_png().
1994 */
Chris Craikb50c2172013-07-29 15:28:30 -07001995PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
1996 png_const_inforp info_ptr));
1997
The Android Open Source Project893912b2009-03-03 19:30:05 -08001998/* Set row_pointers, which is an array of pointers to scanlines for use
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001999 * by png_write_png().
2000 */
Chris Craikb50c2172013-07-29 15:28:30 -07002001PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
2002 png_inforp info_ptr, png_bytepp row_pointers));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002003#endif
2004
2005/* Returns number of color channels in image. */
Chris Craikb50c2172013-07-29 15:28:30 -07002006PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
2007 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002008
2009#ifdef PNG_EASY_ACCESS_SUPPORTED
2010/* Returns image width in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07002011PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
2012 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002013
2014/* Returns image height in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07002015PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
2016 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002017
2018/* Returns image bit_depth. */
Chris Craikb50c2172013-07-29 15:28:30 -07002019PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
2020 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002021
2022/* Returns image color_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002023PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
2024 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002025
2026/* Returns image filter_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002027PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
2028 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002029
2030/* Returns image interlace_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002031PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
2032 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002033
2034/* Returns image compression_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07002035PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
2036 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002037
2038/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002039PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
2040 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2041PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
2042 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2043PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
2044 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002045
2046/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002047PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
2048 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2049PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
2050 (png_const_structrp png_ptr, png_const_inforp info_ptr))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002051
2052/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07002053PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2054 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2055PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2056 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2057PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
2058 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2059PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
2060 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002061
2062#endif /* PNG_EASY_ACCESS_SUPPORTED */
2063
Chris Craikb50c2172013-07-29 15:28:30 -07002064#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002065/* Returns pointer to signature string read from PNG header */
Chris Craikb50c2172013-07-29 15:28:30 -07002066PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
2067 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002068#endif
2069
Patrick Scott5f6bd842010-06-28 16:55:16 -04002070#ifdef PNG_bKGD_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002071PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
2072 png_inforp info_ptr, png_color_16p *background));
2073#endif
2074
2075#ifdef PNG_bKGD_SUPPORTED
2076PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
2077 png_inforp info_ptr, png_const_color_16p background));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002078#endif
2079
Patrick Scott5f6bd842010-06-28 16:55:16 -04002080#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002081PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
2082 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
2083 double *red_y, double *green_x, double *green_y, double *blue_x,
2084 double *blue_y))
2085PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
2086 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
2087 double *green_X, double *green_Y, double *green_Z, double *blue_X,
2088 double *blue_Y, double *blue_Z))
2089PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
2090 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2091 png_fixed_point *int_white_x, png_fixed_point *int_white_y,
2092 png_fixed_point *int_red_x, png_fixed_point *int_red_y,
2093 png_fixed_point *int_green_x, png_fixed_point *int_green_y,
2094 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
2095PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
2096 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2097 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
2098 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
2099 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
2100 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
2101 png_fixed_point *int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002102#endif
2103
Patrick Scott5f6bd842010-06-28 16:55:16 -04002104#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002105PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
2106 png_inforp info_ptr,
2107 double white_x, double white_y, double red_x, double red_y, double green_x,
2108 double green_y, double blue_x, double blue_y))
2109PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
2110 png_inforp info_ptr, double red_X, double red_Y, double red_Z,
2111 double green_X, double green_Y, double green_Z, double blue_X,
2112 double blue_Y, double blue_Z))
2113PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
2114 png_inforp info_ptr, png_fixed_point int_white_x,
2115 png_fixed_point int_white_y, png_fixed_point int_red_x,
2116 png_fixed_point int_red_y, png_fixed_point int_green_x,
2117 png_fixed_point int_green_y, png_fixed_point int_blue_x,
2118 png_fixed_point int_blue_y))
2119PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
2120 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
2121 png_fixed_point int_red_Z, png_fixed_point int_green_X,
2122 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2123 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
2124 png_fixed_point int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002125#endif
2126
Patrick Scott5f6bd842010-06-28 16:55:16 -04002127#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002128PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
2129 png_const_inforp info_ptr, double *file_gamma))
2130PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2131 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2132 png_fixed_point *int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002133#endif
2134
Patrick Scott5f6bd842010-06-28 16:55:16 -04002135#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002136PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
2137 png_inforp info_ptr, double file_gamma))
2138PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
2139 png_inforp info_ptr, png_fixed_point int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002140#endif
2141
Patrick Scott5f6bd842010-06-28 16:55:16 -04002142#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002143PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
2144 png_inforp info_ptr, png_uint_16p *hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002145#endif
2146
Patrick Scott5f6bd842010-06-28 16:55:16 -04002147#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002148PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2149 png_inforp info_ptr, png_const_uint_16p hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002150#endif
2151
Chris Craikb50c2172013-07-29 15:28:30 -07002152PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
2153 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
2154 int *bit_depth, int *color_type, int *interlace_method,
2155 int *compression_method, int *filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002156
Chris Craikb50c2172013-07-29 15:28:30 -07002157PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2158 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2159 int color_type, int interlace_method, int compression_method,
2160 int filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002161
Patrick Scott5f6bd842010-06-28 16:55:16 -04002162#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002163PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2164 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 -08002165 int *unit_type));
2166#endif
2167
Patrick Scott5f6bd842010-06-28 16:55:16 -04002168#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002169PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2170 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2171 int unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002172#endif
2173
Patrick Scott5f6bd842010-06-28 16:55:16 -04002174#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002175PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
2176 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
2177 png_int_32 *X1, int *type, int *nparams, png_charp *units,
2178 png_charpp *params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002179#endif
2180
Patrick Scott5f6bd842010-06-28 16:55:16 -04002181#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002182PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2183 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2184 int type, int nparams, png_const_charp units, png_charpp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002185#endif
2186
Patrick Scott5f6bd842010-06-28 16:55:16 -04002187#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002188PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2189 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2190 int *unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002191#endif
2192
Patrick Scott5f6bd842010-06-28 16:55:16 -04002193#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002194PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2195 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 -08002196#endif
2197
Chris Craikb50c2172013-07-29 15:28:30 -07002198PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
2199 png_inforp info_ptr, png_colorp *palette, int *num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002200
Chris Craikb50c2172013-07-29 15:28:30 -07002201PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2202 png_inforp info_ptr, png_const_colorp palette, int num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002203
Patrick Scott5f6bd842010-06-28 16:55:16 -04002204#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002205PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2206 png_inforp info_ptr, png_color_8p *sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002207#endif
2208
Patrick Scott5f6bd842010-06-28 16:55:16 -04002209#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002210PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2211 png_inforp info_ptr, png_const_color_8p sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002212#endif
2213
Patrick Scott5f6bd842010-06-28 16:55:16 -04002214#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002215PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2216 png_const_inforp info_ptr, int *file_srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002217#endif
2218
Patrick Scott5f6bd842010-06-28 16:55:16 -04002219#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002220PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2221 png_inforp info_ptr, int srgb_intent));
2222PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
2223 png_inforp info_ptr, int srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002224#endif
2225
Patrick Scott5f6bd842010-06-28 16:55:16 -04002226#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002227PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
2228 png_inforp info_ptr, png_charpp name, int *compression_type,
2229 png_bytepp profile, png_uint_32 *proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002230#endif
2231
Patrick Scott5f6bd842010-06-28 16:55:16 -04002232#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002233PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2234 png_inforp info_ptr, png_const_charp name, int compression_type,
2235 png_const_bytep profile, png_uint_32 proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002236#endif
2237
Patrick Scott5f6bd842010-06-28 16:55:16 -04002238#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002239PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2240 png_inforp info_ptr, png_sPLT_tpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002241#endif
2242
Patrick Scott5f6bd842010-06-28 16:55:16 -04002243#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002244PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2245 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002246#endif
2247
Patrick Scott5f6bd842010-06-28 16:55:16 -04002248#ifdef PNG_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002249/* png_get_text also returns the number of text chunks in *num_text */
Chris Craikb50c2172013-07-29 15:28:30 -07002250PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2251 png_inforp info_ptr, png_textp *text_ptr, int *num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002252#endif
2253
Chris Craikb50c2172013-07-29 15:28:30 -07002254/* Note while png_set_text() will accept a structure whose text,
2255 * language, and translated keywords are NULL pointers, the structure
2256 * returned by png_get_text will always contain regular
2257 * zero-terminated C strings. They might be empty strings but
2258 * they will never be NULL pointers.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002259 */
2260
Patrick Scott5f6bd842010-06-28 16:55:16 -04002261#ifdef PNG_TEXT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002262PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2263 png_inforp info_ptr, png_const_textp text_ptr, int num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002264#endif
2265
Patrick Scott5f6bd842010-06-28 16:55:16 -04002266#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002267PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2268 png_inforp info_ptr, png_timep *mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002269#endif
2270
Patrick Scott5f6bd842010-06-28 16:55:16 -04002271#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002272PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2273 png_inforp info_ptr, png_const_timep mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002274#endif
2275
Patrick Scott5f6bd842010-06-28 16:55:16 -04002276#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002277PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2278 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
2279 png_color_16p *trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002280#endif
2281
Patrick Scott5f6bd842010-06-28 16:55:16 -04002282#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002283PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2284 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
2285 png_const_color_16p trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002286#endif
2287
Patrick Scott5f6bd842010-06-28 16:55:16 -04002288#ifdef PNG_sCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002289PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
2290 png_const_inforp info_ptr, int *unit, double *width, double *height))
2291#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2292 defined(PNG_FLOATING_POINT_SUPPORTED)
2293/* NOTE: this API is currently implemented using floating point arithmetic,
2294 * consequently it can only be used on systems with floating point support.
2295 * In any case the range of values supported by png_fixed_point is small and it
2296 * is highly recommended that png_get_sCAL_s be used instead.
2297 */
2298PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2299 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2300 png_fixed_point *width, png_fixed_point *height))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002301#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002302PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2303 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2304 png_charpp swidth, png_charpp sheight));
2305
2306PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
2307 png_inforp info_ptr, int unit, double width, double height))
2308PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
2309 png_inforp info_ptr, int unit, png_fixed_point width,
2310 png_fixed_point height))
2311PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2312 png_inforp info_ptr, int unit,
2313 png_const_charp swidth, png_const_charp sheight));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002314#endif /* PNG_sCAL_SUPPORTED */
2315
Chris Craikb50c2172013-07-29 15:28:30 -07002316#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2317/* Provide the default handling for all unknown chunks or, optionally, for
2318 * specific unknown chunks.
2319 *
2320 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2321 * ignored and the default was used, the per-chunk setting only had an effect on
2322 * write. If you wish to have chunk-specific handling on read in code that must
2323 * work on earlier versions you must use a user chunk callback to specify the
2324 * desired handling (keep or discard.)
2325 *
2326 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2327 * parameter is interpreted as follows:
2328 *
2329 * READ:
2330 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2331 * Known chunks: do normal libpng processing, do not keep the chunk (but
2332 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2333 * Unknown chunks: for a specific chunk use the global default, when used
2334 * as the default discard the chunk data.
2335 * PNG_HANDLE_CHUNK_NEVER:
2336 * Discard the chunk data.
2337 * PNG_HANDLE_CHUNK_IF_SAFE:
2338 * Keep the chunk data if the chunk is not critical else raise a chunk
2339 * error.
2340 * PNG_HANDLE_CHUNK_ALWAYS:
2341 * Keep the chunk data.
2342 *
2343 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2344 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2345 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2346 * it simply resets the behavior to the libpng default.
2347 *
2348 * INTERACTION WTIH USER CHUNK CALLBACKS:
2349 * The per-chunk handling is always used when there is a png_user_chunk_ptr
2350 * callback and the callback returns 0; the chunk is then always stored *unless*
2351 * it is critical and the per-chunk setting is other than ALWAYS. Notice that
2352 * the global default is *not* used in this case. (In effect the per-chunk
2353 * value is incremented to at least IF_SAFE.)
2354 *
2355 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2356 * per-chunk defaults will be honored. If you want to preserve the current
2357 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2358 * as the default - if you don't do this libpng 1.6 will issue a warning.
2359 *
2360 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2361 * earlier simply return '1' (handled).
2362 *
2363 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2364 * If this is *not* set known chunks will always be handled by libpng and
2365 * will never be stored in the unknown chunk list. Known chunks listed to
2366 * png_set_keep_unknown_chunks will have no effect. If it is set then known
2367 * chunks listed with a keep other than AS_DEFAULT will *never* be processed
2368 * by libpng, in addition critical chunks must either be processed by the
2369 * callback or saved.
2370 *
2371 * The IHDR and IEND chunks must not be listed. Because this turns off the
2372 * default handling for chunks that would otherwise be recognized the
2373 * behavior of libpng transformations may well become incorrect!
2374 *
2375 * WRITE:
2376 * When writing chunks the options only apply to the chunks specified by
2377 * png_set_unknown_chunks (below), libpng will *always* write known chunks
2378 * required by png_set_ calls and will always write the core critical chunks
2379 * (as required for PLTE).
2380 *
2381 * Each chunk in the png_set_unknown_chunks list is looked up in the
2382 * png_set_keep_unknown_chunks list to find the keep setting, this is then
2383 * interpreted as follows:
2384 *
2385 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2386 * Write safe-to-copy chunks and write other chunks if the global
2387 * default is set to _ALWAYS, otherwise don't write this chunk.
2388 * PNG_HANDLE_CHUNK_NEVER:
2389 * Do not write the chunk.
2390 * PNG_HANDLE_CHUNK_IF_SAFE:
2391 * Write the chunk if it is safe-to-copy, otherwise do not write it.
2392 * PNG_HANDLE_CHUNK_ALWAYS:
2393 * Write the chunk.
2394 *
2395 * Note that the default behavior is effectively the opposite of the read case -
2396 * in read unknown chunks are not stored by default, in write they are written
2397 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2398 * - on write the safe-to-copy bit is checked, on read the critical bit is
2399 * checked and on read if the chunk is critical an error will be raised.
2400 *
2401 * num_chunks:
2402 * ===========
2403 * If num_chunks is positive, then the "keep" parameter specifies the manner
2404 * for handling only those chunks appearing in the chunk_list array,
2405 * otherwise the chunk list array is ignored.
2406 *
2407 * If num_chunks is 0 the "keep" parameter specifies the default behavior for
2408 * unknown chunks, as described above.
2409 *
2410 * If num_chunks is negative, then the "keep" parameter specifies the manner
2411 * for handling all unknown chunks plus all chunks recognized by libpng
2412 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2413 * be processed by libpng.
2414 */
2415PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
2416 int keep, png_const_bytep chunk_list, int num_chunks));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002417
Chris Craikb50c2172013-07-29 15:28:30 -07002418/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2419 * the result is therefore true (non-zero) if special handling is required,
2420 * false for the default handling.
2421 */
2422PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
2423 png_const_bytep chunk_name));
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002424#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002425
2426#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
2427PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
2428 png_inforp info_ptr, png_const_unknown_chunkp unknowns,
2429 int num_unknowns));
2430 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2431 * unknowns to the location currently stored in the png_struct. This is
2432 * invariably the wrong value on write. To fix this call the following API
2433 * for each chunk in the list with the correct location. If you know your
2434 * code won't be compiled on earlier versions you can rely on
2435 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2436 * the correct thing.
2437 */
2438
2439PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2440 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
2441
2442PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
2443 png_inforp info_ptr, png_unknown_chunkpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002444#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002445
2446/* Png_free_data() will turn off the "valid" flag for anything it frees.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002447 * If you need to turn it off for a chunk that your application has freed,
2448 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2449 */
Chris Craikb50c2172013-07-29 15:28:30 -07002450PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2451 png_inforp info_ptr, int mask));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002452
Patrick Scott5f6bd842010-06-28 16:55:16 -04002453#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002454/* The "params" pointer is currently not used and is for future expansion. */
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302455#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002456PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
2457 int transforms, png_voidp params));
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302458#endif
2459#ifdef PNG_WRITE_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002460PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
2461 int transforms, png_voidp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002462#endif
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302463#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002464
Chris Craikb50c2172013-07-29 15:28:30 -07002465PNG_EXPORT(180, png_const_charp, png_get_copyright,
2466 (png_const_structrp png_ptr));
2467PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2468 (png_const_structrp png_ptr));
2469PNG_EXPORT(182, png_const_charp, png_get_header_version,
2470 (png_const_structrp png_ptr));
2471PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2472 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002473
2474#ifdef PNG_MNG_FEATURES_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002475PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
2476 png_uint_32 mng_features_permitted));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002477#endif
2478
2479/* For use in png_set_keep_unknown, added to version 1.2.6 */
2480#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2481#define PNG_HANDLE_CHUNK_NEVER 1
2482#define PNG_HANDLE_CHUNK_IF_SAFE 2
2483#define PNG_HANDLE_CHUNK_ALWAYS 3
Chris Craikb50c2172013-07-29 15:28:30 -07002484#define PNG_HANDLE_CHUNK_LAST 4
The Android Open Source Project893912b2009-03-03 19:30:05 -08002485
2486/* Strip the prepended error numbers ("#nnn ") from error and warning
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002487 * messages before passing them to the error or warning handler.
2488 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002489#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002490PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
2491 png_uint_32 strip_mode));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002492#endif
2493
Chris Craikb50c2172013-07-29 15:28:30 -07002494/* Added in libpng-1.2.6 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002495#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002496PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
2497 png_uint_32 user_width_max, png_uint_32 user_height_max));
2498PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2499 (png_const_structrp png_ptr));
2500PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2501 (png_const_structrp png_ptr));
2502/* Added in libpng-1.4.0 */
2503PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
2504 png_uint_32 user_chunk_cache_max));
2505PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2506 (png_const_structrp png_ptr));
2507/* Added in libpng-1.4.1 */
2508PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
2509 png_alloc_size_t user_chunk_cache_max));
2510PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2511 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002512#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002513
2514#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2515PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2516 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2517
2518PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2519 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2520
2521PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2522 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2523
2524PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2525 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2526#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2527PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2528 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2529#endif
2530
2531PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
2532 png_const_inforp info_ptr))
2533#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2534PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2535 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2536#endif
2537
2538# ifdef PNG_pHYs_SUPPORTED
2539PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2540 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2541 int *unit_type));
2542# endif /* PNG_pHYs_SUPPORTED */
2543#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
2544
2545/* Added in libpng-1.4.0 */
2546#ifdef PNG_IO_STATE_SUPPORTED
2547PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
2548
2549/* Removed from libpng 1.6; use png_get_io_chunk_type. */
2550PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
2551 PNG_DEPRECATED)
2552
2553PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2554 (png_const_structrp png_ptr));
2555
2556/* The flags returned by png_get_io_state() are the following: */
2557# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2558# define PNG_IO_READING 0x0001 /* currently reading */
2559# define PNG_IO_WRITING 0x0002 /* currently writing */
2560# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2561# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2562# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2563# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2564# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2565# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
2566#endif /* ?PNG_IO_STATE_SUPPORTED */
2567
2568/* Interlace support. The following macros are always defined so that if
2569 * libpng interlace handling is turned off the macros may be used to handle
2570 * interlaced images within the application.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002571 */
Chris Craikb50c2172013-07-29 15:28:30 -07002572#define PNG_INTERLACE_ADAM7_PASSES 7
2573
2574/* Two macros to return the first row and first column of the original,
2575 * full, image which appears in a given pass. 'pass' is in the range 0
2576 * to 6 and the result is in the range 0 to 7.
2577 */
2578#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2579#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2580
2581/* A macro to return the offset between pixels in the output row for a pair of
2582 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2583 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2584 * COL_OFFSET is from one column to the next, within a row.
2585 */
2586#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2587#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2588
2589/* Two macros to help evaluate the number of rows or columns in each
2590 * pass. This is expressed as a shift - effectively log2 of the number or
2591 * rows or columns in each 8x8 tile of the original image.
2592 */
2593#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2594#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2595
2596/* Hence two macros to determine the number of rows or columns in a given
2597 * pass of an image given its height or width. In fact these macros may
2598 * return non-zero even though the sub-image is empty, because the other
2599 * dimension may be empty for a small image.
2600 */
2601#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2602 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2603#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2604 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2605
2606/* For the reader row callbacks (both progressive and sequential) it is
2607 * necessary to find the row in the output image given a row in an interlaced
2608 * image, so two more macros:
2609 */
2610#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2611 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2612#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2613 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2614
2615/* Two macros which return a boolean (0 or 1) saying whether the given row
2616 * or column is in a particular pass. These use a common utility macro that
2617 * returns a mask for a given pass - the offset 'off' selects the row or
2618 * column version. The mask has the appropriate bit set for each column in
2619 * the tile.
2620 */
2621#define PNG_PASS_MASK(pass,off) ( \
2622 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2623 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2624
2625#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2626 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2627#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2628 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002629
2630#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2631/* With these routines we avoid an integer divide, which will be slower on
2632 * most machines. However, it does take more operations than the corresponding
2633 * divide method, so it may be slower on a few RISC systems. There are two
2634 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2635 *
2636 * Note that the rounding factors are NOT supposed to be the same! 128 and
2637 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2638 * standard method.
2639 *
2640 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2641 */
2642
Chris Craikb50c2172013-07-29 15:28:30 -07002643 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002644
Chris Craikb50c2172013-07-29 15:28:30 -07002645# define png_composite(composite, fg, alpha, bg) \
2646 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2647 * (png_uint_16)(alpha) \
2648 + (png_uint_16)(bg)*(png_uint_16)(255 \
2649 - (png_uint_16)(alpha)) + 128); \
The Android Open Source Project893912b2009-03-03 19:30:05 -08002650 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2651
Chris Craikb50c2172013-07-29 15:28:30 -07002652# define png_composite_16(composite, fg, alpha, bg) \
2653 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2654 * (png_uint_32)(alpha) \
2655 + (png_uint_32)(bg)*(65535 \
2656 - (png_uint_32)(alpha)) + 32768); \
The Android Open Source Project893912b2009-03-03 19:30:05 -08002657 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2658
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002659#else /* Standard method using integer division */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002660
Chris Craikb50c2172013-07-29 15:28:30 -07002661# define png_composite(composite, fg, alpha, bg) \
2662 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
2663 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2664 127) / 255)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002665
2666# define png_composite_16(composite, fg, alpha, bg) \
2667 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
Chris Craikb50c2172013-07-29 15:28:30 -07002668 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2669 32767) / 65535)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002670#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2671
Chris Craikb50c2172013-07-29 15:28:30 -07002672#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2673PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2674PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2675PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2676#endif
2677
2678PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
2679 png_const_bytep buf));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002680/* No png_get_int_16 -- may be added if there's a real need for it. */
2681
Chris Craikb50c2172013-07-29 15:28:30 -07002682/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2683#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2684PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2685#endif
2686#ifdef PNG_SAVE_INT_32_SUPPORTED
2687PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2688#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002689
2690/* Place a 16-bit number into a buffer in PNG byte order.
2691 * The parameter is declared unsigned int, not png_uint_16,
2692 * just to avoid potential problems on pre-ANSI C compilers.
2693 */
Chris Craikb50c2172013-07-29 15:28:30 -07002694#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2695PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002696/* No png_save_int_16 -- may be added if there's a real need for it. */
Chris Craikb50c2172013-07-29 15:28:30 -07002697#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002698
Chris Craikb50c2172013-07-29 15:28:30 -07002699#ifdef PNG_USE_READ_MACROS
2700/* Inline macros to do direct reads of bytes from the input buffer.
2701 * The png_get_int_32() routine assumes we are using two's complement
2702 * format for negative values, which is almost certainly true.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002703 */
Chris Craikb50c2172013-07-29 15:28:30 -07002704# define PNG_get_uint_32(buf) \
2705 (((png_uint_32)(*(buf)) << 24) + \
2706 ((png_uint_32)(*((buf) + 1)) << 16) + \
2707 ((png_uint_32)(*((buf) + 2)) << 8) + \
2708 ((png_uint_32)(*((buf) + 3))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002709
Chris Craikb50c2172013-07-29 15:28:30 -07002710 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2711 * function) incorrectly returned a value of type png_uint_32.
2712 */
2713# define PNG_get_uint_16(buf) \
2714 ((png_uint_16) \
2715 (((unsigned int)(*(buf)) << 8) + \
2716 ((unsigned int)(*((buf) + 1)))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002717
Chris Craikb50c2172013-07-29 15:28:30 -07002718# define PNG_get_int_32(buf) \
2719 ((png_int_32)((*(buf) & 0x80) \
2720 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2721 : (png_int_32)png_get_uint_32(buf)))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002722
Chris Craikb50c2172013-07-29 15:28:30 -07002723 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2724 * but defining a macro name prefixed with PNG_PREFIX.
2725 */
2726# ifndef PNG_PREFIX
2727# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2728# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2729# define png_get_int_32(buf) PNG_get_int_32(buf)
2730# endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002731#else
Chris Craikb50c2172013-07-29 15:28:30 -07002732# ifdef PNG_PREFIX
2733 /* No macros; revert to the (redefined) function */
2734# define PNG_get_uint_32 (png_get_uint_32)
2735# define PNG_get_uint_16 (png_get_uint_16)
2736# define PNG_get_int_32 (png_get_int_32)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002737# endif
2738#endif
2739
Chris Craikb50c2172013-07-29 15:28:30 -07002740/*******************************************************************************
2741 * SIMPLIFIED API
2742 *******************************************************************************
2743 *
2744 * Please read the documentation in libpng-manual.txt (TODO: write said
2745 * documentation) if you don't understand what follows.
2746 *
2747 * The simplified API hides the details of both libpng and the PNG file format
2748 * itself. It allows PNG files to be read into a very limited number of
2749 * in-memory bitmap formats or to be written from the same formats. If these
2750 * formats do not accomodate your needs then you can, and should, use the more
2751 * sophisticated APIs above - these support a wide variety of in-memory formats
2752 * and a wide variety of sophisticated transformations to those formats as well
2753 * as a wide variety of APIs to manipulate ancillary information.
2754 *
2755 * To read a PNG file using the simplified API:
2756 *
2757 * 1) Declare a 'png_image' structure (see below) on the stack and set the
2758 * version field to PNG_IMAGE_VERSION.
2759 * 2) Call the appropriate png_image_begin_read... function.
2760 * 3) Set the png_image 'format' member to the required sample format.
2761 * 4) Allocate a buffer for the image and, if required, the color-map.
2762 * 5) Call png_image_finish_read to read the image and, if required, the
2763 * color-map into your buffers.
2764 *
2765 * There are no restrictions on the format of the PNG input itself; all valid
2766 * color types, bit depths, and interlace methods are acceptable, and the
2767 * input image is transformed as necessary to the requested in-memory format
2768 * during the png_image_finish_read() step. The only caveat is that if you
2769 * request a color-mapped image from a PNG that is full-color or makes
2770 * complex use of an alpha channel the transformation is extremely lossy and the
2771 * result may look terrible.
2772 *
2773 * To write a PNG file using the simplified API:
2774 *
2775 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2776 * 2) Initialize the members of the structure that describe the image, setting
2777 * the 'format' member to the format of the image samples.
2778 * 3) Call the appropriate png_image_write... function with a pointer to the
2779 * image and, if necessary, the color-map to write the PNG data.
2780 *
2781 * png_image is a structure that describes the in-memory format of an image
2782 * when it is being read or defines the in-memory format of an image that you
2783 * need to write:
2784 */
2785#define PNG_IMAGE_VERSION 1
The Android Open Source Project893912b2009-03-03 19:30:05 -08002786
Chris Craikb50c2172013-07-29 15:28:30 -07002787typedef struct png_control *png_controlp;
2788typedef struct
2789{
2790 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2791 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2792 png_uint_32 width; /* Image width in pixels (columns) */
2793 png_uint_32 height; /* Image height in pixels (rows) */
2794 png_uint_32 format; /* Image format as defined below */
2795 png_uint_32 flags; /* A bit mask containing informational flags */
2796 png_uint_32 colormap_entries;
2797 /* Number of entries in the color-map */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002798
Chris Craikb50c2172013-07-29 15:28:30 -07002799 /* In the event of an error or warning the following field will be set to a
2800 * non-zero value and the 'message' field will contain a '\0' terminated
2801 * string with the libpng error or warning message. If both warnings and
2802 * an error were encountered, only the error is recorded. If there
2803 * are multiple warnings, only the first one is recorded.
2804 *
2805 * The upper 30 bits of this value are reserved, the low two bits contain
2806 * a value as follows:
2807 */
2808# define PNG_IMAGE_WARNING 1
2809# define PNG_IMAGE_ERROR 2
2810 /*
2811 * The result is a two bit code such that a value more than 1 indicates
2812 * a failure in the API just called:
2813 *
2814 * 0 - no warning or error
2815 * 1 - warning
2816 * 2 - error
2817 * 3 - error preceded by warning
2818 */
2819# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002820
Chris Craikb50c2172013-07-29 15:28:30 -07002821 png_uint_32 warning_or_error;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002822
Chris Craikb50c2172013-07-29 15:28:30 -07002823 char message[64];
2824} png_image, *png_imagep;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002825
Chris Craikb50c2172013-07-29 15:28:30 -07002826/* The samples of the image have one to four channels whose components have
2827 * original values in the range 0 to 1.0:
2828 *
2829 * 1: A single gray or luminance channel (G).
2830 * 2: A gray/luminance channel and an alpha channel (GA).
2831 * 3: Three red, green, blue color channels (RGB).
2832 * 4: Three color channels and an alpha channel (RGBA).
2833 *
2834 * The components are encoded in one of two ways:
2835 *
2836 * a) As a small integer, value 0..255, contained in a single byte. For the
2837 * alpha channel the original value is simply value/255. For the color or
2838 * luminance channels the value is encoded according to the sRGB specification
2839 * and matches the 8-bit format expected by typical display devices.
2840 *
2841 * The color/gray channels are not scaled (pre-multiplied) by the alpha
2842 * channel and are suitable for passing to color management software.
2843 *
2844 * b) As a value in the range 0..65535, contained in a 2-byte integer. All
2845 * channels can be converted to the original value by dividing by 65535; all
2846 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2847 * the sRGB specification. This encoding is identified by the
2848 * PNG_FORMAT_FLAG_LINEAR flag below.
2849 *
2850 * When the simplified API needs to convert between sRGB and linear colorspaces,
2851 * the actual sRGB transfer curve defined in the sRGB specification (see the
2852 * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2853 * approximation used elsewhere in libpng.
2854 *
2855 * When an alpha channel is present it is expected to denote pixel coverage
2856 * of the color or luminance channels and is returned as an associated alpha
2857 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2858 * value.
2859 *
2860 * The samples are either contained directly in the image data, between 1 and 8
2861 * bytes per pixel according to the encoding, or are held in a color-map indexed
2862 * by bytes in the image data. In the case of a color-map the color-map entries
2863 * are individual samples, encoded as above, and the image data has one byte per
2864 * pixel to select the relevant sample from the color-map.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002865 */
2866
Chris Craikb50c2172013-07-29 15:28:30 -07002867/* PNG_FORMAT_*
2868 *
2869 * #defines to be used in png_image::format. Each #define identifies a
2870 * particular layout of sample data and, if present, alpha values. There are
2871 * separate defines for each of the two component encodings.
2872 *
2873 * A format is built up using single bit flag values. All combinations are
2874 * valid. Formats can be built up from the flag values or you can use one of
2875 * the predefined values below. When testing formats always use the FORMAT_FLAG
2876 * macros to test for individual features - future versions of the library may
2877 * add new flags.
2878 *
2879 * When reading or writing color-mapped images the format should be set to the
2880 * format of the entries in the color-map then png_image_{read,write}_colormap
2881 * called to read or write the color-map and set the format correctly for the
2882 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
2883 *
2884 * NOTE: libpng can be built with particular features disabled, if you see
2885 * compiler errors because the definition of one of the following flags has been
2886 * compiled out it is because libpng does not have the required support. It is
2887 * possible, however, for the libpng configuration to enable the format on just
2888 * read or just write; in that case you may see an error at run time. You can
2889 * guard against this by checking for the definition of the appropriate
2890 * "_SUPPORTED" macro, one of:
2891 *
2892 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2893 */
2894#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2895#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
2896#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */
2897#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002898
Chris Craikb50c2172013-07-29 15:28:30 -07002899#ifdef PNG_FORMAT_BGR_SUPPORTED
2900# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002901#endif
2902
Chris Craikb50c2172013-07-29 15:28:30 -07002903#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2904# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002905#endif
2906
Chris Craikb50c2172013-07-29 15:28:30 -07002907/* Commonly used formats have predefined macros.
2908 *
2909 * First the single byte (sRGB) formats:
2910 */
2911#define PNG_FORMAT_GRAY 0
2912#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
2913#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2914#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2915#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2916#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2917#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2918#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2919#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2920
2921/* Then the linear 2-byte formats. When naming these "Y" is used to
2922 * indicate a luminance (gray) channel.
2923 */
2924#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2925#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2926#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2927#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2928 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2929
2930/* With color-mapped formats the image data is one byte for each pixel, the byte
2931 * is an index into the color-map which is formatted as above. To obtain a
2932 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2933 * to one of the above definitions, or you can use one of the definitions below.
2934 */
2935#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
2936#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
2937#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
2938#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
2939#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
2940#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
2941
2942/* PNG_IMAGE macros
2943 *
2944 * These are convenience macros to derive information from a png_image
2945 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
2946 * actual image sample values - either the entries in the color-map or the
2947 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
2948 * for the pixels and will always return 1 for color-mapped formats. The
2949 * remaining macros return information about the rows in the image and the
2950 * complete image.
2951 *
2952 * NOTE: All the macros that take a png_image::format parameter are compile time
2953 * constants if the format parameter is, itself, a constant. Therefore these
2954 * macros can be used in array declarations and case labels where required.
2955 * Similarly the macros are also pre-processor constants (sizeof is not used) so
2956 * they can be used in #if tests.
2957 *
2958 * First the information about the samples.
2959 */
2960#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
2961 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
2962 /* Return the total number of channels in a given format: 1..4 */
2963
2964#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
2965 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
2966 /* Return the size in bytes of a single component of a pixel or color-map
2967 * entry (as appropriate) in the image: 1 or 2.
2968 */
2969
2970#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
2971 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
2972 /* This is the size of the sample data for one sample. If the image is
2973 * color-mapped it is the size of one color-map entry (and image pixels are
2974 * one byte in size), otherwise it is the size of one image pixel.
2975 */
2976
2977#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
2978 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
2979 /* The maximum size of the color-map required by the format expressed in a
2980 * count of components. This can be used to compile-time allocate a
2981 * color-map:
2982 *
2983 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
2984 *
2985 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
2986 *
2987 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
2988 * information from one of the png_image_begin_read_ APIs and dynamically
2989 * allocate the required memory.
2990 */
2991
2992/* Corresponding information about the pixels */
2993#define PNG_IMAGE_PIXEL_(test,fmt)\
2994 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
2995
2996#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
2997 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
2998 /* The number of separate channels (components) in a pixel; 1 for a
2999 * color-mapped image.
3000 */
3001
3002#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
3003 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
3004 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
3005 * image.
3006 */
3007
3008#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
3009 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
3010
3011/* Information about the whole row, or whole image */
3012#define PNG_IMAGE_ROW_STRIDE(image)\
3013 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
3014 /* Return the total number of components in a single row of the image; this
3015 * is the minimum 'row stride', the minimum count of components between each
3016 * row. For a color-mapped image this is the minimum number of bytes in a
3017 * row.
3018 */
3019
3020#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
3021 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
3022 /* Return the size, in bytes, of an image buffer given a png_image and a row
3023 * stride - the number of components to leave space for in each row.
3024 */
3025
3026#define PNG_IMAGE_SIZE(image)\
3027 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
3028 /* Return the size, in bytes, of the image in memory given just a png_image;
3029 * the row stride is the minimum stride required for the image.
3030 */
3031
3032#define PNG_IMAGE_COLORMAP_SIZE(image)\
3033 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
3034 /* Return the size, in bytes, of the color-map of this image. If the image
3035 * format is not a color-map format this will return a size sufficient for
3036 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
3037 * you don't want to allocate a color-map in this case.
3038 */
3039
3040/* PNG_IMAGE_FLAG_*
3041 *
3042 * Flags containing additional information about the image are held in the
3043 * 'flags' field of png_image.
3044 */
3045#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
3046 /* This indicates the the RGB values of the in-memory bitmap do not
3047 * correspond to the red, green and blue end-points defined by sRGB.
3048 */
3049
3050#define PNG_IMAGE_FLAG_FAST 0x02
3051 /* On write emphasise speed over compression; the resultant PNG file will be
3052 * larger but will be produced significantly faster, particular for large
3053 * images. Do not use this option for images which will be distributed, only
3054 * used it when producing intermediate files that will be read back in
3055 * repeatedly. For a typical 24-bit image the option will double the read
3056 * speed at the cost of increasing the image size by 25%, however for many
3057 * more compressible images the PNG file can be 10 times larger with only a
3058 * slight speed gain.
3059 */
3060
3061#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
3062 /* On read if the image is a 16-bit per component image and there is no gAMA
3063 * or sRGB chunk assume that the components are sRGB encoded. Notice that
3064 * images output by the simplified API always have gamma information; setting
3065 * this flag only affects the interpretation of 16-bit images from an
3066 * external source. It is recommended that the application expose this flag
3067 * to the user; the user can normally easily recognize the difference between
3068 * linear and sRGB encoding. This flag has no effect on write - the data
3069 * passed to the write APIs must have the correct encoding (as defined
3070 * above.)
3071 *
3072 * If the flag is not set (the default) input 16-bit per component data is
3073 * assumed to be linear.
3074 *
3075 * NOTE: the flag can only be set after the png_image_begin_read_ call,
3076 * because that call initializes the 'flags' field.
3077 */
3078
3079#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
3080/* READ APIs
3081 * ---------
3082 *
3083 * The png_image passed to the read APIs must have been initialized by setting
3084 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
3085 */
3086#ifdef PNG_STDIO_SUPPORTED
3087PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
3088 const char *file_name));
3089 /* The named file is opened for read and the image header is filled in
3090 * from the PNG header in the file.
3091 */
3092
3093PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
3094 FILE* file));
3095 /* The PNG header is read from the stdio FILE object. */
3096#endif /* PNG_STDIO_SUPPORTED */
3097
3098PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
3099 png_const_voidp memory, png_size_t size));
3100 /* The PNG header is read from the given memory buffer. */
3101
3102PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
3103 png_const_colorp background, void *buffer, png_int_32 row_stride,
3104 void *colormap));
3105 /* Finish reading the image into the supplied buffer and clean up the
3106 * png_image structure.
3107 *
3108 * row_stride is the step, in byte or 2-byte units as appropriate,
3109 * between adjacent rows. A positive stride indicates that the top-most row
3110 * is first in the buffer - the normal top-down arrangement. A negative
3111 * stride indicates that the bottom-most row is first in the buffer.
3112 *
3113 * background need only be supplied if an alpha channel must be removed from
3114 * a png_byte format and the removal is to be done by compositing on a solid
3115 * color; otherwise it may be NULL and any composition will be done directly
3116 * onto the buffer. The value is an sRGB color to use for the background,
3117 * for grayscale output the green channel is used.
3118 *
3119 * background must be supplied when an alpha channel must be removed from a
3120 * single byte color-mapped output format, in other words if:
3121 *
3122 * 1) The original format from png_image_begin_read_from_* had
3123 * PNG_FORMAT_FLAG_ALPHA set.
3124 * 2) The format set by the application does not.
3125 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3126 * PNG_FORMAT_FLAG_LINEAR *not* set.
3127 *
3128 * For linear output removing the alpha channel is always done by compositing
3129 * on black and background is ignored.
3130 *
3131 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3132 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3133 * image->colormap_entries will be updated to the actual number of entries
3134 * written to the colormap; this may be less than the original value.
3135 */
3136
3137PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3138 /* Free any data allocated by libpng in image->opaque, setting the pointer to
3139 * NULL. May be called at any time after the structure is initialized.
3140 */
3141#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */
3142
3143#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
3144#ifdef PNG_STDIO_SUPPORTED
3145/* WRITE APIS
3146 * ----------
3147 * For write you must initialize a png_image structure to describe the image to
3148 * be written. To do this use memset to set the whole structure to 0 then
3149 * initialize fields describing your image.
3150 *
3151 * version: must be set to PNG_IMAGE_VERSION
3152 * opaque: must be initialized to NULL
3153 * width: image width in pixels
3154 * height: image height in rows
3155 * format: the format of the data (image and color-map) you wish to write
3156 * flags: set to 0 unless one of the defined flags applies; set
3157 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3158 * values do not correspond to the colors in sRGB.
3159 * colormap_entries: set to the number of entries in the color-map (0 to 256)
3160 */
3161PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3162 const char *file, int convert_to_8bit, const void *buffer,
3163 png_int_32 row_stride, const void *colormap));
3164 /* Write the image to the named file. */
3165
3166PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
3167 int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3168 const void *colormap));
3169 /* Write the image to the given (FILE*). */
3170
3171/* With both write APIs if image is in one of the linear formats with 16-bit
3172 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3173 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3174 * encoded PNG file is written.
3175 *
3176 * With color-mapped data formats the colormap parameter point to a color-map
3177 * with at least image->colormap_entries encoded in the specified format. If
3178 * the format is linear the written PNG color-map will be converted to sRGB
3179 * regardless of the convert_to_8_bit flag.
3180 *
3181 * With all APIs row_stride is handled as in the read APIs - it is the spacing
3182 * from one row to the next in component sized units (1 or 2 bytes) and if
3183 * negative indicates a bottom-up row layout in the buffer.
3184 *
3185 * Note that the write API does not support interlacing or sub-8-bit pixels.
3186 */
3187#endif /* PNG_STDIO_SUPPORTED */
3188#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
3189/*******************************************************************************
3190 * END OF SIMPLIFIED API
3191 ******************************************************************************/
3192
3193#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
3194PNG_EXPORT(242, void, png_set_check_for_invalid_index,
3195 (png_structrp png_ptr, int allowed));
3196# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
3197PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
3198 png_const_infop info_ptr));
3199# endif
3200#endif /* CHECK_FOR_INVALID_INDEX */
3201
3202/*******************************************************************************
3203 * IMPLEMENTATION OPTIONS
3204 *******************************************************************************
3205 *
3206 * Support for arbitrary implementation-specific optimizations. The API allows
3207 * particular options to be turned on or off. 'Option' is the number of the
3208 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3209 * by the PNG_OPTION_ defines below.
3210 *
3211 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
3212 * are detected at run time, however sometimes it may be impossible
3213 * to do this in user mode, in which case it is necessary to discover
3214 * the capabilities in an OS specific way. Such capabilities are
3215 * listed here when libpng has support for them and must be turned
3216 * ON by the application if present.
3217 *
3218 * SOFTWARE: sometimes software optimizations actually result in performance
3219 * decrease on some architectures or systems, or with some sets of
3220 * PNG images. 'Software' options allow such optimizations to be
3221 * selected at run time.
3222 */
3223#ifdef PNG_SET_OPTION_SUPPORTED
3224#ifdef PNG_ARM_NEON_API_SUPPORTED
3225# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3226#endif
3227#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3228#define PNG_OPTION_NEXT 4 /* Next option - numbers must be even */
3229
3230/* Return values: NOTE: there are four values and 'off' is *not* zero */
3231#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3232#define PNG_OPTION_INVALID 1 /* Option number out of range */
3233#define PNG_OPTION_OFF 2
3234#define PNG_OPTION_ON 3
3235
3236PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3237 int onoff));
The Android Open Source Project893912b2009-03-03 19:30:05 -08003238#endif
3239
Chris Craikb50c2172013-07-29 15:28:30 -07003240/*******************************************************************************
3241 * END OF HARDWARE OPTIONS
3242 ******************************************************************************/
3243
3244/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
3245 * defs, scripts/pnglibconf.h, and scripts/pnglibconf.h.prebuilt
3246 */
3247
3248/* The last ordinal number (this is the *last* one already used; the next
3249 * one to use is one more than this.) Maintainer, remember to add an entry to
3250 * scripts/symbols.def as well.
3251 */
3252#ifdef PNG_EXPORT_LAST_ORDINAL
3253 PNG_EXPORT_LAST_ORDINAL(244);
The Android Open Source Project893912b2009-03-03 19:30:05 -08003254#endif
3255
The Android Open Source Project893912b2009-03-03 19:30:05 -08003256#ifdef __cplusplus
3257}
3258#endif
3259
3260#endif /* PNG_VERSION_INFO_ONLY */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04003261/* Do not put anything past this line */
The Android Open Source Project893912b2009-03-03 19:30:05 -08003262#endif /* PNG_H */