blob: 996d1d6c94047eaf185e4067268c30753c5de055 [file] [log] [blame]
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -06001
Andreas Dilger47a0c421997-05-16 02:46:07 -05002/* png.h - header file for PNG reference library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06003 *
Glenn Randers-Pehrsoncad67982011-02-13 06:10:34 -06004 * libpng version 1.5.2beta01 - February 13, 2011
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -06005 * Copyright (c) 1998-2011 Glenn Randers-Pehrson
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -05006 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06008 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -05009 * This code is released under the libpng license (See LICENSE, below)
Glenn Randers-Pehrson3e61d792009-06-24 09:31:28 -050010 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -050011 * Authors and maintainers:
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060012 * 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
Glenn Randers-Pehrsoncad67982011-02-13 06:10:34 -060014 * libpng versions 0.97, January 1998, through 1.5.2beta01 - February 13, 2011: Glenn
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060015 * See also "Contributing Authors", below.
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -050016 *
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060017 * Note about libpng version numbers:
18 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060019 * 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:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060024 *
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050025 * 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)
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -060057 * 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
Glenn Randers-Pehrsond4e81092001-01-31 05:56:52 -060068 * 1.0.9 1 10009 2.1.0.9
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -060069 * 1.0.10beta1 1 10010 2.1.0.10beta1
Glenn Randers-Pehrsone1644472001-03-23 05:06:56 -060070 * 1.0.10rc1 1 10010 2.1.0.10rc1
Glenn Randers-Pehrson13cfbac2001-03-30 06:42:28 -060071 * 1.0.10 1 10010 2.1.0.10
Glenn Randers-Pehrsone1eff582001-04-14 20:15:41 -050072 * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3
Glenn Randers-Pehrson82ae3832001-04-20 10:32:10 -050073 * 1.0.11rc1 1 10011 2.1.0.11rc1
Glenn Randers-Pehrson32835392001-04-27 08:29:32 -050074 * 1.0.11 1 10011 2.1.0.11
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -050075 * 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)
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -050079 * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -050080 * 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
Glenn Randers-Pehrson5cded0b2001-11-07 07:10:08 -060083 * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4
Glenn Randers-Pehrsondb3b88d2001-12-04 06:30:43 -060084 * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2
85 * 1.2.1 3 10201 3.1.2.1
Glenn Randers-Pehrson25228ab2002-03-31 07:33:55 -060086 * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6
Glenn Randers-Pehrsonfcbd7872002-04-07 16:35:38 -050087 * 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
Glenn Randers-Pehrson4fb046a2002-04-15 09:25:51 -050090 * 1.0.13 10 10013 10.so.0.1.0.13
91 * 1.2.2 12 10202 12.so.0.1.2.2
Glenn Randers-Pehrson22f28962002-05-13 18:17:09 -050092 * 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
Glenn Randers-Pehrsond020e9d2002-06-28 09:34:00 -050094 * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3
Glenn Randers-Pehrson2ae022d2002-07-01 22:23:46 -050095 * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1
96 * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1
Glenn Randers-Pehrson484a8a12002-07-07 19:15:20 -050097 * 1.0.14 10 10014 10.so.0.1.0.14
98 * 1.2.4 13 10204 12.so.0.1.2.4
Glenn Randers-Pehrson51d92502002-08-23 23:07:42 -050099 * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2
Glenn Randers-Pehrson5ff38d32002-09-17 23:38:46 -0500100 * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3
Glenn Randers-Pehrson0cc2f952002-10-03 06:32:37 -0500101 * 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
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500104 * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4
Glenn Randers-Pehrson37f116a2004-08-15 07:15:39 -0500105 * 1.0.16 10 10016 10.so.0.1.0.16
106 * 1.2.6 13 10206 12.so.0.1.2.6
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500107 * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2
Glenn Randers-Pehrson5b779162004-09-04 13:25:08 -0500108 * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1
109 * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500110 * 1.0.17 10 10017 12.so.0.1.0.17
111 * 1.2.7 13 10207 12.so.0.1.2.7
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600112 * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5
Glenn Randers-Pehrson584b96e2004-11-29 15:08:00 -0600113 * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5
114 * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5
Glenn Randers-Pehrson917648e2004-12-02 18:14:51 -0600115 * 1.0.18 10 10018 12.so.0.1.0.18
116 * 1.2.8 13 10208 12.so.0.1.2.8
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -0600117 * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3
Glenn Randers-Pehrson4deeb792006-03-22 16:21:59 -0600118 * 1.2.9beta4-11 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrson3a512032006-03-31 05:29:33 -0600119 * 1.2.9rc1 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsona7d0c942006-04-14 06:22:52 -0500120 * 1.2.9 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsond60b8fa2006-04-20 21:31:14 -0500121 * 1.2.10beta1-7 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500122 * 1.2.10rc1-2 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson86dc9812006-05-10 07:27:44 -0500123 * 1.2.10 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson73b064c2006-05-15 06:44:21 -0500124 * 1.4.0beta1-5 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -0500125 * 1.2.11beta1-4 13 10211 12.so.0.11[.0]
Glenn Randers-Pehrson3424ee72006-07-12 13:33:47 -0500126 * 1.4.0beta7-8 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500127 * 1.2.11 13 10211 12.so.0.11[.0]
128 * 1.2.12 13 10212 12.so.0.12[.0]
Glenn Randers-Pehrson701dbaa2006-11-17 09:36:54 -0600129 * 1.4.0beta9-14 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500130 * 1.2.13 13 10213 12.so.0.13[.0]
Glenn Randers-Pehrson97a9b482008-10-25 20:03:28 -0500131 * 1.4.0beta15-36 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrsonfa028102009-10-10 06:15:21 -0500132 * 1.4.0beta37-87 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson733da8c2009-10-30 00:00:15 -0500133 * 1.4.0rc01 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson62ca98e2009-12-20 15:14:57 -0600134 * 1.4.0beta88-109 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson67a83db2010-01-01 18:26:18 -0600135 * 1.4.0rc02-08 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson75202242009-12-25 14:25:29 -0600136 * 1.4.0 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600137 * 1.4.1beta01-03 14 10401 14.so.14.1[.0]
138 * 1.4.1rc01 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson7a5be532010-02-14 07:16:19 -0600139 * 1.4.1beta04-12 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrsonaaf377c2010-03-08 11:20:30 -0600140 * 1.4.1 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson5b3d5542010-06-18 21:55:53 -0500141 * 1.4.2 14 10402 14.so.14.2[.0]
142 * 1.4.3 14 10403 14.so.14.3[.0]
Glenn Randers-Pehrson2776d5e2010-11-21 15:18:02 -0600143 * 1.4.4 14 10404 14.so.14.4[.0]
Glenn Randers-Pehrsonfd20a5a2010-12-27 08:53:08 -0600144 * 1.5.0beta01-58 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600145 * 1.5.0rc01-07 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonf5ea1b72011-01-06 06:42:51 -0600146 * 1.5.0 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonef123cc2011-01-28 15:20:34 -0600147 * 1.5.1beta01-11 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrson3d3aae12011-02-02 22:58:27 -0600148 * 1.5.1rc01-02 15 10501 15.so.15.1[.0]
149 * 1.5.1 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600150 * 1.5.2beta01 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600151 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600152 * Henceforth the source version will match the shared-library major
153 * and minor numbers; the shared-library major version number will be
154 * used for changes in backward compatibility, as it is intended. The
155 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
156 * for applications, is an unsigned integer of the form xyyzz corresponding
157 * to the source version x.y.z (leading zeros in y and z). Beta versions
158 * were given the previous public release number plus a letter, until
159 * version 1.0.6j; from then on they were given the upcoming public
160 * release number plus "betaNN" or "rcN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600161 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600162 * Binary incompatibility exists only when applications make direct access
163 * to the info_ptr or png_ptr members through png.h, and the compiled
164 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500165 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600166 * DLLNUM will change each time there are forward or backward changes
167 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600168 *
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500169 * See libpng-manual.txt or libpng.3 for more information. The PNG
170 * specification is available as a W3C Recommendation and as an ISO
171 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600172 */
173
174/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600175 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
176 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500177 * If you modify libpng you may insert additional notices immediately following
178 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600179 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500180 * This code is released under the libpng license.
181 *
Glenn Randers-Pehrsoncad67982011-02-13 06:10:34 -0600182 * libpng versions 1.2.6, August 15, 2004, through 1.5.2beta01, February 13, 2011, are
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600183 * Copyright (c) 2004, 2006-2011 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500184 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500185 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500186 *
187 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500188 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500189 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500190 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500191 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500192 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500193 *
194 * Simon-Pierre Cadieux
195 * Eric S. Raymond
196 * Gilles Vollant
197 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500198 * and with the following additions to the disclaimer:
199 *
200 * There is no warranty against interference with your enjoyment of the
201 * library or against infringement. There is no warranty that our
202 * efforts or the library will fulfill any of your particular purposes
203 * or needs. This library is provided with all faults, and the entire
204 * risk of satisfactory quality, performance, accuracy, and effort is with
205 * the user.
206 *
207 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500208 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600209 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500210 * with the following individuals added to the list of Contributing Authors:
211 *
212 * Tom Lane
213 * Glenn Randers-Pehrson
214 * Willem van Schaik
215 *
216 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600217 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600218 * Distributed according to the same disclaimer and license as libpng-0.88,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500219 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600220 *
221 * John Bowler
222 * Kevin Bracey
223 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600224 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600225 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500226 * Tom Tanner
227 *
228 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
229 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
230 *
231 * For the purposes of this copyright and license, "Contributing Authors"
232 * is defined as the following set of individuals:
233 *
234 * Andreas Dilger
235 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600236 * Guy Eric Schalnat
237 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600238 * Tim Wegner
239 *
240 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600241 * and Group 42, Inc. disclaim all warranties, expressed or implied,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600242 * including, without limitation, the warranties of merchantability and of
243 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600244 * assume no liability for direct, indirect, incidental, special, exemplary,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600245 * or consequential damages, which may result from the use of the PNG
246 * Reference Library, even if advised of the possibility of such damage.
247 *
248 * Permission is hereby granted to use, copy, modify, and distribute this
249 * source code, or portions hereof, for any purpose, without fee, subject
250 * to the following restrictions:
251 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600252 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600253 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500254 * 2. Altered versions must be plainly marked as such and must not
255 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600256 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600257 * 3. This Copyright notice may not be removed or altered from
258 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600259 *
260 * The Contributing Authors and Group 42, Inc. specifically permit, without
261 * fee, and encourage the use of this source code as a component to
262 * supporting the PNG file format in commercial products. If you use this
263 * source code in a product, acknowledgment is not required but would be
264 * appreciated.
265 */
266
267/*
268 * A "png_get_copyright" function is available, for convenient use in "about"
269 * boxes and the like:
270 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600271 * printf("%s", png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600272 *
273 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500274 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600275 */
276
277/*
278 * Libpng is OSI Certified Open Source Software. OSI Certified is a
279 * certification mark of the Open Source Initiative.
280 */
281
282/*
283 * The contributing authors would like to thank all those who helped
284 * with testing, bug fixes, and patience. This wouldn't have been
285 * possible without all of you.
286 *
287 * Thanks to Frank J. T. Wojcik for helping with the documentation.
288 */
289
290/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600291 * Y2K compliance in libpng:
292 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600293 *
Glenn Randers-Pehrsoncad67982011-02-13 06:10:34 -0600294 * February 13, 2011
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600295 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600296 * Since the PNG Development group is an ad-hoc body, we can't make
297 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600298 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500299 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600300 * upward through 1.5.2beta01 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500301 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600302 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600303 * Libpng only has three year fields. One is a 2-byte unsigned integer
304 * that will hold years up to 65535. The other two hold the date in text
305 * format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600306 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600307 * The integer is
308 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600309 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600310 * The strings are
311 * "png_charp time_buffer" in png_struct and
312 * "near_time_buffer", which is a local character string in png.c.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600313 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600314 * There are seven time-related functions:
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600315 * png.c: png_convert_to_rfc_1123() in png.c
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600316 * (formerly png_convert_to_rfc_1152() in error)
317 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
318 * png_convert_from_time_t() in pngwrite.c
319 * png_get_tIME() in pngget.c
320 * png_handle_tIME() in pngrutil.c, called in pngread.c
321 * png_set_tIME() in pngset.c
322 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600323 *
324 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600325 * png_convert_from_time_t() function calls gmtime() to convert from system
326 * clock time, which returns (year - 1900), which we properly convert to
327 * the full 4-digit year. There is a possibility that applications using
328 * libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500329 * function, or that they are incorrectly passing only a 2-digit year
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600330 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500331 * but this is not under our control. The libpng documentation has always
332 * stated that it works with 4-digit years, and the APIs have been
333 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600334 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600335 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
336 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600337 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500338 * zlib, upon which libpng depends, is also Y2K compliant. It contains
339 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600340 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600341 * Glenn Randers-Pehrson
342 * libpng maintainer
343 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500344 */
345
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500346#ifndef PNG_H
347#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500348
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500349/* This is not the place to learn how to use libpng. The file libpng-manual.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500350 * describes how to use libpng, and the file example.c summarizes it
351 * with some code on which to build. This file is useful for looking
352 * at the actual function definitions and structure components.
353 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500354
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500355/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600356#define PNG_LIBPNG_VER_STRING "1.5.2beta01"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500357#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrsoncad67982011-02-13 06:10:34 -0600358 " libpng version 1.5.2beta01 - February 13, 2011\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500359
Glenn Randers-Pehrsonf1eb9182010-02-08 15:36:41 -0600360#define PNG_LIBPNG_VER_SONUM 15
361#define PNG_LIBPNG_VER_DLLNUM 15
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500362
363/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
364#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600365#define PNG_LIBPNG_VER_MINOR 5
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600366#define PNG_LIBPNG_VER_RELEASE 2
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500367/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500368 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
369 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600370
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600371#define PNG_LIBPNG_VER_BUILD 01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600372
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600373/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600374#define PNG_LIBPNG_BUILD_ALPHA 1
375#define PNG_LIBPNG_BUILD_BETA 2
376#define PNG_LIBPNG_BUILD_RC 3
377#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600378#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500379
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600380/* Release-Specific Flags */
381#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
382 PNG_LIBPNG_BUILD_STABLE only */
383#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
384 PNG_LIBPNG_BUILD_SPECIAL */
385#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
386 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500387
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500388#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600389
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500390/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
391 * We must not include leading zeros.
392 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
393 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500394 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
395 */
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600396#define PNG_LIBPNG_VER 10502 /* 1.5.2 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500397
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500398/* Library configuration: these options cannot be changed after
399 * the library has been built.
400 */
401#ifndef PNGLCONF_H
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -0500402 /* If pnglibconf.h is missing, you can
403 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
404 */
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500405# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600406#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500407
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500408#ifndef PNG_VERSION_INFO_ONLY
409/* Standard header files (not needed for the version info) */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500410# ifdef PNG_SETJMP_SUPPORTED
411# include <setjmp.h>
412# endif
413
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500414/* Need the time information for converting tIME chunks, it
415 * defines struct tm:
416 */
417#ifdef PNG_CONVERT_tIME_SUPPORTED
418 /* "time.h" functions are not supported on all operating systems */
419# include <time.h>
420#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500421
422/* Machine specific configuration. */
423# include "pngconf.h"
424#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500425
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600426/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500427 * Added at libpng-1.2.8
428 *
429 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600430 * VS_FF_PRIVATEBUILD File *was not* built using standard release
431 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500432 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600433 *
434 * VS_FF_SPECIALBUILD File *was* built by the original company using
435 * standard release procedures but is a variation of the standard
436 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500437 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600438 */
439
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500440#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600441# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600442 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600443#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500444# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600445# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600446 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600447# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600448# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600449# endif
450#endif
451
452#ifndef PNG_VERSION_INFO_ONLY
453
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500454/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
455#ifdef __cplusplus
456extern "C" {
457#endif /* __cplusplus */
458
Andreas Dilger47a0c421997-05-16 02:46:07 -0500459/* Version information for C files, stored in png.c. This had better match
460 * the version above.
461 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500462#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500463
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500464/* This file is arranged in several sections:
465 *
466 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500467 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500468 * 2. Type definitions (base types are defined in pngconf.h), structure
469 * definitions.
470 * 3. Exported library functions.
471 *
472 * The library source code has additional files (principally pngpriv.h) that
473 * allow configuration of the library.
474 */
475/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500476 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500477 *
478 * Run time configuration allows the application to choose between
479 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500480 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500481 * override these (and only these) settings. Note that this won't
482 * change what the library does, only application code, and the
483 * settings can (and probably should) be made on a per-file basis
484 * by setting the #defines before including png.h
485 *
486 * Use macros to read integers from PNG data or use the exported
487 * functions?
488 * PNG_USE_READ_MACROS: use the macros (see below) Note that
489 * the macros evaluate their argument multiple times.
490 * PNG_NO_USE_READ_MACROS: call the relevant library function.
491 *
492 * Use the alternative algorithm for compositing alpha samples that
493 * does not use division?
494 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
495 * algorithm.
496 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
497 *
498 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
499 * false?
500 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
501 * APIs to png_warning.
502 * Otherwise the calls are mapped to png_error.
503 */
504
505/* Section 2: type definitions, including structures and compile time
506 * constants.
507 * See pngconf.h for base types that vary by machine/system
508 */
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500509
510/* This triggers a compiler error in png.c, if png.c and png.h
511 * do not agree upon the version number.
512 */
Glenn Randers-Pehrson47a007a2011-02-03 21:26:21 -0600513typedef char* png_libpng_version_1_5_2beta01;
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500514
Andreas Dilger47a0c421997-05-16 02:46:07 -0500515/* Three color definitions. The order of the red, green, and blue, (and the
516 * exact size) is not important, although the size of the fields need to
517 * be png_byte or png_uint_16 (as defined below).
518 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500519typedef struct png_color_struct
520{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600521 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500522 png_byte green;
523 png_byte blue;
524} png_color;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500525typedef png_color FAR * png_colorp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500526typedef PNG_CONST png_color FAR * png_const_colorp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500527typedef png_color FAR * FAR * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500528
529typedef struct png_color_16_struct
530{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500531 png_byte index; /* used for palette files */
532 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500533 png_uint_16 green;
534 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500535 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500536} png_color_16;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500537typedef png_color_16 FAR * png_color_16p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500538typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500539typedef png_color_16 FAR * FAR * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500540
541typedef struct png_color_8_struct
542{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500543 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500544 png_byte green;
545 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500546 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500547 png_byte alpha; /* for alpha channel files */
548} png_color_8;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500549typedef png_color_8 FAR * png_color_8p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500550typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500551typedef png_color_8 FAR * FAR * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500552
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600553/*
554 * The following two structures are used for the in-core representation
555 * of sPLT chunks.
556 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600557typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600558{
559 png_uint_16 red;
560 png_uint_16 green;
561 png_uint_16 blue;
562 png_uint_16 alpha;
563 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600564} png_sPLT_entry;
565typedef png_sPLT_entry FAR * png_sPLT_entryp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500566typedef PNG_CONST png_sPLT_entry FAR * png_const_sPLT_entryp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600567typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600568
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500569/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
570 * occupy the LSB of their respective members, and the MSB of each member
571 * is zero-filled. The frequency member always occupies the full 16 bits.
572 */
573
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600574typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600575{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500576 png_charp name; /* palette name */
577 png_byte depth; /* depth of palette samples */
578 png_sPLT_entryp entries; /* palette entries */
579 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600580} png_sPLT_t;
581typedef png_sPLT_t FAR * png_sPLT_tp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500582typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600583typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600584
585#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600586/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600587 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500588 * points to a regular zero-terminated C string. The "text", "lang", and
589 * "lang_key" fields can be regular C strings, empty strings, or NULL pointers.
590 * However, the * structure returned by png_get_text() will always contain
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600591 * regular zero-terminated C strings (possibly empty), never NULL pointers,
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500592 * so they can be safely used in printf() and other string-handling functions.
593 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500594typedef struct png_text_struct
595{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500596 int compression; /* compression value:
597 -1: tEXt, none
598 0: zTXt, deflate
599 1: iTXt, none
600 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500601 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500602 png_charp text; /* comment, may be an empty string (ie "")
603 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600604 png_size_t text_length; /* length of the text string */
605 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500606 png_charp lang; /* language code, 0-79 characters
607 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600608 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500609 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500610} png_text;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500611typedef png_text FAR * png_textp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500612typedef PNG_CONST png_text FAR * png_const_textp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500613typedef png_text FAR * FAR * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600614#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500615
616/* Supported compression types for text in PNG files (tEXt, and zTXt).
617 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
618#define PNG_TEXT_COMPRESSION_NONE_WR -3
619#define PNG_TEXT_COMPRESSION_zTXt_WR -2
620#define PNG_TEXT_COMPRESSION_NONE -1
621#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600622#define PNG_ITXT_COMPRESSION_NONE 1
623#define PNG_ITXT_COMPRESSION_zTXt 2
624#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500625
626/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600627 * Two conversions are provided, both from time_t and struct tm. There
628 * is no portable way to convert to either of these structures, as far
629 * as I know. If you know of a portable way, send it to me. As a side
Glenn Randers-Pehrson231e6872001-01-12 15:13:06 -0600630 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600631 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500632typedef struct png_time_struct
633{
634 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500635 png_byte month; /* month of year, 1 - 12 */
636 png_byte day; /* day of month, 1 - 31 */
637 png_byte hour; /* hour of day, 0 - 23 */
638 png_byte minute; /* minute of hour, 0 - 59 */
639 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500640} png_time;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500641typedef png_time FAR * png_timep;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500642typedef PNG_CONST png_time FAR * png_const_timep;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500643typedef png_time FAR * FAR * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500644
Glenn Randers-Pehrson38674ec2009-06-16 13:33:01 -0500645#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600646 defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600647/* png_unknown_chunk is a structure to hold queued chunks for which there is
648 * no specific support. The idea is that we can use this to queue
649 * up private chunks for output even though the library doesn't actually
650 * know about their semantics.
651 */
652typedef struct png_unknown_chunk_t
653{
654 png_byte name[5];
655 png_byte *data;
656 png_size_t size;
657
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600658 /* libpng-using applications should NOT directly modify this byte. */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600659 png_byte location; /* mode of operation at read time */
660}
661png_unknown_chunk;
662typedef png_unknown_chunk FAR * png_unknown_chunkp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500663typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600664typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
665#endif
666
Glenn Randers-Pehrsonf0cdbe72010-02-08 23:18:15 -0600667typedef struct png_info_def png_info;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500668typedef png_info FAR * png_infop;
John Bowler0a5c9c02011-01-22 17:36:34 -0600669typedef PNG_CONST png_info FAR * png_const_infop;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500670typedef png_info FAR * FAR * png_infopp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500671
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500672/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500673#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600674#define PNG_UINT_32_MAX ((png_uint_32)(-1))
675#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500676
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500677/* These are constants for fixed point values encoded in the
678 * PNG specification manner (x100000)
679 */
680#define PNG_FP_1 100000
681#define PNG_FP_HALF 50000
682
Andreas Dilger47a0c421997-05-16 02:46:07 -0500683/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500684/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500685#define PNG_COLOR_MASK_PALETTE 1
686#define PNG_COLOR_MASK_COLOR 2
687#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500688
689/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500690#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500691#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
692#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
693#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500694#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600695/* aliases */
696#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
697#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500698
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500699/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500700#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
701#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
702
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500703/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500704#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600705#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500706#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
707
708/* These are for the interlacing type. These values should NOT be changed. */
709#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
710#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
711#define PNG_INTERLACE_LAST 2 /* Not a valid value */
712
713/* These are for the oFFs chunk. These values should NOT be changed. */
714#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
715#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
716#define PNG_OFFSET_LAST 2 /* Not a valid value */
717
718/* These are for the pCAL chunk. These values should NOT be changed. */
719#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
720#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
721#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
722#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
723#define PNG_EQUATION_LAST 4 /* Not a valid value */
724
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600725/* These are for the sCAL chunk. These values should NOT be changed. */
726#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
727#define PNG_SCALE_METER 1 /* meters per pixel */
728#define PNG_SCALE_RADIAN 2 /* radians per pixel */
729#define PNG_SCALE_LAST 3 /* Not a valid value */
730
Andreas Dilger47a0c421997-05-16 02:46:07 -0500731/* These are for the pHYs chunk. These values should NOT be changed. */
732#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
733#define PNG_RESOLUTION_METER 1 /* pixels/meter */
734#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
735
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600736/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600737#define PNG_sRGB_INTENT_PERCEPTUAL 0
738#define PNG_sRGB_INTENT_RELATIVE 1
739#define PNG_sRGB_INTENT_SATURATION 2
740#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600741#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600742
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600743/* This is for text chunks */
744#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600745
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600746/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500747#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600748
Andreas Dilger47a0c421997-05-16 02:46:07 -0500749/* These determine if an ancillary chunk's data has been successfully read
750 * from the PNG header, or if the application has filled in the corresponding
751 * data in the info_struct to be written into the output file. The values
752 * of the PNG_INFO_<chunk> defines should NOT be changed.
753 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500754#define PNG_INFO_gAMA 0x0001
755#define PNG_INFO_sBIT 0x0002
756#define PNG_INFO_cHRM 0x0004
757#define PNG_INFO_PLTE 0x0008
758#define PNG_INFO_tRNS 0x0010
759#define PNG_INFO_bKGD 0x0020
760#define PNG_INFO_hIST 0x0040
761#define PNG_INFO_pHYs 0x0080
762#define PNG_INFO_oFFs 0x0100
763#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500764#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600765#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600766#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
767#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
768#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600769#define PNG_INFO_IDAT 0x8000L /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500770
Andreas Dilger47a0c421997-05-16 02:46:07 -0500771/* This is used for the transformation routines, as some of them
772 * change these values for the row. It also should enable using
773 * the routines for other purposes.
774 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500775typedef struct png_row_info_struct
776{
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600777 png_uint_32 width; /* width of row */
778 png_size_t rowbytes; /* number of bytes in row */
779 png_byte color_type; /* color type of row */
780 png_byte bit_depth; /* bit depth of row */
781 png_byte channels; /* number of channels (1, 2, 3, or 4) */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600782 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500783} png_row_info;
784
Andreas Dilger47a0c421997-05-16 02:46:07 -0500785typedef png_row_info FAR * png_row_infop;
786typedef png_row_info FAR * FAR * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600787
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500788/* These are the function types for the I/O functions and for the functions
789 * that allow the user to override the default I/O functions with his or her
790 * own. The png_error_ptr type should match that of user-supplied warning
791 * and error functions, while the png_rw_ptr type should match that of the
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500792 * user read/write data functions. Note that the 'write' function must not
Glenn Randers-Pehrsonea2f7e02010-08-18 08:14:54 -0500793 * modify the buffer it is passed. The 'read' function, on the other hand, is
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500794 * expected to return the read data in the buffer.
Guy Schalnat0f716451995-11-28 11:22:13 -0600795 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600796typedef struct png_struct_def png_struct;
John Bowler0a5c9c02011-01-22 17:36:34 -0600797typedef PNG_CONST png_struct FAR * png_const_structp;
Guy Schalnat6d764711995-12-19 03:22:19 -0600798typedef png_struct FAR * png_structp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600799
John Bowler9c693602011-02-12 08:58:21 -0600800typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
801typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
802typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
803typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
804 int));
805typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
806 int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600807
Guy Schalnat69b14481996-01-10 02:56:49 -0600808#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600809typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
810typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
John Bowler9616ad92011-02-16 06:13:46 -0600811
812/* The following callback receives png_uint_32 row_number, int pass for the
813 * png_bytep data of the row. When transforming an interlaced image the
814 * row number is the row number within the sub-image of the interlace pass, so
815 * the value will increase to the height of the sub-image (not the full image)
816 * then reset to 0 for the next pass.
817 *
818 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
819 * find the output pixel (x,y) given an interlaced sub-image pixel
820 * (row,col,pass). (See below for these macros.)
821 */
John Bowler9c693602011-02-12 08:58:21 -0600822typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600823 png_uint_32, int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600824#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600825
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600826#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500827 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
John Bowler9c693602011-02-12 08:58:21 -0600828typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600829 png_bytep));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600830#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600831
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500832#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600833typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600834 png_unknown_chunkp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600835#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500836#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600837typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600838#endif
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600839
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600840#ifdef PNG_SETJMP_SUPPORTED
841/* This must match the function definition in <setjmp.h>, and the
842 * application must include this before png.h to obtain the definition
Glenn Randers-Pehrson77396b62010-08-02 08:00:10 -0500843 * of jmp_buf. The function is required to be PNG_NORETURN. (Note that
844 * PNG_PTR_NORETURN is used here because current versions of the Microsoft
845 * C compiler do not support the PNG_NORETURN attribute on a pointer.)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500846 *
847 * If you get a type warning from the compiler when linking against this line
848 * then your compiler has 'longjmp' that does not match the requirements of the
849 * compiler that built libpng. You will have to write a wrapper function for
850 * your compiler's longjmp and call png_set_longjmp_fn directly (not via the
851 * png_jmpbuf macro.)
852 *
853 * If you get a warning here while building the library you will need to make
854 * changes to ensure that pnglibconf.h records the calling convention used by
855 * your compiler. This may be very difficult - try using a different compiler
856 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600857 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600858typedef PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)),
Glenn Randers-Pehrson77396b62010-08-02 08:00:10 -0500859 PNG_PTR_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600860#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600861
862/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600863#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
864#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600865#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
866#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600867#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
868#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600869#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600870#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
871#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
872#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600873#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500874#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500875#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600876/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600877#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500878#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
879/* Added to libpng-1.4.0 */
880#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600881
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600882/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600883#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600884#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600885#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600886
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600887/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600888 * this allowed the zlib default functions to be used on Windows
889 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
890 * ignores the first argument) should be completely compatible with the
891 * following.
892 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600893typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
John Bowler9c693602011-02-12 08:58:21 -0600894 png_alloc_size_t));
895typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500896
Andreas Dilger47a0c421997-05-16 02:46:07 -0500897typedef png_struct FAR * FAR * png_structpp;
Guy Schalnat6d764711995-12-19 03:22:19 -0600898
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500899/* Section 3: exported functions
900 * Here are the function definitions most commonly used. This is not
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500901 * the place to find out how to use libpng. See libpng-manual.txt for the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500902 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600903 * a simple one line description of the use of each function.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600904 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600905 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
906 * pngconf.h and in the *.dfn files in the scripts directory.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600907 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600908 * PNG_EXPORT(ordinal, type, name, (args));
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600909 *
910 * ordinal: ordinal that is used while building
911 * *.def files. The ordinal value is only
912 * relevant when preprocessing png.h with
913 * the *.dfn files for building symbol table
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600914 * entries, and are removed by pngconf.h.
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600915 * type: return type of the function
916 * name: function name
917 * args: function arguments, with types
918 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600919 * When we wish to append attributes to a function prototype we use
920 * the PNG_EXPORTA() macro instead.
921 *
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600922 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
923 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600924 * ordinal, type, name, and args: same as in PNG_EXPORT().
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600925 * attributes: function attributes
Andreas Dilger47a0c421997-05-16 02:46:07 -0500926 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500927
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500928/* Returns the version number of the library */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600929PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500930
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600931/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500932 * Handling more than 8 bytes from the beginning of the file is an error.
933 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600934PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600935
Andreas Dilger47a0c421997-05-16 02:46:07 -0500936/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
937 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
938 * signature, and non-zero otherwise. Having num_to_check == 0 or
939 * start > 7 will always fail (ie return non-zero).
940 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600941PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600942 png_size_t num_to_check));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600943
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500944/* Simple signature checking function. This is the same as calling
945 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
946 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600947#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500948
Andreas Dilger47a0c421997-05-16 02:46:07 -0500949/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600950PNG_EXPORTA(4, png_structp, png_create_read_struct,
951 (png_const_charp user_png_ver, png_voidp error_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600952 png_error_ptr error_fn, png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600953 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -0500954
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500955/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600956PNG_EXPORTA(5, png_structp, png_create_write_struct,
957 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600958 png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600959 PNG_ALLOCATED);
Guy Schalnate5a37791996-06-05 15:50:50 -0500960
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600961PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
John Bowler0a5c9c02011-01-22 17:36:34 -0600962 (png_const_structp png_ptr));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500963
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600964PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600965 png_size_t size));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500966
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600967/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
968 * match up.
969 */
970#ifdef PNG_SETJMP_SUPPORTED
971/* This function returns the jmp_buf built in to *png_ptr. It must be
972 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
973 * unless the default error function is overridden in which case NULL is
974 * acceptable. The size of the jmp_buf is checked against the actual size
975 * allocated by the library - the call will return NULL on a mismatch
976 * indicating an ABI mismatch.
977 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600978PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600979 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600980# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600981 (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600982#else
983# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600984 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600985#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -0600986/* This function should be used by libpng applications in place of
987 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
988 * will use it; otherwise it will call PNG_ABORT(). This function was
989 * added in libpng-1.5.0.
990 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600991PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
992 PNG_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600993
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -0500994#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500995/* Reset the compression stream */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600996PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -0500997#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500998
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -0500999/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001000#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001001PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1002 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001003 png_error_ptr warn_fn,
1004 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001005 PNG_ALLOCATED);
1006PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1007 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001008 png_error_ptr warn_fn,
1009 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001010 PNG_ALLOCATED);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001011#endif
1012
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001013/* Write the PNG file signature. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001014PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001015
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001016/* Write a PNG chunk - size, type, (optional) data, CRC. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001017PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
1018 chunk_name, png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001019
1020/* Write the start of a PNG chunk - length and chunk name. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001021PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001022 png_const_bytep chunk_name, png_uint_32 length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001023
1024/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001025PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
1026 png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001027
1028/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001029PNG_EXPORT(17, void, png_write_chunk_end, (png_structp png_ptr));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001030
Andreas Dilger47a0c421997-05-16 02:46:07 -05001031/* Allocate and initialize the info structure */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001032PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001033 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001034
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001035PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001036 png_size_t png_info_struct_size));
Guy Schalnat0d580581995-07-20 02:43:20 -05001037
Andreas Dilger47a0c421997-05-16 02:46:07 -05001038/* Writes all the PNG information before the image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001039PNG_EXPORT(20, void, png_write_info_before_PLTE,
1040 (png_structp png_ptr, png_infop info_ptr));
1041PNG_EXPORT(21, void, png_write_info,
1042 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001043
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001044#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001045/* Read the information before the actual image data. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001046PNG_EXPORT(22, void, png_read_info,
1047 (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001048#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001049
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001050#ifdef PNG_TIME_RFC1123_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001051PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001052 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001053 png_const_timep ptime));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001054#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001055
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001056#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001057/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001058PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001059 PNG_CONST struct tm FAR * ttime));
Guy Schalnat0d580581995-07-20 02:43:20 -05001060
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001061/* Convert from time_t to png_time. Uses gmtime() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001062PNG_EXPORT(25, void, png_convert_from_time_t,
1063 (png_timep ptime, time_t ttime));
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001064#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001065
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001066#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001067/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001068PNG_EXPORT(26, void, png_set_expand, (png_structp png_ptr));
1069PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structp png_ptr));
1070PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structp png_ptr));
1071PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001072#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001073
John Bowler4d562962011-02-12 09:01:20 -06001074#ifdef PNG_READ_EXPAND_16_SUPPORTED
1075/* Expand to 16 bit channels, forces conversion of palette to RGB and expansion
1076 * of a tRNS chunk if present.
1077 */
1078PNG_EXPORT(221, void, png_set_expand_16, (png_structp png_ptr));
1079#endif
1080
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001081#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001082/* Use blue, green, red order for pixels. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001083PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001084#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001085
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001086#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001087/* Expand the grayscale to 24-bit RGB if necessary. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001088PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
John Bowlerf21a0d02011-01-23 23:55:19 -06001089#endif
Guy Schalnat69b14481996-01-10 02:56:49 -06001090
John Bowlerf21a0d02011-01-23 23:55:19 -06001091#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001092/* Reduce RGB to grayscale. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001093PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
1094 int error_action, double red, double green));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001095PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001096 int error_action, png_fixed_point red, png_fixed_point green));
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001097
John Bowler0a5c9c02011-01-22 17:36:34 -06001098PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001099 png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001100#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001101
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001102PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001103 png_colorp palette));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001104
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001105#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001106PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001107#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001108
1109#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1110 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001111PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001112#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001113
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001114#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1115 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001116PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001117#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001118
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001119#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001120/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001121PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001122 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001123/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001124# define PNG_FILLER_BEFORE 0
1125# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001126/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001127PNG_EXPORT(40, void, png_set_add_alpha,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001128 (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001129 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001130#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001131
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001132#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001133/* Swap bytes in 16-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001134PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001135#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001136
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001137#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001138/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001139PNG_EXPORT(42, void, png_set_packing, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001140#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001141
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001142#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1143 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001144/* Swap packing order of pixels in bytes. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001145PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001146#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001147
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001148#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001149/* Converts files to legal bit depths. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001150PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
1151 true_bits));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001152#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001153
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001154#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1155 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001156/* Have the code handle the interlacing. Returns the number of passes.
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001157 * MUST be called before png_read_update_info or png_start_read_image,
1158 * otherwise it will not have the desired effect. Note that it is still
1159 * necessary to call png_read_row or png_read_rows png_get_image_height
1160 * times for each pass.
1161*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001162PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001163#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001164
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001165#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001166/* Invert monochrome files */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001167PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001168#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001169
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001170#ifdef PNG_READ_BACKGROUND_SUPPORTED
Guy Schalnat0d580581995-07-20 02:43:20 -05001171/* Handle alpha and tRNS by replacing with a background color. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001172PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr,
1173 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001174 int need_expand, double background_gamma));
John Bowler660c6e42010-12-19 06:22:23 -06001175PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001176 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001177 int need_expand, png_fixed_point background_gamma));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001178#endif
1179#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001180# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1181# define PNG_BACKGROUND_GAMMA_SCREEN 1
1182# define PNG_BACKGROUND_GAMMA_FILE 2
1183# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001184#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001185
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001186#ifdef PNG_READ_16_TO_8_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001187/* Strip the second byte of information from a 16-bit depth file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001188PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001189#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001190
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001191#ifdef PNG_READ_QUANTIZE_SUPPORTED
1192/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001193 * available.
1194 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001195PNG_EXPORT(49, void, png_set_quantize,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001196 (png_structp png_ptr, png_colorp palette,
1197 int num_palette, int maximum_colors, png_const_uint_16p histogram,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001198 int full_quantize));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001199#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001200
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001201#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001202/* The threshold on gamma processing is configurable but hard-wired into the
1203 * library. The following is the floating point variant.
1204 */
1205#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1206
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -05001207/* Handle gamma correction. Screen_gamma=(display_exponent) */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001208PNG_FP_EXPORT(50, void, png_set_gamma,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001209 (png_structp png_ptr, double screen_gamma,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001210 double default_file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001211PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001212 png_fixed_point screen_gamma, png_fixed_point default_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001213#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001214
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001215#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001216/* Set how many lines between output flushes - 0 for no flushing */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001217PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
Guy Schalnat0f716451995-11-28 11:22:13 -06001218/* Flush the current PNG output buffer */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001219PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001220#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001221
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001222/* Optional update palette with requested transformations */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001223PNG_EXPORT(53, void, png_start_read_image, (png_structp png_ptr));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001224
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001225/* Optional call to update the users info structure */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001226PNG_EXPORT(54, void, png_read_update_info,
1227 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001228
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001229#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001230/* Read one or more rows of image data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001231PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001232 png_bytepp display_row, png_uint_32 num_rows));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001233#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001234
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001235#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001236/* Read a row of data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001237PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001238 png_bytep display_row));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001239#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001240
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001241#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001242/* Read the whole image into memory at once. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001243PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001244#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001245
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001246/* Write a row of image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001247PNG_EXPORT(58, void, png_write_row,
1248 (png_structp png_ptr, png_const_bytep row));
Guy Schalnat0d580581995-07-20 02:43:20 -05001249
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001250/* Write a few rows of image data: (*row) is not written; however, the type
1251 * is declared as writeable to maintain compatibility with previous versions
1252 * of libpng and to allow the 'display_row' array from read_rows to be passed
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001253 * unchanged to write_rows.
1254 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001255PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001256 png_uint_32 num_rows));
Guy Schalnat0d580581995-07-20 02:43:20 -05001257
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001258/* Write the image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001259PNG_EXPORT(60, void, png_write_image,
1260 (png_structp png_ptr, png_bytepp image));
Guy Schalnat0d580581995-07-20 02:43:20 -05001261
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001262/* Write the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001263PNG_EXPORT(61, void, png_write_end,
1264 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001265
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001266#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001267/* Read the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001268PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001269#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001270
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001271/* Free any memory associated with the png_info_struct */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001272PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001273 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001274
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001275/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001276PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001277 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001278
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001279/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001280PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001281 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001282
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001283/* Set the libpng method of handling chunk CRC errors */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001284PNG_EXPORT(66, void, png_set_crc_action,
1285 (png_structp png_ptr, int crit_action, int ancil_action));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001286
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001287/* Values for png_set_crc_action() say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001288 * ancillary and critical chunks, and whether to use the data contained
1289 * therein. Note that it is impossible to "discard" data in a critical
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001290 * chunk. For versions prior to 0.90, the action was always error/quit,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001291 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1292 * chunks is warn/discard. These values should NOT be changed.
1293 *
1294 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001295 */
1296#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1297#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1298#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1299#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1300#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1301#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1302
Andreas Dilger47a0c421997-05-16 02:46:07 -05001303/* These functions give the user control over the scan-line filtering in
1304 * libpng and the compression methods used by zlib. These functions are
1305 * mainly useful for testing, as the defaults should work with most users.
1306 * Those users who are tight on memory or want faster performance at the
1307 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001308 * header file (zlib.h) for an explination of the compression functions.
1309 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001310
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001311/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001312 * value for "method" is 0.
1313 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001314PNG_EXPORT(67, void, png_set_filter,
1315 (png_structp png_ptr, int method, int filters));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001316
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001317/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001318 * are chosen so that they don't conflict with real filter types
1319 * below, in case they are supplied instead of the #defined constants.
1320 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001321 */
1322#define PNG_NO_FILTERS 0x00
1323#define PNG_FILTER_NONE 0x08
1324#define PNG_FILTER_SUB 0x10
1325#define PNG_FILTER_UP 0x20
1326#define PNG_FILTER_AVG 0x40
1327#define PNG_FILTER_PAETH 0x80
1328#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1329 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1330
Andreas Dilger47a0c421997-05-16 02:46:07 -05001331/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1332 * These defines should NOT be changed.
1333 */
1334#define PNG_FILTER_VALUE_NONE 0
1335#define PNG_FILTER_VALUE_SUB 1
1336#define PNG_FILTER_VALUE_UP 2
1337#define PNG_FILTER_VALUE_AVG 3
1338#define PNG_FILTER_VALUE_PAETH 4
1339#define PNG_FILTER_VALUE_LAST 5
1340
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001341#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001342/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1343 * defines, either the default (minimum-sum-of-absolute-differences), or
1344 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1345 *
1346 * Weights are factors >= 1.0, indicating how important it is to keep the
1347 * filter type consistent between rows. Larger numbers mean the current
1348 * filter is that many times as likely to be the same as the "num_weights"
1349 * previous filters. This is cumulative for each previous row with a weight.
1350 * There needs to be "num_weights" values in "filter_weights", or it can be
1351 * NULL if the weights aren't being specified. Weights have no influence on
1352 * the selection of the first row filter. Well chosen weights can (in theory)
1353 * improve the compression for a given image.
1354 *
1355 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1356 * filter type. Higher costs indicate more decoding expense, and are
1357 * therefore less likely to be selected over a filter with lower computational
1358 * costs. There needs to be a value in "filter_costs" for each valid filter
1359 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1360 * setting the costs. Costs try to improve the speed of decompression without
1361 * unduly increasing the compressed image size.
1362 *
1363 * A negative weight or cost indicates the default value is to be used, and
1364 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1365 * The default values for both weights and costs are currently 1.0, but may
1366 * change if good general weighting/cost heuristics can be found. If both
1367 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1368 * to the UNWEIGHTED method, but with added encoding time/computation.
1369 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001370PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
1371 int heuristic_method, int num_weights, png_const_doublep filter_weights,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001372 png_const_doublep filter_costs));
1373PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001374 (png_structp png_ptr,
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001375 int heuristic_method, int num_weights, png_const_fixed_point_p
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001376 filter_weights, png_const_fixed_point_p filter_costs));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001377#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1378
1379/* Heuristic used for row filter selection. These defines should NOT be
1380 * changed.
1381 */
1382#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1383#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1384#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1385#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1386
1387/* Set the library compression level. Currently, valid values range from
1388 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1389 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1390 * shown that zlib compression levels 3-6 usually perform as well as level 9
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001391 * for PNG images, and do considerably fewer caclulations. In the future,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001392 * these values may not correspond directly to the zlib compression levels.
1393 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001394PNG_EXPORT(69, void, png_set_compression_level,
1395 (png_structp png_ptr, int level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001396
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001397PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001398 int mem_level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001399
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001400PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001401 int strategy));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001402
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001403PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001404 int window_bits));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001405
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001406PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
1407 int method));
Guy Schalnat0d580581995-07-20 02:43:20 -05001408
Guy Schalnate5a37791996-06-05 15:50:50 -05001409/* These next functions are called for input/output, memory, and error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001410 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001411 * and call standard C I/O routines such as fread(), fwrite(), and
1412 * fprintf(). These functions can be made to use other I/O routines
1413 * at run time for those applications that need to handle I/O in a
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -05001414 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
Andreas Dilger47a0c421997-05-16 02:46:07 -05001415 * more information.
1416 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001417
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001418#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001419/* Initialize the input/output for the PNG file to the default functions. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001420PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001421#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001422
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001423/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001424 * supplied functions. If no messages are to be printed you must still
1425 * write and use replacement functions. The replacement error_fn should
1426 * still do a longjmp to the last setjmp location if you are using this
1427 * method of error handling. If error_fn or warning_fn is NULL, the
1428 * default function will be used.
1429 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001430
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001431PNG_EXPORT(75, void, png_set_error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001432 (png_structp png_ptr, png_voidp error_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001433 png_error_ptr error_fn, png_error_ptr warning_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001434
Guy Schalnate5a37791996-06-05 15:50:50 -05001435/* Return the user pointer associated with the error functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001436PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001437
1438/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001439 * If buffered output is not used, then output_flush_fn can be set to NULL.
1440 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1441 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001442 * It is probably a mistake to use NULL for output_flush_fn if
1443 * write_data_fn is not also NULL unless you have built libpng with
1444 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1445 * default flush function, which uses the standard *FILE structure, will
1446 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001447 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001448PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001449 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001450
1451/* Replace the default data input function with a user supplied one. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001452PNG_EXPORT(78, void, png_set_read_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001453 png_rw_ptr read_data_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001454
1455/* Return the user pointer associated with the I/O functions */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001456PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001457
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001458PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001459 png_read_status_ptr read_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001460
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001461PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001462 png_write_status_ptr write_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001463
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001464#ifdef PNG_USER_MEM_SUPPORTED
1465/* Replace the default memory allocation functions with user supplied one(s). */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001466PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001467 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001468/* Return the user pointer associated with the memory functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001469PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001470#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001471
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001472#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001473PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001474 png_user_transform_ptr read_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001475#endif
1476
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001477#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001478PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001479 png_user_transform_ptr write_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001480#endif
1481
John Bowler0a5c9c02011-01-22 17:36:34 -06001482#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001483PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
1484 png_voidp user_transform_ptr, int user_transform_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001485 int user_transform_channels));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001486/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001487PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001488 (png_const_structp png_ptr));
1489#endif
1490
1491#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1492/* Return information about the row currently being processed. Note that these
1493 * APIs do not fail but will return unexpected results if called outside a user
1494 * transform callback. Also note that when transforming an interlaced image the
John Bowler9616ad92011-02-16 06:13:46 -06001495 * row number is the row number within the sub-image of the interlace pass, so
1496 * the value will increase to the height of the sub-image (not the full image)
1497 * then reset to 0 for the next pass.
John Bowler5432c012011-02-12 08:59:17 -06001498 *
John Bowler9616ad92011-02-16 06:13:46 -06001499 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1500 * find the output pixel (x,y) given an interlaced sub-image pixel
1501 * (row,col,pass). (See below for these macros.)
John Bowler0a5c9c02011-01-22 17:36:34 -06001502 */
1503PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structp));
1504PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structp));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001505#endif
1506
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -06001507#ifdef PNG_USER_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001508PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001509 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
John Bowler0a5c9c02011-01-22 17:36:34 -06001510PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001511#endif
1512
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001513#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001514/* Sets the function callbacks for the push reader, and a pointer to a
1515 * user-defined structure available to the callback functions.
1516 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001517PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr,
1518 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001519 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001520
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001521/* Returns the user pointer associated with the push read functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001522PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, (png_const_structp png_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001523
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001524/* Function to be called when data becomes available */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001525PNG_EXPORT(92, void, png_process_data,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001526 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001527 png_bytep buffer, png_size_t buffer_size));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001528
John Bowler0a5c9c02011-01-22 17:36:34 -06001529/* A function which may be called *only* within png_process_data to stop the
1530 * processing of any more data. The function returns the number of bytes
1531 * remaining, excluding any that libpng has cached internally. A subsequent
1532 * call to png_process_data must supply these bytes again. If the argument
1533 * 'save' is set to true the routine will first save all the pending data and
1534 * will always return 0.
1535 */
1536PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structp, int save));
1537
1538/* A function which may be called *only* outside (after) a call to
1539 * png_process_data. It returns the number of bytes of data to skip in the
1540 * input. Normally it will return 0, but if it returns a non-zero value the
1541 * application must skip than number of bytes of input data and pass the
1542 * following data to the next call to png_process_data.
1543 */
1544PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structp));
1545
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001546/* Function that combines rows. 'new_row' is a flag that should come from
1547 * the callback and be non-NULL if anything needs to be done; the library
1548 * stores its own version of the new data internally and ignores the passed
1549 * in value.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001550 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001551PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001552 png_bytep old_row, png_const_bytep new_row));
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001553#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001554
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001555PNG_EXPORTA(94, png_voidp, png_malloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001556 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001557 PNG_ALLOCATED);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001558/* Added at libpng version 1.4.0 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001559PNG_EXPORTA(95, png_voidp, png_calloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001560 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001561 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001562
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001563/* Added at libpng version 1.2.4 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001564PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001565 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001566
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001567/* Frees a pointer allocated by png_malloc() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001568PNG_EXPORT(97, void, png_free, (png_structp png_ptr, png_voidp ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001569
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001570/* Free data that was allocated internally */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001571PNG_EXPORT(98, void, png_free_data,
1572 (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));
1573
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001574/* Reassign responsibility for freeing existing data, whether allocated
1575 * by libpng or by the application */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001576PNG_EXPORT(99, void, png_data_freer,
1577 (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));
1578
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001579/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001580#define PNG_DESTROY_WILL_FREE_DATA 1
1581#define PNG_SET_WILL_FREE_DATA 1
1582#define PNG_USER_WILL_FREE_DATA 2
1583/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001584#define PNG_FREE_HIST 0x0008
1585#define PNG_FREE_ICCP 0x0010
1586#define PNG_FREE_SPLT 0x0020
1587#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001588#define PNG_FREE_PCAL 0x0080
1589#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001590#define PNG_FREE_UNKN 0x0200
1591#define PNG_FREE_LIST 0x0400
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001592#define PNG_FREE_PLTE 0x1000
1593#define PNG_FREE_TRNS 0x2000
1594#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001595#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001596#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001597
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001598#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001599PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001600 png_alloc_size_t size), PNG_ALLOCATED);
1601PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001602#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001603
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001604#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001605/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001606PNG_EXPORTA(102, void, png_error,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001607 (png_structp png_ptr, png_const_charp error_message),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001608 PNG_NORETURN);
Guy Schalnat0d580581995-07-20 02:43:20 -05001609
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001610/* The same, but the chunk name is prepended to the error string. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001611PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001612 png_const_charp error_message), PNG_NORETURN);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001613
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001614#else
1615/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001616PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001617#endif
1618
Guy Schalnat6d764711995-12-19 03:22:19 -06001619/* Non-fatal error in libpng. Can continue, but may have a problem. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001620PNG_EXPORT(105, void, png_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001621 png_const_charp warning_message));
Guy Schalnat0d580581995-07-20 02:43:20 -05001622
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001623/* Non-fatal error in libpng, chunk name is prepended to message. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001624PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001625 png_const_charp warning_message));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001626
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001627#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1628/* Benign error in libpng. Can continue, but may have a problem.
1629 * User can choose whether to handle as a fatal error or as a warning. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001630# undef png_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001631PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001632 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001633
1634/* Same, chunk name is prepended to message. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001635# undef png_chunk_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001636PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001637 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001638
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001639PNG_EXPORT(109, void, png_set_benign_errors,
1640 (png_structp png_ptr, int allowed));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001641#else
1642# ifdef PNG_ALLOW_BENIGN_ERRORS
1643# define png_benign_error png_warning
1644# define png_chunk_benign_error png_chunk_warning
1645# else
1646# define png_benign_error png_error
1647# define png_chunk_benign_error png_chunk_error
1648# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001649#endif
1650
Andreas Dilger47a0c421997-05-16 02:46:07 -05001651/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1652 * Similarly, the png_get_<chunk> calls are used to read values from the
1653 * png_info_struct, either storing the parameters in the passed variables, or
1654 * setting pointers into the png_info_struct where the data is stored. The
1655 * png_get_<chunk> functions return a non-zero value if the data was available
1656 * in info_ptr, or return zero and do not change any of the parameters if the
1657 * data was not available.
1658 *
1659 * These functions should be used instead of directly accessing png_info
1660 * to avoid problems with future changes in the size and internal layout of
1661 * png_info_struct.
1662 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001663/* Returns "flag" if chunk data is valid in info_ptr. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001664PNG_EXPORT(110, png_uint_32, png_get_valid,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001665 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001666 png_uint_32 flag));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001667
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001668/* Returns number of bytes needed to hold a transformed row. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001669PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001670 png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001671
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001672#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001673/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001674 * returned from png_read_png().
1675 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001676PNG_EXPORT(112, png_bytepp, png_get_rows,
John Bowler0a5c9c02011-01-22 17:36:34 -06001677 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001678/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001679 * by png_write_png().
1680 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001681PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
1682 png_infop info_ptr, png_bytepp row_pointers));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001683#endif
1684
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001685/* Returns number of color channels in image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001686PNG_EXPORT(114, png_byte, png_get_channels,
John Bowler0a5c9c02011-01-22 17:36:34 -06001687 (png_const_structp png_ptr, png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001688
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001689#ifdef PNG_EASY_ACCESS_SUPPORTED
1690/* Returns image width in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001691PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001692 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001693
1694/* Returns image height in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001695PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001696 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001697
1698/* Returns image bit_depth. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001699PNG_EXPORT(117, png_byte, png_get_bit_depth,
John Bowler0a5c9c02011-01-22 17:36:34 -06001700 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001701
1702/* Returns image color_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001703PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001704 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001705
1706/* Returns image filter_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001707PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001708 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001709
1710/* Returns image interlace_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001711PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001712 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001713
1714/* Returns image compression_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001715PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001716 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001717
1718/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001719PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06001720 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001721PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06001722 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001723PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06001724 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001725
1726/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001727PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
John Bowler0a5c9c02011-01-22 17:36:34 -06001728 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001729PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06001730 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001731
1732/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001733PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06001734 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001735PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06001736 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001737PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06001738 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001739PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06001740 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001741
1742#endif /* PNG_EASY_ACCESS_SUPPORTED */
1743
Andreas Dilger47a0c421997-05-16 02:46:07 -05001744/* Returns pointer to signature string read from PNG header */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001745PNG_EXPORT(130, png_const_bytep, png_get_signature,
John Bowler0a5c9c02011-01-22 17:36:34 -06001746 (png_const_structp png_ptr, png_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001747
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001748#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001749PNG_EXPORT(131, png_uint_32, png_get_bKGD,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001750 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001751 png_color_16p *background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001752#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001753
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001754#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001755PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001756 png_const_color_16p background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001757#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001758
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001759#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001760PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structp png_ptr,
1761 png_const_infop info_ptr, double *white_x, double *white_y, double *red_x,
1762 double *red_y, double *green_x, double *green_y, double *blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001763 double *blue_y));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001764#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001765PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001766 (png_const_structp png_ptr,
1767 png_const_infop info_ptr, png_fixed_point *int_white_x,
1768 png_fixed_point *int_white_y, png_fixed_point *int_red_x,
1769 png_fixed_point *int_red_y, png_fixed_point *int_green_x,
1770 png_fixed_point *int_green_y, png_fixed_point *int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001771 png_fixed_point *int_blue_y));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001772#endif
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001773#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001774
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001775#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001776PNG_FP_EXPORT(135, void, png_set_cHRM,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001777 (png_structp png_ptr, png_infop info_ptr,
1778 double white_x, double white_y, double red_x, double red_y, double green_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001779 double green_y, double blue_x, double blue_y));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001780PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_structp png_ptr,
1781 png_infop info_ptr, png_fixed_point int_white_x,
1782 png_fixed_point int_white_y, png_fixed_point int_red_x,
1783 png_fixed_point int_red_y, png_fixed_point int_green_x,
1784 png_fixed_point int_green_y, png_fixed_point int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001785 png_fixed_point int_blue_y));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001786#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001787
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001788#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001789PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001790 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001791 double *file_gamma));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001792PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06001793 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001794 png_fixed_point *int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001795#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001796
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001797#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001798PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
1799 png_infop info_ptr, double file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001800PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001801 png_infop info_ptr, png_fixed_point int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001802#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001803
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001804#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001805PNG_EXPORT(141, png_uint_32, png_get_hIST,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001806 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001807 png_uint_16p *hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001808#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001809
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001810#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001811PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
1812 png_infop info_ptr, png_const_uint_16p hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001813#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001814
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001815PNG_EXPORT(143, png_uint_32, png_get_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001816 (png_structp png_ptr, png_infop info_ptr,
1817 png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001818 int *interlace_method, int *compression_method, int *filter_method));
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001819
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001820PNG_EXPORT(144, void, png_set_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001821 (png_structp png_ptr, png_infop info_ptr,
1822 png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001823 int interlace_method, int compression_method, int filter_method));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001824
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001825#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001826PNG_EXPORT(145, png_uint_32, png_get_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001827 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001828 png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001829#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001830
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001831#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001832PNG_EXPORT(146, void, png_set_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001833 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001834 png_int_32 offset_x, png_int_32 offset_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001835#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001836
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001837#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001838PNG_EXPORT(147, png_uint_32, png_get_pCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001839 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001840 png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001841 int *nparams,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001842 png_charp *units, png_charpp *params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001843#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001844
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001845#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001846PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001847 png_infop info_ptr,
1848 png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001849 int nparams, png_const_charp units, png_charpp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001850#endif
1851
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001852#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001853PNG_EXPORT(149, png_uint_32, png_get_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001854 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001855 png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001856#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001857
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001858#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001859PNG_EXPORT(150, void, png_set_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001860 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001861 png_uint_32 res_x, png_uint_32 res_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001862#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001863
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001864PNG_EXPORT(151, png_uint_32, png_get_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001865 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001866 png_colorp *palette, int *num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001867
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001868PNG_EXPORT(152, void, png_set_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001869 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001870 png_const_colorp palette, int num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001871
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001872#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001873PNG_EXPORT(153, png_uint_32, png_get_sBIT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001874 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001875 png_color_8p *sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001876#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001877
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001878#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001879PNG_EXPORT(154, void, png_set_sBIT,
1880 (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001881#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001882
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001883#ifdef PNG_sRGB_SUPPORTED
John Bowler0a5c9c02011-01-22 17:36:34 -06001884PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06001885 png_const_infop info_ptr, int *file_srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001886#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001887
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001888#ifdef PNG_sRGB_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001889PNG_EXPORT(156, void, png_set_sRGB,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06001890 (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001891PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06001892 png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001893#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001894
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001895#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001896PNG_EXPORT(158, png_uint_32, png_get_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001897 (png_const_structp png_ptr, png_const_infop info_ptr,
1898 png_charpp name, int *compression_type, png_bytepp profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001899 png_uint_32 *proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001900#endif
1901
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001902#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001903PNG_EXPORT(159, void, png_set_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001904 (png_structp png_ptr, png_infop info_ptr,
1905 png_const_charp name, int compression_type, png_const_bytep profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001906 png_uint_32 proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001907#endif
1908
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001909#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001910PNG_EXPORT(160, png_uint_32, png_get_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001911 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001912 png_sPLT_tpp entries));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001913#endif
1914
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001915#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001916PNG_EXPORT(161, void, png_set_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001917 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001918 png_const_sPLT_tp entries, int nentries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001919#endif
1920
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001921#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001922/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001923PNG_EXPORT(162, png_uint_32, png_get_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001924 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001925 png_textp *text_ptr, int *num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001926#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001927
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001928/* Note while png_set_text() will accept a structure whose text,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001929 * language, and translated keywords are NULL pointers, the structure
1930 * returned by png_get_text will always contain regular
1931 * zero-terminated C strings. They might be empty strings but
1932 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05001933 */
1934
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001935#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001936PNG_EXPORT(163, void, png_set_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001937 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001938 png_const_textp text_ptr, int num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001939#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001940
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001941#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001942PNG_EXPORT(164, png_uint_32, png_get_tIME,
John Bowler0a5c9c02011-01-22 17:36:34 -06001943 (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001944#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001945
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001946#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001947PNG_EXPORT(165, void, png_set_tIME,
1948 (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001949#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001950
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001951#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001952PNG_EXPORT(166, png_uint_32, png_get_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001953 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001954 png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001955#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001956
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001957#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001958PNG_EXPORT(167, void, png_set_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001959 (png_structp png_ptr, png_infop info_ptr,
1960 png_const_bytep trans_alpha, int num_trans,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001961 png_const_color_16p trans_color));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001962#endif
1963
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001964#ifdef PNG_sCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001965PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001966 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001967 int *unit, double *width, double *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05001968#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001969/* NOTE: this API is currently implemented using floating point arithmetic,
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05001970 * consequently it can only be used on systems with floating point support.
1971 * In any case the range of values supported by png_fixed_point is small and it
1972 * is highly recommended that png_get_sCAL_s be used instead.
1973 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001974PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06001975 (png_structp png_ptr, png_const_infop info_ptr, int *unit,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001976 png_fixed_point *width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001977 png_fixed_point *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05001978#endif
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001979PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
John Bowler0a5c9c02011-01-22 17:36:34 -06001980 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001981 int *unit, png_charpp swidth, png_charpp sheight));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001982
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001983PNG_FP_EXPORT(170, void, png_set_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001984 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001985 int unit, double width, double height));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001986PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr,
1987 png_infop info_ptr, int unit, png_fixed_point width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001988 png_fixed_point height));
1989PNG_EXPORT(171, void, png_set_sCAL_s,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001990 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001991 int unit, png_const_charp swidth, png_const_charp sheight));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001992#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001993
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05001994#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
1995/* Provide a list of chunks and how they are to be handled, if the built-in
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001996 handling or default unknown chunk handling is not desired. Any chunks not
1997 listed will be handled in the default manner. The IHDR and IEND chunks
1998 must not be listed.
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -05001999 keep = 0: follow default behaviour
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002000 = 1: do not keep
2001 = 2: keep only if safe-to-copy
2002 = 3: keep even if unsafe-to-copy
2003*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002004PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002005 (png_structp png_ptr, int keep,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002006 png_const_bytep chunk_list, int num_chunks));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002007PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002008 png_const_bytep chunk_name));
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002009#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002010#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002011PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002012 png_infop info_ptr, png_const_unknown_chunkp unknowns,
2013 int num_unknowns));
2014PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2015 (png_structp png_ptr, png_infop info_ptr, int chunk, int location));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002016PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002017 png_const_infop info_ptr, png_unknown_chunkpp entries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002018#endif
2019
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002020/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002021 * If you need to turn it off for a chunk that your application has freed,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002022 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2023 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002024PNG_EXPORT(177, void, png_set_invalid,
2025 (png_structp png_ptr, png_infop info_ptr, int mask));
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002026
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002027#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05002028/* The "params" pointer is currently not used and is for future expansion. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002029PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002030 int transforms, png_voidp params));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002031PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002032 int transforms, png_voidp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002033#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002034
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002035PNG_EXPORT(180, png_const_charp, png_get_copyright,
John Bowler0a5c9c02011-01-22 17:36:34 -06002036 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002037PNG_EXPORT(181, png_const_charp, png_get_header_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002038 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002039PNG_EXPORT(182, png_const_charp, png_get_header_version,
John Bowler0a5c9c02011-01-22 17:36:34 -06002040 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002041PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002042 (png_const_structp png_ptr));
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06002043
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002044#ifdef PNG_MNG_FEATURES_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002045PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002046 png_uint_32 mng_features_permitted));
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002047#endif
2048
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002049/* For use in png_set_keep_unknown, added to version 1.2.6 */
2050#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2051#define PNG_HANDLE_CHUNK_NEVER 1
2052#define PNG_HANDLE_CHUNK_IF_SAFE 2
2053#define PNG_HANDLE_CHUNK_ALWAYS 3
2054
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002055/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002056 * messages before passing them to the error or warning handler.
2057 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002058#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002059PNG_EXPORT(185, void, png_set_strip_error_numbers,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002060 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002061 png_uint_32 strip_mode));
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06002062#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002063
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002064/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002065#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002066PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002067 png_uint_32 user_width_max, png_uint_32 user_height_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002068PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002069 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002070PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002071 (png_const_structp png_ptr));
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05002072/* Added in libpng-1.4.0 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002073PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002074 png_uint_32 user_chunk_cache_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002075PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002076 (png_const_structp png_ptr));
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002077/* Added in libpng-1.4.1 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002078PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002079 png_alloc_size_t user_chunk_cache_max));
2080PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002081 (png_const_structp png_ptr));
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002082#endif
2083
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002084#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002085PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002086 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002087
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002088PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002089 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002090
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002091PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002092 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002093
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002094PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
John Bowler0a5c9c02011-01-22 17:36:34 -06002095 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002096#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002097PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002098 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002099#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002100
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002101PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002102 png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002103#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002104PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002105 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002106#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002107
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002108# ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002109PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002110 png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002111 int *unit_type));
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002112# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002113#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002114
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002115/* Added in libpng-1.4.0 */
2116#ifdef PNG_IO_STATE_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002117PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002118
Glenn Randers-Pehrsona63dbed2011-01-22 08:51:19 -06002119PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
2120 (png_structp png_ptr), PNG_DEPRECATED);
Glenn Randers-Pehrsoncf7cce62011-01-22 12:42:43 -06002121PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
John Bowler0a5c9c02011-01-22 17:36:34 -06002122 (png_const_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002123
2124/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002125# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2126# define PNG_IO_READING 0x0001 /* currently reading */
2127# define PNG_IO_WRITING 0x0002 /* currently writing */
2128# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2129# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2130# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2131# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2132# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2133# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002134#endif /* ?PNG_IO_STATE_SUPPORTED */
2135
John Bowler660c6e42010-12-19 06:22:23 -06002136/* Interlace support. The following macros are always defined so that if
2137 * libpng interlace handling is turned off the macros may be used to handle
2138 * interlaced images within the application.
2139 */
2140#define PNG_INTERLACE_ADAM7_PASSES 7
2141
2142/* Two macros to return the first row and first column of the original,
2143 * full, image which appears in a given pass. 'pass' is in the range 0
2144 * to 6 and the result is in the range 0 to 7.
2145 */
2146#define PNG_PASS_START_ROW(pass) (((1U&~(pass))<<(3-((pass)>>1)))&7)
2147#define PNG_PASS_START_COL(pass) (((1U& (pass))<<(3-(((pass)+1)>>1)))&7)
2148
2149/* Two macros to help evaluate the number of rows or columns in each
2150 * pass. This is expressed as a shift - effectively log2 of the number or
2151 * rows or columns in each 8x8 tile of the original image.
2152 */
2153#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2154#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2155
2156/* Hence two macros to determine the number of rows or columns in a given
2157 * pass of an image given its height or width. In fact these macros may
2158 * return non-zero even though the sub-image is empty, because the other
2159 * dimension may be empty for a small image.
2160 */
2161#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2162 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2163#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2164 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2165
John Bowler9616ad92011-02-16 06:13:46 -06002166/* For the reader row callbacks (both progressive and sequential) it is
2167 * necessary to find the row in the output image given a row in an interlaced
2168 * image, so two more macros:
John Bowler660c6e42010-12-19 06:22:23 -06002169 */
2170#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
2171 (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2172#define PNG_COL_FROM_PASS_COL(xIn, pass) \
2173 (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2174
2175/* Two macros which return a boolean (0 or 1) saying whether the given row
2176 * or column is in a particular pass. These use a common utility macro that
2177 * returns a mask for a given pass - the offset 'off' selects the row or
2178 * column version. The mask has the appropriate bit set for each column in
2179 * the tile.
2180 */
2181#define PNG_PASS_MASK(pass,off) ( \
2182 ((0x110145AFU>>(((7-(off))-(pass))<<2)) & 0xFU) | \
2183 ((0x01145AF0U>>(((7-(off))-(pass))<<2)) & 0xF0U))
2184
2185#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2186 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2187#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2188 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2189
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002190#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05002191/* With these routines we avoid an integer divide, which will be slower on
2192 * most machines. However, it does take more operations than the corresponding
2193 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002194 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2195 *
2196 * Note that the rounding factors are NOT supposed to be the same! 128 and
2197 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2198 * standard method.
2199 *
2200 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2201 */
2202
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002203 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002204
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002205# define png_composite(composite, fg, alpha, bg) \
2206 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2207 * (png_uint_16)(alpha) \
2208 + (png_uint_16)(bg)*(png_uint_16)(255 \
2209 - (png_uint_16)(alpha)) + (png_uint_16)128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002210 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002211
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002212# define png_composite_16(composite, fg, alpha, bg) \
2213 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2214 * (png_uint_32)(alpha) \
2215 + (png_uint_32)(bg)*(png_uint_32)(65535L \
2216 - (png_uint_32)(alpha)) + (png_uint_32)32768L); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002217 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2218
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002219#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002220
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002221# define png_composite(composite, fg, alpha, bg) \
2222 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002223 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2224 (png_uint_16)127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002225
2226# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002227 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002228 (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002229 (png_uint_32)32767) / (png_uint_32)65535L)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002230#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2231
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002232#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002233PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2234PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2235PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002236#endif
2237
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002238PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002239 png_const_bytep buf));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002240/* No png_get_int_16 -- may be added if there's a real need for it. */
2241
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002242/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002243#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002244PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002245#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002246#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002247PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002248#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002249
2250/* Place a 16-bit number into a buffer in PNG byte order.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002251 * The parameter is declared unsigned int, not png_uint_16,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002252 * just to avoid potential problems on pre-ANSI C compilers.
2253 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002254#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002255PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002256/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002257#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002258
John Bowlerf21a0d02011-01-23 23:55:19 -06002259#ifdef PNG_USE_READ_MACROS
2260/* Inline macros to do direct reads of bytes from the input buffer.
2261 * The png_get_int_32() routine assumes we are using two's complement
2262 * format for negative values, which is almost certainly true.
2263 */
2264# define png_get_uint_32(buf) \
2265 (((png_uint_32)(*(buf)) << 24) + \
2266 ((png_uint_32)(*((buf) + 1)) << 16) + \
2267 ((png_uint_32)(*((buf) + 2)) << 8) + \
2268 ((png_uint_32)(*((buf) + 3))))
2269
2270 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2271 * function) incorrectly returned a value of type png_uint_32.
2272 */
2273# define png_get_uint_16(buf) \
2274 ((png_uint_16) \
2275 (((unsigned int)(*(buf)) << 8) + \
2276 ((unsigned int)(*((buf) + 1)))))
2277
2278# define png_get_int_32(buf) \
2279 ((png_int_32)((*(buf) & 0x80) \
2280 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2281 : (png_int_32)png_get_uint_32(buf)))
2282#endif
2283
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002284/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
2285 * defs
2286 */
2287
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06002288/* The last ordinal number (this is the *last* one already used; the next
John Bowler71a10f22011-01-22 17:03:33 -06002289 * one to use is one more than this.) Maintainer, remember to add an entry to
2290 * scripts/symbols.def as well.
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002291 */
2292#ifdef PNG_EXPORT_LAST_ORDINAL
John Bowler4d562962011-02-12 09:01:20 -06002293 PNG_EXPORT_LAST_ORDINAL(221);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002294#endif
2295
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06002296#ifdef __cplusplus
2297}
2298#endif
2299
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05002300#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002301/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05002302#endif /* PNG_H */